roqua-core-api 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afcb8f55c765892ee686c50b9b069af7a42242cc
-  data.tar.gz: 231798c7c1c9f410237f4d9f4d683be12d3c8188
+  metadata.gz: a72749c7f2600d3b71d258d719abc54d8e81f6ca
+  data.tar.gz: cd987f3e2b2784a18f901c09bcbe624c69f97943
 SHA512:
-  metadata.gz: 053913480e04a70b7e0521b65ebc4bfac5fcb1901efcd7864a34e98642f1570e8c186bf54fd65271b88ead86d982c6e9575dd677d340efc4cfe43102770d7764
-  data.tar.gz: 9eb9cd12a83f09c7a8e956098b42d305ea639020a085eb3240403b90599b743951f5b442d140199eca9f743224f0f2f27a63c036707d75bd0ae7f22708311a91
+  metadata.gz: 6ecc43438656a7fd8336060b40f27ce0a3325a6382edc494ad465aa90f82a126077d1c3c838b32baebbafa7feab364beee5e063320fbbbad122937b46d16087f
+  data.tar.gz: d23c4e9df670e6e818e492f97ef7e412f1814fe1c7e5f6d49fa414e716f87db6b5bb878c86098558c1bf146ab3a7bf9e75e30d35428ba101c36115c7fc571c5c

data/ChangeLog.md

@@ -1,3 +1,9 @@
+### 0.2.2
+
+* Added Sessions::HmacAuthSession
+* Added Sessions::HmacAuthRequest
+* Added SsoLogin
+
 ### 0.2.1
 
 * Allow SendInviteEmail to receive a person_id instead of a dossier_id

data/lib/roqua/core_api/sessions/auth_session.rb

@@ -13,40 +13,28 @@ module Roqua
 
         def get(path, timeout: default_timeout, **params)
           perform_request_or_fail do
-            HTTParty.get(full_url_for(path),
-                         headers: headers,
-                         query: params,
-                         basic_auth: basic_auth,
-                         timeout: timeout)
+            HTTParty.get full_url_for(path),
+                         query_string_options('GET', path, params, timeout: timeout)
           end
         end
 
         def post(path, timeout: default_timeout, **params)
           perform_request_or_fail do
-            HTTParty.post(full_url_for(path),
-                          headers: headers.merge('Content-Type' => 'application/json'),
-                          body: params.to_json,
-                          basic_auth: basic_auth,
-                          timeout: timeout)
+            HTTParty.post full_url_for(path),
+                          json_body_options('POST', path, params, timeout: timeout)
           end
         end
 
         def patch(path, timeout: default_timeout, **params)
           perform_request_or_fail do
-            HTTParty.patch(full_url_for(path),
-                           headers: headers.merge('Content-Type' => 'application/json'),
-                           body: params.to_json,
-                           basic_auth: basic_auth,
-                           timeout: timeout)
+            HTTParty.patch full_url_for(path),
+                           json_body_options('PATCH', path, params, timeout: timeout)
           end
         end
 
         def delete(path, timeout: default_timeout, **params)
-          HTTParty.delete(full_url_for(path),
-                          headers: headers,
-                          query: params,
-                          basic_auth: basic_auth,
-                          timeout: timeout)
+          HTTParty.delete full_url_for(path),
+                          query_string_options('DELETE', path, params, timeout: timeout)
         end
 
         private
@@ -63,6 +51,20 @@ module Roqua
           end
         end
 
+        def json_body_options(request_method, path, params, timeout:)
+          {headers: headers(request_method, path, params).merge('Content-Type' => 'application/json'),
+           body: params.to_json,
+           basic_auth: basic_auth,
+           timeout: timeout}
+        end
+
+        def query_string_options(request_method, path, params, timeout:)
+          {headers: headers(request_method, path, params),
+           query: params,
+           basic_auth: basic_auth,
+           timeout: timeout}
+        end
+
         def full_url_for(path)
           core_site + api_base + path + '.json'
         end
@@ -71,7 +73,7 @@ module Roqua
           '/api/v1'
         end
 
-        def headers
+        def headers(_request_method, _path, _params)
           {}
         end
 

data/lib/roqua/core_api/sessions/hmac_auth_request.rb

@@ -0,0 +1,52 @@
+module Roqua
+  module CoreApi
+    module Sessions
+      # Make a single hmac signed request.
+      # HmacAuthRequest.new(consumer_key: 'mykey', consumer_secret: '...')
+      # HmacAuthRequest.new(consumer_key: 'mykey', hmac: '...', nonce: '...', timestamp: 1467704698)
+      class HmacAuthRequest < AuthSession
+        attr_reader :consumer_key, :consumer_secret, :timestamp, :nonce
+
+        def initialize(consumer_key: ENV.fetch('CORE_CONSUMER_KEY'),
+                       consumer_secret: ENV.fetch('CORE_CONSUMER_SECRET'),
+                       timestamp: Time.now.to_i,
+                       nonce: SecureRandom.urlsafe_base64(32),
+                       hmac: nil,
+                       **additional_arguments)
+          @consumer_key = consumer_key
+          @consumer_secret = consumer_secret
+          @timestamp = timestamp
+          @nonce = nonce
+          @hmac = hmac
+          super additional_arguments
+        end
+
+        def headers(request_method, path, params)
+          {'Authorization' => "HMAC #{consumer_key}:#{hmac(request_method, path, params)}:#{nonce}:#{timestamp}"}
+        end
+
+        # handle 401 response.
+        def access_denied(response)
+          fail Unauthorized, response
+        end
+
+        private
+
+        def hmac(request_method, path, params)
+          @hmac || calculate_hmac(request_method, path, params)
+        end
+
+        def calculate_hmac(request_method, path, params)
+          checker = Authmac::HmacChecker.new(consumer_secret, '|', 'sha256')
+          params_to_sign = params.merge \
+            'request_method' => request_method,
+            'request_path' => "/api/v1#{path}",
+            'timestamp'    => timestamp.to_s,
+            'nonce'        => nonce,
+            'consumer_key' => consumer_key
+          checker.sign(params_to_sign.with_indifferent_access)
+        end
+      end
+    end
+  end
+end

data/lib/roqua/core_api/sessions/hmac_auth_session.rb

@@ -0,0 +1,25 @@
+module Roqua
+  module CoreApi
+    module Sessions
+      class HmacAuthSession < AuthSession
+        attr_reader :consumer_key, :consumer_secret
+
+        delegate :headers, :access_denied, to: :hmac_auth_request
+
+        def initialize(consumer_key: ENV.fetch('CORE_CONSUMER_KEY'),
+                       consumer_secret: ENV.fetch('CORE_CONSUMER_SECRET'),
+                       **additional_arguments)
+          @consumer_key = consumer_key
+          @consumer_secret = consumer_secret
+          super additional_arguments
+        end
+
+        private
+
+        def hmac_auth_request
+          HmacAuthRequest.new(consumer_key: consumer_key, consumer_secret: consumer_secret)
+        end
+      end
+    end
+  end
+end

data/lib/roqua/core_api/sessions/oauth_session.rb

@@ -29,7 +29,7 @@ module Roqua
           end
         end
 
-        def headers
+        def headers(_request_method, _path, _params)
           {"Authorization" => "Bearer #{access_token}"}
         end
       end

data/lib/roqua/core_api/sessions/token_session.rb

@@ -29,7 +29,7 @@ module Roqua
           end
         end
 
-        def headers
+        def headers(_request_method, _path, _params)
           {"Authorization" => "Session #{access_token}"}
         end
       end

data/lib/roqua/core_api/sessions.rb

@@ -3,6 +3,8 @@ require 'roqua/core_api/sessions/auth_session'
 require 'roqua/core_api/sessions/oauth_session'
 require 'roqua/core_api/sessions/token_session'
 require 'roqua/core_api/sessions/basic_auth_session'
+require 'roqua/core_api/sessions/hmac_auth_request'
+require 'roqua/core_api/sessions/hmac_auth_session'
 
 module Roqua
   module CoreApi
@@ -17,5 +19,9 @@ module Roqua
     def self.basic_auth_session(*arguments, &block)
       Sessions::BasicAuthSession.new(*arguments, &block)
     end
+
+    def self.hmac_auth_request(*arguments)
+      Sessions::HmacAuthRequest(*arguments)
+    end
   end
 end

data/lib/roqua/core_api/sso_login.rb

@@ -0,0 +1,28 @@
+module Roqua
+  module CoreApi
+    # @api private
+    class SsoLogin < Base
+      object :session, class: Sessions::AuthSession
+      string :organization_id
+      string :dossier_group_id
+      string :external_identifier
+      hash :extra_params, strip: false, default: {}
+
+      def execute
+        response = session.get "/sso/login", **sso_params
+        if response.code == 422
+          errors_to_usecase response
+        end
+        response['token_session']
+      end
+
+      def sso_params
+        extra_params.merge(
+          organization_id: organization_id,
+          dossier_group_id: dossier_group_id,
+          external_identifier: external_identifier
+        ).symbolize_keys
+      end
+    end
+  end
+end

data/lib/roqua/core_api/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module CoreApi
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end

data/lib/roqua/core_api.rb

@@ -25,6 +25,7 @@ module Roqua
     autoload :Person
     autoload :SendEmailTo
     autoload :SendInviteEmail
+    autoload :SsoLogin
     autoload :UpdatePerson
     autoload :UpdateDossier
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-core-api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-05 00:00:00.000000000 Z
+date: 2016-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -210,8 +210,11 @@ files:
 - lib/roqua/core_api/sessions.rb
 - lib/roqua/core_api/sessions/auth_session.rb
 - lib/roqua/core_api/sessions/basic_auth_session.rb
+- lib/roqua/core_api/sessions/hmac_auth_request.rb
+- lib/roqua/core_api/sessions/hmac_auth_session.rb
 - lib/roqua/core_api/sessions/oauth_session.rb
 - lib/roqua/core_api/sessions/token_session.rb
+- lib/roqua/core_api/sso_login.rb
 - lib/roqua/core_api/update_dossier.rb
 - lib/roqua/core_api/update_person.rb
 - lib/roqua/core_api/version.rb
@@ -258,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: API wrapper gem around Core's API