lucid_shopify-resource 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 442ac5f02ccc7d05e3cc715a51338656e0577f33e3f715a81f797fcf0ab7df52
-  data.tar.gz: 49e45c0d8538b6605029e310e028da06d775bba70e9b78558269ef0905c3ba7a
+  metadata.gz: c4b65bc3519016b53e1811d4e93a8833d84f6173fbdaadefd8bd60f2e3e48783
+  data.tar.gz: 8790c0ffcc53b524c1fa50efb53b8476be148fb146d149e93945ecbc87f91a5c
 SHA512:
-  metadata.gz: 26424188f53a43cfdf2553dec31a4eafae04c3fb041db665f5f894676af0208cce54dcfaf6b1d5d79134f6cb8541cf9647a11f72ccd5576d50c0017c2eddabbc
-  data.tar.gz: 99372149fd632daa266b7f11eb7d5d5876105d95c55e9453ec85e24e7fe156c6f4d8dd88e83f97bf08f362504c2659199135263e36429905a2865a9a30b61ab6
+  metadata.gz: 7c6dd3baa65eada85753f56f28904e722a6faf821f8cea44eaf9b50cc435f88191b88477c33288d11eab2d44c493cf00d79bbe64ebe89f247da67eabafb5c58f
+  data.tar.gz: 3d8bb9f9843b44491c77dde4bb1117388c860cc2351cdff34022a46fc7e969d797f6ca236d574015392dedf05aa7fed2fe4ba0b828d0a606b80cf553ab1ed617

data/lib/lucid_shopify/resource.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module LucidShopify
-  module Resource; end
+  module Resource
+    autoload :Create, 'lucid_shopify/resource/create'
+    autoload :Delete, 'lucid_shopify/resource/delete'
+    autoload :Read, 'lucid_shopify/resource/read'
+    autoload :Update, 'lucid_shopify/resource/update'
+  end
 end
-
-require 'lucid_shopify/resource/create'
-require 'lucid_shopify/resource/delete'
-require 'lucid_shopify/resource/read'
-require 'lucid_shopify/resource/update'

data/lib/lucid_shopify/resource/base.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'lucid_shopify/container'
+
+module LucidShopify
+  module Resource
+    module Base
+      module ClassMethods
+        #
+        # Set the remote API resource name for the subclass.
+        #
+        # @param resource_name [String, #to_s]
+        #
+        # @example
+        #   resource :orders
+        #
+        def resource(resource_name)
+          define_method(:resource) { resource_name.to_s }
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      #
+      # @param client [Client]
+      #
+      def initialize(client: Container[:client])
+        @client = client
+      end
+
+      # @return [Client]
+      attr_reader :client
+
+      #
+      # @abstract Use {ClassMethods#resource} to implement (required)
+      #
+      # @return [String]
+      #
+      def resource
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/lucid_shopify/resource/create.rb

@@ -1,12 +1,25 @@
 # frozen_string_literal: true
 
+require 'lucid_shopify/resource/base'
+
 module LucidShopify
   module Resource
     #
-    # @abstract
+    # @example
+    #   class OrderRepository
+    #     include LucidShopify::Resource::Create
+    #
+    #     resource :orders
     #
-    class Create
-      def self.new; raise NotImplementedError; end
+    #     # ...
+    #   end
+    #
+    module Create
+      def self.included(base)
+        base.include(Base)
+
+        raise NotImplementedError # TODO
+      end
     end
   end
 end

data/lib/lucid_shopify/resource/delete.rb

@@ -1,12 +1,25 @@
 # frozen_string_literal: true
 
+require 'lucid_shopify/resource/base'
+
 module LucidShopify
   module Resource
     #
-    # @abstract
+    # @example
+    #   class OrderRepository
+    #     include LucidShopify::Resource::Delete
+    #
+    #     resource :orders
     #
-    class Delete
-      def self.new; raise NotImplementedError; end
+    #     # ...
+    #   end
+    #
+    module Delete
+      def self.included(base)
+        base.include(Base)
+
+        raise NotImplementedError # TODO
+      end
     end
   end
 end

data/lib/lucid_shopify/resource/read.rb

@@ -1,67 +1,46 @@
 # frozen_string_literal: true
 
+require 'lucid_shopify/resource/base'
+
 module LucidShopify
   module Resource
-    #
-    # @abstract
     #
     # @example
-    #   class Orders < LucidShopify::Resource::Read
+    #   class OrderRepository
+    #     include LucidShopify::Resource::Read
+    #
     #     resource :orders
     #
-    #     default_params fields: %w(id tags)
+    #     default_params fields: %w[id tags]
+    #
+    #     # ...
     #   end
     #
-    class Read
-      include Enumerable
-      include LucidShopify
-
-      #
-      # @param client [LucidShopify::Client]
-      #
-      def initialize(client: Client.new(send_request: SendThrottledRequest.new))
-        @client = client
-      end
-
-      # @return [LucidShopify::Client]
-      attr_reader :client
-
-      #
-      # Set the remote API resource name for the subclass.
-      #
-      # @param resource_name [String, #to_s]
-      #
-      # @example
-      #   resource :orders
-      #
-      def self.resource(resource_name)
-        define_method(:resource) { resource_name.to_s }
+    module Read
+      module ClassMethods
+        #
+        # Set the default query params. Note that 'fields' may be passed as an
+        # array of strings.
+        #
+        # @param params [Hash]
+        #
+        # @example
+        #   default_params fields: %w(id tags)
+        #
+        def default_params(params)
+          define_method(:default_params) { params }
+        end
       end
 
-      #
-      # @abstract
-      #
-      # @return [String]
-      #
-      def resource
-        raise NotImplementedError
-      end
+      include Enumerable
 
-      #
-      # Set the default query params. Note that 'fields' may be passed as an
-      # array of strings.
-      #
-      # @param params [Hash]
-      #
-      # @example
-      #   default_params fields: %w(id tags)
-      #
-      def self.default_params(params)
-        define_method(:default_params) { params }
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.include(Base)
       end
 
       #
-      # @abstract
+      # @abstract Use {ClassMethods#default_params} to implement (optional)
       #
       # @return [Hash]
       #
@@ -81,7 +60,7 @@ module LucidShopify
       end
 
       #
-      # @param credentials [LucidShopify::RequestCredentials]
+      # @param credentials [RequestCredentials]
       # @param id [Integer]
       # @param params [Hash]
       #
@@ -100,7 +79,7 @@ module LucidShopify
       #
       # Throttling is always enabled.
       #
-      # @param credentials [LucidShopify::RequestCredentials]
+      # @param credentials [RequestCredentials]
       # @param params [Hash]
       #
       # @yield [Hash]
@@ -114,10 +93,12 @@ module LucidShopify
 
         assert_fields_id!(params = finalized_params(params))
 
+        throttled_client = client.throttled
+
         since_id = 1
 
         loop do
-          results = client.get(credentials, resource, params.merge(since_id: since_id))
+          results = throttled_client.get(credentials, resource, params.merge(since_id: since_id))
           results.each do |result|
             yield result
           end
@@ -139,12 +120,11 @@ module LucidShopify
       end
 
       #
-      # @param client [LucidShopify::AuthorizedClient]
       # @param params [Hash]
       #
       # @return [Integer]
       #
-      def count(client, params = {})
+      def count(params = {})
         params = finalize_params(params)
 
         client.get("#{resource}/count", params)['count']

data/lib/lucid_shopify/resource/update.rb

@@ -1,12 +1,25 @@
 # frozen_string_literal: true
 
+require 'lucid_shopify/resource/base'
+
 module LucidShopify
   module Resource
     #
-    # @abstract
+    # @example
+    #   class OrderRepository
+    #     include LucidShopify::Resource::Update
+    #
+    #     resource :orders
     #
-    class Update
-      def self.new; raise NotImplementedError; end
+    #     # ...
+    #   end
+    #
+    module Update
+      def self.included(base)
+        base.include(Base)
+
+        raise NotImplementedError # TODO
+      end
     end
   end
 end

data/lib/lucid_shopify/resource/version.rb

@@ -2,6 +2,6 @@
 
 module LucidShopify
   class Resource
-    VERSION = '0.2.2'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucid_shopify-resource
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Kelsey Judson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
+date: 2018-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.9'
 description: 
 email: kelsey@lucid.nz
 executables: []
@@ -61,6 +61,7 @@ files:
 - README.md
 - lib/lucid_shopify-resource.rb
 - lib/lucid_shopify/resource.rb
+- lib/lucid_shopify/resource/base.rb
 - lib/lucid_shopify/resource/create.rb
 - lib/lucid_shopify/resource/delete.rb
 - lib/lucid_shopify/resource/read.rb