intercom-rails 0.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff3876d40d57f39f1867e5a85924bb95b37881f0f412f55d62b6aaafdd4bd137
-  data.tar.gz: 57411d70e56d4aca7ec19c8e99f891527819c8d878ca8354de7d9750f8b48bae
+  metadata.gz: 5dee175c5039fa80194ff69042d5de615a7a801351da87b5c7459e2504f58e05
+  data.tar.gz: ccbaed8ae280936a62c3c1b3ca90f907b71e67b18b0e3e5f6aa2bcf4e7f11f05
 SHA512:
-  metadata.gz: 3baa59dfce787f287e1442da9cbc63d9d564e720cf445a930dfe7c1351cfd5982b46184af342e51454a034910e6966487b7c0029db495e3018bb63c2ddba25bb
-  data.tar.gz: f2f35de9546ef409652ef7956161eb05ad5798c23808b8320764e49519648c5f0aa0b01ee276efc98f2f0982bd0e5dfc3036910d4b97c574ff2a7f8900904d08
+  metadata.gz: 1bb0fd7b74175353525d1feb105b69be217620b831d17c639aa8666bfd03249ac25a57542be9419294a71ee54990d89af73473952d5fc24fd6b4e25caae83ead
+  data.tar.gz: eccb8b923bba00629e59784e8ff76f7fd4d8489568d9e3c2d199e30bf9e6e5c1493d4a35d095299dfcca7d3af107df08396aac7cd1e0caae28ba0e1e6e6d092c

data/README.md

@@ -4,7 +4,7 @@ The easiest way to install Intercom in a rails app.
 
 For interacting with the Intercom REST API, use the `intercom` gem (https://github.com/intercom/intercom-ruby)
 
-Requires ruby 2.0 or higher for `intercom-rails  >= 0.4.0`
+Requires Ruby 2.0 or higher.
 
 ## Installation
 Add this to your Gemfile:
@@ -19,7 +19,7 @@ Then run:
 bundle install
 ```
 
-Take note of your `app_id` from [here](https://app.intercom.io/a/apps/_/settings/api-keys) and generate a config file:
+Take note of your `app_id` from [here](https://app.intercom.com/a/apps/_/settings/web) and generate a config file:
 
 ```
 rails generate intercom:config YOUR-APP-ID
@@ -43,7 +43,7 @@ To disable automatic insertion for a particular controller or action you can:
 ```
 
 ### Troubleshooting
-If it's not working make sure:
+If things are not working make sure that:
 
 * You've generated a config file with your `app_id` as detailed above.
 * Your user object responds to an `id` or `email` method.
@@ -51,18 +51,18 @@ If it's not working make sure:
 ```ruby
   config.user.current = Proc.new { current_user_object }
 ```
-If your users can be defined in different ways in your app you can also pass an array as follows :
+If your users can be defined in different ways in your app you can also pass an array as follows:
 ```ruby
   config.user.current = [Proc.new { current_user_object }, Proc.new { @user_object }]
 ```
-* If you want the Intercom Messenger to be available when there is no current user,  set `config.include_for_logged_out_users = true` in your config and sign up for the [Inbox](https://www.intercom.io/live-chat) package.
+* If you want the Intercom Messenger to be available when there is no current user,  set `config.include_for_logged_out_users = true` in your config.
 
-Feel free to mail us: team@intercom.io, if you're still having trouble.
+Feel free to mail us: team@intercom.io, if you're still having trouble and we'll work with you to get you sorted.
 
 ## Configuration
 
 ### API Secret
-It is possible to enable Identity Verification for the Intercom Messenger and you can find the documentation in how to [here](https://developers.intercom.com/docs/enable-secure-mode-on-your-web-product). If you want to use this feature, ensure you set your Identity Verification Secret as the API secret in `config/initializers/intercom.rb`:
+It is possible to enable Identity Verification for the Intercom Messenger and you can find the documentation in how to do it [here](https://developers.intercom.com/docs/enable-secure-mode-on-your-web-product). We strongly encourage doing this as it makes your installation more secure! If you want to use this feature, ensure you set your Identity Verification Secret as the API secret in `config/initializers/intercom.rb`:
 
 ```ruby
   config.api_secret = '123456'
@@ -70,19 +70,17 @@ It is possible to enable Identity Verification for the Intercom Messenger and yo
 **Note: This example is just for the sake of simplicity, you should never include this secret in source control. Instead, you should use the Rails [secret config](http://guides.rubyonrails.org/4_1_release_notes.html#config-secrets-yml) feature.**
 
 ### Shutdown
-
-If you use Intercom Inbox combined with another product like Messages, any user that uses a shared computer and browser with someone else will be able to see the most recently logged in user’s conversation history until the cookie expires.
-Because of this, it’s very important to properly shutdown Intercom when a user’s session on your app ends (via manually or automatically logging out).
+We make use of first-party cookies so that we can identify your users the next time they open your messenger. When people share devices with someone else, they might be able to see the most recently logged in user’s conversation history until the cookie expires. Because of this, it’s very important to properly shutdown Intercom when a user’s session on your app ends (either manually or due to an automated logout).
 
 #### Using Devise
 
-If you use devise, you can override (if not already done) the session_controller by replacing in your `config/routes.rb` file :
+If you use devise, you can override (if not already done) the session_controller by replacing in your `config/routes.rb` file:
 ```ruby
 devise_for :users
 ```
-by
+with
 ```ruby
-devise_for :users, controllers: {sessions: "sessions"}
+devise_for :users, controllers: { sessions: "sessions" }
 ```
 
 Then you can use the following code to prepare Intercom Shutdown on log out in your `app/session_controller.rb`
@@ -242,6 +240,23 @@ config.company.custom_data = {
 }
 ```
 
+In some situations you'll want to set some custom company data attribute specific to a request.
+You can do this similarly to user data attribute set by using the `intercom_custom_data` helper available in your controllers:
+
+```ruby
+class AppsController < ActionController::Base
+  def activate
+    intercom_custom_data.company[:app_activated_at] = Time.now
+    ...
+  end
+
+  def destroy
+    intercom_custom_data.company[:app_deleted_at] = Time.now
+    ...
+  end
+end
+```
+
 ### Messenger
 Intercom includes an in-app messenger which allows a user to read messages and start conversations.
 
@@ -381,10 +396,10 @@ You can do this using the [intercom-ruby](https://github.com/intercom/intercom-r
 
 ```
 class User
-  after_destroy { DeleteFromIntercom.perform_later(self)
+  after_destroy { DeleteFromIntercomJob.perform_later(self) }
 end
 
-class DeleteFromIntercom < ApplicationJob
+class DeleteFromIntercomJob < ApplicationJob
   def perform(user)
     intercom = Intercom::Client.new
     user = intercom.users.find(id: user.id)
@@ -433,4 +448,4 @@ intercom-rails is released under the [MIT License](http://www.opensource.org/lic
 
 ## Copyright
 
-Copyright (c) 2011-2012 Intercom, Inc.  All rights reserved.
+Copyright (c) 2011-2020 Intercom, Inc.  All rights reserved.

data/lib/intercom-rails/auto_include_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module IntercomRails
 
   module AutoInclude
@@ -8,12 +10,11 @@ module IntercomRails
     end
 
     class Filter
-
-      CLOSING_BODY_TAG = %r{</body>}
-      BLACKLISTED_CONTROLLER_NAMES = ["Devise::PasswordsController"]
+      CLOSING_BODY_TAG = "</body>"
+      BLOCKED_CONTROLLER_NAMES = %w{ Devise::PasswordsController }
 
       def self.filter(controller)
-        return if BLACKLISTED_CONTROLLER_NAMES.include?(controller.class.name)
+        return if BLOCKED_CONTROLLER_NAMES.include?(controller.class.name)
         auto_include_filter = new(controller)
         return unless auto_include_filter.include_javascript?
 
@@ -32,9 +33,7 @@ module IntercomRails
       end
 
       def include_javascript!
-        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
+        response.body = response.body.insert(response.body.rindex(CLOSING_BODY_TAG), intercom_script_tag.to_s)
       end
 
       def include_javascript?
@@ -63,7 +62,7 @@ module IntercomRails
       end
 
       def response_has_closing_body_tag?
-        !!(response.body[CLOSING_BODY_TAG])
+        response.body.include? CLOSING_BODY_TAG
       end
 
       def intercom_script_tag_called_manually?
@@ -83,7 +82,7 @@ module IntercomRails
           nonce = CoreExtensions::IntercomRails::AutoInclude.csp_nonce_hook(controller)
           options.merge!(:nonce => nonce)
         end
-        @script_tag = ScriptTag.new(options)
+        @script_tag ||= ScriptTag.new(options)
       end
 
       def show_everywhere?

data/lib/intercom-rails/config.rb

@@ -108,6 +108,7 @@ module IntercomRails
     config_accessor :enabled_environments, &ARRAY_VALIDATOR
     config_accessor :include_for_logged_out_users
     config_accessor :hide_default_launcher
+    config_accessor :api_base
     config_accessor :encrypted_mode
 
     def self.api_key=(*)

data/lib/intercom-rails/custom_data_helper.rb

@@ -1,6 +1,7 @@
 module IntercomRails
 
   module CustomDataHelper
+    STORE = Struct.new(:user, :company)
 
     # This helper allows custom data attributes to be added to a user
     # for the current request from within the controller. e.g.
@@ -10,12 +11,7 @@ module IntercomRails
     #   ...
     # end
     def intercom_custom_data
-      @_request_specific_intercom_custom_data ||= begin
-        s = Struct.new(:user, :company).new
-        s.user = {}
-        s.company = {}
-        s
-      end
+      @_request_specific_intercom_custom_data ||= STORE.new({}, {})
     end
 
   end

data/lib/intercom-rails/encrypted_mode.rb

@@ -2,7 +2,7 @@ module IntercomRails
   class EncryptedMode
     attr_reader :secret, :initialization_vector, :enabled
 
-    ENCRYPTED_MODE_SETTINGS_WHITELIST = [:app_id, :session_duration, :widget, :custom_launcher_selector, :hide_default_launcher, :alignment, :horizontal_padding, :vertical_padding]
+    ENCRYPTED_MODE_SETTINGS_WHITELIST = [:app_id, :session_duration, :widget, :custom_launcher_selector, :hide_default_launcher, :api_base, :alignment, :horizontal_padding, :vertical_padding]
 
     def initialize(secret, initialization_vector, options)
       @secret = secret

data/lib/intercom-rails/script_tag.rb

@@ -1,13 +1,20 @@
-require 'active_support/json'
-require 'active_support/core_ext/hash/indifferent_access'
-require 'active_support/core_ext/string/output_safety'
+# frozen_string_literal: true
+
+require 'active_support/all'
 require 'action_view'
 
 module IntercomRails
 
   class ScriptTag
+    # Base64 regexp:
+    # - blocks of 4 [A-Za-z0-9+/]
+    # followed either by:
+    # - blocks of 2 [A-Za-z0-9+/] + '=='
+    # - blocks of 3 [A-Za-z0-9+/] + '='
+    NONCE_RE = %r{^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$}
 
     include ::ActionView::Helpers::JavaScriptHelper
+    include ::ActionView::Helpers::TagHelper
 
     attr_reader :user_details, :company_details, :show_everywhere, :session_duration
     attr_accessor :secret, :widget_options, :controller, :nonce, :encrypted_mode_enabled, :encrypted_mode
@@ -46,21 +53,14 @@ module IntercomRails
       valid
     end
 
-    def valid_nonce?
-      valid = false
-      if nonce
-        # Base64 regexp:
-        # - blocks of 4 [A-Za-z0-9+/]
-        # followed either by:
-        # - blocks of 2 [A-Za-z0-9+/] + '=='
-        # - blocks of 3 [A-Za-z0-9+/] + '='
-        base64_regexp = Regexp.new('^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$')
-        m = base64_regexp.match(nonce)
-        if nonce == m.to_s
-          valid = true
-        end
+    if //.respond_to?(:match?)
+      def valid_nonce?
+        nonce && NONCE_RE.match?(nonce)
+      end
+    else
+      def valid_nonce?
+        nonce && !!NONCE_RE.match(nonce)
       end
-      valid
     end
 
     def intercom_settings
@@ -69,16 +69,15 @@ module IntercomRails
       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[:api_base] = Config.api_base if Config.api_base
+      hsh[:installation_type] = 'rails'
       hsh
     end
 
     def to_s
-      js_options = 'id="IntercomSettingsScriptTag"'
-      if nonce && valid_nonce?
-        js_options = js_options + " nonce=\"#{nonce}\""
-      end
-      str = "<script #{js_options}>#{intercom_javascript}</script>\n"
-      str.respond_to?(:html_safe) ? str.html_safe : str
+      html_options = { id: 'IntercomSettingsScriptTag' }
+      html_options['nonce'] = nonce if valid_nonce?
+      javascript_tag(intercom_javascript, html_options) + "\n"
     end
 
     def csp_sha256
@@ -111,9 +110,7 @@ module IntercomRails
       plaintext_javascript = ActiveSupport::JSON.encode(plaintext_settings).gsub('<', '\u003C')
       intercom_encrypted_payload_javascript = encrypted_mode.encrypted_javascript(intercom_settings)
 
-      str = "window.intercomSettings = #{plaintext_javascript};#{intercom_encrypted_payload_javascript}(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='#{Config.library_url || "https://widget.intercom.io/widget/#{j 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);}};})()"
-
-      str
+      "window.intercomSettings = #{plaintext_javascript};#{intercom_encrypted_payload_javascript}(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='#{Config.library_url || "https://widget.intercom.io/widget/#{j 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);}};})()"
     end
 
     def user_details=(user_details)

data/lib/intercom-rails/version.rb

@@ -1,3 +1,3 @@
 module IntercomRails
-  VERSION = "0.4.1"
+  VERSION = "1.0.0"
 end

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

@@ -127,4 +127,8 @@ IntercomRails.config do |config|
   #
   # If you'd like to hide default launcher button uncomment this line
   # config.hide_default_launcher = true
+  #
+  # If you need to route your Messenger requests through a different endpoint than the default, uncomment the below line. Generally speaking, this is not needed.
+  # config.api_base = "https://#{config.app_id}.intercom-messenger.com"
+  #
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: intercom-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Ben McRedmond
 - Ciaran Lee
 - Darragh Curran
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-06 00:00:00.000000000 Z
+date: 2024-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -46,42 +46,42 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 3.2.12
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 3.2.12
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -102,14 +102,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.5
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.5
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +124,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
@@ -187,7 +201,7 @@ homepage: http://www.intercom.io
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -202,9 +216,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: intercom-rails
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Rails helper for emitting javascript script tags for Intercom
 test_files: []