intercom-rails 0.2.33 → 0.2.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03b50b1d5b763f0ef0a553e7d72d8daa1a3cd412
-  data.tar.gz: 4aacec38fd8a8696f56ee130487b9519959ea946
+  metadata.gz: bf8138e7cf9f1c997403f95a28146cdac9404b2d
+  data.tar.gz: 9c551fd51c30b8416ade93d958f5e4577f96f38f
 SHA512:
-  metadata.gz: 5d80bc1ade277f6ea62376c67abd0185c30e9730fe2ba19b3132afb193229c3cbda4128e5d51566fa0a2a8adcdc0da975444651b52851f9717ce7ed313e7e728
-  data.tar.gz: 1a7bb15f5946f704f24a33007eda1dc19757bc78b7389c99c0f51dcb80665a73ab57f7717a5e8703338373ddfff783dd11363a12cd739623cdf659353b6237bf
+  metadata.gz: f03ac8ed8936cfcaac4e0c373c3e0a2a8840efddba212c7cde24fa8436707f9b07de6ff1ef4cee5e899179ef51ab41265a5d3a44e66b5a371b565ffd697ea633
+  data.tar.gz: 99d4081d4157c022428e1509a5130d86c8eb25e69946451f66d740284609c8fc3991bc6e70e3e9b5da346bc2ae5ff11c470e44eba919c7bd0d3861dc55051fcd

data/README.mdown

@@ -44,6 +44,10 @@ 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 :
+```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 [Acquire](https://www.intercom.io/live-chat) package.
 
 Feel free to mail us: team@intercom.io, if you're still having trouble.
@@ -64,23 +68,62 @@ Because of this, it’s very important to properly shutdown Intercom when a user
 
 #### 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" :
+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
+```ruby
+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`
 
 ```ruby
-  Rails.application.config.session_store :cookie_store, key: 'intercom-session-' + IntercomRails.config.app_id
+class SessionsController < Devise::SessionsController
+
+  after_action :prepare_intercom_shutdown, only: [:destroy]
+
+  # Your logic here
+
+  protected
+  def prepare_intercom_shutdown
+    IntercomRails::ShutdownHelper.prepare_intercom_shutdown(session)
+  end
+end
 ```
 
-You should not modify or remove existing configurations in this file.
+Assuming that the `destroy` method of session_controller redirects to your `visitors_controller.rb#index` method, edit your `visitors_controller` as follow :
+
+
+```ruby
+class VisitorsController < ApplicationController
+  after_action :intercom_shutdown, only: [:index]
+
+  def index
+    # You logic here
+  end
+
+  # You logic here
+
+  protected
+  def intercom_shutdown
+    IntercomRails::ShutdownHelper.intercom_shutdown(session, cookies)
+  end
+end
+```
 
 #### 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.
+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.
 
 ```ruby
-IntercomRails::ShutdownHelper::intercom_shutdown_helper(self)
+IntercomRails::ShutdownHelper::intercom_shutdown_helper(cookies)
 ```
 
+**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.
+But you can use the same logic as the `devise` implementation above.
+
 #### Session Duration
 
 To add a `session_duration` variable (in ms) to the widget, add the following line to `config/initializers/intercom.rb`:

data/lib/intercom-rails/config.rb

@@ -68,6 +68,18 @@ module IntercomRails
       raise ArgumentError, "#{field_name} is not a proc" unless value.kind_of?(Proc)
     end
 
+    IS_ARAY_OF_PROC_VALIDATOR = Proc.new do |data, field_name|
+        raise ArgumentError, "#{field_name} data should be a proc or an array of proc" unless data.all? { |value| value.kind_of?(Proc)}
+    end
+
+    IS_PROC_OR_ARRAY_OF_PROC_VALIDATOR = Proc.new do |data, field_name|
+      if data.kind_of?(Array)
+        IS_ARAY_OF_PROC_VALIDATOR.call(data, field_name)
+      else
+        IS_PROC_VALIDATOR.call(data, field_name)
+      end
+    end
+
     def self.reset!
       to_reset = self.constants.map {|c| const_get c}
       to_reset << self
@@ -88,7 +100,7 @@ module IntercomRails
     config_accessor :include_for_logged_out_users
 
     config_group :user do
-      config_accessor :current, &IS_PROC_VALIDATOR
+      config_accessor :current, &IS_PROC_OR_ARRAY_OF_PROC_VALIDATOR
       config_accessor :exclude_if, &IS_PROC_VALIDATOR
       config_accessor :model, &IS_PROC_VALIDATOR
       config_accessor :company_association, &IS_PROC_VALIDATOR

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

@@ -16,7 +16,11 @@ module IntercomRails
 
       def self.potential_user_objects
         if config.current.present?
-          [Proc.new { instance_eval &IntercomRails.config.user.current }]
+          if config.current.kind_of?(Array)
+            config.current.map { |user| Proc.new { instance_eval &user } }
+          else
+            [Proc.new { instance_eval &IntercomRails.config.user.current }]
+          end
         else
           PREDEFINED_POTENTIAL_USER_OBJECTS
         end

data/lib/intercom-rails/script_tag.rb

@@ -137,8 +137,7 @@ module IntercomRails
     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?
-      return 'abcd1234' if defined?(Rails) && Rails.env.development?
-
+      return 'abcd1234' if defined?(Rails) && (Rails.env.development? || Rails.env.test?)
       nil
     end
 

data/lib/intercom-rails/shutdown_helper.rb

@@ -4,8 +4,27 @@ module IntercomRails
     # 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}")
+    def self.intercom_shutdown_helper(cookies)
+      if (cookies.is_a?(ActionDispatch::Cookies::CookieJar))
+        cookies["intercom-session-#{IntercomRails.config.app_id}"] = { value: nil, expires: 1.day.ago}
+      else
+        controller = cookies
+        Rails.logger.info("Warning: IntercomRails::ShutdownHelper.intercom_shutdown_helper takes an instance of ActionDispatch::Cookies::CookieJar as an argument since v0.2.34. Passing a controller is depreciated. See https://github.com/intercom/intercom-rails#shutdown for more details.")
+        controller.response.delete_cookie("intercom-session-#{IntercomRails.config.app_id}", { value: nil, expires: 1.day.ago})
+      end
+    rescue
     end
+
+    def self.prepare_intercom_shutdown(session)
+      session[:perform_intercom_shutdown] = true
+    end
+
+    def self.intercom_shutdown(session, cookies)
+      if session[:perform_intercom_shutdown]
+        session.delete(:perform_intercom_shutdown)
+        intercom_shutdown_helper(cookies)
+      end
+    end
+
   end
 end

data/lib/intercom-rails/version.rb

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

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

@@ -5,8 +5,11 @@ IntercomRails.config do |config|
 
   # == Intercom session_duration
   #
+  <%- if @session_duration -%>
   config.session_duration = <%= @session_duration %>
-
+  <%- else -%>
+  # 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.
@@ -40,6 +43,7 @@ IntercomRails.config do |config|
   config.user.current = Proc.new { <%= @current_user %> }
   <%- else -%>
   # config.user.current = Proc.new { current_user }
+  # config.user.current = [Proc.new { current_user }]
   <%- end -%>
 
   # == Include for logged out Users

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.33
+  version: 0.2.34
 platform: ruby
 authors:
 - Ben McRedmond
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-20 00:00:00.000000000 Z
+date: 2016-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -204,9 +204,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: intercom-rails
-rubygems_version: 2.2.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Rails helper for emitting javascript script tags for Intercom
 test_files: []
-has_rdoc: