intercom-rails 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08651bb54d9b9c588783f70646f08de114e2d7fc
-  data.tar.gz: 9bb02e0bdcb79a59d7e3a5ba6cde2ad7f5982caa
+  metadata.gz: fad8f8d2ec8aa23c29149ded67376d397692901d
+  data.tar.gz: bcc4e82069fe43a4058dee9aba24d30976f2f002
 SHA512:
-  metadata.gz: 72371243fbae2337000a1f3eb7dbf0beb32bb98ff3cf08b1430f04e7f7be2e755685910518742ae884a605359927247e6b2adcdba6d5da51d3bc08e5a231368c
-  data.tar.gz: a5b853032d971f3c50ef477982f065f3c55b3739ebc02a64f91e91f432b05c466e9ab08c37a76aabf305d2f4b6cbab6744a9613772adb51cbd3104db6d5af805
+  metadata.gz: 46d75b65e5324ef4df39e0858d2ae8d76186acb325a51b63e41237d2bc17d936dd6e4bedf4c3bbbb88c64d29b9eb4c021022117a30ddfdb41f069d524b03a262
+  data.tar.gz: 6a5707a85610968b143730224ae3ffc90af1bd49ceafc7b97d82c87a2214877ef71d0a80eeb2e18f25e050f7dcff16d3f51c71866f96898fd84facee3444bbc8

data/README.mdown

@@ -17,13 +17,21 @@ Then run:
 bundle install
 ```
 
-Take note of your `app_id` from [here](https://app.intercom.io/apps/api_keys) and generate a config file:
+Take note of your `app_id` from [here](https://app.intercom.io/a/apps/_/settings/api-keys) and generate a config file:
 
 ```
 rails generate intercom:config YOUR-APP-ID
 ```
 
-To make installing Intercom as easy as possible, where possible a `<script>` tag **will be automatically inserted before the closing `</body>` tag**. For most Rails apps, **you won't need to do any extra config**. Having trouble? Check out troubleshooting below.
+To make installing Intercom easy, where possible a `<script>` tag **will be automatically inserted before the closing `</body>` tag**. For most Rails apps, **you won't need to do any extra config**. Having trouble? Check out troubleshooting below.
+
+
+### Live Chat / Acquire
+With our [Acquire package](https://www.intercom.io/live-chat), Intercom Messenger now works with logged out users and visitors to your web site. Include the Intercom snippet on every page by setting:
+
+```ruby
+  config.include_for_logged_out_users = true
+```
 
 ### Disabling automatic insertion
 
@@ -151,6 +159,8 @@ e.g.
     :is_paid => Proc.new { |user| user.plan.present? },
     :email_verified => :email_verified?
   }
+  # or If User::custom_data method returns a hash
+  config.user.custom_data = Proc.new { |user| user.custom_data }
 ```
 
 In some situations you'll want to set some custom data attribute specific to a request.
@@ -230,13 +240,6 @@ config.company.custom_data = {
 }
 ```
 
-### Live Chat / Acquire
-With our [Acquire package](https://www.intercom.io/live-chat), Intercom Messenger now works with logged out users and visitors to your web site. Include the Intercom snippet on every page by setting:
-
-```ruby
-  config.include_for_logged_out_users = true
-```
-
 ### Messenger
 Intercom includes an in-app messenger which allows a user to read messages and start conversations.
 
@@ -258,6 +261,12 @@ You can customize the CSS selector, by setting
   config.inbox.custom_activator = '.intercom-link'
 ```
 
+You can hide default launcher button, by setting
+
+```ruby
+  config.hide_default_launcher = true
+```
+
 You can read more about configuring the messenger in your applications settings, within Intercom.
 
 ### Environments
@@ -363,6 +372,24 @@ The SHA-256 hash is available using `csp_sha256` just after generating the tag i
 <% add_entry_to_csp_whitelist(intercom_script_tag.csp_sha256) %>
 ```
 
+## Deleting your users
+If you delete a user from your system, you should also delete them from Intercom lest they still receive messages.
+
+You can do this using the [intercom-ruby](https://github.com/intercom/intercom-ruby) gem. In the example below we're using an ActiveJob to perform the delete in the background.
+
+```
+class User
+  after_destroy { DeleteFromIntercom.perform_later(self)
+end
+
+class DeleteFromIntercom < ApplicationJob
+  def perform(user)
+    intercom = Intercom::Client.new
+    intercom.users.find(email: user.email).delete
+  end
+end
+```
+
 ## Running tests/specs
 
 specs should run on a clean clone of this repo, using the following commands. (developed against ruby 2.1.2 and 1.9.3)
@@ -374,6 +401,24 @@ or
 bundle exec rspec spec/
 ```
 
+
+## Pull Requests
+
+- **Add tests!** Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour**. Make sure the README and any other
+  relevant documentation are kept up-to-date.
+
+- **Create topic branches**. Don't ask us to pull from your master branch.
+
+- **One pull request per feature**. If you want to do more than one thing, send
+  multiple pull requests.
+
+- **Send coherent history**. Make sure each individual commit in your pull
+  request is meaningful. If you had to make multiple intermediate commits while
+  developing, please squash them before sending them to us.
+  
+
 ## Contributors
 
 - Dr Nic Williams (@drnic) - provided a rails generator for adding the Intercom javascript tag into your layout.

data/lib/intercom-rails/auto_include_filter.rb

@@ -32,7 +32,9 @@ module IntercomRails
       end
 
       def include_javascript!
-        response.body = response.body.gsub(CLOSING_BODY_TAG, intercom_script_tag.to_s + '\\0')
+        split = response.body.split("</body>")
+        response.body = split.first + intercom_script_tag.to_s + "</body>"
+        response.body = response.body + split.last if split.size > 1
       end
 
       def include_javascript?

data/lib/intercom-rails/config.rb

@@ -21,13 +21,7 @@ module IntercomRails
 
     def self.config_writer(name, &block)
       meta_class.send(:define_method, "#{name}=") do |value|
-        block.call(value) if block && (block.arity <= 1)
-
-        if block && (block.arity > 1)
-          field_name = underscored_class_name ? "#{underscored_class_name}.#{name}" : name
-          block.call(value, field_name)
-        end
-
+        validate(name, value, block)
         instance_variable_set("@#{name}", value)
       end
     end
@@ -45,6 +39,17 @@ module IntercomRails
     end
 
     private
+
+    def self.validate(name, value, block)
+      return unless block
+      args = [value]
+      if block.arity > 1
+        field_name = underscored_class_name ? "#{underscored_class_name}.#{name}" : name
+        args << field_name
+      end
+      block.call(*args)
+    end
+
     def self.underscored_class_name
       @underscored_class_name
     end
@@ -54,9 +59,14 @@ module IntercomRails
   class Config < ConfigSingleton
 
     CUSTOM_DATA_VALIDATOR = Proc.new do |custom_data, field_name|
-      raise ArgumentError, "#{field_name} custom_data should be a hash" unless custom_data.kind_of?(Hash)
-      unless custom_data.values.all? { |value| value.kind_of?(Proc) || value.kind_of?(Symbol) }
-        raise ArgumentError, "all custom_data attributes should be either a Proc or a symbol"
+      case custom_data
+      when Hash
+        unless custom_data.values.all? { |value| value.kind_of?(Proc) || value.kind_of?(Symbol) }
+          raise ArgumentError, "all custom_data attributes should be either a Proc or a symbol"
+        end
+      when Proc, Symbol
+      else
+        raise ArgumentError, "#{field_name} custom_data should be either be a hash or a Proc/Symbol that returns a hash when called"
       end
     end
 
@@ -97,6 +107,7 @@ module IntercomRails
     config_accessor :library_url
     config_accessor :enabled_environments, &ARRAY_VALIDATOR
     config_accessor :include_for_logged_out_users
+    config_accessor :hide_default_launcher
 
     def self.api_key=(*)
       warn "Setting an Intercom API key is no longer supported; remove the `config.api_key = ...` line from config/initializers/intercom.rb"
@@ -116,6 +127,7 @@ module IntercomRails
 
     config_group :company do
       config_accessor :current, &IS_PROC_VALIDATOR
+      config_accessor :exclude_if, &IS_PROC_VALIDATOR
       config_accessor :plan, &IS_PROC_VALIDATOR
       config_accessor :monthly_spend, &IS_PROC_VALIDATOR
       config_accessor :custom_data, &CUSTOM_DATA_VALIDATOR

data/lib/intercom-rails/date_helper.rb

@@ -3,6 +3,7 @@ module IntercomRails
     def self.convert_dates_to_unix_timestamps(object)
       return Hash[object.map { |k, v| [k, convert_dates_to_unix_timestamps(v)] }] if object.is_a?(Hash)
       return object.to_i if object.is_a?(Time) || object.is_a?(DateTime)
+      return object.to_time.to_i if object.is_a?(Date)
       object
     end
   end

data/lib/intercom-rails/proxy.rb

@@ -129,16 +129,19 @@ module IntercomRails
 
       def custom_data_from_config
         return {} if config.custom_data.blank?
-        config.custom_data.reduce({}) do |custom_data, (k,v)|
-          custom_data.merge(k => custom_data_value_from_proc_or_symbol(v))
-        end
-      end
-
-      def custom_data_value_from_proc_or_symbol(proc_or_symbol)
-        if proc_or_symbol.kind_of?(Symbol)
-          proxied_object.send(proc_or_symbol)
-        elsif proc_or_symbol.kind_of?(Proc)
-          proc_or_symbol.call(proxied_object)
+        custom_data_value(config.custom_data)
+      end
+
+      def custom_data_value(proc_or_symbol_or_hash)
+        case proc_or_symbol_or_hash
+        when Symbol
+          proxied_object.send(proc_or_symbol_or_hash)
+        when Proc
+          proc_or_symbol_or_hash.call(proxied_object)
+        when Hash
+          proc_or_symbol_or_hash.reduce({}) do |custom_data, (k,v)|
+            custom_data.merge(k => custom_data_value(v))
+          end
         end
       end
 

data/lib/intercom-rails/proxy/company.rb

@@ -24,6 +24,8 @@ module IntercomRails
       end
 
       def valid?
+        return false if company.blank? || company.respond_to?(:new_record?) && company.new_record?
+        return false if config.company.exclude_if.present? && config.company.exclude_if.call(company)
         company.present? && identity_present?
       end
 

data/lib/intercom-rails/script_tag.rb

@@ -64,6 +64,7 @@ module IntercomRails
       hsh[:session_duration] = @session_duration if @session_duration.present?
       hsh[:widget] = widget_options if widget_options.present?
       hsh[:company] = company_details if company_details.present?
+      hsh[:hide_default_launcher] = Config.hide_default_launcher if Config.hide_default_launcher
       hsh
     end
 

data/lib/intercom-rails/version.rb

@@ -1,3 +1,3 @@
 module IntercomRails
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/lib/rails/generators/intercom/config/intercom.rb.erb

@@ -84,6 +84,11 @@ IntercomRails.config do |config|
   #
   # config.company.current = Proc.new { current_user.company }
 
+  # == Exclude company
+  # A Proc that given a company returns true if the company should be excluded
+  # from imports and Javascript inclusion, false otherwise.
+  #
+  # config.company.exclude_if = Proc.new { |app| app.subdomain == 'demo' }
 
   # == Company Custom Data
   # A hash of additional data you wish to send about a company.
@@ -119,4 +124,7 @@ IntercomRails.config do |config|
   # uncomment this line and clicks on any element that matches the query will
   # open the messenger
   # config.inbox.custom_activator = '.intercom'
+  #
+  # If you'd like to hide default launcher button uncomment this line
+  # config.hide_default_launcher = true
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Ben McRedmond
@@ -10,146 +10,146 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-28 00:00:00.000000000 Z
+date: 2016-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - '>'
       - !ruby/object:Gem::Version
         version: 3.2.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - '>'
       - !ruby/object:Gem::Version
         version: 3.2.12
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.5
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.2
+        version: 1.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.2
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Intercom (https://www.intercom.io) is a customer relationship management
@@ -163,25 +163,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.mdown
-- Rakefile
 - lib/data/cacert.pem
-- lib/intercom-rails.rb
 - lib/intercom-rails/auto_include_filter.rb
 - lib/intercom-rails/config.rb
 - lib/intercom-rails/custom_data_helper.rb
 - lib/intercom-rails/date_helper.rb
 - lib/intercom-rails/exceptions.rb
-- lib/intercom-rails/proxy.rb
 - lib/intercom-rails/proxy/company.rb
 - lib/intercom-rails/proxy/user.rb
+- lib/intercom-rails/proxy.rb
 - lib/intercom-rails/railtie.rb
 - lib/intercom-rails/script_tag.rb
 - lib/intercom-rails/script_tag_helper.rb
 - lib/intercom-rails/shutdown_helper.rb
 - lib/intercom-rails/version.rb
+- lib/intercom-rails.rb
 - lib/rails/generators/intercom/config/config_generator.rb
 - lib/rails/generators/intercom/config/intercom.rb.erb
+- Rakefile
+- README.mdown
 homepage: http://www.intercom.io
 licenses:
 - MIT
@@ -192,17 +192,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: intercom-rails
-rubygems_version: 2.5.1
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Rails helper for emitting javascript script tags for Intercom