intercom-rails 0.3.5 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90db5a172849d4e46208b7e4945becc12bda59a0
-  data.tar.gz: 5f6a61ef04bb2a4a55c21aee3959f79453b5b1ab
+  metadata.gz: 2c8c86341c15d5e3d7620a1a737c2a2eb62744b3
+  data.tar.gz: bccf57bc964ba2aa3daa7dee8b7e569e21d28d4f
 SHA512:
-  metadata.gz: 29c9e1b05d138b9d666948e9209fe049758abe7244147605c31d6d644c615d5b96c74b6ea6a5d6fd7d2efc9484dce4dae481251470b8d5af28437b2e0fdc6328
-  data.tar.gz: b7ecd91c086b837ebdf2c3bbd3264f7fdfd4de5a8ecb59af7c3010bfe2a0f55c185b7b788eae1e9c19aadcd9e9d5cb559fac6f43990ebc175d7a2095efbbfda0
+  metadata.gz: 923ca98ea86eee4d13dbfc68691f706883fe08929e6d147888522e2aa1f93f95f6720e5ce033671e29531d4811fff9e13a73ec6bc7c26f23f805b085d3617f63
+  data.tar.gz: 396f0c39720971cd3afc59869e015c076cc4ba5e608b41069a0406902ad70e9b70c784a7f41ee7983739e04feaca4d619a832d8f1b2c9d704c5fb5ee7b14a747

data/README.md

@@ -4,6 +4,8 @@ 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  >= 4.0`
+
 ## Installation
 Add this to your Gemfile:
 
@@ -26,7 +28,7 @@ rails generate intercom:config YOUR-APP-ID
 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 
+### Live Chat
 With the Intercom Messenger you can [chat](https://www.intercom.com/live-chat) with users and visitors to your web site. Include the Intercom Messenger on every page by setting:
 ```ruby
   config.include_for_logged_out_users = true
@@ -60,7 +62,7 @@ Feel free to mail us: team@intercom.io, if you're still having trouble.
 ## Configuration
 
 ### API Secret
-If you want to use secure mode, ensure you set your API secret in `config/initializers/intercom.rb`:
+If you want to use Identity Verification, ensure you set your API secret in `config/initializers/intercom.rb`:
 
 ```ruby
   config.api_secret = '123456'
@@ -384,7 +386,8 @@ end
 class DeleteFromIntercom < ApplicationJob
   def perform(user)
     intercom = Intercom::Client.new
-    intercom.users.find(email: user.email).delete
+    user = intercom.users.find(id: user.id)
+    deleted_user = intercom.users.delete(user)
   end
 end
 ```
@@ -416,7 +419,7 @@ bundle exec rspec spec/
 - **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
 

data/lib/intercom-rails.rb

@@ -3,6 +3,7 @@ require 'intercom-rails/date_helper'
 require 'intercom-rails/proxy'
 require 'intercom-rails/proxy/user'
 require 'intercom-rails/proxy/company'
+require 'intercom-rails/encrypted_mode'
 require 'intercom-rails/script_tag'
 require 'intercom-rails/script_tag_helper'
 require 'intercom-rails/custom_data_helper'

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 :encrypted_mode
 
     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"

data/lib/intercom-rails/encrypted_mode.rb

@@ -0,0 +1,34 @@
+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]
+
+    def initialize(secret, initialization_vector, options)
+      @secret = secret
+      @initialization_vector = initialization_vector || SecureRandom.random_bytes(12)
+      @enabled = options.fetch(:enabled, false)
+    end
+
+    def plaintext_part(settings)
+      enabled ? settings.slice(*ENCRYPTED_MODE_SETTINGS_WHITELIST) : settings
+    end
+
+    def encrypted_javascript(payload)
+      enabled ? "window.intercomEncryptedPayload = \"#{encrypt(payload)}\";" : ""
+    end
+
+    def encrypt(payload)
+      return nil unless enabled
+      payload = payload.except(*ENCRYPTED_MODE_SETTINGS_WHITELIST)
+      key = Digest::SHA256.digest(secret)
+      cipher = OpenSSL::Cipher.new('aes-256-gcm')
+      cipher.encrypt
+      cipher.key = key
+      cipher.iv = initialization_vector
+      json = ActiveSupport::JSON.encode(payload).gsub('<', '\u003C')
+      encrypted = initialization_vector + cipher.update(json) + cipher.final + cipher.auth_tag
+      Base64.encode64(encrypted).gsub("\n", "\\n")
+    end
+  end
+end

data/lib/intercom-rails/script_tag.rb

@@ -10,7 +10,7 @@ module IntercomRails
     include ::ActionView::Helpers::JavaScriptHelper
 
     attr_reader :user_details, :company_details, :show_everywhere, :session_duration
-    attr_accessor :secret, :widget_options, :controller, :nonce
+    attr_accessor :secret, :widget_options, :controller, :nonce, :encrypted_mode_enabled, :encrypted_mode
 
     def initialize(options = {})
       self.secret = options[:secret] || Config.api_secret
@@ -20,6 +20,9 @@ module IntercomRails
       @session_duration = session_duration_from_config
       self.user_details = options[:find_current_user_details] ? find_current_user_details : options[:user_details]
 
+      self.encrypted_mode_enabled = options[:encrypted_mode] || Config.encrypted_mode
+      self.encrypted_mode = IntercomRails::EncryptedMode.new(secret, options[:initialization_vector], {:enabled => encrypted_mode_enabled})
+
       # Request specific custom data for non-signed up users base on lead_attributes
       self.user_details = self.user_details.merge(find_lead_attributes)
 
@@ -94,11 +97,21 @@ module IntercomRails
       custom_data.select {|k, v| lead_attributes.map(&:to_s).include?(k)}
     end
 
+    def plaintext_settings
+      encrypted_mode.plaintext_part(intercom_settings)
+    end
+
+    def encrypted_settings
+      encrypted_mode.encrypt(intercom_settings)
+    end
+
     private
+
     def intercom_javascript
-      intercom_settings_json = ActiveSupport::JSON.encode(intercom_settings).gsub('<', '\u003C')
+      plaintext_javascript = ActiveSupport::JSON.encode(plaintext_settings).gsub('<', '\u003C')
+      intercom_encrypted_payload_javascript = encrypted_mode.encrypted_javascript(intercom_settings)
 
-      str = "window.intercomSettings = #{intercom_settings_json};(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);}};})()"
 
       str
     end

data/lib/intercom-rails/script_tag_helper.rb

@@ -5,14 +5,14 @@ module IntercomRails
     # Generate an intercom script tag.
     #
     # @param user_details [Hash] a customizable hash of user details
-    # @param options [Hash] an optional hash for secure mode and widget customisation
+    # @param options [Hash] an optional hash for Identity Verification and widget customization
     # @option user_details [String] :app_id Your application id
     # @option user_details [String] :user_id unique id of this user within your application
     # @option user_details [String] :email email address for this user
     # @option user_details [String] :name the users name, _optional_ but useful for identify people in the Intercom App.
     # @option user_details [Hash] :custom_data custom attributes you'd like saved for this user on Intercom.
     # @option options [String] :widget a hash containing a css selector for an element which when clicked should show the Intercom widget
-    # @option options [String] :secret Your app secret for secure mode
+    # @option options [String] :secret Your app secret for Identity Verification
     # @option options [String] :nonce a nonce generated by your CSP framework to be included inside the javascript tag
     # @return [String] Intercom script tag
     # @example basic example

data/lib/intercom-rails/shutdown_helper.rb

@@ -2,7 +2,6 @@ module IntercomRails
   module ShutdownHelper
     # This helper allows to erase cookies when a user log out of an application
     # It is recommanded to call this function every time a user log out of your application
-    # specifically if you use both "Acquire" and another Intercom product
     # Do not use before a redirect_to because it will not clear the cookies on a redirection
     def self.intercom_shutdown_helper(cookies)
       if (cookies.is_a?(ActionDispatch::Cookies::CookieJar))

data/lib/intercom-rails/version.rb

@@ -1,3 +1,3 @@
 module IntercomRails
-  VERSION = "0.3.5"
+  VERSION = "0.3.8"
 end

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

@@ -7,7 +7,7 @@ module Intercom
       end
 
       argument :app_id, :desc => "Your Intercom app-id, which can be found here: https://app.intercom.io/apps/api_keys"
-      argument :api_secret, :desc => "Your Intercom api-secret, used for secure mode", :optional => true
+      argument :api_secret, :desc => "Your Intercom api-secret, used for Identity Verification", :optional => true
       argument :session_duration, :desc => "user session duration, this should match your app", :optional => true
 
       FALSEY_RESPONSES = ['n', 'no']

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

@@ -11,8 +11,8 @@ IntercomRails.config do |config|
   # config.session_duration = 300000
   <%- end -%>
   # == Intercom secret key
-  # This is required to enable secure mode, you can find it on your Setup
-  # guide in the "Secure Mode" step.
+  # This is required to enable Identity Verification, you can find it on your Setup
+  # guide in the "Identity Verification" step.
   #
   <%- if @api_secret -%>
   config.api_secret = "<%= @api_secret %>"
@@ -38,7 +38,7 @@ IntercomRails.config do |config|
 
   # == Include for logged out Users
   # If set to true, include the Intercom messenger on all pages, regardless of whether
-  # The user model class (set below) is present. Only available for Apps on the Acquire plan.
+  # The user model class (set below) is present.
   <%- if @include_for_logged_out_users -%>
   config.include_for_logged_out_users = true
   <%- else -%>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.8
 platform: ruby
 authors:
 - Ben McRedmond
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-12 00:00:00.000000000 Z
+date: 2018-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -171,6 +171,7 @@ files:
 - lib/intercom-rails/config.rb
 - lib/intercom-rails/custom_data_helper.rb
 - lib/intercom-rails/date_helper.rb
+- lib/intercom-rails/encrypted_mode.rb
 - lib/intercom-rails/exceptions.rb
 - lib/intercom-rails/proxy.rb
 - lib/intercom-rails/proxy/company.rb
@@ -202,9 +203,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: intercom-rails
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rails helper for emitting javascript script tags for Intercom
 test_files: []
-has_rdoc: