frederick_api 0.6 → 0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9848d60ef419d88f6758574988f60f90337c64645316a0c716c12aaf497f43a9
-  data.tar.gz: 2e6096aeca9837b93ee25a2468bc7d3e2cf2712f6c735fb7330cf13a489f3b1e
+  metadata.gz: 327163b30ae7b807b87a78479bc2cf6944a30d0fbc98d8c0156aaf557fd55445
+  data.tar.gz: dd84394527eb5bccfa256e2b59d4ed27a172ad7fffec9e1dcd5f83d46d8bd0de
 SHA512:
-  metadata.gz: 06f920d1c60e09288bb9c75ef3b9be31168b93fe24ab681c33b1e2b77fb9127172e86608da5c8f862a43965867e1e33f571a91dfb80bd768cc9b227979b084dc
-  data.tar.gz: 738cf8ec474b270d81e79a95499325f62f70557baf09bc16220abd4d467564ead6607bf180bb22352bd309d78fdab6ce84435863341ea8c99c89985d430939b7
+  metadata.gz: 1c6109c022a72aacac5e95f66a315226732657b327eed72252ad6df76ed0cc2976e6adc0c1a573d47c5e8335eb6ce0a53401f3dfd9ebe13ab433f530b34a1f48
+  data.tar.gz: b818f0bcaf5a470ce4956e1337b5dd1f8f181fe52b5a30b1c86399d37e17282afa0a3d5dc62d8bd67d3819b55a3015d5824db8e28cb6e7df5252d6490297c05d

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:
@@ -111,4 +126,4 @@ 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.  
+ job does not return a resource.

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/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/helpers/paginator.rb

@@ -17,12 +17,11 @@ module FrederickAPI
 
           (total_pages - current_page).times do
             first_resource.class.with_headers(first_resource.custom_headers) do
-              current_result_set = current_result_set ? current_result_set.pages.next : self.result_set.pages.next
+              current_result_set = next_result_set(current_result_set)
               raise 'next link not found' unless current_result_set
               results.push(*current_result_set.to_a)
             end
           end
-
           results
         end
 
@@ -47,6 +46,18 @@ module FrederickAPI
         def current_page
           params.fetch("page.#{page_param}", 1).to_i
         end
+
+        private
+
+          # refetching the next link if no response is found.
+          def next_result_set(current_result_set)
+            if current_result_set
+              response = current_result_set.pages.next
+              response.present? ? response : current_result_set.pages.next
+            else
+              self.result_set.pages.next
+            end
+          end
       end
     end
   end

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

@@ -7,6 +7,17 @@ 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 = [
@@ -45,7 +56,7 @@ module FrederickAPI
 
           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, params: params, additional_headers: { 'X-Request-Method' => 'GET' })
+          request(:post, path_without_params, body: params.to_json, additional_headers: { 'X-Request-Method' => 'GET' })
         end
 
         # Retry once on unhandled server errors
@@ -82,14 +93,21 @@ module FrederickAPI
           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 => ex
-            klass.parser.parse(klass, ex.env.response)
+          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

@@ -36,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/version.rb

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

data/lib/frederick_api.rb

@@ -25,6 +25,7 @@ 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'
@@ -32,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frederick_api
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.10'
 platform: ruby
 authors:
 - Frederick Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2022-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_api_client
@@ -36,13 +36,17 @@ 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
@@ -75,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: Frederick API Client