lucid_shopify 0.28.1 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc9f09b59b1297f36b850794a77f5602080821f6cd8529c975f2a82da0bb4998
-  data.tar.gz: feb36398f8fb6535de819260a10c484c28c645a648e4d3d615cd3f4275cbe05f
+  metadata.gz: a99dcbd8e551ee898a53837cd9a91bb62bac7223038eac70109ddd3424b249c8
+  data.tar.gz: 10aad4e20e50af8facb41cd9d624e8867d1ef2d1707067566d9fb4ca3a2b72c8
 SHA512:
-  metadata.gz: 1792732667c7bd22629876a50cdcec207bf38d239190001e51eea4b905eca9109c4c631e10c51718ecbb638caa49743c5051c7b7562a1a2199fa1001b014400f
-  data.tar.gz: 1d89d70db5b8ce7c94915d4adac81230468114b97b4f6014bd595ddcb7581d8edd0c189e3ee0fb45253917639439096bc055e491c4c88ea78e30c9a81611b8df
+  metadata.gz: d0f44d70b758e58aec0cb6798d424c0f67a3e614f1f160b86e5f27e0bf5cf590243745e491ef4a1b6e9f8ae7c1364c1ab05028239fe7aeef51e7455e160d0386
+  data.tar.gz: 6ea021837da9b31acf7063bf7c43b932145e2dc79db06d0291900d85ef287dfd5f18a45ca0772794a57d249ec54153ee3ebe4236bb806dc6b253abc9c492e42d

data/README.md

@@ -14,20 +14,28 @@ Usage
 
 ### Configure the default API client
 
-    LucidShopify.config = LucidShopify::Config.new(
-      '...', # api_version, e.g. '2019-04'
-      '...', # api_key
-      '...', # shared_secret
-      '...', # scope
-      '...', # callback_uri (for OAuth; unused by this gem)
-      '...', # billing_callback_uri
-      '...', # webhook_uri
+    LucidShopify.configure(
+      api_key: '...',
+      api_version: '...', # e.g. '2019-07'
+      billing_callback_uri: '...',
+      callback_uri: '...', # (for OAuth; unused by this gem)
+      logger: Logger.new(STDOUT),
+      scope: '...',
+      shared_secret: '...',
+      webhook_uri: '...',
     )
 
-For private apps, where these credentials may not be not necessary,
-the default unconfigured behaviour is equivalent to:
+Alternatively load the configuration from a Ruby file. The Ruby
+file is evaluated and should return a hash.
 
-    LucidShopify.config = LucidShopify::Config::PRIVATE_APP
+    LucidShopify.configure_from_file('config/shopify.rb') # the default path
+
+When loading from a file, any environment variables matching the
+upcased key with the prefix ‘SHOPIFY_’ will override values in the
+file. For example ‘SHOPIFY_SHARED_SECRET=...’.
+
+All keys are optional and in some private apps, you may not require
+any configuration at all.
 
 Additionally, each API request requires authorisation:
 
@@ -134,7 +142,9 @@ charge:
 
 Request logging is disabled by default. To enable it:
 
-    LucidShopify.config.logger = Logger.new(STDOUT)
+    LucidShopify.configure(
+      logger: Logger.new(STDOUT),
+    )
 
 
 ### Make throttled API requests

data/lib/lucid_shopify/config.rb

@@ -1,78 +1,55 @@
 # frozen_string_literal: true
 
-require 'forwardable'
 require 'logger'
 
 require 'lucid_shopify'
+require 'lucid_utils'
 
 module LucidShopify
-  NotConfiguredError = Class.new(Error)
-
   class << self
-    extend Forwardable
-
-    def_delegators(
-      :config,
-      :api_version,
-      :api_key,
-      :shared_secret,
-      :scope,
-      :billing_callback_uri,
-      :webhook_uri,
-      :logger
-    )
-
-    # @param config [Config]
-    attr_writer :config
-
     #
-    # @return [Config]
+    # @param options [Hash]
     #
-    # @raise [NotConfiguredError] if credentials are unset
+    # @return [Config]
     #
-    def config
-      raise NotConfiguredError unless @config
-
-      @config
+    def configure(options = {})
+      @config = Config.new(
+        **@config.to_h.compact,
+        **options,
+      )
     end
-  end
-
-  class Config
-    extend Dry::Initializer
-
-    # @return [String]
-    param :api_version
-    # @return [String]
-    param :api_key
-    # @return [String]
-    param :shared_secret
-    # @return [String]
-    param :scope
-    # @return [String]
-    param :callback_uri
-    # @return [String]
-    param :billing_callback_uri
-    # @return [String]
-    param :webhook_uri
 
     #
-    # @return [Logger]
+    # @param path [String]
     #
-    def logger
-      @logger ||= Logger.new(File::NULL)
+    # @return [Config]
+    #
+    def configure_from_file(path = 'config/shopify.rb')
+      options = LucidUtils::ConfigFromFile.new.(path, env_prefix: 'shopify')
+
+      configure(options)
     end
 
     #
-    # @param new_logger [Logger]
+    # @return [Config]
     #
-    def logger=(new_logger)
-      raise ArgumentError, 'not a Logger' unless new_logger.is_a?(Logger)
-
-      @logger = new_logger
+    def config
+      @config ||= configure
     end
+  end
 
-    PRIVATE_APP = new(ENV.fetch('SHOPIFY_API_VERSION', '2019-04'), '', '', '', '', '', '') # 2019-04 was the first versioned API
+  class Config < Dry::Struct
+    attribute :api_version, Types::String.default('2019-07')
+    attribute :logger, Types::Logger.default(Logger.new(File::NULL).freeze)
+
+    # The following attributes may be unnecessary in some private apps.
+    attribute? :api_key, Types::String
+    attribute? :billing_callback_uri, Types::String
+    attribute? :callback_uri, Types::String
+    attribute? :scope, Types::String
+    attribute? :shared_secret, Types::String
+    attribute? :webhook_uri, Types::String
   end
 
-  self.config = Config::PRIVATE_APP
+  self.configure
 end

data/lib/lucid_shopify/types.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module LucidShopify
+  module Types
+    include Dry.Types(default: :strict)
+
+    Logger = Instance(Logger)
+  end
+end

data/lib/lucid_shopify/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LucidShopify
-  VERSION = '0.28.1'
+  VERSION = '0.31.0'
 end

data/lib/lucid_shopify.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'dry/initializer'
+require 'dry/struct'
 
 begin
   require 'redis'
@@ -29,6 +30,7 @@ module LucidShopify
   autoload :Result, 'lucid_shopify/result'
   autoload :SendRequest, 'lucid_shopify/send_request'
   autoload :ThrottledStrategy, 'lucid_shopify/throttled_strategy'
+  autoload :Types, 'lucid_shopify/types'
   autoload :VerifyCallback, 'lucid_shopify/verify_callback'
   autoload :VerifyWebhook, 'lucid_shopify/verify_webhook'
   autoload :VERSION, 'lucid_shopify/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucid_shopify
 version: !ruby/object:Gem::Version
-  version: 0.28.1
+  version: 0.31.0
 platform: ruby
 authors:
 - Kelsey Judson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-11 00:00:00.000000000 Z
+date: 2019-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: lucid_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 description: 
 email: kelsey@lucid.nz
 executables: []
@@ -137,6 +165,7 @@ files:
 - lib/lucid_shopify/response.rb
 - lib/lucid_shopify/send_request.rb
 - lib/lucid_shopify/throttled_strategy.rb
+- lib/lucid_shopify/types.rb
 - lib/lucid_shopify/verify_callback.rb
 - lib/lucid_shopify/verify_webhook.rb
 - lib/lucid_shopify/version.rb