backlog_kit 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e134e8fc91f309ca6a70a8ad4280b03b4b06973
-  data.tar.gz: f6e4204aaf0ff0226f8acc95b41f437d04adf6b7
+  metadata.gz: 752006db289cf9dfc2aa04609fed2c79a74bbe61
+  data.tar.gz: b3efd3ad0b22dfc8918e8424212bf93ad7304757
 SHA512:
-  metadata.gz: 7811c7270d413a3afc7c056be6fbcba44b1a81fa9e11377c913bafc7ef88a914b3bc0e82e2df3d7ffe58b496f0554b35f6ef3d9718cf2eb7a5418aedbbd96e08
-  data.tar.gz: 26478ad2a3c3fef466033aac4dec28cd74cb58e9e1086b89e46c1c11d57d93d18f860e8e3974b888840c25f4b22c35e8351ff15bdb1a7152c184bd63c6082982
+  metadata.gz: 4ef392ccd33e88bc673d77ccebbaa04f03aebc81c6aea71b44d2dd0adae9447defb1981b3908f5a5c2b7705a4efc1c25d462faa68c5305f5c3042b77f0857a55
+  data.tar.gz: 70d3ea2aa209d494d34f2fa1b976d4e1df68a02e6ec246c2a83264795de09a8380da6e533459e7d286e59542655e1876d5e8522ff7811735280d2cf6ab64711f

data/README.md

@@ -31,20 +31,51 @@ Or install it yourself as:
 ```ruby
 require 'backlog_kit'
 
-client = BacklogKit::Client.new(space_id: 'emsk', api_key: '1234567890abcdefghij1234567890abcdefghij1234567890abcdefghij1234')
+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.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.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
+client.get_groups.body[0].members[0].mail_address # method chaining
+```
+
+You can also use low-level methods.
+
+```ruby
+client.get('projects/1234/customFields') # GET
+client.post('groups', name: 'beer') # POST
+client.put('space/notification', content: 'Cheers!') # PUT
+client.patch('groups/3712', name: 'whiskey') # PATCH
+client.delete('groups/3712') # DELETE
+```
+
+## Authentication
+
+### API Key
+
+```ruby
+client = BacklogKit::Client.new(
+  space_id: 'emsk',
+  api_key: '1234567890abcdefghij1234567890abcdefghij1234567890abcdefghij1234'
+)
+```
+
+### OAuth access token
+
+```ruby
+client = BacklogKit::Client.new(
+  space_id: 'emsk',
+  api_key: nil, # api_key should be nil
+  access_token: 'abcdefghij1234567890abcdefghij1234567890abcdefghij1234567890abcd'
+)
 ```
 
 ## ENV
@@ -53,6 +84,9 @@ client.delete('groups/3712') # DELETE method
 | :----------- | :---------- |
 | `BACKLOG_SPACE_ID` | Your Backlog SPACE ID. |
 | `BACKLOG_API_KEY` | Your Backlog API KEY. |
+| `BACKLOG_OAUTH_CLIENT_ID` | CLIENT ID of your Backlog application. |
+| `BACKLOG_OAUTH_CLIENT_SECRET` | CLIENT SECRET of your Backlog application. |
+| `BACKLOG_OAUTH_REFRESH_TOKEN` | REFRESH TOKEN obtained from the Backlog token endpoint. |
 
 You can create instance more easily.
 
@@ -60,6 +94,23 @@ You can create instance more easily.
 client = BacklogKit::Client.new
 ```
 
+## Supported API
+
+* Git
+* Group
+* Issue
+* Notification
+* Priority
+* Project
+* Resolution
+* Space
+* Star
+* Status
+* User
+* Wiki
+
+See [RDoc](http://www.rubydoc.info/gems/backlog_kit) for more details.
+
 ## 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.

data/lib/backlog_kit/client.rb

@@ -1,6 +1,7 @@
 require 'backlog_kit/error'
 require 'backlog_kit/response'
 require 'backlog_kit/version'
+require 'backlog_kit/client/authorization'
 require 'backlog_kit/client/git'
 require 'backlog_kit/client/group'
 require 'backlog_kit/client/issue'
@@ -19,6 +20,7 @@ require 'backlog_kit/hash_extensions'
 
 module BacklogKit
   class Client
+    include BacklogKit::Client::Authorization
     include BacklogKit::Client::Git
     include BacklogKit::Client::Group
     include BacklogKit::Client::Issue
@@ -34,17 +36,36 @@ module BacklogKit
 
     USER_AGENT = "BacklogKit Ruby Gem #{BacklogKit::VERSION}".freeze
 
-    attr_accessor(:space_id, :api_key)
+    attr_accessor(
+      :space_id,
+      :api_key,
+      :client_id,
+      :client_secret,
+      :refresh_token,
+      :redirect_uri,
+      :state,
+      :access_token
+    )
 
     def initialize(options = {})
-      @space_id = ENV['BACKLOG_SPACE_ID']
-      @api_key  = ENV['BACKLOG_API_KEY']
+      @space_id      = ENV['BACKLOG_SPACE_ID']
+      @api_key       = ENV['BACKLOG_API_KEY']
+      @client_id     = ENV['BACKLOG_OAUTH_CLIENT_ID']
+      @client_secret = ENV['BACKLOG_OAUTH_CLIENT_SECRET']
+      @refresh_token = ENV['BACKLOG_OAUTH_REFRESH_TOKEN']
 
       options.each do |key, value|
         instance_variable_set(:"@#{key}", value)
       end
     end
 
+    def authorization_url
+      url = "#{host}/OAuth2AccessRequest.action?response_type=code&client_id=#{@client_id}"
+      url += "&redirect_uri=#{URI.escape(@redirect_uri)}" if @redirect_uri
+      url += "&state=#{@state}" if @state
+      url
+    end
+
     def get(path, params = {})
       request(:get, path, params)
     end
@@ -67,8 +88,8 @@ module BacklogKit
 
     private
 
-    def request(method, path, params = {})
-      params.camelize_keys!
+    def request(method, path, params = {}, raw_params = false)
+      params.camelize_keys! unless raw_params
       faraday_response = connection.send(method, request_path(path), params)
       BacklogKit::Response.new(faraday_response)
     rescue Faraday::ConnectionFailed => e
@@ -91,11 +112,19 @@ module BacklogKit
     end
 
     def request_headers
-      { 'User-Agent' => USER_AGENT }
+      headers = { 'User-Agent' => USER_AGENT }
+      headers.merge!('Authorization' => "Bearer #{@access_token}") if oauth_request?
+      headers
+    end
+
+    def oauth_request?
+      !@api_key && @access_token
     end
 
     def request_path(path)
-      "/api/v2/#{URI.escape(path)}?apiKey=#{URI.escape(@api_key.to_s)}"
+      path = "/api/v2/#{URI.escape(path)}"
+      path += "?apiKey=#{URI.escape(@api_key.to_s)}" if @api_key
+      path
     end
   end
 end

data/lib/backlog_kit/client/authorization.rb

@@ -0,0 +1,26 @@
+module BacklogKit
+  class Client
+    module Authorization
+      def create_token(oauth_code)
+        params = {
+          client_id: client_id,
+          client_secret: client_secret,
+          grant_type: 'authorization_code',
+          code: oauth_code
+        }
+        params.merge!(redirect_uri: redirect_uri) if redirect_uri
+        request(:post, 'oauth2/token', params, true)
+      end
+
+      def update_token
+        params = {
+          client_id: client_id,
+          client_secret: client_secret,
+          grant_type: 'refresh_token',
+          refresh_token: refresh_token
+        }
+        request(:post, 'oauth2/token', params, true)
+      end
+    end
+  end
+end

data/lib/backlog_kit/version.rb

@@ -1,3 +1,3 @@
 module BacklogKit
-  VERSION = '0.11.0'.freeze
+  VERSION = '0.12.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backlog_kit
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - emsk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2015-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -184,6 +184,7 @@ files:
 - bin/setup
 - lib/backlog_kit.rb
 - lib/backlog_kit/client.rb
+- lib/backlog_kit/client/authorization.rb
 - lib/backlog_kit/client/git.rb
 - lib/backlog_kit/client/group.rb
 - lib/backlog_kit/client/issue.rb