lucid-shopify 0.36.0 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6941ffc0f656f4a3f25df0ba4530aa8c793d3aedd3e87c0a4a333c5528ef6d16
-  data.tar.gz: 20b48f8e246754880b4f5506387774b5213605c2bf97bb7db2251c2ca24273c0
+  metadata.gz: 514e2e06b6f26b6bb7cf487e1c8bdf15ced2d6f22edc0999bb938d80ed56b84e
+  data.tar.gz: '00976c459f606e71d097a016b1529f2e735366a49ff0972da489522638501170'
 SHA512:
-  metadata.gz: 0460cdf66d11da1376772eba36cd03a94b60592e0385cf15b9026092107720c8d165791bd0459d791735b29c9683af76241128783cf6ad268c1c13b45f3726ad
-  data.tar.gz: d24830b5067246abd9918e87772a0f726a3a5b96594d81d17e5f6684977579ea0c73221c4f7bca8f884b9bc33cff80dabdf7fa9e201bd8a6dccb90fbe3012f41
+  metadata.gz: 4a90a8ecb406a9ebdd61d3605a278a5a1f9de09133b26561b406f8fefa4bbeccea2db2d46f060b55bf5c54a9b8a01ba5b1f97b345b1d582578bedcafdb514cfb
+  data.tar.gz: 8b3649891e6cc04e146b8e793cd959c52169b94bb1deb06ae65191fe40e91b87ac31d713be6db50f97176c7f8e7c105dd9955a7413a6aa7723b9f64e690ed99b

data/README.md

@@ -14,28 +14,19 @@ Usage
 
 ### Configure the default API client
 
-    Lucid::Shopify.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: '...',
-    )
-
-Alternatively load the configuration from a Ruby file. The Ruby
-file is evaluated and should return a hash.
-
-    Lucid::Shopify.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=...’.
+    Lucid::Shopify.configure do |config|
+      config.api_key = '...'
+      config.api_version = '...' # e.g. '2019-07'
+      config.billing_callback_uri = '...'
+      config.callback_uri = '...' # (for OAuth; unused by this gem)
+      config.logger = Logger.new(STDOUT)
+      config.scope = '...'
+      config.shared_secret = '...'
+      config.webhook_uri = '...'
+    end
 
-All keys are optional and in some private apps, you may not require
-any configuration at all.
+All settings are optional and in some private apps, you may not
+require any configuration at all.
 
 Additionally, each API request requires authorisation:
 
@@ -142,9 +133,7 @@ charge:
 
 Request logging is disabled by default. To enable it:
 
-    Lucid::Shopify.configure(
-      logger: Logger.new(STDOUT),
-    )
+    Lucid::Shopify.config.logger = Logger.new(STDOUT)
 
 
 ### Make throttled API requests

data/lib/lucid/shopify/client.rb

@@ -50,6 +50,13 @@ module Lucid
         self.class.new(**@params, throttling: false)
       end
 
+      # @param credentials [Credentials]
+      #
+      # @return [AuthenticatedClient]
+      def authenticate(credentials)
+        AuthenticatedClient.new(self, credentials)
+      end
+
       # @see DeleteRequest#initialize
       def delete(*args)
         send_request.(DeleteRequest.new(*args))
@@ -70,5 +77,22 @@ module Lucid
         send_request.(PutRequest.new(*args))
       end
     end
+
+    class AuthenticatedClient
+      # @private
+      #
+      # @param client [Client]
+      # @param credentials [Credentials]
+      def initialize(client, credentials)
+        @client = client
+        @credentials = credentials
+      end
+
+      %i[delete get post_json put_json].each do |method|
+        define_method(method) do |*args|
+          @client.__send__(method, @credentials, *args)
+        end
+      end
+    end
   end
 end

data/lib/lucid/shopify/container.rb

@@ -4,7 +4,6 @@ require 'dry/container'
 require 'http'
 
 require 'lucid/shopify'
-require 'lucid/shopify/config'
 
 module Lucid
   module Shopify

data/lib/lucid/shopify/version.rb

@@ -2,6 +2,6 @@
 
 module Lucid
   module Shopify
-    VERSION = '0.36.0'
+    VERSION = '0.37.0'
   end
 end

data/lib/lucid/shopify.rb

@@ -39,6 +39,17 @@ module Lucid
     autoload :WebhookHandlerList, 'lucid/shopify/webhook_handler_list'
     autoload :WebhookList, 'lucid/shopify/webhook_list'
 
+    extend Dry::Configurable
+
+    setting :api_key
+    setting :api_version, '2019-07'
+    setting :billing_callback_uri
+    setting :callback_uri
+    setting :logger, Logger.new(File::NULL).freeze
+    setting :scope
+    setting :shared_secret
+    setting :webhook_uri
+
     class << self
       # Webhooks created for each shop.
       #
@@ -67,5 +78,3 @@ module Lucid
     end
   end
 end
-
-require 'lucid/shopify/config'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucid-shopify
 version: !ruby/object:Gem::Version
-  version: 0.36.0
+  version: 0.37.0
 platform: ruby
 authors:
 - Kelsey Judson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-01 00:00:00.000000000 Z
+date: 2020-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -66,6 +66,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: '0.67'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: dry-container
   requirement: !ruby/object:Gem::Requirement
@@ -122,20 +136,6 @@ 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.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 description: 
 email: kelsey@lucid.nz
 executables: []
@@ -148,7 +148,6 @@ files:
 - lib/lucid/shopify/activate_charge.rb
 - lib/lucid/shopify/authorise.rb
 - lib/lucid/shopify/client.rb
-- lib/lucid/shopify/config.rb
 - lib/lucid/shopify/container.rb
 - lib/lucid/shopify/create_all_webhooks.rb
 - lib/lucid/shopify/create_charge.rb
@@ -192,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Shopify client library

data/lib/lucid/shopify/config.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'logger'
-
-require 'lucid/shopify'
-require 'lucid/utils'
-
-module Lucid
-  module Shopify
-    class << self
-      # @param options [Hash]
-      #
-      # @return [Config]
-      def configure(options = {})
-        @config = Config.new(
-          **@config.to_h.compact,
-          **options,
-        )
-      end
-
-      # @param path [String]
-      #
-      # @return [Config]
-      def configure_from_file(path = 'config/shopify.rb')
-        options = Utils::ConfigFromFile.new.(path, env_prefix: 'shopify')
-
-        configure(options)
-      end
-
-      # @return [Config]
-      def config
-        @config ||= configure
-      end
-    end
-
-    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.configure
-  end
-end