lucid_intercom 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c79fdf9db9290c3f3ce19018e653330829d4ae65d9d651dcc01a3654e38d3a2
-  data.tar.gz: 75ad290ae14e0f376d61481354be8d0f657975158cc909f6c0d835434a83d211
+  metadata.gz: c68b630c07ce2c240795b154f8d5c874db29c516e357582b4f1dcfe8e4504f50
+  data.tar.gz: f2f796e2d8e4cea69af445d8a17befa36dec12c7abceed9eaa43172c970b8da8
 SHA512:
-  metadata.gz: 51125d01350d54d600663f6be32bf98665bbb7c24f82aeae488fd8fe27b4a6ee0e4e6df0da1fbcf8acccc93f2cd16b627dda81ef2bea6b51b7e2c1e2fcc73c09
-  data.tar.gz: 0ea00b6f1ae51e1216e349d45cc5be0dd54f0363d1a4da3c952a1a5674ade82b5968b8f129c6472ba4736100cc637e9b9056be6e2a9abb42ef67ea03b11978a7
+  metadata.gz: 8a41991df15b5cf39e7e97d9e00fce2380765f96dabe2907fa684b539d3e504de095eb09b0f6c4d7e9e0194245cc7d2127e7816b471de1cae610c363a07a750d
+  data.tar.gz: a57a7947ffde3d25d6aa844d8ba1ea16e4e3cacc3ef307751a397d2d0f4df2dde82a2f0538213694446e3127359a5f08c3d2546eb633bf9c509f2b91ee61c98c

data/README.md

@@ -14,15 +14,24 @@ Usage
 
 ### Configure the default API credentials
 
-    LucidIntercom.config = LucidIntercom::Config.new(
-      '...', # access_token
-      '...', # secret
-      '...', # app_id
-      '...', # app_prefix
-      123456 # admin_id
+    LucidIntercom.configure(
+      access_token: '...',
+      admin_id: 123456,
+      app_id: '...',
+      app_prefix: '...',
+      secret: '...',
     )
 
-Here, ‘app_prefix’ is the snakecased app name, e.g. ‘smart_order_tags’
+Here, ‘app_prefix’ is the snakecased app name, e.g. ‘smart_order_tags’.
+
+Alternatively load the configuration from a Ruby file. The Ruby
+file is evaluated and should return a hash.
+
+    LucidIntercom.configure_from_file('config/intercom.rb') # the default path
+
+When loading from a file, any environment variables matching the
+upcased key with the prefix ‘INTERCOM_’ will override values in the
+file. For example ‘INTERCOM_APP_ID=...’.
 
 
 ### Render the browser snippet

data/lib/lucid_intercom/company_custom_attributes.rb

@@ -34,7 +34,7 @@ module LucidIntercom
     # @return [Hash]
     #
     private def app
-      prefix = LucidIntercom.app_prefix
+      prefix = LucidIntercom.config.app_prefix
 
       app_data.each_with_object({}) do |(k, v), h|
         h["#{prefix}_#{k}"] = v

data/lib/lucid_intercom/config.rb

@@ -1,51 +1,48 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-
 require 'lucid_intercom'
+require 'lucid_utils'
 
 module LucidIntercom
   NotConfiguredError = Class.new(Error)
 
   class << self
-    extend Forwardable
+    #
+    # @param options [Hash]
+    #
+    # @return [Config]
+    #
+    def configure(options = {})
+      @config = Config.new(
+        **@config.to_h.compact,
+        **options,
+      )
+    end
 
-    def_delegators(
-      :config,
-      :access_token,
-      :secret,
-      :app_id,
-      :app_prefix,
-      :admin_id # for messages/emails
-    )
+    #
+    # @param path [String]
+    #
+    # @return [Config]
+    #
+    def configure_from_file(path = 'config/intercom.rb')
+      options = LucidUtils::ConfigFromFile.new.(path, env_prefix: 'intercom')
 
-    # @param config [Config]
-    attr_writer :config
+      configure(options)
+    end
 
     #
     # @return [Config]
     #
-    # @raise [NotConfiguredError] if config is unset
-    #
     def config
-      raise NotConfiguredError unless @config
-
-      @config
+      @config ||= configure
     end
   end
 
-  class Config
-    extend Dry::Initializer
-
-    # @return [String]
-    param :access_token
-    # @return [String]
-    param :secret
-    # @return [String]
-    param :app_id
-    # @return [String] the snakecased app name, e.g. 'smart_order_tags'
-    param :app_prefix
-    # @return [Integer]
-    param :admin_id
+  class Config < Dry::Struct
+    attribute :access_token, Types::String
+    attribute :admin_id, Types::Integer
+    attribute :app_id, Types::String
+    attribute :app_prefix, Types::String # the snakecased app name, e.g. 'smart_order_tags'
+    attribute :secret, Types::String
   end
 end

data/lib/lucid_intercom/event.rb

@@ -64,7 +64,7 @@ module LucidIntercom
     #   event :changed_plan
     #
     def self.event(name)
-      define_method(:name) { "#{LucidIntercom.app_prefix}_#{name}" }
+      define_method(:name) { "#{LucidIntercom.config.app_prefix}_#{name}" }
 
       private :name
     end

data/lib/lucid_intercom/post_request.rb

@@ -19,7 +19,7 @@ module LucidIntercom
     #
     def call(path, data)
       res = @http.headers(
-        'Authorization' => "Bearer #{LucidIntercom.access_token}",
+        'Authorization' => "Bearer #{LucidIntercom.config.access_token}",
         'Accept' => 'application/json',
         'Content-Type' => 'application/json'
       ).post("https://api.intercom.io/#{path}", json: data)

data/lib/lucid_intercom/render_snippet.rb

@@ -32,7 +32,7 @@ module LucidIntercom
     #
     private def unauthenticated_settings
       {
-        app_id: LucidIntercom.app_id,
+        app_id: LucidIntercom.config.app_id,
       }
     end
 

data/lib/lucid_intercom/send_email.rb

@@ -24,7 +24,7 @@ module LucidIntercom
         template: 'plain',
         from: {
           type: 'admin',
-          id: LucidIntercom.admin_id,
+          id: LucidIntercom.config.admin_id,
         },
         to: {
           type: 'user',

data/lib/lucid_intercom/send_message.rb

@@ -21,7 +21,7 @@ module LucidIntercom
         body: body,
         from: {
           type: 'admin',
-          id: LucidIntercom.admin_id,
+          id: LucidIntercom.config.admin_id,
         },
         to: {
           type: 'user',

data/lib/lucid_intercom/types.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module LucidIntercom
+  module Types
+    include Dry.Types(default: :strict)
+  end
+end

data/lib/lucid_intercom/user_attributes.rb

@@ -43,7 +43,7 @@ module LucidIntercom
     # @return [String]
     #
     private def user_hash(email)
-      OpenSSL::HMAC.hexdigest('sha256', LucidIntercom.secret, email)
+      OpenSSL::HMAC.hexdigest('sha256', LucidIntercom.config.secret, email)
     end
   end
 end

data/lib/lucid_intercom/version.rb

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

data/lib/lucid_intercom.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'dry/initializer'
+require 'dry/struct'
 
 module LucidIntercom
   autoload :Attributes, 'lucid_intercom/attributes.rb'
@@ -19,7 +20,10 @@ module LucidIntercom
   autoload :Response, 'lucid_intercom/response.rb'
   autoload :SendEmail, 'lucid_intercom/send_email.rb'
   autoload :SendMessage, 'lucid_intercom/send_message.rb'
+  autoload :Types, 'lucid_intercom/types.rb'
   autoload :UpdateUser, 'lucid_intercom/update_user.rb'
   autoload :UserAttributes, 'lucid_intercom/user_attributes.rb'
   autoload :VERSION, 'lucid_intercom/version.rb'
 end
+
+require 'lucid_intercom/config'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucid_intercom
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Kelsey Judson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2019-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ 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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 description: 
 email: kelsey@lucid.nz
 executables: []
@@ -119,6 +147,7 @@ files:
 - lib/lucid_intercom/send_email.rb
 - lib/lucid_intercom/send_message.rb
 - lib/lucid_intercom/snippet.html
+- lib/lucid_intercom/types.rb
 - lib/lucid_intercom/update_user.rb
 - lib/lucid_intercom/user_attributes.rb
 - lib/lucid_intercom/version.rb