cognito-client 0.4.1 → 0.5.0

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100

data/lib/cognito/client.rb

@@ -1,104 +1,67 @@
 # frozen_string_literal: true
-
-module Cognito
+require 'bundler/setup'
+
+require 'concord'
+require 'anima'
+require 'procto'
+require 'adamantium'
+require 'abstract_type'
+require 'http'
+require 'addressable'
+require 'openssl'
+require 'base64'
+
+require 'cognito/client/connection'
+require 'cognito/client/request'
+require 'cognito/client/document'
+require 'cognito/client/resource_identifier'
+
+# resources
+require 'cognito/client/resource'
+require 'cognito/client/resource/profile'
+require 'cognito/client/resource/identity_search'
+require 'cognito/client/resource/identity_search_job'
+require 'cognito/client/resource/identity_assessment'
+
+# responses
+require 'cognito/client/response'
+require 'cognito/client/response/builder'
+require 'cognito/client/response/profile'
+require 'cognito/client/response/identity_assessment'
+require 'cognito/client/response/identity_search'
+require 'cognito/client/response/identity_search_job'
+
+# params
+require 'cognito/client/params'
+require 'cognito/client/params/omitted'
+require 'cognito/client/params/identity'
+require 'cognito/client/params/identity_assessment'
+require 'cognito/client/params/identity_search'
+
+# commands
+require 'cognito/client/command'
+require 'cognito/client/commands/mixins/create_behavior'
+require 'cognito/client/commands/create_profile'
+require 'cognito/client/commands/create_identity'
+require 'cognito/client/commands/create_identity_assessment'
+require 'cognito/client/commands/create_identity_search'
+require 'cognito/client/commands/retrieve_identity_search_job'
+require 'cognito/client/commands/retrieve_identity_location'
+
+class Cognito
   class Client
-    include HTTParty,
-            Responder
-
-    URI = 'https://sandbox.cognitohq.com'
-
-    # Default URI, can be override with Client#base_uri
-    base_uri URI
-
-    # Don't follow redirects.
-    no_follow true
-    follow_redirects false
-
-    def initialize(options = {})
-      @errors = []
-      @api_key = options.fetch(:api_key) { @errors << :api_key }
-      @api_secret = options.fetch(:api_secret) { @errors << :api_secret }
-      self.base_uri = options.fetch(:base_uri) { URI }
-
-      if @errors.any?
-        raise ArgumentError, "missing keyword: #{@errors.join(',')}"
-      end
-    end
-
-    def base_uri=(uri)
-      self.class.base_uri(uri)
-    end
-
-    def create_profile!
-      post('/profiles', profile_params.to_json)
-    end
-
-    def search!(profile_id, phone_number, options = {})
-      payload = search_params(profile_id, phone_number).to_json
-      post('/identity_searches', payload, options)
-    end
-
-    def search_status!(search_job_id, options = {})
-      get("/identity_searches/jobs/#{search_job_id}", options)
-    end
-
-    def retrieve_search(search_id, options = {})
-      get("/identity_searches/#{search_id}", options)
-    end
-
-    protected
-
-    def get(path, options = {})
-      headers = notarize_request('get', path, '').headers
-      response_from(self.class.get(path, headers: headers), options)
-    end
-
-    def post(path, payload, options = {})
-      headers = notarize_request('post', path, payload).headers
-      response_from(self.class.post(path, headers: headers, body: payload), options)
-    end
-
-    private
-
-    def notarize_request(verb, path, body)
-      target = "#{verb} #{path}"
+    include Concord.new(:server)
 
-      Notary.new(
-        api_key: @api_key,
-        api_secret: @api_secret,
-        target: target,
-        body: body
-      )
+    def self.create(**connection_params)
+      new(Connection.parse(**connection_params))
     end
 
-    def profile_params
-      {
-        data: {
-          type: PROFILE
-        }
-      }
+    def create_profile
+      Command::CreateProfile.call(server)
     end
 
-    # rubocop:disable Metrics/MethodLength
-    def search_params(profile_id, phone_number)
-      {
-        data: {
-          type: IDENTITY_SEARCH,
-          attributes: {
-            phone: {
-              number: phone_number
-            }
-          },
-          relationships: {
-            profile: {
-              data: {
-                type: PROFILE,
-                id:   profile_id
-              }
-            }
-          }
-        }
-      }
+    def create_identity_search(**params)
+      Command::CreateIdentitySearch.call(params.merge(connection: server))
     end
-  end
-end
+  end # Client
+end # Cognito

data/lib/cognito/client/command.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+class Cognito
+  class Client
+    class Command
+      include Procto.call(:run), AbstractType, Adamantium
+
+      Failed = Class.new(StandardError)
+
+      def run
+        fail Failed, failure_reason unless success?
+
+        present_response
+      end
+
+      private
+
+      def failure_reason
+        return response.reason if response.to_str.empty?
+
+        response
+      end
+
+      abstract_method :present_response
+      abstract_method :success?
+      abstract_method :request
+      abstract_method :connection
+
+      def response
+        connection.run(request)
+      end
+      memoize :response, freezer: :flat
+    end # Command
+  end # Client
+end # Cognito

data/lib/cognito/client/commands/create_identity.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+#
+class Cognito
+  class Client
+    class Command
+      class CreateIdentity < self
+        include Mixins::CreateBehavior,
+                AbstractType,
+                Anima.new(:connection, :name, :phone_number)
+
+        private :name, :phone_number
+
+        OMITTED = Params::Omitted.new
+
+        # ignores :reek:FeatureEnvy:
+        def initialize(name: OMITTED, phone_number: OMITTED, **params)
+          super(params.merge(name: name, phone_number: phone_number))
+        end
+      end # CreateIdentity
+    end # Command
+  end # Client
+end # Cognito

data/lib/cognito/client/commands/create_identity_assessment.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+class Cognito
+  class Client
+    class Command
+      class CreateIdentityAssessment < CreateIdentity
+        include Mixins::CreateBehavior, anima.add(:identity_search_identifier)
+
+        ENDPOINT = '/identity_assessments'
+
+        private
+
+        def params
+          Params::IdentityAssessment.call(
+            identity_search_identifier: identity_search_identifier,
+            name:                       name,
+            phone_number:               phone_number
+          )
+        end
+
+        def present_response
+          Response::IdentityAssessment.build(response, connection)
+        end
+      end # CreateIdentityAssessment
+    end # Command
+  end # Client
+end # Cognito

data/lib/cognito/client/commands/create_identity_search.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+class Cognito
+  class Client
+    class Command
+      class CreateIdentitySearch < CreateIdentity
+        include Mixins::CreateBehavior, anima.add(:profile_id)
+
+        private :profile_id, :name, :phone_number
+
+        ENDPOINT = '/identity_searches'
+
+        private
+
+        def params
+          Params::IdentitySearch.call(
+            profile_id:   profile_id,
+            name:         name,
+            phone_number: phone_number
+          )
+        end
+
+        def present_response
+          case response.code
+          when 202
+            Response::IdentitySearchJob.build(response, connection)
+          when 201
+            Response::IdentitySearch.build(response, connection)
+          end
+        end
+
+        def success?
+          response.status.accepted? || response.status.created?
+        end
+      end # CreateIdentitySearch
+    end # Command
+  end # Client
+end # Cognito

data/lib/cognito/client/commands/create_profile.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+class Cognito
+  class Client
+    class Command
+      class CreateProfile < self
+        include Mixins::CreateBehavior, Concord.new(:connection)
+
+        ENDPOINT = '/profiles'
+        PARAMS   = IceNine.deep_freeze(data: { type: 'profile' })
+
+        private
+
+        def present_response
+          Response::Profile.build(response, connection)
+        end
+
+        # ignores :reek:UtilityFunction:
+        def params
+          PARAMS
+        end
+      end # CreateProfile
+    end # Command
+  end # Client
+end # Cognito

data/lib/cognito/client/commands/mixins/create_behavior.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+class Cognito
+  class Client
+    class Command
+      module Mixins
+        module CreateBehavior
+          private
+
+          def success?
+            response.status.created?
+          end
+
+          def request
+            Request.post(self.class::ENDPOINT, params)
+          end
+        end # CreateBehavior
+      end # Mixins
+    end # Command
+  end # Client
+end # Cognito

data/lib/cognito/client/commands/retrieve_identity_location.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+class Cognito
+  class Client
+    class Command
+      class RetrieveIdentityLocation < self
+        include Concord.new(:connection, :endpoint)
+
+        private
+
+        def present_response
+          identity_resource
+        end
+
+        def identity_resource
+          Response::IdentitySearch.build(response, connection)
+        end
+
+        def success?
+          response.code.equal?(200)
+        end
+
+        def request
+          Request.get(endpoint)
+        end
+      end # RetrieveIdentityLocation
+    end # Command
+  end # Client
+end # Cognito

data/lib/cognito/client/commands/retrieve_identity_search_job.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+class Cognito
+  class Client
+    class Command
+      class RetrieveIdentitySearchJob < self
+        include Concord.new(:connection, :endpoint)
+
+        private
+
+        def present_response
+          case response.code
+          when 303
+            identity_resource
+          when 200
+            processing_response
+          else
+            fail Failed, response.reason
+          end
+        end
+
+        def identity_resource
+          RetrieveIdentityLocation.call(connection, response['Location'])
+        end
+
+        def processing_response
+          Response::IdentitySearchJob.build(response, connection)
+        end
+
+        def success?
+          response.status.success? || response.status.redirect?
+        end
+
+        def request
+          Request.get(endpoint)
+        end
+      end # RetrieveIdentitySearchJob
+    end # Command
+  end # Client
+end # Cognito

data/lib/cognito/client/connection.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+class Cognito
+  class Client
+    class Connection
+      include Anima.new(:uri, :api_key, :api_secret, :api_version)
+
+      def self.parse(uri:, **api_params)
+        new(uri: Addressable::URI.parse(uri), **api_params)
+      end
+
+      # ignores :reek:FeatureEnvy:
+      def run(request)
+        signed_request =
+          request.sign(date: Time.now.httpdate, api_key: api_key, api_secret: api_secret)
+
+        HTTP
+          .headers(signed_request.headers.merge(version_headers))
+          .request(
+            signed_request.verb,
+            endpoint(signed_request.endpoint),
+            json: signed_request.data
+          )
+      end
+
+      def endpoint(route)
+        uri.join(route).to_str
+      end
+
+      private
+
+      def version_headers
+        { 'Cognito-Version' => api_version }
+      end
+    end # Connection
+  end # Client
+end # Cognito