intercom-rails 0.2.31 → 0.2.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3aece6afdf71811d91c2971e43834534012c2dc0
-  data.tar.gz: ee3a90363e1fe29bd1392cb8fa8942c535279655
+  metadata.gz: 03b50b1d5b763f0ef0a553e7d72d8daa1a3cd412
+  data.tar.gz: 4aacec38fd8a8696f56ee130487b9519959ea946
 SHA512:
-  metadata.gz: 16b271674d1d3cd029e603e5855bb9b901edb3e4a61bfc353f3951ea4f3454c3e2484bedfeec79b324da07db2c471d21c41f10091cb0b3ce805fe3d00c553ed4
-  data.tar.gz: 32818a64edc5805d05621e8ed6e0969cfc8862ffcb417bca5c8e46df5db8139790fd3d51b11b1fb21bc74f0dfbd430fc5d983ba2be1b95b883b628dfdf179c4b
+  metadata.gz: 5d80bc1ade277f6ea62376c67abd0185c30e9730fe2ba19b3132afb193229c3cbda4128e5d51566fa0a2a8adcdc0da975444651b52851f9717ce7ed313e7e728
+  data.tar.gz: 1a7bb15f5946f704f24a33007eda1dc19757bc78b7389c99c0f51dcb80665a73ab57f7717a5e8703338373ddfff783dd11363a12cd739623cdf659353b6237bf

data/README.mdown

@@ -1,5 +1,7 @@
 # IntercomRails
 
+[![Join the chat at https://gitter.im/intercom/intercom-rails](https://badges.gitter.im/intercom/intercom-rails.svg)](https://gitter.im/intercom/intercom-rails?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 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)
@@ -54,8 +56,44 @@ If you want to use secure mode, ensure you set your API secret in `config/initia
 ```ruby
   config.api_secret = '123456'
 ```
+**Note: This example is just for the sake of simplicity, you should never include your api 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 Acquire combined with another product like Support, Learn or Engage, 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).
+
+#### Using Devise
+
+If your Rails application uses devise for authentication, you simply need to add the following line in your "config/initializers/session_store.rb" :
+
+```ruby
+  Rails.application.config.session_store :cookie_store, key: 'intercom-session-' + IntercomRails.config.app_id
+```
+
+You should not modify or remove existing configurations in this file.
+
+#### Using another service
+
+If you use another service than Devise or if you implemented your own authentication service, you can call the following method in a controller to shutdown Intercom on logout (self being the controller instance).
+**Be aware that if you call this method before a 'redirect_to' (quite common on logout) it will have no impact** as it is impossible to update cookies when you use a redirection.
+
+```ruby
+IntercomRails::ShutdownHelper::intercom_shutdown_helper(self)
+```
+
+#### Session Duration
+
+To add a `session_duration` variable (in ms) to the widget, add the following line to `config/initializers/intercom.rb`:
+
+```ruby
+config.session_duration = 5 * 60 * 1000
+```
+That will force your Intercom session to expire after 5 minutes which is the minimum amount of time authorized.
+
+More information about how session_duration works in [intercom documentation](https://docs.intercom.io/configuring-for-your-product-or-site/customizing-the-intercom-messenger#secure-user-conversations-configure-your-cookie-timeout)
 
 ### User Custom data attributes
+
 You can associate any attributes, specific to your app, with a user in Intercom.
 For custom data attributes you want updated on every request set them in `config/initializers/intercom.rb`, the latest value will be sent to Intercom on each page visit.
 
@@ -106,6 +144,10 @@ Basic usage is as follows - in `config/initializers/intercom.rb`
 config.company.current = Proc.new { current_company }
 ```
 
+`current_company` is the method/variable that contains the user's current company in your controllers.
+If you are using devise you should replace `current_company` with `current_user.company` in the above code and every time you see 'current_company' in your configuration file.
+This will result in injecting the user current company in the widget settings.
+
 and like with Users, you can set custom attribute on companies too:
 
 ```ruby
@@ -247,14 +289,6 @@ The SHA-256 hash is available using `csp_sha256` just after generating the tag i
 <%= intercom_script_tag %>
 <% add_entry_to_csp_whitelist(intercom_script_tag.csp_sha256) %>
 ```
-## Importing your users
-To get started faster with Intercom, `IntercomRails` includes a Rake task that will do an initial import of your users:
-
-```
-rake intercom:import
-```
-
-Any custom data defined in `config/initializers/intercom.rb` will also be sent.
 
 ## Running tests/specs
 

data/lib/intercom-rails.rb

@@ -6,6 +6,7 @@ require 'intercom-rails/proxy/company'
 require 'intercom-rails/script_tag'
 require 'intercom-rails/script_tag_helper'
 require 'intercom-rails/custom_data_helper'
+require 'intercom-rails/shutdown_helper'
 require 'intercom-rails/auto_include_filter'
 require 'intercom-rails/config'
 require 'intercom-rails/import'

data/lib/intercom-rails/config.rb

@@ -80,6 +80,7 @@ module IntercomRails
     end
 
     config_accessor :app_id
+    config_accessor :session_duration
     config_accessor :api_secret
     config_accessor :api_key
     config_accessor :library_url

data/lib/intercom-rails/script_tag.rb

@@ -9,7 +9,7 @@ module IntercomRails
 
     include ::ActionView::Helpers::JavaScriptHelper
 
-    attr_reader :user_details, :company_details, :show_everywhere
+    attr_reader :user_details, :company_details, :show_everywhere, :session_duration
     attr_accessor :secret, :widget_options, :controller, :nonce
 
     def initialize(options = {})
@@ -17,6 +17,7 @@ module IntercomRails
       self.widget_options = widget_options_from_config.merge(options[:widget] || {})
       self.controller = options[:controller]
       @show_everywhere = options[:show_everywhere]
+      @session_duration = session_duration_from_config
       self.user_details = options[:find_current_user_details] ? find_current_user_details : options[:user_details]
       self.company_details = if options[:find_current_company_details]
         find_current_company_details
@@ -56,6 +57,7 @@ module IntercomRails
 
     def intercom_settings
       hsh = user_details
+      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
@@ -121,6 +123,17 @@ module IntercomRails
       OpenSSL::HMAC.hexdigest("sha256", secret, (user_details[:user_id] || user_details[:email]).to_s)
     end
 
+    def session_duration_from_config
+      session_duration = IntercomRails.config.session_duration
+      if session_duration && valid_session_duration?(session_duration)
+        session_duration
+      end
+    end
+
+    def valid_session_duration?(session_duration)
+      session_duration.is_a?(Integer) && session_duration > 0
+    end
+
     def app_id
       return user_details[:app_id] if user_details[:app_id].present?
       return IntercomRails.config.app_id if IntercomRails.config.app_id.present?

data/lib/intercom-rails/shutdown_helper.rb

@@ -0,0 +1,11 @@
+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 (controller)
+      controller.response.delete_cookie("intercom-session-#{IntercomRails.config.app_id}")
+    end
+  end
+end

data/lib/intercom-rails/version.rb

@@ -1,3 +1,3 @@
 module IntercomRails
-  VERSION = "0.2.31"
+  VERSION = "0.2.33"
 end

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

@@ -9,12 +9,14 @@ module Intercom
       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_key, :desc => "An Intercom API key, for various rake tasks", :optional => true
+      argument :session_duration, :desc => "user session duration, this should match your app", :optional => true
 
       FALSEY_RESPONSES = ['n', 'no']
       def create_config_file
         @app_id = app_id
         @api_secret = api_secret
         @api_key = api_key
+        @session_duration = session_duration
         @include_for_logged_out_users = false
 
         introduction = <<-desc

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

@@ -3,6 +3,10 @@ IntercomRails.config do |config|
   #
   config.app_id = ENV["INTERCOM_APP_ID"] || "<%= @app_id %>"
 
+  # == Intercom session_duration
+  #
+  config.session_duration = <%= @session_duration %>
+
   # == Intercom secret key
   # This is required to enable secure mode, you can find it on your Setup
   # guide in the "Secure Mode" step.
@@ -71,6 +75,7 @@ IntercomRails.config do |config|
   # == User -> Company association
   # A Proc that given a user returns an array of companies
   # that the user belongs to.
+  # This is only used for importing users using rake command but it will not inject a list of companies in the intercom widget
   #
   # config.user.company_association = Proc.new { |user| user.companies.to_a }
   # config.user.company_association = Proc.new { |user| [user.company] }
@@ -81,6 +86,11 @@ IntercomRails.config do |config|
   # could be a company, app or group.
   #
   # config.company.current = Proc.new { current_company }
+  #
+  # Or if you are using devise you can just use the following config
+  #
+  # config.company.current = Proc.new { current_user.company }
+
 
   # == Company Custom Data
   # A hash of additional data you wish to send about a company.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.31
+  version: 0.2.33
 platform: ruby
 authors:
 - Ben McRedmond
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2016-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -180,11 +180,13 @@ files:
 - 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/rails/generators/intercom/config/config_generator.rb
 - lib/rails/generators/intercom/config/intercom.rb.erb
 homepage: http://www.intercom.io
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -202,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: intercom-rails
-rubygems_version: 2.5.0
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Rails helper for emitting javascript script tags for Intercom