frederick_api 0.4.6 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e5ec62b4c9ba2fe7d5e1724f45b0104c95642e82
-  data.tar.gz: 5216931a23bf50e10bf3ff9697c47e0310189dae
+SHA256:
+  metadata.gz: 7131c40a141f015fe0057617182b61268033205cf7c1e12a63e1d89466e0ea5f
+  data.tar.gz: 937cd61c99a614ba7425223d699583e19f24452e554f41ccbf0cd2189616685d
 SHA512:
-  metadata.gz: b8f4e02a2941809f5e92e83120a90cd527a47da319e8e56f557c2cffa939bc4c7e7d63166437325d88285a67d11633a5b3f53ff8dcea6f0ec0ae84bade98c4b4
-  data.tar.gz: a19981df22a71b41c2b896f15af49c146eeccb5802993ade16ed0feadf1c1e6667b38141e1b9e6c8346d2e98c605710e611883b794c708618c5f5b3cf19985e6
+  metadata.gz: 03f21ac6d2f71bed9bcf24e04475555bed790a421978f9ce59ebd84d9c15bfe0a509ad54f4436de1b7a8157409f0394bc39cad7f11f79486e13c4ff7bcbdcdce
+  data.tar.gz: 9f50eb76e2907162c452971f40c135e68bd64ebceb543cd6bef9aaf5b6a30d8dbf3fd525116051e8a93953bb5e71a72187da4be8d159078c145e0366d02a3d86

data/README.md

@@ -101,3 +101,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 resources.  

data/lib/frederick_api.rb

@@ -12,11 +12,13 @@ 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'

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/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/requestor.rb

@@ -33,7 +33,6 @@ module FrederickAPI
 
           params.delete(klass.primary_key)
           return request(:post, path, params, 'X-Request-Method' => 'GET') if get_via_post_path?(path)
-
           request(:get, path, params)
         end
 
@@ -49,15 +48,23 @@ module FrederickAPI
         # Retry once on unhandled server errors
         def request(type, path, params, additional_headers = {})
           headers = klass.custom_headers.merge(additional_headers)
+          make_request = proc { handle_background(handle_errors(make_request(type, path, params, headers))) }
           begin
-            handle_errors(make_request(type, path, params, headers))
+            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)
-            handle_errors(make_request(type, path, params, headers))
+            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?
@@ -67,7 +74,9 @@ module FrederickAPI
           end
 
           def make_request(type, path, params, headers)
-            klass.parser.parse(klass, connection.run(type, path, params, headers))
+            faraday_response = connection.run(type, path, params, headers)
+            return klass.parser.parse(klass, faraday_response) unless faraday_response.status == 303
+            linked(faraday_response.headers['location'])
           end
 
           def get_via_post_path?(path)

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
 

data/lib/frederick_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frederick_api
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: '0.5'
 platform: ruby
 authors:
 - Frederick Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-29 00:00:00.000000000 Z
+date: 2019-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_api_client
@@ -36,6 +36,7 @@ files:
 - lib/frederick_api.rb
 - lib/frederick_api/configuration.rb
 - lib/frederick_api/v2/automation.rb
+- lib/frederick_api/v2/background_job.rb
 - lib/frederick_api/v2/business_category.rb
 - lib/frederick_api/v2/communication_content.rb
 - lib/frederick_api/v2/contact.rb
@@ -43,6 +44,7 @@ files:
 - lib/frederick_api/v2/contact_property.rb
 - lib/frederick_api/v2/contact_type.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
@@ -74,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: Frederick API Client