Sha256: 41b0ff5f7480c24ad6852850aeb0c8aeee5a2c20d98fa3351b5970bef092ae1c
Contents?: true
Size: 1.99 KB
Versions: 4
Compression:
Stored size: 1.99 KB
Contents
# BacklogKit Ruby wrapper for the Nulab's Backlog API. http://developer.nulab-inc.com/docs/backlog ## Installation Add this line to your application's Gemfile: ```ruby gem 'backlog_kit' ``` And then execute: $ bundle Or install it yourself as: $ gem install backlog_kit ## Usage ```ruby require 'backlog_kit' client = BacklogKit::Client.new(space_id: 'emsk', api_key: '1234567890abcdefghij1234567890abcdefghij1234567890abcdefghij1234') client.get('space').body # get body client.get('space').headers # get headers client.get('space').status # get status client.get('space/activities') # no params client.get('space/activities', activity_type_id: [1, 4], min_id: 100) # underscored key client.get('space/activities', activityTypeId: [1, 4], minId: 100) # camelized key client.post('groups', name: 'beer') # POST method client.put('space/notification', content: 'Cheers!') # PUT method client.patch('groups/3712', name: 'whiskey') # PATCH method client.delete('groups/3712') # DELETE method ``` ## ENV | ENV Variable | Description | | :----------- | :---------- | | `BACKLOG_SPACE_ID` | Your Backlog SPACE ID. | | `BACKLOG_API_KEY` | Your Backlog API KEY. | You can create instance more easily. ```ruby client = BacklogKit::Client.new ``` ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). ## Contributing 1. Fork it ( https://github.com/emsk/backlog_kit/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create a new Pull Request
Version data entries
4 entries across 4 versions & 1 rubygems
Version | Path |
---|---|
backlog_kit-0.4.0 | README.md |
backlog_kit-0.3.0 | README.md |
backlog_kit-0.2.0 | README.md |
backlog_kit-0.1.0 | README.md |