Giter VIP home page Giter VIP logo

blimp's Introduction

Blimp Gem Version Dependency Status

Ruby gem that implements Blimp's public API.

Note: This is a maintained fork of the Blimp gem by Blake Williams.

Installation

Add this line to your application's Gemfile:

gem 'jonahoffline-blimp'

NOTE: Must include the httparty gem:

gem 'httparty'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jonahoffline-blimp

Usage

Use the following template for your API credentials. If you don't have them already, you can get them here.

Blimp.api_key = "API_KEY"
Blimp.app_id = "APP_ID"
Blimp.app_secret = "APP_SECRET"
Blimp.username = "USERNAME"

This gem implements Company, Project, Goal, Task, Comment, File, and User resources. There are two main methods for finding resources, first there is the find method that finds a single instance of a resource by its id. There is also a find_all method that returns an array of all of that resource.

project = Blimp::Project.find(1)  # Finds a project with an id of 1
Blimp::Company.find_all # Finds all of the companies you have access to 

project.name = "New Project Name" # Set the name of the project
project.save # Attempts to save the project's changes

Todo

  • Start testing the gem with Minitest
  • Handle required fields when creating new resources
  • Have better error coverage

Contributing

  1. Fork it
  2. Commit your changes
  3. Push to the your fork
  4. Create new Pull Request

blimp's People

Contributors

jonahoffline avatar ryanoliver avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.