intercom-rails 0.2.27 → 0.2.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f58be9d0de209b0d290aa407beebc68ad2c1076
-  data.tar.gz: 790375aec627e79a396437ed3c0bdce84ca5a259
+  metadata.gz: 141d27f9b5389539330869833167ba06547a9d47
+  data.tar.gz: a8dae5495febc5dda1d64187e90fd747a7039006
 SHA512:
-  metadata.gz: 517b3b4d5b9d9514d88c7cda5786c1e29c6f187c287cadfda89d942cc891da5bc046d244c01db8da7be40aa28a4ea7c3c8a19f1635f7024d140255d64e49f84c
-  data.tar.gz: 1262b4f8175737c25f292bb4f205191ba5d1f544801bdcd39e3630e5c54a9079c1c9451cd50fa3f5cde3c3fa18f86e79b2be5631868f98fd7fea5ab7f4204e2c
+  metadata.gz: 91d844a6dca6093fdf67361f98772de2fe4e76a833c989dac1597b755f2deaeadc9def4a4d241bc8dbd2292032b041030511d2a5e3f05fbcbccc5430b8840dd2
+  data.tar.gz: f9d24e5b3dffdd193d63f27032a3c37a26c5385151a838208d370336f2a01323d760eacd7f69c5b091d80e8359ec4cf94201c7e577e642fc2e41367ef744bce4

data/README.mdown

@@ -39,6 +39,7 @@ If it's not working make sure:
 * You've generated a config file with your `app_id` as detailed above.
 * Your user object responds to an `id` or `email` method.
 * Your current user is accessible in your controllers as `current_user` or `@user`, if not in `config/initializers/intercom.rb`:
+* 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.
 
 ```ruby
   config.user.current = Proc.new { current_user_object }
@@ -115,28 +116,29 @@ config.company.custom_data = {
 }
 ```
 
-### Inbox
-Intercom includes an inbox which allows a user to read their past conversations with your app, and start new conversations. It's hidden by default, you can include a link to open it by adding a line to `config/initializers/intercom.rb`:
-
-To use the default link style, which requires no extra config and includes a small question mark icon in the bottom right corner of your app:
+### 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.inbox.style = :default
+  config.include_for_logged_out_users = true
 ```
 
-If you want to customize the style of the link that opens the inbox:
+### Messenger
+Intercom includes an in-app messenger which allows a user to read messages and start conversations.
+
+By default Intercom will add a button that opens the messenger to the page. If you want to customize the style of the link that opens the messenger:
 
 ```ruby
   config.inbox.style = :custom
 ```
 
-This option attaches the inbox open event to the click event of an element with an id of `Intercom`. So the simplest option here would be to add something like the following to your layout:
+With this option enabled, clicks on any element with an id of `Intercom` will open the messenger. So the simplest option here would be to add something like the following to your layout:
 
 ```html
   <a id="Intercom">Support</a>
 ```
 
-You can read more about configuring the Inbox within Intercom (Config menu -> Inbox Link).
+You can read more about configuring the messenger in your applications settings, within Intercom.
 
 ### Environments
 

data/lib/intercom-rails/auto_include_filter.rb

@@ -54,7 +54,11 @@ module IntercomRails
       end
 
       def intercom_script_tag
-        @script_tag ||= ScriptTag.new(:find_current_user_details => true, :find_current_company_details => true, :controller => controller)
+        @script_tag ||= ScriptTag.new(:find_current_user_details => true, :find_current_company_details => true, :controller => controller, :show_everywhere => show_everywhere?)
+      end
+
+      def show_everywhere?
+        IntercomRails.config.include_for_logged_out_users
       end
 
       def enabled_for_environment?

data/lib/intercom-rails/config.rb

@@ -84,6 +84,7 @@ module IntercomRails
     config_accessor :api_key
     config_accessor :library_url
     config_accessor :enabled_environments, &ARRAY_VALIDATOR
+    config_accessor :include_for_logged_out_users
 
     config_group :user do
       config_accessor :current, &IS_PROC_VALIDATOR

data/lib/intercom-rails/script_tag.rb

@@ -10,13 +10,14 @@ module IntercomRails
       new(*args).output
     end
 
-    attr_reader :user_details, :company_details
+    attr_reader :user_details, :company_details, :show_everywhere
     attr_accessor :secret, :widget_options, :controller
 
     def initialize(options = {})
       self.secret = options[:secret] || Config.api_secret
       self.widget_options = widget_options_from_config.merge(options[:widget] || {})
       self.controller = options[:controller]
+      @show_everywhere = options[:show_everywhere]
       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
@@ -26,7 +27,11 @@ module IntercomRails
     end
 
     def valid?
-      user_details[:app_id].present? && (user_details[:user_id] || user_details[:email]).present?
+      valid = user_details[:app_id].present?
+      unless @show_everywhere
+        valid = valid && (user_details[:user_id] || user_details[:email]).present?
+      end
+      valid
     end
 
     def intercom_settings

data/lib/intercom-rails/version.rb

@@ -1,3 +1,3 @@
 module IntercomRails
-  VERSION = "0.2.27"
+  VERSION = "0.2.28"
 end

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

@@ -15,6 +15,7 @@ module Intercom
         @app_id = app_id
         @api_secret = api_secret
         @api_key = api_key
+        @include_for_logged_out_users = false
 
         introduction = <<-desc
 Intercom will automatically insert its javascript before the closing '</body>'

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

@@ -4,8 +4,8 @@ IntercomRails.config do |config|
   config.app_id = ENV["INTERCOM_APP_ID"] || "<%= @app_id %>"
 
   # == Intercom secret key
-  # This is required to enable secure mode, you can find it on your Intercom
-  # "security" configuration page.
+  # This is required to enable secure mode, you can find it on your Setup
+  # guide in the "Secure Mode" step.
   #
   <%- if @api_secret -%>
   config.api_secret = "<%= @api_secret %>"
@@ -38,6 +38,15 @@ IntercomRails.config do |config|
   # config.user.current = Proc.new { current_user }
   <%- end -%>
 
+  # == 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.
+  <%- if @include_for_logged_out_users -%>
+  config.include_for_logged_out_users = true
+  <%- else -%>
+  # config.include_for_logged_out_users = true
+  <%- end -%>
+
   # == User model class
   # The class which defines your user model
   #
@@ -95,14 +104,11 @@ IntercomRails.config do |config|
   # config.company.monthly_spend = Proc.new { |current_company| current_company.plan.price }
   # config.company.monthly_spend = Proc.new { |current_company| (current_company.plan.price - current_company.subscription.discount) }
 
-  # == Inbox Style
-  # This enables the Intercom inbox which allows your users to read their
-  # past conversations with your app, as well as start new ones. It is
-  # disabled by default.
-  #   * :default shows a small tab with a question mark icon on it
-  #   * :custom attaches the inbox open event to an anchor with an
-  #             id of #Intercom.
+  # == Custom Style
+  # By default, Intercom will add a button that opens the messenger to
+  # the page. If you'd like to use your own link to open the messenger,
+  # uncomment this line and clicks on any element with id 'Intercom' will
+  # open the messenger.
   #
-  # config.inbox.style = :default
   # config.inbox.style = :custom
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.27
+  version: 0.2.28
 platform: ruby
 authors:
 - Ben McRedmond
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-28 00:00:00.000000000 Z
+date: 2015-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -207,3 +207,4 @@ signing_key:
 specification_version: 4
 summary: Rails helper for emitting javascript script tags for Intercom
 test_files: []
+has_rdoc: