lucid_intercom 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae5331c5e43c8500eba29e4aa59eb888b5cf36eb688e4261bb36a03e69c73668
-  data.tar.gz: 512c22f9afc0ca22de424e8e7cb05620c962c97902c03f0f5ca700176be7f386
+  metadata.gz: 40151e3c0b77b0c04c814fdfa8a03a5c742e41d59f91decbad56707340ca2982
+  data.tar.gz: ead12913bf87b9b27fcdc77740c82bcbc1172f8fce9db7ef9e814983c5f63137
 SHA512:
-  metadata.gz: 275bf250cc1623219ccc046a0209f7b3dc3424eba9b0ea7facdb293115b52c1048f7b974c01058e0c3110eee5cc0712542e116db445cc41ecff6aa4471b90552
-  data.tar.gz: 5b933a4d0827a816cceec0ebcee906e2d5fffafb6d2b3472f4c64da792433e64a6bf05aec32ab46fb3dd8433e2720677b65cbd2d9d0daab49bcc0631a9c9c0c2
+  metadata.gz: edf6696d6613c69a1dead35474beddf87e21650d47a595356d081c70b81e8503117e8704281c5a226d8ce18e1628b26c29f56dd8b90404dd69b4331a069eba89
+  data.tar.gz: 4d5a29e39c4888affa6b7cc8d49881af4463732ad2735315d3344ce6882786fbe30da517d9295ab486e82e87e60f5deaa9e80dcdf96a4b41926f54e6ea7d1aff

data/lib/lucid_intercom/attributes.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry-initializer'
-
-require 'lucid_intercom/convert'
+require 'lucid_intercom/container'
 
 module LucidIntercom
   class Attributes
@@ -10,6 +8,8 @@ module LucidIntercom
 
     # @return [Hash] shop attributes as returned by the Shopify API
     param :shopify_data, reader: :private
+    # @return [Hash] app attributes (unprefixed)
+    param :app_data, reader: :private, default: -> { {} }
 
     #
     # @abstract
@@ -18,7 +18,7 @@ module LucidIntercom
     #
     # @return [Hash]
     #
-    def to_h(convert: Convert.new)
+    def to_h(convert: Container[:convert])
       convert.({})
     end
   end

data/lib/lucid_intercom/company_attributes.rb

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 
-require 'lucid_intercom/attributes'
+require 'lucid_intercom/container'
 
 module LucidIntercom
   class CompanyAttributes < Attributes
+    # @return [CompanyCustomAttributes]
+    param :custom, default: -> { CompanyCustomAttributes.new(shopify_data, app_data) }
+
     #
     # @param browser [Boolean] format for browser snippet
     # @param convert [#call]
     #
     # @return [Hash]
     #
-    def to_h(browser: false, convert: Convert.new)
+    def to_h(browser: false, convert: Container[:convert])
       convert.({}.tap do |h|
         h[browser ? :id : :company_id] = shopify_data['myshopify_domain']
         h[:name] = shopify_data['name']

data/lib/lucid_intercom/company_custom_attributes.rb

@@ -1,19 +1,15 @@
 # frozen_string_literal: true
 
-require 'lucid_intercom/attributes'
-require 'lucid_intercom/config'
+require 'lucid_intercom/container'
 
 module LucidIntercom
   class CompanyCustomAttributes < Attributes
-    # @return [Hash] app attributes (unprefixed)
-    param :app_data, reader: :private
-
     #
     # @param convert [#call]
     #
     # @return [Hash]
     #
-    def to_h(convert: Convert.new)
+    def to_h(convert: Container[:convert])
       convert.(shopify.merge(app))
     end
 

data/lib/lucid_intercom/config.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require 'dry-initializer'
 require 'forwardable'
 
-require 'lucid_intercom/error'
+require 'lucid_intercom'
 
 module LucidIntercom
   NotConfiguredError = Class.new(Error)

data/lib/lucid_intercom/container.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'dry/container'
+
+require 'lucid_intercom'
+
+module LucidIntercom
+  Container = Dry::Container.new
+
+  # Services only (dependencies); no value objects, entities.
+  Container.register(:convert) { Convert.new }
+  Container.register(:notify_changed_plan) { NotifyChangedPlan.new }
+  Container.register(:notify_installed) { NotifyInstalled.new }
+  Container.register(:notify_uninstalled) { NotifyUninstalled.new }
+  Container.register(:post_request) { PostRequest.new }
+  Container.register(:render_snippet) { RenderSnippet.new }
+  Container.register(:update_user) { UpdateUser.new }
+end

data/lib/lucid_intercom/event.rb

@@ -1,35 +1,72 @@
 # frozen_string_literal: true
 
-require 'lucid_intercom/company_attributes'
-require 'lucid_intercom/company_custom_attributes'
-require 'lucid_intercom/config'
-require 'lucid_intercom/user_attributes'
+require 'lucid_intercom/container'
 
 module LucidIntercom
   class Event
-    extend Dry::Initializer
+    #
+    # @param post_request [#call]
+    # @param update_user [#call]
+    #
+    def initialize(post_request: Container[:post_request],
+                   update_user: Container[:update_user])
+      @post_request = post_request
+      @update_user = update_user
+    end
+
+    #
+    # @param shopify_data_or_user [Hash, UserAttributes] shop attributes as returned by the Shopify API
+    # @param *args [Array<Object>]
+    #
+    def notify(shopify_data_or_user, *args)
+      user = shopify_data_or_user
+      user = UserAttributes.new(user, app_data(*args)) if user.is_a?(Hash)
+
+      @post_request.('events', data(user, *args)).assert!
+
+      @update_user.(user)
+    end
+
+    alias_method :call, :notify
+
+    #
+    # @param user [UserAttributes]
+    # @param *args [Array<Object>]
+    #
+    # @return [Hash]
+    #
+    private def data(user, *args)
+      {
+        **data_user_id(user),
+        event_name: name,
+        created_at: Time.now.utc.to_i,
+        metadata: metadata(user, *args),
+      }
+    end
 
-    # @return [Hash] shop attributes as returned by the Shopify API
-    param :shopify_data
-    # @return [CompanyAttributes]
-    option :company, default: proc { CompanyAttributes.new(shopify_data) }
-    # @return [CompanyCustomAttributes]
-    option :company_custom, default: proc { CompanyCustomAttributes.new(shopify_data, app_data) }
-    # @return [UserAttributes]
-    option :user, default: proc { UserAttributes.new(shopify_data) }
+    #
+    # @param user [UserAttributes]
+    #
+    # @return [Hash]
+    #
+    private def data_user_id(user)
+      {
+        user.id_key => user.id,
+      }
+    end
 
     #
     # Set the event name for the subclass.
     #
-    # @param event_name [String, #to_s]
+    # @param name [String, #to_s]
     #
     # @example
     #   event :changed_plan
     #
-    def self.event(event_name)
-      define_method(:event_name) do
-        "#{LucidIntercom.app_prefix}_#{event_name}"
-      end
+    def self.event(name)
+      define_method(:name) { "#{LucidIntercom.app_prefix}_#{name}" }
+
+      private :name
     end
 
     #
@@ -37,16 +74,19 @@ module LucidIntercom
     #
     # @return [String]
     #
-    def event_name
+    private def name
       raise NotImplementedError
     end
 
     #
     # @abstract
     #
+    # @param user [UserAttributes]
+    # @param *args [Array<Object>]
+    #
     # @return [Hash]
     #
-    def event_metadata
+    private def metadata(user, *args)
       raise NotImplementedError
     end
 
@@ -61,17 +101,8 @@ module LucidIntercom
     #
     # @return [Hash]
     #
-    def app_data
+    private def app_data(*)
       {}
     end
-
-    #
-    # @return [Hash]
-    #
-    def user_id
-      {
-        user.id_key => user.id,
-      }
-    end
   end
 end

data/lib/lucid_intercom/{changed_plan_event.rb → notify_changed_plan.rb}

@@ -3,26 +3,25 @@
 require 'lucid_intercom/event'
 
 module LucidIntercom
-  class ChangedPlanEvent < Event
-    # @return [String, nil] e.g. 'free', or nil to unset
-    param :new_plan
-
+  class NotifyChangedPlan < Event
     event :changed_plan
 
     #
-    # @return [Hash]
+    # @see Event#metadata
     #
-    def event_metadata
+    private def metadata(user, new_plan)
       {
-        company_id: company.to_h[:company_id],
+        company_id: user.company.to_h[:company_id],
         new_plan: new_plan,
       }
     end
 
+    #
+    # @param new_plan [String, nil] e.g. 'free', or nil to unset
     #
     # @return [Hash]
     #
-    def app_data
+    private def app_data(new_plan)
       {
         plan: new_plan,
       }

data/lib/lucid_intercom/{installed_event.rb → notify_installed.rb}

@@ -3,26 +3,25 @@
 require 'lucid_intercom/event'
 
 module LucidIntercom
-  class InstalledEvent < Event
-    # @return [String] e.g. 'free'
-    param :new_plan
-
+  class NotifyInstalled < Event
     event :installed
 
     #
-    # @return [Hash]
+    # @see Event#metadata
     #
-    def event_metadata
+    private def metadata(user, new_plan)
       {
-        company_id: company.to_h[:company_id],
+        company_id: user.company.to_h[:company_id],
         new_plan: new_plan,
       }
     end
 
+    #
+    # @param new_plan [String] e.g. 'free'
     #
     # @return [Hash]
     #
-    def app_data
+    private def app_data(new_plan)
       {
         plan: new_plan,
       }

data/lib/lucid_intercom/{uninstalled_event.rb → notify_uninstalled.rb}

@@ -3,22 +3,22 @@
 require 'lucid_intercom/event'
 
 module LucidIntercom
-  class UninstalledEvent < Event
+  class NotifyUninstalled < Event
     event :uninstalled
 
     #
-    # @return [Hash]
+    # @see Event#metadata
     #
-    def event_metadata
+    private def metadata(user, *args)
       {
-        company_id: company.to_h[:company_id],
+        company_id: user.company.to_h[:company_id],
       }
     end
 
     #
     # @return [Hash]
     #
-    def app_data
+    private def app_data(*)
       {
         plan: nil,
       }

data/lib/lucid_intercom/post_request.rb

@@ -2,8 +2,7 @@
 
 require 'http'
 
-require 'lucid_intercom/config'
-require 'lucid_intercom/response'
+require 'lucid_intercom'
 
 module LucidIntercom
   class PostRequest

data/lib/lucid_intercom/render_snippet.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'lucid_intercom/config'
+require 'lucid_intercom'
 
 module LucidIntercom
   class RenderSnippet
     TEMPLATE = File.read("#{__dir__}/snippet.html").freeze
 
     #
-    # @param shopify_data [Hash] shop attributes as returned by the Shopify API
+    # @param shopify_data_or_user [Hash, UserAttributes] shop attributes as returned by the Shopify API
     # @param app_data [Hash] app attributes (unprefixed)
     #
     # @example Unauthenticated visitor
@@ -18,17 +18,13 @@ module LucidIntercom
     #
     # @return [String]
     #
-    def call(shopify_data = {}, app_data = {})
-      settings = shopify_data.empty? ? unauthenticated_settings : {
-        **unauthenticated_settings,
-        **UserAttributes.new(shopify_data).to_h(browser: true),
-        company: CompanyAttributes.new(shopify_data).to_h(browser: true).merge(CompanyCustomAttributes.new(shopify_data, app_data).to_h)
-      }
+    def call(shopify_data_or_user = {}, app_data = {})
+      user = shopify_data_or_user
+      user = UserAttributes.new(user, app_data) if user.is_a?(Hash)
 
-      TEMPLATE % {
-        settings: settings.to_json,
-        app_id: settings[:app_id],
-      }
+      settings = shopify_data_or_user.is_a?(Hash) && shopify_data_or_user.empty? ? unauthenticated_settings : authenticated_settings(user)
+
+      TEMPLATE % {settings: settings.to_json, app_id: settings[:app_id]}
     end
 
     #
@@ -39,5 +35,18 @@ module LucidIntercom
         app_id: LucidIntercom.app_id,
       }
     end
+
+    #
+    # @param user [UserAttributes]
+    #
+    # @return [Hash]
+    #
+    private def authenticated_settings(user)
+      {
+        **unauthenticated_settings,
+        **user.to_h(browser: true),
+        company: user.company.to_h(browser: true).merge(user.company.custom.to_h),
+      }
+    end
   end
 end

data/lib/lucid_intercom/response.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry-initializer'
-
-require 'lucid_intercom/error'
+require 'lucid_intercom'
 
 module LucidIntercom
   class Response

data/lib/lucid_intercom/update_user.rb

@@ -1,41 +1,38 @@
 # frozen_string_literal: true
 
-require 'dry-initializer'
-
-require 'lucid_intercom/post_request'
+require 'lucid_intercom/container'
 
 module LucidIntercom
   class UpdateUser
-    extend Dry::Initializer
-
-    # @return [PostRequest]
-    option :post_request, default: proc { PostRequest.new }
+    #
+    # @param post_request [#call]
+    #
+    def initialize(post_request: Container[:post_request])
+      @post_request = post_request
+    end
 
     #
-    # Create or update user identified by event attributes. This is only used in
-    # the context of events.
+    # Create or update user.
     #
-    # @param event [Events::Event]
+    # @param user [UserAttributes]
     #
     # @raise [Response::ClientError] for status 4xx
     # @raise [Response::ServerError] for status 5xx
     #
-    def call(event)
-      data = data(event)
-
-      post_request.('users', data).assert!
+    def call(user)
+      @post_request.('users', data(user)).assert!
     end
 
     #
-    # @param event [Events::Event]
+    # @param user [UserAttributes]
     #
     # @return [Hash]
     #
-    private def data(event)
-      event.user.to_h.merge(
+    private def data(user)
+      user.to_h.merge(
         companies: [
-          event.company.to_h.merge(
-            custom_attributes: event.company_custom.to_h
+          user.company.to_h.merge(
+            custom_attributes: user.company.custom.to_h
           ),
         ]
       )

data/lib/lucid_intercom/user_attributes.rb

@@ -1,17 +1,19 @@
 # frozen_string_literal: true
 
-require 'lucid_intercom/attributes'
-require 'lucid_intercom/config'
+require 'lucid_intercom/container'
 
 module LucidIntercom
   class UserAttributes < Attributes
+    # @return [CompanyAttributes]
+    param :company, default: -> { CompanyAttributes.new(shopify_data, app_data) }
+
     #
     # @param browser [Boolean] format for browser snippet
     # @param convert [#call]
     #
     # @return [Hash]
     #
-    def to_h(browser: false, convert: Convert.new)
+    def to_h(browser: false, convert: Container[:convert])
       convert.({}.tap do |h|
         h[:user_hash] = user_hash(id) if browser # or myshopify_domain
         h[:email] = shopify_data['email']

data/lib/lucid_intercom/version.rb

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

data/lib/lucid_intercom.rb

@@ -1,21 +1,23 @@
 # frozen_string_literal: true
 
-# Primarily for Bundler.
+require 'dry/initializer'
 
-require 'lucid_intercom/attributes.rb'
-require 'lucid_intercom/changed_plan_event.rb'
-require 'lucid_intercom/company_attributes.rb'
-require 'lucid_intercom/company_custom_attributes.rb'
-require 'lucid_intercom/config.rb'
-require 'lucid_intercom/convert.rb'
-require 'lucid_intercom/error.rb'
-require 'lucid_intercom/event.rb'
-require 'lucid_intercom/installed_event.rb'
-require 'lucid_intercom/post_request.rb'
-require 'lucid_intercom/render_snippet.rb'
-require 'lucid_intercom/response.rb'
-require 'lucid_intercom/send_event.rb'
-require 'lucid_intercom/uninstalled_event.rb'
-require 'lucid_intercom/update_user.rb'
-require 'lucid_intercom/user_attributes.rb'
-require 'lucid_intercom/version.rb'
+module LucidIntercom
+  autoload :Attributes, 'lucid_intercom/attributes.rb'
+  autoload :CompanyAttributes, 'lucid_intercom/company_attributes.rb'
+  autoload :CompanyCustomAttributes, 'lucid_intercom/company_custom_attributes.rb'
+  autoload :Config, 'lucid_intercom/config.rb'
+  autoload :Container, 'lucid_intercom/container.rb'
+  autoload :Convert, 'lucid_intercom/convert.rb'
+  autoload :Error, 'lucid_intercom/error.rb'
+  autoload :Event, 'lucid_intercom/event.rb'
+  autoload :NotifyChangedPlan, 'lucid_intercom/notify_changed_plan.rb'
+  autoload :NotifyInstalled, 'lucid_intercom/notify_installed.rb'
+  autoload :NotifyUninstalled, 'lucid_intercom/notify_uninstalled.rb'
+  autoload :PostRequest, 'lucid_intercom/post_request.rb'
+  autoload :RenderSnippet, 'lucid_intercom/render_snippet.rb'
+  autoload :Response, 'lucid_intercom/response.rb'
+  autoload :UpdateUser, 'lucid_intercom/update_user.rb'
+  autoload :UserAttributes, 'lucid_intercom/user_attributes.rb'
+  autoload :VERSION, 'lucid_intercom/version.rb'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucid_intercom
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Kelsey Judson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-11 00:00:00.000000000 Z
+date: 2018-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,14 +44,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: 0.58.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: 0.58.2
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: dry-initializer
   requirement: !ruby/object:Gem::Requirement
@@ -89,20 +103,20 @@ files:
 - README.md
 - lib/lucid_intercom.rb
 - lib/lucid_intercom/attributes.rb
-- lib/lucid_intercom/changed_plan_event.rb
 - lib/lucid_intercom/company_attributes.rb
 - lib/lucid_intercom/company_custom_attributes.rb
 - lib/lucid_intercom/config.rb
+- lib/lucid_intercom/container.rb
 - lib/lucid_intercom/convert.rb
 - lib/lucid_intercom/error.rb
 - lib/lucid_intercom/event.rb
-- lib/lucid_intercom/installed_event.rb
+- lib/lucid_intercom/notify_changed_plan.rb
+- lib/lucid_intercom/notify_installed.rb
+- lib/lucid_intercom/notify_uninstalled.rb
 - lib/lucid_intercom/post_request.rb
 - lib/lucid_intercom/render_snippet.rb
 - lib/lucid_intercom/response.rb
-- lib/lucid_intercom/send_event.rb
 - lib/lucid_intercom/snippet.html
-- lib/lucid_intercom/uninstalled_event.rb
 - lib/lucid_intercom/update_user.rb
 - lib/lucid_intercom/user_attributes.rb
 - lib/lucid_intercom/version.rb

data/lib/lucid_intercom/send_event.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require 'dry-initializer'
-
-require 'lucid_intercom/post_request'
-
-module LucidIntercom
-  class SendEvent
-    extend Dry::Initializer
-
-    # @return [PostRequest]
-    option :post_request, default: proc { PostRequest.new }
-    # @return [UpdateUser]
-    option :update_user, default: proc { UpdateUser.new }
-
-    #
-    # @param event [Events::Event]
-    #
-    # @raise [Response::ClientError] for status 4xx
-    # @raise [Response::ServerError] for status 5xx
-    #
-    def call(event)
-      post_request.('events', data(event)).assert!
-
-      update_user.(event)
-    end
-
-    #
-    # @param event [Events::Event]
-    #
-    # @return [Hash]
-    #
-    private def data(event)
-      {
-        **event.user_id,
-        event_name: event.event_name,
-        created_at: Time.now.utc.to_i,
-        metadata: event.event_metadata,
-      }
-    end
-  end
-end