lucid_shopify 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12b757cd447fee99904c3353433439aa23137a30f013bf12a69306e1caa9b713
-  data.tar.gz: d813b755fb636bbc8aaec08b32d1a041c7c2cb68ba276860b4b60e0b962b8595
+  metadata.gz: '06921ad4b8c0a2b5d8fd6a6e2d58001fde145d1f0c8dae16c1727cfba09f41b5'
+  data.tar.gz: bc83dad007907aa4f368903d4c9679dda345983c6b4269ceb513ba5982665a06
 SHA512:
-  metadata.gz: 602f0e5c4bdca73c5aa52d86e726fed91399df1cf443394e1f97a64c8d32676be0ea2b40a7369ffc1325332debb5cecdc8160748c5386bc77d1f0cf62c97db46
-  data.tar.gz: 4fe28f3352a77227954df395ac17675bf749852cb7d3c373caf0d8cd892580d8e74ad67feea840a2fc95413d6c0c1dd654abbd2a51ad9c783eb869c51e8f9426
+  metadata.gz: a9659399ab10805210c7c97fbdd43d8e712881a1f3b9e172d1d1432ac72b56f22f00df51073df1b594b934515d3e1c2ba12d9ba68e83605d435b4639bced3442
+  data.tar.gz: 914b1beba17b2d7d98b6c90b7fea4e94947585ef213ff84fe6e41566fdb826b09765da39b270f09baa2b262aee9b7d3cdee47696504cd899374f7a2a9f3eac0e

data/README.md

@@ -79,7 +79,7 @@ Create/delete webhooks manually:
 Verify callback requests with the request params:
 
     begin
-      LucidShopify::AssertCallback.new.(params)
+      LucidShopify::VerifyCallback.new.(params)
     rescue LucidShopify::Error => e
       # ...
     end
@@ -87,7 +87,7 @@ Verify callback requests with the request params:
 Verify webhook requests with the request data and the HMAC header:
 
     begin
-      LucidShopify::AssertWebhook.new.(data, hmac)
+      LucidShopify::VerifyWebhook.new.(data, hmac)
     rescue LucidShopify::Error => e
       # ...
     end

data/lib/lucid_shopify/charge.rb

@@ -4,7 +4,19 @@ require 'lucid_shopify'
 
 module LucidShopify
   #
-  # Convenient way to build the charge hash for {CreateCharge}.
+  # @example Subclass to provide application defaults
+  #   class Charge < LucidShopify::Charge
+  #     def initialize(shop)
+  #       super('Application name',
+  #             9,
+  #             test: test?,
+  #             trial_days: shop.trial_started_at?.nil? ? 30 : nil)
+  #     end
+  #
+  #     def test?
+  #       # ...
+  #     end
+  #   end
   #
   class Charge
     #

data/lib/lucid_shopify/client.rb

@@ -2,43 +2,89 @@
 
 require 'lucid_shopify/container'
 
-%w(delete get post put).each { |m| require "lucid_shopify/#{m}_request" }
+%w[delete get post put].each { |m| require "lucid_shopify/#{m}_request" }
 
 module LucidShopify
   class Client
     #
     # @param send_request [#call]
+    # @param send_throttled_request [#call]
     #
-    def initialize(send_request: Container[:send_request])
+    def initialize(send_request: Container[:send_request],
+                   send_throttled_request: Container[:send_throttled_request],
+                   throttling: false)
       @send_request = send_request
+      @send_throttled_request = send_throttled_request
+      @throttling = throttling
+
+      @params = {
+        send_request: @send_request,
+        send_throttled_request: @send_throttled_request
+      }
+    end
+
+    #
+    # @return [#call]
+    #
+    private def send_request
+      throttled? ? @send_throttled_request : @send_request
+    end
+
+    #
+    # @return [Boolean]
+    #
+    def throttled?
+      @throttling
+    end
+
+    #
+    # Returns a new instance with throttling enabled, or self.
+    #
+    # @return [Client, self]
+    #
+    def throttled
+      return self if throttled?
+
+      self.class.new(**@params, throttling: true)
+    end
+
+    #
+    # Returns a new instance with throttling disabled, or self.
+    #
+    # @return [Client, self]
+    #
+    def unthrottled
+      return self unless throttled?
+
+      self.class.new(**@params, throttling: false)
     end
 
     #
     # @see DeleteRequest#initialize
     #
     def delete(*args)
-      @send_request.(DeleteRequest.new(*args))
+      send_request.(DeleteRequest.new(*args))
     end
 
     #
     # @see GetRequest#initialize
     #
     def get(*args)
-      @send_request.(GetRequest.new(*args))
+      send_request.(GetRequest.new(*args))
     end
 
     #
     # @see PostRequest#initialize
     #
     def post_json(*args)
-      @send_request.(PostRequest.new(*args))
+      send_request.(PostRequest.new(*args))
     end
 
     #
     # @see PutRequest#initialize
     #
     def put_json(*args)
-      @send_request.(PutRequest.new(*args))
+      send_request.(PutRequest.new(*args))
     end
   end
 end

data/lib/lucid_shopify/container.rb

@@ -9,8 +9,6 @@ module LucidShopify
 
   # Services only (dependencies); no value objects, entities.
   Container.register(:activate_charge) { ActivateCharge.new }
-  Container.register(:assert_callback) { AssertCallback.new }
-  Container.register(:assert_webhook) { AssertWebhook.new }
   Container.register(:client) { Client.new }
   Container.register(:create_all_webhooks) { CreateAllWebhooks.new }
   Container.register(:create_charge) { CreateCharge.new }
@@ -20,4 +18,6 @@ module LucidShopify
   Container.register(:fetch_access_token) { FetchAccessToken.new }
   Container.register(:send_request) { SendRequest.new }
   Container.register(:send_throttled_request) { SendThrottledRequest.new }
+  Container.register(:verify_callback) { VerifyCallback.new }
+  Container.register(:verify_webhook) { VerifyWebhook.new }
 end

data/lib/lucid_shopify/{assert_callback.rb → verify_callback.rb}

@@ -5,11 +5,11 @@ require 'openssl'
 require 'lucid_shopify'
 
 module LucidShopify
-  class AssertCallback
+  class VerifyCallback
     Error = Class.new(Error)
 
     #
-    # Assert that the callback request originated from Shopify.
+    # Verify that the callback request originated from Shopify.
     #
     # @param params [Hash] the request params
     #

data/lib/lucid_shopify/{assert_webhook.rb → verify_webhook.rb}

@@ -6,11 +6,11 @@ require 'openssl'
 require 'lucid_shopify'
 
 module LucidShopify
-  class AssertWebhook
+  class VerifyWebhook
     Error = Class.new(Error)
 
     #
-    # Assert that the webhook request originated from Shopify.
+    # Verify that the webhook request originated from Shopify.
     #
     # @param data [String] the signed request data
     # @param hmac [String] the signature

data/lib/lucid_shopify/version.rb

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

data/lib/lucid_shopify.rb

@@ -4,8 +4,6 @@ require 'dry/initializer'
 
 module LucidShopify
   autoload :ActivateCharge, 'lucid_shopify/activate_charge'
-  autoload :AssertCallback, 'lucid_shopify/assert_callback'
-  autoload :AssertWebhook, 'lucid_shopify/assert_webhook'
   autoload :Charge, 'lucid_shopify/charge'
   autoload :Client, 'lucid_shopify/client'
   autoload :Config, 'lucid_shopify/config'
@@ -27,6 +25,8 @@ module LucidShopify
   autoload :Result, 'lucid_shopify/result'
   autoload :SendRequest, 'lucid_shopify/send_request'
   autoload :SendThrottledRequest, 'lucid_shopify/send_throttled_request'
+  autoload :VerifyCallback, 'lucid_shopify/verify_callback'
+  autoload :VerifyWebhook, 'lucid_shopify/verify_webhook'
   autoload :VERSION, 'lucid_shopify/version'
   autoload :Webhook, 'lucid_shopify/webhook'
   autoload :WebhookHandlerList, 'lucid_shopify/webhook_handler_list'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucid_shopify
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Kelsey Judson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-01 00:00:00.000000000 Z
+date: 2018-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -117,8 +117,6 @@ files:
 - README.md
 - lib/lucid_shopify.rb
 - lib/lucid_shopify/activate_charge.rb
-- lib/lucid_shopify/assert_callback.rb
-- lib/lucid_shopify/assert_webhook.rb
 - lib/lucid_shopify/charge.rb
 - lib/lucid_shopify/client.rb
 - lib/lucid_shopify/config.rb
@@ -139,6 +137,8 @@ files:
 - lib/lucid_shopify/response.rb
 - lib/lucid_shopify/send_request.rb
 - lib/lucid_shopify/send_throttled_request.rb
+- lib/lucid_shopify/verify_callback.rb
+- lib/lucid_shopify/verify_webhook.rb
 - lib/lucid_shopify/version.rb
 - lib/lucid_shopify/webhook.rb
 - lib/lucid_shopify/webhook_handler_list.rb