lucid_shopify 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a53c313f841a7f88609457eb4b2c4f1a7651eee3d687097be04f98d75f36f4a0
-  data.tar.gz: e3190ad427bd79f7bd0fe8f7ace431aad5544d9fe162b1098a5885d3a2959efc
+  metadata.gz: f12ecc227e47e723f176fabe2da11a246c3c3ab920f8428f6b78f63d383bce68
+  data.tar.gz: 3748d4c3d77de580e798fa2586d2369726fc125fc03d5092ad02d6ab25916bde
 SHA512:
-  metadata.gz: 36cb4616edbe9d671ff6b34f3ee92d92e5a50bf20d7da05d2bfe783b307b8678d7c36d920174223ebf15739bd76577d001275db4c6f34805d09b8c485bd3aa14
-  data.tar.gz: '04293660bb3c7abb9d4999924fbd311ccbf29de0e9d405338321e5e95bb2257a4861ead6be9c4684e7ca7424a9d46c015a95ae0a3b44354c2a7225bd877ece18'
+  metadata.gz: fc9ef0cb927c5c3657071fc498ac4059eed8b75336bc10b9fb3467484e95d75d0e1225f0fe57cfe53ad2868f8168f0faef36b4566f522f36b03f8586f42a7d2d
+  data.tar.gz: e014298a2e6f39dd17840b34c5444d60d93ebf44a20e2e045e9effce75d5d949211a7e8a42940f69baef37dba3fadc7e8002694a8ed99f5a20c3bc619357dbe0

data/README.md

@@ -40,17 +40,14 @@ This is only useful during the OAuth2 process.
 
 Configure each webhook the app will create (if any):
 
-    LucidShopify.webhooks << {topic: 'orders/create', fields: %w(id tags)}
-    LucidShopify.webhooks << {topic: '...', fields: %w(...)}
+    LucidShopify.webhooks.register('orders/create', fields: 'id,tags'}
 
 
 ### Register webhook handlers
 
 For each webhook, register one or more handlers:
 
-    delegate_webhooks = LucidShopify::DelegateWebhooks.default
-
-    delegate_webhooks.register('orders/create', OrdersCreateWebhook.new)
+    LucidShopify.handlers.register('orders/create', OrdersCreateWebhook.new)
 
 See the inline method documentation for more detail.
 
@@ -59,7 +56,7 @@ to create a worker around something like this:
 
     webhook = LucidShopify::Webhook.new(myshopify_domain, topic, data)
 
-    delegate_webhooks.(webhook)
+    LucidShopify.handlers.delegate(webhook)
 
 
 ### Create and delete webhooks

data/lib/lucid_shopify/create_all_webhooks.rb

@@ -23,18 +23,4 @@ module LucidShopify
       end.map(&:value)
     end
   end
-
-  class << self
-    #
-    # Webhooks created for each shop.
-    #
-    # @return [Array<Hash>]
-    #
-    # @example
-    #   LucidShopify.webhooks << {topic: 'orders/create', fields: 'id,line_items'}
-    #
-    def webhooks
-      @webhooks ||= []
-    end
-  end
 end

data/lib/lucid_shopify/version.rb

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

data/lib/lucid_shopify/webhook_handler_list.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module LucidShopify
+  class WebhookHandlerList
+    def initialize
+      @handlers = {}
+    end
+
+    #
+    # Register a handler for a webhook topic. The callable handler should
+    # receive a single {Webhook} argument.
+    #
+    # @param topic [String]
+    # @param handler [#call]
+    #
+    def register(topic, handler = nil, &block)
+      raise ArgumentError unless nil ^ handler ^ block
+
+      handler = block if block
+
+      @handlers[topic] ||= []
+      @handlers[topic] << handler
+
+      nil
+    end
+
+    #
+    # @param topic [String]
+    #
+    def [](topic)
+      @handlers[topic] || []
+    end
+
+    #
+    # Call each of the handlers registered for the given topic in turn.
+    #
+    # @param webhook [Webhook]
+    #
+    def delegate(webhook)
+      self[webhook.topic].each { |handler| handler.(webhook) }
+    end
+  end
+end

data/lib/lucid_shopify/webhook_list.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module LucidShopify
+  class WebhookList
+    include Enumerable
+
+    def initialize
+      @webhooks = []
+    end
+
+    #
+    # @yield [Hash]
+    #
+    def each(&block)
+      @webhooks.each(&block)
+    end
+
+    #
+    # @param topic [String]
+    # @param fields [String] e.g. 'id,tags'
+    #
+    def register(topic, fields: nil)
+      @webhooks << {}.tap do |webhook|
+        webhook[:topic] = topic
+        webhook[:fields] = fields if fields
+      end
+
+      nil
+    end
+  end
+end

data/lib/lucid_shopify.rb

@@ -13,7 +13,6 @@ module LucidShopify
   autoload :CreateAllWebhooks, 'lucid_shopify/create_all_webhooks'
   autoload :CreateCharge, 'lucid_shopify/create_charge'
   autoload :CreateWebhook, 'lucid_shopify/create_webhook'
-  autoload :DelegateWebhooks, 'lucid_shopify/delegate_webhooks'
   autoload :DeleteAllWebhooks, 'lucid_shopify/delete_all_webhooks'
   autoload :DeleteRequest, 'lucid_shopify/delete_request'
   autoload :DeleteWebhook, 'lucid_shopify/delete_webhook'
@@ -27,8 +26,40 @@ module LucidShopify
   autoload :Response, 'lucid_shopify/response'
   autoload :Result, 'lucid_shopify/result'
   autoload :SendRequest, 'lucid_shopify/send_request'
-  autoload :ThrottledRequest, 'lucid_shopify/send_throttled_request'
+  autoload :SendThrottledRequest, 'lucid_shopify/send_throttled_request'
   autoload :VERSION, 'lucid_shopify/version'
   autoload :Webhook, 'lucid_shopify/webhook'
-  autoload :Webhooks, 'lucid_shopify/webhooks'
+  autoload :WebhookHandlerList, 'lucid_shopify/webhook_handler_list'
+  autoload :WebhookList, 'lucid_shopify/webhook_list'
+
+  class << self
+    #
+    # Webhooks created for each shop.
+    #
+    # @return [WebhookList]
+    #
+    # @example
+    #   LucidShopify.webhooks.register('orders/create', fields: 'id,tags')
+    #
+    def webhooks
+      @webhooks ||= WebhookList.new
+    end
+
+    #
+    # Handlers for webhook topics.
+    #
+    # @return [WebhookHandlerList]
+    #
+    # @example
+    #   LucidShopify.handlers.register('orders/create', OrdersCreateWebhook.new)
+    #
+    # @example Call topic handlers
+    #   webhook = Webhook.new(myshopify_domain, topic, data)
+    #
+    #   LucidShopify.handlers.delegate(webhook)
+    #
+    def handlers
+      @handlers ||= WebhookHandlerList.new
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucid_shopify
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Kelsey Judson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-30 00:00:00.000000000 Z
+date: 2018-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -126,7 +126,6 @@ files:
 - lib/lucid_shopify/create_all_webhooks.rb
 - lib/lucid_shopify/create_charge.rb
 - lib/lucid_shopify/create_webhook.rb
-- lib/lucid_shopify/delegate_webhooks.rb
 - lib/lucid_shopify/delete_all_webhooks.rb
 - lib/lucid_shopify/delete_request.rb
 - lib/lucid_shopify/delete_webhook.rb
@@ -142,6 +141,8 @@ files:
 - lib/lucid_shopify/send_throttled_request.rb
 - lib/lucid_shopify/version.rb
 - lib/lucid_shopify/webhook.rb
+- lib/lucid_shopify/webhook_handler_list.rb
+- lib/lucid_shopify/webhook_list.rb
 homepage: https://github.com/lucidnz/gem-lucid_shopify
 licenses:
 - ISC

data/lib/lucid_shopify/delegate_webhooks.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module LucidShopify
-  class DelegateWebhooks
-    class << self
-      #
-      # @return [DelegateWebhooks]
-      #
-      def default
-        @default ||= new
-      end
-    end
-
-    def initialize
-      @handlers = {}
-    end
-
-    # @return [Hash<String, Array<#call>>]
-    attr_reader :handlers
-
-    #
-    # Call each of the handlers registered for the given topic in turn. See
-    # {#register} below for more on webhook handlers.
-    #
-    # @param webhook [Webhook]
-    #
-    def call(webhook)
-      handlers[webhook.topic]&.each { |handler| handler.(webhook) }
-    end
-
-    #
-    # Register a handler for a webhook topic. The callable handler will be
-    # called with the argument passed to {#call}.
-    #
-    # @param topic [String] e.g. 'orders/create'
-    # @param handler [#call]
-    #
-    def register(topic, handler)
-      handlers[topic] ||= []
-      handlers[topic] << handler
-    end
-  end
-end