frederick_api 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7585f21ab85ccf59525a4d78a455952b54d8f902
-  data.tar.gz: 38057990239e4c0af5b99ad07c36aa2cf6aea783
+  metadata.gz: 5ba4333ebf8f9acb3b07440cceb399011c16d04e
+  data.tar.gz: 626edbc12159446fa20ebb8cae9a7e9e70492ae3
 SHA512:
-  metadata.gz: 6b603fee87f814268d6b9eb6a163e1941996a33e819c983a152227a44bd3e36077a4341021533b97323dabff808683af25eaa47e57a40103bc756b3c89a08e2b
-  data.tar.gz: a3a0a5a8b77cdb1e76010a78a0079ca1733938cb1aaa973d8d412c3e0287d7c63d05ad36f5d2a53c0c3f460d5e124fad661664808b3404cc1eba507293dfaead
+  metadata.gz: f5176eee73f6cc0d5cc54169eb4cf7c431b249652c8b0b6f6fa0f0508b52a8b2a4321ff373a8084958245c3f8c5ed040a18a6ad445422b2aa68231bc2595e54c
+  data.tar.gz: 3988226a53e5b7696fe0aaed9c90feabc6b1cf535a40f86a8c2568c7c13df705c91d971f611b3fe35328dba925ffeb46b4ca254247d637708a1fa0c2b2c36367

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module FrederickAPI
+  module V2
+    module Helpers
+      # HasMany association that supports returning a query builder instead of a simple array
+      # Allows querying of the association such as `contact_list.contacts.select('properties.external_id').all`
+      module HasMany
+        extend ActiveSupport::Concern
+
+        # Class methods added to resource
+        module ClassMethods
+          def has_many(attr_name, options = {})
+            self.associations = self.associations + [HasMany::Association.new(attr_name, self, options)]
+          end
+        end
+
+        # Class used to request data for has_many association
+        class Association < JsonApiClient::Associations::BaseAssociation
+          def query_builder(url)
+            association_class.query_builder.new(
+              association_class,
+              association_class.requestor_class.new(association_class, url)
+            )
+          end
+
+          def data(url)
+            query_builder(url)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,6 +7,13 @@ module FrederickAPI
     module Helpers
       # Used to convert nested params to dot notation for Frederick API
       class QueryBuilder < JsonApiClient::Query::Builder
+        attr_reader :requestor
+
+        def initialize(klass, requestor = nil)
+          super(klass)
+          @requestor = requestor || klass.requestor
+        end
+
         def params
           to_dot_params(
             filter_params.merge(pagination_params.merge(includes_params).merge(select_params))
@@ -16,6 +23,17 @@ 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
 

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

@@ -5,6 +5,22 @@ module FrederickAPI
     module Helpers
       # Requestor for v2 client to use built on top of JsonApiClient::Query::Requestor
       class Requestor < JsonApiClient::Query::Requestor
+        attr_reader :path
+
+        def initialize(klass, path = nil)
+          @klass = klass
+          @path = path
+        end
+
+        def resource_path(parameters)
+          base_path = path || klass.path(parameters)
+          if (resource_id = parameters[klass.primary_key])
+            File.join(base_path, encode_part(resource_id))
+          else
+            base_path
+          end
+        end
+
         # Retry once on unhandled server errors
         def request(type, path, params)
           super

data/lib/frederick_api/v2/resource.rb

@@ -5,6 +5,8 @@ module FrederickAPI
     # Class from which Frederick V2 Resources inherit
     # Inherits functionality from JsonApiClient::Resource
     class Resource < JsonApiClient::Resource
+      include FrederickAPI::V2::Helpers::HasMany
+
       self.query_builder = FrederickAPI::V2::Helpers::QueryBuilder
       self.paginator = FrederickAPI::V2::Helpers::Paginator
       self.requestor_class = FrederickAPI::V2::Helpers::Requestor

data/lib/frederick_api/version.rb

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

data/lib/frederick_api.rb

@@ -2,10 +2,12 @@
 
 # Third-party libs
 require 'json_api_client'
-require 'active_support/core_ext/class/attribute.rb'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/concern'
 
 # FrederickAPI libs
 require 'frederick_api/configuration'
+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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frederick_api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Frederick Engineering
@@ -41,6 +41,7 @@ files:
 - 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/helpers/has_many.rb
 - lib/frederick_api/v2/helpers/paginator.rb
 - lib/frederick_api/v2/helpers/query_builder.rb
 - lib/frederick_api/v2/helpers/requestor.rb