lucid_intercom 0.4.2 → 0.5.0

data/lib/lucid_intercom/snippet.html.erb

@@ -1,14 +1,2 @@
-<script>
-  window.intercomSettings = {
-    app_id: "<%= credentials.app_id %>",
-    <% if attributes %>
-      <% attributes.user_browser.each do |k, v| %><%= k %>: <%= h v %>,<% end %>
-      company: {
-        <% attributes.company_browser.each do |k, v| %><%= k %>: <%= h v %>,<% end %>
-        <% attributes.custom.each do |k, v| %><%= k %>: <%= h v %>,<% end %>
-      },
-    <% end %>
-  };
-</script>
-
-<script>(function(){var w=window;var ic=w.Intercom;if(typeof ic==="function"){ic('reattach_activator');ic('update',intercomSettings);}else{var d=document;var i=function(){i.c(arguments)};i.q=[];i.c=function(args){i.q.push(args)};w.Intercom=i;function l(){var s=d.createElement('script');s.type='text/javascript';s.async=true;s.src='https://widget.intercom.io/widget/<%= credentials.app_id %>';var x=d.getElementsByTagName('script')[0];x.parentNode.insertBefore(s,x);}if(w.attachEvent){w.attachEvent('onload',l);}else{w.addEventListener('load',l,false);}}})()</script>
+<script>window.intercomSettings={app_id:'<%= LucidIntercom.app_id %>',<% if attributes %><% user.each do |k, v| %><%= k %>:<%= escape v %>,<% end %>company:{<% company.each do |k, v| %><%= k %>:<%= escape v %>,<% end %><% company_custom.each do |k, v| %><%= k %>:<%= escape v %>,<% end %>},<% end %>};</script>
+<script>(function(){var w=window;var ic=w.Intercom;if(typeof ic==='function'){ic('reattach_activator');ic('update',intercomSettings);}else{var d=document;var i=function(){i.c(arguments)};i.q=[];i.c=function(args){i.q.push(args)};w.Intercom=i;function l(){var s=d.createElement('script');s.type='text/javascript';s.async=true;s.src='https://widget.intercom.io/widget/<%= LucidIntercom.app_id %>';var x=d.getElementsByTagName('script')[0];x.parentNode.insertBefore(s,x);}if(w.attachEvent){w.attachEvent('onload',l);}else{w.addEventListener('load',l,false);}}})()</script>

data/lib/lucid_intercom/uninstalled_event.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'lucid_intercom/event'
+
+module LucidIntercom
+  class UninstalledEvent < Event
+    event :uninstalled
+
+    #
+    # @return [Hash]
+    #
+    def event_metadata
+      {
+        company_id: company.to_h[:company_id],
+      }
+    end
+
+    #
+    # @return [Hash]
+    #
+    def app_data
+      {
+        plan: nil,
+      }
+    end
+  end
+end

data/lib/lucid_intercom/update_user.rb

@@ -1,74 +1,44 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'net/http'
-require 'uri'
-require 'lucid_intercom/attributes'
-require 'lucid_intercom/credentials'
-require 'lucid_intercom/errors'
+require 'dry-initializer'
+
+require 'lucid_intercom/post_request'
 
 module LucidIntercom
   class UpdateUser
-    #
-    # @param shop_attributes [Hash] shop attributes in format returned by the Shopify API
-    # @param app_attributes [Hash] app-specific attributes (unprefixed)
-    # @param credentials [LucidIntercom::Credentials]
-    #
-    def initialize(shop_attributes, app_attributes, credentials = LucidIntercom.credentials)
-      @attributes = Attributes.new(shop_attributes, app_attributes, credentials)
-      @credentials = credentials
-    end
+    extend Dry::Initializer
 
-    # @return [LucidIntercom::Attributes]
-    attr_reader :attributes
-    # @return [LucidIntercom::Credentials]
-    attr_reader :credentials
+    # @return [PostRequest]
+    option :post_request, default: proc { PostRequest.new }
 
     #
-    # Create or update user identified by attributes.
+    # Create or update user identified by event attributes. This is only used in
+    # the context of events.
     #
-    # @raise [LucidIntercom::RequestError] if the response status >= 400
+    # @param event [Events::Event]
     #
-    def call
-      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
-        http.request(req, data)
-      end
-
-      status = res.code.to_i
-
-      if status >= 400 # rubocop:disable Style/GuardClause
-        raise LucidIntercom::RequestError.new(status), 'invalid response code %s' % status
-      end
-    end
-
+    # @raise [Response::ClientError] for status 4xx
+    # @raise [Response::ServerError] for status 5xx
     #
-    # @return [URI::HTTPS]
-    #
-    private def uri
-      URI('https://api.intercom.io/users')
-    end
+    def call(event)
+      data = data(event)
 
-    #
-    # @return [Net::HTTP::Post]
-    #
-    private def req
-      req = Net::HTTP::Post.new(uri)
-      req['Authorization'] = "Bearer #{credentials.access_token}"
-      req['Accept'] = 'application/json'
-      req['Content-Type'] = 'application/json'
-
-      req
+      post_request.('users', data).assert!
     end
 
+    #
+    # @param event [Events::Event]
     #
     # @return [Hash]
     #
-    private def data
-      user = attributes.user
-      user[:companies] = [attributes.company]
-      user[:companies][0]['custom_attributes'] = attributes.custom
-
-      user.to_json
+    private def data(event)
+      event.user.to_h.merge(
+        companies: [
+          event.company.to_h.merge(
+            custom_attributes: event.company_custom.to_h
+          ),
+        ]
+      )
     end
   end
 end

data/lib/lucid_intercom/user_attributes.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'lucid_intercom/attributes'
+require 'lucid_intercom/config'
+
+module LucidIntercom
+  class UserAttributes < Attributes
+    #
+    # @param browser [Boolean] format for browser snippet
+    # @param convert [#call]
+    #
+    # @return [Hash]
+    #
+    def to_h(browser: false, convert: Convert.new)
+      convert.({}.tap do |h|
+        h[:user_hash] = user_hash(id) if browser # or myshopify_domain
+        h[:email] = shopify_data['email']
+        h[:name] = shopify_data['shop_owner']
+      end)
+    end
+
+    #
+    # Either {:user_id} or {:email}. Currently, we are using the email address.
+    #
+    # @return [Symbol]
+    #
+    def id_key
+      :email
+    end
+
+    #
+    # @return [String]
+    #
+    def id
+      shopify_data[id_key.to_s]
+    end
+
+    #
+    # @param email [String]
+    #
+    # @return [String]
+    #
+    private def user_hash(email)
+      OpenSSL::HMAC.hexdigest('sha256', LucidIntercom.secret, email)
+    end
+  end
+end

data/lib/lucid_intercom/version.rb

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

data/lib/lucid_intercom.rb

@@ -2,9 +2,21 @@
 
 # Primarily for Bundler.
 
-require 'lucid_intercom/attributes'
-require 'lucid_intercom/credentials'
-require 'lucid_intercom/events'
-require 'lucid_intercom/render_snippet'
-require 'lucid_intercom/send_event'
-require 'lucid_intercom/update_user'
+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/snippet.html.erb'
+require 'lucid_intercom/uninstalled_event.rb'
+require 'lucid_intercom/update_user.rb'
+require 'lucid_intercom/user_attributes.rb'
+require 'lucid_intercom/version.rb'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: lucid_intercom
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Kelsey Judson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2018-03-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.52.0
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 
 email: kelsey@lucid.nz
 executables: []
@@ -47,24 +89,22 @@ files:
 - README.md
 - lib/lucid_intercom.rb
 - lib/lucid_intercom/attributes.rb
-- lib/lucid_intercom/attributes/base.rb
-- lib/lucid_intercom/attributes/company.rb
-- lib/lucid_intercom/attributes/custom.rb
-- lib/lucid_intercom/attributes/user.rb
-- lib/lucid_intercom/credentials.rb
-- lib/lucid_intercom/errors.rb
-- lib/lucid_intercom/errors/error.rb
-- lib/lucid_intercom/errors/missing_credentials_error.rb
-- lib/lucid_intercom/errors/request_error.rb
-- lib/lucid_intercom/events.rb
-- lib/lucid_intercom/events/base.rb
-- lib/lucid_intercom/events/changed_plan.rb
-- lib/lucid_intercom/events/installed.rb
-- lib/lucid_intercom/events/uninstalled.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/convert.rb
+- lib/lucid_intercom/error.rb
+- lib/lucid_intercom/event.rb
+- lib/lucid_intercom/installed_event.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.erb
+- lib/lucid_intercom/uninstalled_event.rb
 - lib/lucid_intercom/update_user.rb
+- lib/lucid_intercom/user_attributes.rb
 - lib/lucid_intercom/version.rb
 homepage: https://github.com/lucidnz/gem-lucid_intercom
 licenses:

data/lib/lucid_intercom/attributes/base.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require 'lucid_intercom/credentials'
-
-module LucidIntercom
-  class Attributes
-    class Base
-      #
-      # @param shop_attributes [Hash] shop attributes in format returned by the Shopify API
-      # @param app_attributes [Hash] app-specific attributes (unprefixed)
-      # @param credentials [LucidIntercom::Credentials]
-      #
-      def initialize(shop_attributes = {}, app_attributes = {}, credentials = LucidIntercom.credentials)
-        @credentials = credentials
-        @shop_attributes = shop_attributes
-        @app_attributes = app_attributes
-      end
-
-      # @return [LucidIntercom::Credentials]
-      attr_reader :credentials
-      # @return [Hash]
-      attr_reader :shop_attributes
-      # @return [Hash]
-      attr_reader :app_attributes
-
-      #
-      # @return [Hash]
-      #
-      def call
-        normalize_values(attributes)
-      end
-
-      #
-      # @return [Hash]
-      #
-      private def attributes
-        {}
-      end
-
-      #
-      # Convert attribute values to valid Intercom types.
-      #
-      # @param attributes [Hash]
-      #
-      # @return [Hash]
-      #
-      private def normalize_values(attributes)
-        attributes.each_with_object({}) do |(k, v), a|
-          a[k] = case v
-          when Integer, Float
-            v
-          when Time
-            v.to_i
-          when nil
-            nil # unset attribute
-          else
-            v.to_s
-          end
-        end
-      end
-    end
-  end
-end

data/lib/lucid_intercom/attributes/company.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require 'lucid_intercom/attributes/base'
-
-module LucidIntercom
-  class Attributes
-    class Company < Base
-      #
-      # Standard Intercom company attributes.
-      #
-      # @return [Hash]
-      #
-      private def attributes
-        {
-          company_id: shop_attributes['myshopify_domain'],
-          name: shop_attributes['name'],
-          plan: shop_attributes['plan_name'],
-        }
-      end
-    end
-  end
-end

data/lib/lucid_intercom/attributes/custom.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require 'lucid_intercom/attributes/base'
-require 'lucid_intercom/credentials'
-
-module LucidIntercom
-  class Attributes
-    class Custom < Base
-      #
-      # Custom company attributes.
-      #
-      # @return [Hash]
-      #
-      private def attributes
-        super
-          .merge(attributes_shopify)
-          .merge(attributes_app)
-      end
-
-      #
-      # These custom attributes are prefixed with 'merchant_' to distinguish
-      # from the Shopify intergration's 'shopify_' prefix.
-      #
-      # @return [Hash]
-      #
-      private def attributes_shopify
-        {
-          merchant_domain: shop_attributes['domain'],
-          merchant_myshopify_domain: shop_attributes['myshopify_domain'],
-          merchant_shop_owner: shop_attributes['shop_owner'],
-          merchant_timezone: shop_attributes['timezone'],
-        }
-      end
-
-      #
-      # Anything app-specific.
-      #
-      # @return [Hash]
-      #
-      private def attributes_app
-        app_attributes.each_with_object({}) do |(k, v), a|
-          a["#{credentials.app_prefix}_#{k}"] = v
-        end
-      end
-    end
-  end
-end

data/lib/lucid_intercom/attributes/user.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require 'openssl'
-require 'lucid_intercom/attributes/base'
-
-module LucidIntercom
-  class Attributes
-    class User < Base
-      #
-      # Standard Intercom user attributes.
-      #
-      # @return [Hash]
-      #
-      private def attributes
-        {
-          # NOTE: currently unused in favour of email # user_id: shop_attributes['myshopify_domain'],
-          user_hash: user_hash(shop_attributes['email']),
-          email: shop_attributes['email'],
-          name: shop_attributes['shop_owner'],
-        }
-      end
-
-      private def user_hash(email)
-        OpenSSL::HMAC.hexdigest('sha256', credentials.secret, email)
-      end
-    end
-  end
-end

data/lib/lucid_intercom/credentials.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module LucidIntercom
-  #
-  # @!attribute [rw] access_token
-  #   @return [String]
-  # @!attribute [rw] secret
-  #   @return [String]
-  # @!attribute [rw] app_id
-  #   @return [String]
-  # @!attribute [rw] app_prefix
-  #   @return [String] the snakecased app name, e.g. 'smart_order_tags'
-  #
-  Credentials = Struct.new(:access_token, :secret, :app_id, :app_prefix)
-end
-
-class << LucidIntercom
-  #
-  # Assign default API credentials.
-  #
-  # @param credentials [LucidIntercom::Credentials]
-  #
-  attr_writer :credentials
-
-  #
-  # @return [LucidIntercom::Credentials]
-  #
-  # @raise [LucidIntercom::MissingCredentialsError] if credentials are unset
-  #
-  def credentials
-    raise MissingCredentialsError unless @credentials
-
-    @credentials
-  end
-end

data/lib/lucid_intercom/errors/missing_credentials_error.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'lucid_intercom/errors/error'
-
-module LucidIntercom
-  MissingCredentialsError = Class.new(Error)
-end

data/lib/lucid_intercom/errors/request_error.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'lucid_intercom/errors/error'
-
-module LucidIntercom
-  class RequestError < Error
-    #
-    # @param status [Integer] the HTTP response status
-    #
-    def initialize(status)
-      @status = status
-    end
-
-    # @return [Integer]
-    attr_reader :status
-  end
-end

data/lib/lucid_intercom/errors.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require 'lucid_intercom/errors/request_error'

data/lib/lucid_intercom/events/base.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'lucid_intercom/credentials'
-
-module LucidIntercom
-  module Events
-    class Base
-      #
-      # @param shop_attributes [Hash] shop attributes in format returned by the Shopify API
-      # @param credentials [LucidIntercom::Credentials]
-      #
-      def initialize(shop_attributes, credentials = LucidIntercom.credentials)
-        @credentials = credentials
-        @shop_attributes = shop_attributes
-      end
-
-      # @return [LucidIntercom::Credentials]
-      attr_reader :credentials
-      # @return [Hash]
-      attr_reader :shop_attributes
-    end
-  end
-end

data/lib/lucid_intercom/events/changed_plan.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require 'lucid_intercom/credentials'
-require 'lucid_intercom/send_event'
-require 'lucid_intercom/update_user'
-require 'lucid_intercom/events/base'
-
-module LucidIntercom
-  module Events
-    class ChangedPlan < Base
-      #
-      # @param plan_name [String, nil] e.g. 'free', or nil to unset
-      #
-      def call(plan_name)
-        LucidIntercom::UpdateUser.new(shop_attributes, {plan: plan_name}, credentials).()
-        LucidIntercom::SendEvent.new(shop_attributes, credentials).(event_name, event_metadata(plan_name))
-      end
-
-      #
-      # @return [String]
-      #
-      private def event_name
-        "#{credentials.app_prefix}_changed_plan"
-      end
-
-      #
-      # @return [Hash]
-      #
-      private def event_metadata(plan_name)
-        {
-          company_id: shop_attributes['myshopify_domain'],
-          new_plan: plan_name,
-        }
-      end
-    end
-  end
-end

data/lib/lucid_intercom/events/installed.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require 'lucid_intercom/credentials'
-require 'lucid_intercom/send_event'
-require 'lucid_intercom/update_user'
-require 'lucid_intercom/events/base'
-
-module LucidIntercom
-  module Events
-    class Installed < Base
-      #
-      # @param plan_name [String] e.g. 'free'
-      #
-      def call(plan_name)
-        LucidIntercom::UpdateUser.new(shop_attributes, {plan: plan_name}, credentials).()
-        LucidIntercom::SendEvent.new(shop_attributes, credentials).(event_name, event_metadata(plan_name))
-      end
-
-      #
-      # @return [String]
-      #
-      private def event_name
-        "#{credentials.app_prefix}_installed"
-      end
-
-      #
-      # @return [Hash]
-      #
-      private def event_metadata(plan_name)
-        {
-          company_id: shop_attributes['myshopify_domain'],
-          new_plan: plan_name,
-        }
-      end
-    end
-  end
-end