lucid_shopify-resource 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9eb6d5850cf40e62ec8ac2e639a615bda3548f15b85af2a8d2ef909f732dc94
+  data.tar.gz: afb34a04d86b048528ca6bce9b3d074ef4d9de2cfb03b1ae9401be432d864154
+SHA512:
+  metadata.gz: 0cc9447831828cff0ebde7b974244bc51eb1df033f831776695dbda99c330d3b69464357600b645cb31e4a637f2976ce1667f6cceaf779ef11e657f2bfbf7277
+  data.tar.gz: 21cf824bd293dea5f681da5387fd77605cff3704ef23aa28f7d72b79dbff7cb30171f0350e76917a6c7724e0581e3418898ab293dc7e365918eca4aa65e3b194

data/README.md

@@ -0,0 +1,53 @@
+lucid_shopify-resource
+======================
+
+Installation
+------------
+
+Add the following lines to your ‘Gemfile’:
+
+    git_source :lucid { |r| "https://github.com/lucidnz/gem-lucid_#{r}.git" }
+
+    gem 'lucid_shopify-resource', lucid: 'shopify-resource'
+
+
+Usage
+-----
+
+### Create a resource
+
+_TODO: Implement when needed._
+
+
+### Delete a resource
+
+_TODO: Implement when needed._
+
+
+### Read a resource
+
+Subclass and configure `Read`:
+
+    class Orders < LucidShopify::Resource::Read
+      resource :orders
+
+      default_options fields: %w(id tags), limit: 250
+    end
+
+    orders = Orders.new
+
+    orders.find(request_credentials, id)
+
+The `Orders` class is enumerable. Each page is fetched from the API as needed,
+rather than all at once:
+
+    orders = Orders.new
+
+    orders.each(request_credentials) |order|
+      # ...
+    end
+
+
+### Update a resource
+
+_TODO: Implement when needed._

data/lib/lucid_shopify/resource/create.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module LucidShopify
+  module Resource
+    #
+    # @abstract
+    #
+    class Create
+      def self.new; raise NotImplementedError; end
+    end
+  end
+end

data/lib/lucid_shopify/resource/delete.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module LucidShopify
+  module Resource
+    #
+    # @abstract
+    #
+    class Delete
+      def self.new; raise NotImplementedError; end
+    end
+  end
+end

data/lib/lucid_shopify/resource/read.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module LucidShopify
+  module Resource
+    #
+    # @abstract
+    #
+    # @example
+    #   class Orders < LucidShopify::Resource::Read
+    #     resource :orders
+    #
+    #     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 }
+      end
+
+      #
+      # @abstract
+      #
+      # @return [String]
+      #
+      def resource
+        raise NotImplementedError
+      end
+
+      #
+      # 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 }
+      end
+
+      #
+      # @abstract
+      #
+      # @return [Hash]
+      #
+      def default_params
+        {}
+      end
+
+      #
+      # Defaults set by Shopify when not specified.
+      #
+      # @return [Hash]
+      #
+      def default_shopify_params
+        {
+          limit: 50,
+        }
+      end
+
+      #
+      # @param credentials [LucidShopify::RequestCredentials]
+      # @param id [Integer]
+      # @param params [Hash]
+      #
+      # @return [Hash]
+      #
+      def find(credentials, id, params = {})
+        params = finalized_params(params)
+
+        client.get(credentials, "#{resource}/#{id}", params)[resource]
+      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 [LucidShopify::RequestCredentials]
+      # @param params [Hash]
+      #
+      # @yield [Hash]
+      #
+      # @return [Enumerator]
+      #
+      # @raise [ArgumentError] if 'fields' does not include 'id'
+      #
+      def each(credentials, params = {})
+        return to_enum(__callee__) unless block_given?
+
+        assert_fields_id!(params = finalized_params(params))
+
+        since_id = 1
+
+        loop do
+          results = client.get(credentials, resource, params.merge(since_id: since_id))
+          results.each do |result|
+            yield result
+          end
+
+          break if results.empty?
+
+          since_id = results.last['id']
+        end
+      end
+
+      #
+      # @param params [Hash] the finalized params (see {#finalize_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 client [LucidShopify::AuthorizedClient]
+      # @param params [Hash]
+      #
+      # @return [Integer]
+      #
+      def count(client, params = {})
+        params = finalize_params(params)
+
+        client.get("#{resource}/count", params)['count']
+      end
+
+      #
+      # Merge with default params and format for query string.
+      #
+      # @param params [Hash]
+      #
+      # @return [Hash]
+      #
+      private def finalize_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

data/lib/lucid_shopify/resource/update.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module LucidShopify
+  module Resource
+    #
+    # @abstract
+    #
+    class Update
+      def self.new; raise NotImplementedError; end
+    end
+  end
+end

data/lib/lucid_shopify/resource/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module LucidShopify
+  class Resource
+    VERSION = '0.2.1'
+  end
+end

data/lib/lucid_shopify/resource.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module LucidShopify
+  module Resource; 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.rb

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

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: lucid_shopify-resource
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Kelsey Judson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-02 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.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+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/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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Shopify client library resource helpers
+test_files: []