intercom-rails 0.2.24 → 0.2.25

data/README.mdown

@@ -17,13 +17,13 @@ Then run:
 bundle install
 ```
 
-Take note of your `app_id` from [here](https://www.intercom.io/apps/api_keys) and generate a config file:
+Take note of your `app_id` from [here](https://app.intercom.io/apps/api_keys) and generate a config file:
 
 ```
 rails generate intercom:config YOUR-APP-ID
 ```
 
-To make installing Intercom as easy as possible, 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. 
+To make installing Intercom as easy as possible, 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.
 
 ### Disabling automatic insertion
 
@@ -55,15 +55,16 @@ If you want to use secure mode, ensure you set your API secret in `config/initia
   config.api_secret = '123456'
 ```
 
-### Custom Data
-Custom data lets you associate any data, specific to your app, with a user in Intercom. For custom data variables you want updated on every request set them in `config/initializers/intercom.rb`. 
+### 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.
 
-You can give either a:
+Configure what attributes will be sent using either a:
 
   * `Proc` which will be passed the current user object
-  * Or, a method which will be sent to the current user object 
-  
-to generate the values of the custom data:
+  * Or, a method which will be sent to the current user object
+
+e.g.
 
 ```ruby
   config.user.custom_data = {
@@ -73,7 +74,8 @@ to generate the values of the custom data:
   }
 ```
 
-In some situations you'll want to set some custom data specific to a request. You can do this using the `intercom_custom_data` helper available in your controllers:
+In some situations you'll want to set some custom data attribute specific to a request.
+You can do this using the `intercom_custom_data` helper available in your controllers:
 
 ```ruby
 class AppsController < ActionController::Base
@@ -89,8 +91,29 @@ class AppsController < ActionController::Base
 end
 ```
 
-Attributes must be accessible in order to sync with intercom. Additionally, attriutes ending in "_at" will be parsed as times.
+Attributes must be accessible in order to sync with intercom.
+Additionally, attributes ending in "_at" will be parsed as times.
+
+### Companies
+
+By default, Intercom treats all Users as unrelated individuals. If for example you know users are part of a company, you can group them as such.
+
+Read more about it here http://docs.intercom.io/configuring-Intercom/grouping-users-by-company
+
+Basic usage is as follows - in `config/initializers/intercom.rb`
 
+```ruby
+config.company.current = Proc.new { current_company }
+```
+
+and like with Users, you can set custom attribute on companies too:
+
+```ruby
+config.company.custom_data = {
+  :number_of_messages => Proc.new { |app| app.messages.count },
+  :is_interesting => :is_interesting?
+}
+```
 
 ### 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`:
@@ -117,13 +140,13 @@ You can read more about configuring the Inbox within Intercom (Config menu -> In
 
 ### Environments
 
-By default Intercom will be automatically inserted in all Rails environments. If you would like to specify the environments in which Intercom should be inserted, you can do so as follows:
+By default Intercom will be automatically inserted in development and production Rails environments. If you would like to specify the environments in which Intercom should be inserted, you can do so as follows:
 
 ```ruby
   config.enabled_environments = ["production"]
 ```
 
-### Manually Inserting the Intercom Javascript 
+### Manually Inserting the Intercom Javascript
 
 Some situations may require manually inserting the Intercom script tag. If you simply wish to place the Intercom javascript in a different place within the page or, on a page without a closing `</body>` tag:
 
@@ -173,6 +196,17 @@ rake intercom:import
 
 Any custom data defined in `config/initializers/intercom.rb` will also be sent.
 
+## Running tests/specs
+
+specs should run on a clean clone of this repo, using the following commands. (developed against ruby 2.1.2 and 1.9.3)
+
+```
+bundle install
+bundle exec rake spec
+or
+bundle exec rspec spec/
+```
+
 ## Contributors
 
 - Dr Nic Williams (@drnic) - provided a rails generator for adding the Intercom javascript tag into your layout.
@@ -180,4 +214,8 @@ Any custom data defined in `config/initializers/intercom.rb` will also be sent.
 
 ## License
 
+intercom-rails is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+
+## Copyright
+
 Copyright (c) 2011-2012 Intercom, Inc.  All rights reserved.

data/Rakefile

@@ -8,15 +8,7 @@ end
 
 Bundler::GemHelper.install_tasks
 
-require 'rake/testtask'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 
-Rake::TestTask.new("test") do |test|
-  test.libs << 'lib'
-  test.libs << 'test'
-
-  test.test_files = FileList['test/**/*_test.rb']
-  test.warning = false
-  test.verbose = true
-end
-
-task :default => :test
+task :default => :spec

data/lib/intercom-rails/auto_include_filter.rb

@@ -21,10 +21,10 @@ module IntercomRails
       attr_reader :controller
 
       def initialize(kontroller)
-        @controller = kontroller 
+        @controller = kontroller
       end
 
-      def include_javascript! 
+      def include_javascript!
         response.body = response.body.gsub(CLOSING_BODY_TAG, intercom_script_tag.output + '\\0')
       end
 

data/lib/intercom-rails/config.rb

@@ -2,7 +2,7 @@ require 'active_support/inflector'
 
 module IntercomRails
 
-  class ConfigSingleton 
+  class ConfigSingleton
 
     def self.config_accessor(*args, &block)
       config_reader(*args)
@@ -25,7 +25,7 @@ module IntercomRails
 
         if block && (block.arity > 1)
           field_name = underscored_class_name ? "#{underscored_class_name}.#{name}" : name
-          block.call(value, field_name) 
+          block.call(value, field_name)
         end
 
         instance_variable_set("@#{name}", value)
@@ -78,7 +78,7 @@ module IntercomRails
         end
       end
     end
- 
+
     config_accessor :app_id
     config_accessor :api_secret
     config_accessor :api_key
@@ -86,15 +86,15 @@ module IntercomRails
     config_accessor :enabled_environments, &ARRAY_VALIDATOR
 
     config_group :user do
-      config_accessor :current, &IS_PROC_VALIDATOR 
+      config_accessor :current, &IS_PROC_VALIDATOR
       config_accessor :model, &IS_PROC_VALIDATOR
       config_accessor :company_association, &IS_PROC_VALIDATOR
       config_accessor :custom_data, &CUSTOM_DATA_VALIDATOR
     end
-    
+
     config_group :company do
       config_accessor :current, &IS_PROC_VALIDATOR
-      config_accessor :plan, &IS_PROC_VALIDATOR 
+      config_accessor :plan, &IS_PROC_VALIDATOR
       config_accessor :monthly_spend, &IS_PROC_VALIDATOR
       config_accessor :custom_data, &CUSTOM_DATA_VALIDATOR
     end

data/lib/intercom-rails/custom_data_helper.rb

@@ -1,7 +1,7 @@
 module IntercomRails
 
   module CustomDataHelper
-    
+
     # This helper allows custom data attributes to be added to a user
     # for the current request from within the controller. e.g.
     #

data/lib/intercom-rails/import.rb

@@ -28,7 +28,7 @@ module IntercomRails
       @status_enabled = !!options[:status_enabled]
 
       if uri.scheme == 'https'
-        http.use_ssl = true 
+        http.use_ssl = true
         http.ca_file = File.join(File.dirname(__FILE__), '../data/cacert.pem')
         http.verify_mode = OpenSSL::SSL::VERIFY_PEER
       end
@@ -70,7 +70,7 @@ module IntercomRails
       end
       info "Successfully created #{self.total_sent - self.failed.count} users", :new_line => true
       info "Failed to create #{self.failed.count} #{(self.failed.count == 1) ? 'user' : 'users'}, this is likely due to bad data" unless failed.count.zero?
-      
+
       self
     end
 
@@ -119,15 +119,15 @@ module IntercomRails
         User
       end
     rescue NameError
-      # Rails lazy loads constants, so this is how we check 
+      # Rails lazy loads constants, so this is how we check
       nil
     end
 
     def send_users(users)
-      request = Net::HTTP::Post.new(uri.request_uri) 
+      request = Net::HTTP::Post.new(uri.request_uri)
       request.basic_auth(IntercomRails.config.app_id, IntercomRails.config.api_key)
       request["Content-Type"] = "application/json"
-      request.body = users 
+      request.body = users
 
       response = perform_request(request)
       JSON.parse(response.body)
@@ -136,7 +136,7 @@ module IntercomRails
     MAX_REQUEST_ATTEMPTS = 3
     def perform_request(request, attempts = 0, error = {})
       if (attempts > 0) && (attempts < MAX_REQUEST_ATTEMPTS)
-        sleep(0.5) 
+        sleep(0.5)
       elsif error.present?
         raise error[:exception] if error[:exception]
         raise exception_for_failed_response(error[:failed_response])

data/lib/intercom-rails/proxy.rb

@@ -10,7 +10,7 @@ module IntercomRails
 
       def self.inherited(subclass)
         subclass.class_eval do
-          attr_reader class_string.downcase.to_s 
+          attr_reader class_string.downcase.to_s
         end
       end
 
@@ -23,6 +23,11 @@ module IntercomRails
 
       def to_hash
         data = standard_data.merge(custom_data)
+        [:id, :user_id].each do |id_key|
+          if(data[id_key] && !data[id_key].is_a?(Numeric))
+            data[id_key] = data[id_key].to_s
+          end
+        end
         DateHelper.convert_dates_to_unix_timestamps(data)
       end
 
@@ -76,7 +81,7 @@ module IntercomRails
         identity_attributes << attribute_name if options[:identity]
 
         send(:define_method, attribute_name) do
-          return nil unless proxied_object.respond_to?(attribute_name) 
+          return nil unless proxied_object.respond_to?(attribute_name)
 
           current_value = instance_variable_get(instance_variable_name)
           return current_value if current_value
@@ -116,13 +121,13 @@ module IntercomRails
 
       private
 
-      def custom_data_from_request 
+      def custom_data_from_request
         search_object.intercom_custom_data.send(type)
       rescue NoMethodError
         {}
       end
 
-      def custom_data_from_config 
+      def custom_data_from_config
         return {} if config.custom_data.blank?
         config.custom_data.reduce({}) do |custom_data, (k,v)|
           custom_data.merge(k => custom_data_value_from_proc_or_symbol(v))

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

@@ -22,17 +22,17 @@ module IntercomRails
       def self.current_in_context(search_object)
         begin
           if config.current.present?
-            company_proxy = new(search_object.instance_eval(&config.current), search_object) 
+            company_proxy = new(search_object.instance_eval(&config.current), search_object)
             return company_proxy if company_proxy.valid?
           end
         rescue NameError
         end
 
-        raise NoCompanyFoundError 
+        raise NoCompanyFoundError
       end
 
       def valid?
-        company.present? && identity_present? 
+        company.present? && identity_present?
       end
 
     end

data/lib/intercom-rails/script_tag_helper.rb

@@ -3,7 +3,7 @@ module IntercomRails
 
   module ScriptTagHelper
     # 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
     # @option user_details [String] :app_id Your application id
@@ -12,7 +12,7 @@ module IntercomRails
     # @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 secure mode
     # @return [String] Intercom script tag
     # @example basic example
     #   <%= intercom_script_tag({ :app_id => "your-app-id",

data/lib/intercom-rails/version.rb

@@ -1,3 +1,3 @@
 module IntercomRails
-  VERSION = "0.2.24"
+  VERSION = "0.2.25"
 end

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

@@ -6,7 +6,7 @@ module Intercom
         File.dirname(__FILE__)
       end
 
-      argument :app_id, :desc => "Your Intercom app-id, which can be found here: https://www.intercom.io/apps/api_keys"
+      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
 
@@ -17,7 +17,7 @@ module Intercom
         @api_key = api_key
 
         introduction = <<-desc
-Intercom will automatically insert its javascript before the closing '</body>' 
+Intercom will automatically insert its javascript before the closing '</body>'
 tag on every page where it can find a logged-in user. Intercom by default
 looks for logged-in users, in the controller, via 'current_user' and '@user'.
 
@@ -25,9 +25,9 @@ Is the logged-in user accessible via either 'current_user' or '@user'? [Yn]
         desc
 
         print "#{introduction.strip} "
-        default_ok = $stdin.gets.strip.downcase 
+        default_ok = $stdin.gets.strip.downcase
 
-        if FALSEY_RESPONSES.include?(default_ok) 
+        if FALSEY_RESPONSES.include?(default_ok)
           custom_current_user_question = <<-desc
 
 How do you access the logged-in user in your controllers? This can be

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

@@ -1,12 +1,12 @@
 IntercomRails.config do |config|
   # == Intercom app_id
-  # 
+  #
   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 
+  # == Intercom secret key
+  # This is required to enable secure mode, you can find it on your Intercom
   # "security" configuration page.
-  # 
+  #
   <%- if @api_secret -%>
   config.api_secret = "<%= @api_secret %>"
   <%- else -%>
@@ -15,7 +15,7 @@ IntercomRails.config do |config|
 
   # == Intercom API Key
   # This is required for some Intercom rake tasks like importing your users;
-  # you can generate one at https://www.intercom.io/apps/api_keys.
+  # you can generate one at https://app.intercom.io/apps/api_keys.
   #
   <%- if @api_key -%>
   config.api_key = "<%= @api_key %>"
@@ -37,7 +37,7 @@ IntercomRails.config do |config|
   <%- else -%>
   # config.user.current = Proc.new { current_user }
   <%- end -%>
-  
+
   # == User model class
   # The class which defines your user model
   #
@@ -56,13 +56,13 @@ IntercomRails.config do |config|
   # == User -> Company association
   # A Proc that given a user returns an array of companies
   # that the user belongs to.
-  # 
+  #
   # config.user.company_association = Proc.new { |user| user.companies.to_a }
   # config.user.company_association = Proc.new { |user| [user.company] }
 
   # == Current company method/variable
   # The method/variable that contains the current company for the current user,
-  # in your controllers. 'Companies' are generic groupings of users, so this 
+  # in your controllers. 'Companies' are generic groupings of users, so this
   # could be a company, app or group.
   #
   # config.company.current = Proc.new { current_company }
@@ -79,7 +79,7 @@ IntercomRails.config do |config|
   # == Company Plan name
   # This is the name of the plan a company is currently paying (or not paying) for.
   # e.g. Messaging, Free, Pro, etc.
-  #  
+  #
   # config.company.plan = Proc.new { |current_company| current_company.plan.name }
 
   # == Company Monthly Spend
@@ -88,15 +88,15 @@ 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 
+  # 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.
   #
-  # config.inbox.style = :default 
+  # config.inbox.style = :default
   # config.inbox.style = :custom
 end