frederick_api 0.4.4 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 711d8e8257f97e7ad18803cca7b24e8e87a9f43e
-  data.tar.gz: baf134c2da2e7da52cfeb7a75ccd5b90a18a2200
+SHA256:
+  metadata.gz: af582661b851880a278f82844f06ec98910f639cf0292ec1249f1ed1127b0a27
+  data.tar.gz: 5740b928ced7a2d9f4964388dbd5e543cbb0827c571f562899ab3a651a030f43
 SHA512:
-  metadata.gz: 294478020b031f49b7f5ae1a636977ff5301befb4892f44b9526ddec5037c2b2f4f6461a391e7661ed70db4cdf05177f696bb08c63f158c0d6f1ee4ba7855dff
-  data.tar.gz: fbce1720a78066c1caeeb2e1da9dbf688f250eacea4fa407307a838d492ef898ff8791cbdd83c7cfe1d38462b5f456f1643acc8772063ca7163c5d8effb1df45
+  metadata.gz: dd740314950b62480828dc4878a603582edd4bf00c6bddc7e7a6b694707b90da52fd2e31ccdf226b86afeff09aeccd0a12d94b900f322a1e153a3e5a48ce9515
+  data.tar.gz: e535fb7f7655cbf975424497a333292d1dae97c9c8cb3f0621fac118f6e694d360dd355250f1ab91427144038c6a009392c37a0c47a64b4a9536b34a223a6582

data/README.md

@@ -88,6 +88,21 @@ FrederickAPI::V2::Location.with_access_token(access_token) do
 end
 ```
 
+### Using Headers
+
+`Resource.with_access_token` is extended to take headers in the method `Resource.with_access_token_and_headers`. This is useful when we need to pass the universal customer to services that accept it.
+
+```ruby
+access_token = '9jsdo320fjfkfdksls30dfdcd919bcaa1b7804dbbebda0'
+headers = { 'X-Universal-Customer': '{"source_platform":"mindbody","source_location_id":"1","source_customer_id":"77"}' }
+
+FrederickAPI::V2::CommunicationTemplate.with_access_token_and_headers(access_token, headers) do
+  template = FrederickAPI::V2::CommunicationTemplate.create(template_attributes)
+
+  template.name
+  # => 'Name from Attrs'
+end
+```
 ### Nested Resources
 
 Nested resources must be accessed using `where` to scope the request:
@@ -101,3 +116,14 @@ FrederickAPI::V2::Location.with_access_token(access_token) do
   # => [...]
 end
 ```
+### Background Jobs
+
+FrederickAPI Gem handles asynchronous responses as suggested in 
+[JSONApi Recommendations](https://jsonapi.org/recommendations/#asynchronous-processing) 
+[Asynchronous Processing](https://jsonapi.org/recommendations/#asynchronous-processing).
+Polling until the job is complete, fetching and returning the completed resource.
+
+* A FrederickAPI::V2::Errors::BackgroundJobFailure exception is raised if the API returns 
+an error on an asyncronous job.
+* A BackgroundJob Resource will be returned from the client in the case that a successful 
+ job does not return a resource.

data/lib/frederick_api.rb

@@ -12,17 +12,20 @@ require 'frederick_api/v2/helpers/has_many'
 require 'frederick_api/v2/helpers/paginator'
 require 'frederick_api/v2/helpers/query_builder'
 require 'frederick_api/v2/helpers/requestor'
+require 'frederick_api/v2/helpers/backgroundable_parser'
 require 'frederick_api/v2/resource'
 require 'frederick_api/v2/public_resource'
 
 require 'frederick_api/v2/user'
 require 'frederick_api/v2/location'
+require 'frederick_api/v2/background_job'
 
 # Public resources
 require 'frederick_api/v2/business_category'
 
 # Core resources
 require 'frederick_api/v2/automation'
+require 'frederick_api/v2/automation_step'
 require 'frederick_api/v2/communication_content'
 require 'frederick_api/v2/contact'
 require 'frederick_api/v2/contact_property'
@@ -30,6 +33,9 @@ require 'frederick_api/v2/contact_list'
 require 'frederick_api/v2/contact_type'
 require 'frederick_api/v2/interaction'
 require 'frederick_api/v2/role'
+require 'frederick_api/v2/campaign'
+require 'frederick_api/v2/email_document'
+require 'frederick_api/v2/communication_template'
 
 # Namespace for all Frederick API client methods/classes
 module FrederickAPI

data/lib/frederick_api/v2/automation.rb

@@ -5,6 +5,8 @@ module FrederickAPI
     # /v2/locations/:location_id/automations
     class Automation < Resource
       belongs_to :location
+      has_many :automation_steps
+
       self.read_only_attributes += [:location_id]
     end
   end

data/lib/frederick_api/v2/automation_step.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  module V2
+    # Resource for automation step
+    class AutomationStep < Resource
+      belongs_to :location
+      has_one :automation
+      has_one :previous_automation_step, class_name: 'FrederickAPI::V2::AutomationStep'
+
+      self.read_only_attributes += %i[location_id]
+    end
+  end
+end

data/lib/frederick_api/v2/background_job.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  module V2
+    # V2 Frederick API async background job class for parsing
+    # background job responses coming from API.
+    class BackgroundJob < Resource
+      attr_accessor :response
+
+      def has_errors?
+        @attributes['status'] == 'error'
+      end
+
+      def retry_after
+        try_time = @response[:headers]['retry-after'].to_i
+        @retry_after ||= try_time > 1 ? try_time : 1
+      end
+
+      def response_code
+        @response_code ||= @response[:status]
+      end
+
+      def status
+        @attributes['status']
+      end
+
+      def errors
+        @attributes['messages']
+      end
+
+      def id
+        @attributes['id']
+      end
+    end
+  end
+end

data/lib/frederick_api/v2/campaign.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  module V2
+    # V2 Campaign Resource
+    class Campaign < Resource
+      belongs_to :location
+
+      self.read_only_attributes += [:location_id]
+    end
+  end
+end

data/lib/frederick_api/v2/communication_template.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  module V2
+    # V2 CommunicationTemplate Resource
+    class CommunicationTemplate < Resource; end
+  end
+end

data/lib/frederick_api/v2/email_document.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  module V2
+    # V2 Email Document Resource
+    class EmailDocument < Resource
+      belongs_to :location
+
+      self.read_only_attributes += [:location_id]
+    end
+  end
+end

data/lib/frederick_api/v2/errors/errors.rb

@@ -23,6 +23,10 @@ module FrederickAPI
       class BadRequest < Error; end
       class UnprocessableEntity < Error; end
 
+      # an exception class for when the server reports that a
+      # long running job has failed.
+      class BackgroundJobFailure < Error; end
+
       ERROR_CODES = {
         '400' => BadRequest,
         '422' => UnprocessableEntity

data/lib/frederick_api/v2/helpers/backgroundable_parser.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  module V2
+    module Helpers
+      # Custom Parser for parsing BackgroundJob resources for FrederickAPI V2
+      class BackgroundableParser < ::JsonApiClient::Parsers::Parser
+        def self.parse(klass, response)
+          result_set = super(klass, response)
+          return result_set unless result_set&.first&.type == 'background_jobs'
+          result_set = super(::FrederickAPI::V2::BackgroundJob, response)
+          result_set&.first&.response = { headers: response.headers, status: response.status }
+          result_set
+        end
+      end
+    end
+  end
+end

data/lib/frederick_api/v2/helpers/has_many.rb

@@ -20,7 +20,7 @@ module FrederickAPI
           def query_builder(url)
             association_class.query_builder.new(
               association_class,
-              association_class.requestor_class.new(association_class, url)
+              requestor: association_class.requestor_class.new(association_class, url)
             )
           end
 

data/lib/frederick_api/v2/helpers/query_builder.rb

@@ -9,9 +9,9 @@ module FrederickAPI
       class QueryBuilder < JsonApiClient::Query::Builder
         attr_reader :requestor
 
-        def initialize(klass, requestor = nil)
-          super(klass)
-          @requestor = requestor || klass.requestor
+        def initialize(klass, opts = {})
+          super(klass, opts)
+          @requestor = opts[:requestor] || klass.requestor
         end
 
         def params
@@ -23,17 +23,6 @@ module FrederickAPI
             .merge(additional_params)
         end
 
-        def find(args = {})
-          case args
-          when Hash
-            where(args)
-          else
-            @primary_key = args
-          end
-
-          requestor.get(params)
-        end
-
         def filter_params
           super_filter_params = super
 
@@ -65,6 +54,27 @@ module FrederickAPI
             { prefix => object }
           end
         end
+
+        protected
+
+          def _fetch
+            (requestor || klass.requestor).get(params)
+          end
+
+        private
+
+          def _new_scope(opts = {})
+            self.class.new(@klass,
+                           requestor:         requestor,
+                           primary_key:       opts.fetch(:primary_key, @primary_key),
+                           pagination_params: @pagination_params.merge(opts.fetch(:pagination_params, {})),
+                           path_params:       @path_params.merge(opts.fetch(:path_params, {})),
+                           additional_params: @additional_params.merge(opts.fetch(:additional_params, {})),
+                           filters:           @filters.merge(opts.fetch(:filters, {})),
+                           includes:          @includes + opts.fetch(:includes, []),
+                           orders:            @orders + opts.fetch(:orders, []),
+                           fields:            @fields + opts.fetch(:fields, []))
+          end
       end
     end
   end

data/lib/frederick_api/v2/helpers/requestor.rb

@@ -7,6 +7,24 @@ module FrederickAPI
       class Requestor < JsonApiClient::Query::Requestor
         attr_reader :path
 
+        # For backward compatibility, preserve these JSON API client errors instead of raising
+        # FrederickAPI::Errors::Error
+        JSON_API_CLIENT_PASSTHROUGH_ERRORS = [
+          JsonApiClient::Errors::NotAuthorized,
+          JsonApiClient::Errors::AccessDenied,
+          JsonApiClient::Errors::NotFound,
+          JsonApiClient::Errors::Conflict,
+          JsonApiClient::Errors::ServerError,
+          JsonApiClient::Errors::UnexpectedStatus
+        ].freeze
+
+        # Paths that may have an unbounded query param length so we should always use a POST
+        # instead of a GET to get around AWS Cloudfront limitations
+        GET_VIA_POST_PATHS = [
+          %r{^.*locations\/[^\/]+\/contacts$},
+          %r{^.*locations\/[^\/]+\/interactions$}
+        ].map(&:freeze).freeze
+
         def initialize(klass, path = nil)
           @klass = klass
           @path = path
@@ -21,15 +39,49 @@ module FrederickAPI
           end
         end
 
+        def get(params = {})
+          path = resource_path(params)
+
+          params.delete(klass.primary_key)
+          if get_via_post_path?(path)
+            return request(:post, path, body: params.to_json, additional_headers: { 'X-Request-Method' => 'GET' })
+          end
+
+          request(:get, path, params: params)
+        end
+
+        def linked(path)
+          uri = URI.parse(path)
+          return super unless get_via_post_path?(uri.path)
+
+          path_without_params = "#{uri.scheme}://#{uri.host}#{uri.path}"
+          params = uri.query ? CGI.parse(uri.query).each_with_object({}) { |(k, v), h| h[k] = v[0] } : {}
+          request(:post, path_without_params, body: params.to_json, additional_headers: { 'X-Request-Method' => 'GET' })
+        end
+
         # Retry once on unhandled server errors
-        def request(type, path, params)
-          handle_errors(super)
-        rescue JsonApiClient::Errors::ConnectionError, JsonApiClient::Errors::ServerError => ex
-          raise ex if ex.is_a?(JsonApiClient::Errors::NotFound) || ex.is_a?(JsonApiClient::Errors::Conflict)
-          handle_errors(super)
+        def request(type, path, params: nil, body: nil, additional_headers: {})
+          headers = klass.custom_headers.merge(additional_headers)
+          make_request = proc do
+            handle_background(handle_errors(make_request(type, path, params: params, body: body, headers: headers)))
+          end
+
+          begin
+            make_request.call
+          rescue JsonApiClient::Errors::ConnectionError, JsonApiClient::Errors::ServerError => ex
+            raise ex if ex.is_a?(JsonApiClient::Errors::NotFound) || ex.is_a?(JsonApiClient::Errors::Conflict)
+            make_request.call
+          end
         end
 
         private
+          def handle_background(response)
+            return response unless
+                (job = response&.first).is_a?(::FrederickAPI::V2::BackgroundJob) && job.status != 'complete'
+            raise FrederickAPI::V2::Errors::BackgroundJobFailure, job if job.has_errors?
+            sleep job.retry_after
+            linked(job.links.attributes['self'])
+          end
 
           def handle_errors(result)
             return result unless result.has_errors?
@@ -37,6 +89,25 @@ module FrederickAPI
               FrederickAPI::V2::Errors::Error
             raise error_klass, result
           end
+
+          def make_request(type, path, params:, body:, headers:)
+            faraday_response = connection.run(type, path, params: params, body: body, headers: headers)
+            return klass.parser.parse(klass, faraday_response) unless faraday_response.status == 303
+
+            linked(faraday_response.headers['location'])
+          rescue JsonApiClient::Errors::ClientError => e
+            handle_json_api_client_error(e)
+          end
+
+          def get_via_post_path?(path)
+            GET_VIA_POST_PATHS.any? { |r| r.match(path) }
+          end
+
+          def handle_json_api_client_error(error)
+            raise error if JSON_API_CLIENT_PASSTHROUGH_ERRORS.include?(error.class)
+
+            klass.parser.parse(klass, error.env.response)
+          end
       end
     end
   end

data/lib/frederick_api/v2/resource.rb

@@ -10,6 +10,7 @@ module FrederickAPI
       self.query_builder = FrederickAPI::V2::Helpers::QueryBuilder
       self.paginator = FrederickAPI::V2::Helpers::Paginator
       self.requestor_class = FrederickAPI::V2::Helpers::Requestor
+      self.parser = ::FrederickAPI::V2::Helpers::BackgroundableParser
 
       attr_accessor :custom_headers
 
@@ -35,7 +36,16 @@ module FrederickAPI
       end
 
       def self.with_access_token(token)
-        with_headers(authorization: "Bearer #{token}") do
+        with_access_token_and_headers(token) do
+          yield
+        end
+      end
+
+      def self.with_access_token_and_headers(token, headers = {})
+        with_headers(
+          authorization: "Bearer #{token}",
+          **headers
+        ) do
           yield
         end
       end

data/lib/frederick_api/v2/user.rb

@@ -5,6 +5,7 @@ module FrederickAPI
     # /v2/users
     class User < Resource
       has_many :roles, class_name: 'FrederickAPI::V2::Role'
+      has_many :permitted_locations, class_name: 'FrederickAPI::V2::Location'
     end
   end
 end

data/lib/frederick_api/version.rb

@@ -2,5 +2,5 @@
 
 module FrederickAPI
   # Current gem version
-  VERSION = '0.4.4'
+  VERSION = '0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frederick_api
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: '0.9'
 platform: ruby
 authors:
 - Frederick Engineering
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-11 00:00:00.000000000 Z
+date: 2021-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_api_client
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 1.17.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 1.17.1
 description: Ruby client for the Frederick API
 email:
 - tech@hirefrederick.com
@@ -36,13 +36,19 @@ files:
 - lib/frederick_api.rb
 - lib/frederick_api/configuration.rb
 - lib/frederick_api/v2/automation.rb
+- lib/frederick_api/v2/automation_step.rb
+- lib/frederick_api/v2/background_job.rb
 - lib/frederick_api/v2/business_category.rb
+- lib/frederick_api/v2/campaign.rb
 - lib/frederick_api/v2/communication_content.rb
+- lib/frederick_api/v2/communication_template.rb
 - lib/frederick_api/v2/contact.rb
 - lib/frederick_api/v2/contact_list.rb
 - lib/frederick_api/v2/contact_property.rb
 - lib/frederick_api/v2/contact_type.rb
+- lib/frederick_api/v2/email_document.rb
 - lib/frederick_api/v2/errors/errors.rb
+- lib/frederick_api/v2/helpers/backgroundable_parser.rb
 - lib/frederick_api/v2/helpers/has_many.rb
 - lib/frederick_api/v2/helpers/paginator.rb
 - lib/frederick_api/v2/helpers/query_builder.rb
@@ -58,7 +64,7 @@ homepage: https://github.com/HireFrederick/frederick_api_gem
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -73,9 +79,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Frederick API Client
 test_files: []