rally-wsapi 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be4c514397f117ea3342afc604396b06566f4b85
-  data.tar.gz: 24a2a62eda3acfc4f07987a3b82e5886b4e4a340
+  metadata.gz: e8fcd6dfc98a371448591ac323e980f16b38220b
+  data.tar.gz: 16fde94fe2cd3776b90ca3150f92cbc147634e65
 SHA512:
-  metadata.gz: c9e2349dcf01af9ab1f30d6aa53985ac261393ba7666c0416f74139c26485d44c87a6cc874cb36f4175fc874e8bdac15c91bfe06fcd5e9579557acf30f41c1f2
-  data.tar.gz: e4adcad4ba557ed70b8af29009115af83a29b4e3c7036d27cb6efceab2402ca734e454f7265c8d9696263da0581d83fe0fef5e2f28c124e37a6b0df74890cd0d
+  metadata.gz: df67aba1e91f9e1e650ca5d5304d6d9c16da733471df6e0f4bebc26d4637502a84da570f1cb754c7c67befdeb52ff277a690cf9c2034b336df8c5439fcc27d0a
+  data.tar.gz: 51a297733c01698f72bb1aacd44f7385f7577683b304f0b7fca522e19870e364e039dbe3397ebacb237aee610fbc50e356e7a0a51526ad574670a51a42f09ffd

data/Gemfile.lock

@@ -35,7 +35,7 @@ GEM
       rdoc
     json (1.8.1)
     jwt (1.2.0)
-    mini_portile (0.6.2)
+    mini_portile (0.6.1)
     multi_json (1.10.1)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
@@ -47,7 +47,7 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
-    rack (1.6.0)
+    rack (1.5.2)
     rake (10.4.2)
     rdoc (4.2.0)
       json (~> 1.4)

data/README.md

@@ -14,7 +14,15 @@ s = Wsapi::Session.new("deadbeefdeadbeef")
 The constructor also accepts the following options:
   * `:workspace_id`, if not given, user's default workspace is used for queries
   * `:version`, WSAPI version, default is `3.0`
+  * `oauth2`, see: (using WSAPI with OAuth2)[https://github.com/flowdock/rally-wsapi#using-wsapi-with-oauth2]
 
+### Using WSAPI with OAuth2
+
+Authenticating to WSAPI is also possible with OAuth2. Access token used in
+requests is given in place of the API token. Refresh token can be supplied with
+`Wsapi::Session#.setup_refresh_token(client_id, client_secret, refresh_token)`
+method. It takes optional block parameter, which is called every time the
+access token is refreshed.
 
 ## Method reference for Session
 
@@ -81,6 +89,13 @@ get_editors(project_id, opts = {})
 update_artifact(artifact_type, artifact_id, parameters)
 ```
 
+### Setup refresh token to be used with OAuth2
+```
+setup_refresh_token(client_id, client_secret, refresh_token, &block)
+```
+
+See (Using WSAPI with OAuth2)[https://github.com/flowdock/rally-wsapi#using-wsapi-with-oauth2] for more info.
+
 ## Result objects
 
 There's a couple of convenience classes for the following object types:

data/Rakefile

@@ -6,7 +6,7 @@ Jeweler::Tasks.new do |s|
   s.email = "antti@flowdock.com"
   s.homepage = "http://github.com/flowdock/rally-wsapi"
   s.description = "Simple client for Rally WSAPI"
-  s.authors = ["Antti Pitkänen"]
+  s.authors = ["Antti Pitkänen", "Oskari Virtanen"]
   s.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*"]
   s.licenses = ["MIT"]
 end

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.1.0

data/lib/wsapi/session.rb

@@ -4,7 +4,6 @@ require 'faraday_middleware'
 require 'excon'
 
 require_relative './mapper'
-
 module Wsapi
   class StandardErrorWithResponse < StandardError
     attr_reader :response
@@ -19,6 +18,7 @@ module Wsapi
   class IpAddressLimited < StandardErrorWithResponse; end
 
   WSAPI_URL = ENV['WSAPI_URL'] || 'https://rally1.rallydev.com/slm/webservice/'
+  AUTH_URL = ENV['RALLY_AUTHENTICATION_URL'] || "https://rally1.rallydev.com/login/oauth2/token"
 
   class WsapiAuthentication < Faraday::Middleware
     def initialize(logger, session_id)
@@ -37,13 +37,17 @@ module Wsapi
 
     def initialize(session_id, opts = {})
       @api_version = opts[:version] || "3.0"
-      @session_id = session_id
       @workspace_id = opts[:workspace_id]
-      @conn = Faraday.new(ssl: {version: :TLSv1}) do |faraday|
-        faraday.request :json
-        faraday.use WsapiAuthentication, @session_id
-        faraday.adapter :excon
-      end
+      @conn = connection(session_id)
+    end
+
+    def setup_refresh_token(client_id, client_secret, refresh_token, &block)
+      @oauth2 = {
+        client_id: client_id,
+        client_secret: client_secret,
+        refresh_token: refresh_token,
+        refresh_token_updated: block
+      }
     end
 
     def get_user_subscription
@@ -106,6 +110,14 @@ module Wsapi
 
     private
 
+    def connection(session_id)
+      Faraday.new(ssl: {version: :TLSv1}) do |faraday|
+        faraday.request :json
+        faraday.use WsapiAuthentication, session_id
+        faraday.adapter :excon
+      end
+    end
+
     def workspace_url
       wsapi_resource_url("Workspace/#{@workspace_id}")
     end
@@ -115,22 +127,62 @@ module Wsapi
     end
 
     def wsapi_post(url, opts = {})
-      response = @conn.post url, opts
+      response = wsapi_request_with_refresh_token(:post, url, opts)
       check_response_for_errors!(response)
 
       response
     end
 
     def wsapi_get(url, opts = {})
-      response = @conn.get do |req|
-        req.url url
-        req.params['workspace'] = workspace_url if @workspace_id
-        req.params['query'] = opts[:query] if opts[:query]
-        req.params['start'] = opts[:start] || 1
-        req.params['pagesize'] = opts[:pagesize] || 200
-        req.params['fetch'] = opts[:fetch] || true # by default, fetch full objects
+      request_options = {}
+      request_options['workspace'] = workspace_url if @workspace_id
+      request_options['query'] = opts[:query] if opts[:query]
+      request_options['start'] = opts[:start] || 1
+      request_options['pagesize'] = opts[:pagesize] || 200
+      request_options['fetch'] = opts[:fetch] || true # by default, fetch full objects
+
+      response = wsapi_request_with_refresh_token(:get, url, request_options)
+      check_response_for_errors!(response)
+
+      response
+    end
+
+    def wsapi_request_with_refresh_token(method, url, opts = {})
+      response = @conn.send(method, url, opts)
+      if defined?(@oauth2) && response.status == 401
+        refresh_token_response = refresh_token!
+
+        access_token = MultiJson.load(refresh_token_response.body)["access_token"]
+        @conn = connection(access_token)
+        response = @conn.send(method, url, opts) # Try again with fresh token
+      end
+
+      response
+    end
+
+    def refresh_token!
+      client = Faraday.new(ssl: {version: :TLSv1}) do |faraday|
+        faraday.request :url_encoded
+        faraday.adapter :excon
       end
+
+      refresh_params = {
+        grant_type: "refresh_token",
+        refresh_token: @oauth2[:refresh_token],
+        client_id: @oauth2[:client_id],
+        client_secret: @oauth2[:client_secret]
+      }
+
+      response = client.post AUTH_URL, refresh_params
+
       check_response_for_errors!(response)
+
+      response_body = MultiJson.load(response.body)
+
+      @oauth2[:refresh_token] = response_body["refresh_token"]
+      if @oauth2[:refresh_token_updated]
+        @oauth2[:refresh_token_updated].call(MultiJson.load(response.body))
+      end
       response
     end
 

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rally-wsapi
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Antti Pitkänen
+- Oskari Virtanen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-05 00:00:00.000000000 Z
+date: 2015-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Simple client for Rally WSAPI