lucid-shopify-resource 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d5e6b82b24ef7b83a7fe75a831a5fbe6c948273cee6aba4a44d8fb082237c81f
+  data.tar.gz: c797e482f078659810d1fe933a8ff988cc659cc59b76e30ef1056a768da27ea1
+SHA512:
+  metadata.gz: 5d6489add0fc1676421b4b9bddfe3982cf410fd8fc0d63cc60c2af751a011a3fbea71d8372716aebd4d5fa05a6e84116ecbfda673db6b9cc4b4d2f7e5fa00ad0
+  data.tar.gz: 32171a0111ca911d45342ae930799a682c38089becf244fe89f22a9509d99914444da42409a57ca558a8c28d254cf9cdcefbf9f8f0e2b39ef27ea4f8a9f48427

data/README.md

@@ -0,0 +1,78 @@
+lucid-shopify-resource
+======================
+
+Installation
+------------
+
+Add the gem to your ‘Gemfile’:
+
+    gem 'lucid-shopify'
+    gem 'lucid-shopify-resource'
+
+
+Usage
+-----
+
+### Create a resource
+
+    class OrderRepository
+      include Lucid::Shopify::Resource::Create
+
+      resource :orders
+    end
+
+    order_repo = OrderRepository.new
+
+    order_repo.create(credentials, new_order)
+
+
+### Delete a resource
+
+    class OrderRepository
+      include Lucid::Shopify::Resource::Delete
+
+      resource :orders
+    end
+
+    order_repo = OrderRepository.new
+
+    order_repo.delete(credentials, id)
+
+
+### Read a resource
+
+Include and configure `Read`:
+
+    class OrderRepository
+      include Lucid::Shopify::Resource::Read
+
+      resource :orders
+
+      default_params fields: %w[id tags], limit: 250
+    end
+
+    order_repo = OrderRepository.new
+
+    order_repo.find(credentials, id)
+
+The `OrderRepository` class is enumerable. Each page is fetched
+from the API as needed, rather than all at once:
+
+    order_repo = OrderRepository.new
+
+    order_repo.each(credentials) |order|
+      # ...
+    end
+
+
+### Update a resource
+
+    class OrderRepository
+      include Lucid::Shopify::Resource::Update
+
+      resource :orders
+    end
+
+    order_repo = OrderRepository.new
+
+    order_repo.create(credentials, id, order)

data/lib/lucid-shopify-resource.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Primarily for Bundler.
+
+require 'lucid/shopify/resource'

data/lib/lucid/shopify/resource.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Lucid
+  module Shopify
+    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
+end

data/lib/lucid/shopify/resource/base.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+require 'lucid/shopify/container'
+
+module Lucid
+  module Shopify
+    module Resource
+      module Base
+        module ClassMethods
+          # Set the remote API resource name for the subclass. If a singular
+          # is not provided, the plural will be used, without any trailing 's'.
+          #
+          # @param resource_plural [String, #to_s]
+          # @param resource_singular [String, #to_s, nil]
+          #
+          # @example
+          #   resource :orders
+          def resource(resource_plural, resource_singular = nil)
+            define_method(:resource) { resource_plural.to_s }
+            define_method(:resource_singular) do
+              resource_singular.nil? ? resource_plural.to_s.sub(/s$/, '') : resource_singular.to_s
+            end
+          end
+        end
+
+        # @param base [Class, Module]
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        # @abstract Use {ClassMethods#resource} to implement (required)
+        #
+        # @return [String]
+        def resource
+          raise NotImplementedError
+        end
+
+        # @return [Client]
+        def client
+          @client ||= Container[:client]
+        end
+
+        # @param new_client [Client]
+        def client=(new_client)
+          @client = new_client
+        end
+
+        # @return [Logger]
+        def logger
+          @logger ||= Logger.new(IO::NULL)
+        end
+
+        # @param new_logger [Logger]
+        def logger=(new_logger)
+          @logger = new_logger
+        end
+      end
+    end
+  end
+end

data/lib/lucid/shopify/resource/create.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'lucid/shopify/resource/base'
+
+module Lucid
+  module Shopify
+    module Resource
+      # @example
+      #   class OrderRepository
+      #     include Lucid::Shopify::Resource::Create
+      #
+      #     resource :orders
+      #
+      #     # ...
+      #   end
+      module Create
+        # @param base [Class, Module]
+        def self.included(base)
+          base.include(Base)
+        end
+
+        # @param credentials [Credentials]
+        # @param data [Hash]
+        #
+        # @return [Integer] the new ID
+        def create(credentials, data)
+          data = client.post_json(credentials, resource, resource_singular => data).to_h
+
+          data.dig(resource_singular, 'id').tap do |id|
+            logger.info("Created #{resource_singular} id=#{id}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lucid/shopify/resource/delete.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'lucid/shopify/resource/base'
+
+module Lucid
+  module Shopify
+    module Resource
+      # @example
+      #   class OrderRepository
+      #     include Lucid::Shopify::Resource::Delete
+      #
+      #     resource :orders
+      #
+      #     # ...
+      #   end
+      module Delete
+        # @param base [Class, Module]
+        def self.included(base)
+          base.include(Base)
+        end
+
+        # @param credentials [Credentials]
+        # @param id [Integer]
+        def delete(credentials, id)
+          client.delete(credentials, "#{resource}/#{id}").tap do
+            logger.info("Deleted #{resource_singular} id=#{id}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lucid/shopify/resource/read.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require 'lucid/shopify/resource/base'
+
+module Lucid
+  module Shopify
+    module Resource
+      # @example
+      #   class OrderRepository
+      #     include Lucid::Shopify::Resource::Read
+      #
+      #     resource :orders
+      #
+      #     default_params fields: %w[id tags]
+      #
+      #     # ...
+      #   end
+      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
+
+        include Enumerable
+
+        # @param base [Class, Module]
+        def self.included(base)
+          base.extend(ClassMethods)
+          base.include(Base)
+        end
+
+        # @abstract Use {ClassMethods#default_params} to implement (optional)
+        #
+        # @return [Hash]
+        def default_params
+          {}
+        end
+
+        # Defaults set by Shopify when not specified.
+        #
+        # @return [Hash]
+        def default_shopify_params
+          {
+            limit: 50,
+          }
+        end
+
+        # @param credentials [Credentials]
+        # @param id [Integer]
+        # @param params [Hash]
+        #
+        # @return [Hash]
+        def find(credentials, id, params = {})
+          params = finalise_params(params)
+
+          logger.info("Fetching #{resource_singular} id=#{id}")
+
+          client.get(credentials, "#{resource}/#{id}", params)[resource_singular]
+        end
+
+        # Iterate over results. If set, the 'fields' option must include 'id'. We
+        # would not need this if we used offset pagination, but offset pagination
+        # is unreliable.
+        #
+        # Throttling is always enabled.
+        #
+        # @param credentials [Credentials]
+        # @param params [Hash]
+        #
+        # @yield [Hash]
+        #
+        # @return [Enumerator]
+        #
+        # @raise [ArgumentError] if 'fields' does not include 'id'
+        def each(credentials, params = {})
+          return to_enum(__method__, credentials, params) unless block_given?
+
+          assert_fields_id!(params = finalise_params(params))
+
+          throttled_client = client.throttled
+
+          since_id = params.delete('since_id') || 1
+
+          loop do
+            logger.info("Fetching #{resource} since_id=#{since_id}")
+
+            results = throttled_client.get(credentials, resource, params.merge(since_id: since_id))[resource]
+            results.each do |result|
+              yield result
+            end
+
+            break if results.empty?
+
+            since_id = results.last['id']
+          end
+        end
+
+        # @param params [Hash] the finalised params (see {#finalise_params})
+        private def assert_fields_id!(params)
+          return unless params['fields']
+          return unless params['fields'] !~ /\bid\b/
+
+          raise ArgumentError, 'attempt to paginate without id field'
+        end
+
+        # @param credentials [Credentials]
+        # @param params [Hash]
+        #
+        # @return [Integer]
+        def count(credentials, params = {})
+          params = finalise_params(params)
+
+          logger.info("Fetching #{resource} count")
+
+          client.get(credentials, "#{resource}/count", params)['count']
+        end
+
+        # Merge with default params and format for query string.
+        #
+        # @param params [Hash]
+        #
+        # @return [Hash]
+        private def finalise_params(params)
+          params = default_shopify_params.merge(default_params).merge(params)
+
+          params.each_with_object({}) do |(k, v), h|
+            k = k.to_s
+            k == 'fields' && v.is_a?(Array) ? v.join(',') : v
+            h[k] = v
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lucid/shopify/resource/update.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'lucid/shopify/resource/base'
+
+module Lucid
+  module Shopify
+    module Resource
+      # @example
+      #   class OrderRepository
+      #     include Lucid::Shopify::Resource::Update
+      #
+      #     resource :orders
+      #
+      #     # ...
+      #   end
+      module Update
+        # @param base [Class, Module]
+        def self.included(base)
+          base.include(Base)
+        end
+
+        # @param credentials [Credentials]
+        # @param id [Integer]
+        # @param data [Hash]
+        def update(credentials, id, data)
+          client.put_json(credentials, "#{resource}/#{id}", resource_singular => data).tap do
+            logger.info("Updated #{resource_singular} id=#{id}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lucid/shopify/resource/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Lucid
+  module Shopify
+    module Resource
+      VERSION = '0.8.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: lucid-shopify-resource
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Kelsey Judson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+- !ruby/object:Gem::Dependency
+  name: lucid-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+description: 
+email: kelsey@lucid.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+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
+- lib/lucid/shopify/resource/update.rb
+- lib/lucid/shopify/resource/version.rb
+homepage: https://github.com/lucidnz/gem-lucid-shopify-resource
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Shopify client library resource helpers
+test_files: []