intercom-rails 0.0.2 → 0.0.3

data/MIT-LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2011- Intercom App, Inc. (https://www.intercom.io)
+Copyright (c) 2011- Intercom, Inc. (https://www.intercom.io)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.rdoc

@@ -9,9 +9,22 @@ Add this to your Gemfile:
 
   gem "intercom-rails"
 
+Then run:
+
 <code>bundle install</code>
 
 == Usage
+
+Take note of your app_id from here: You can find your app id here: https://www.intercom.io/apps/api_keys
+
+=== rails generator
+
+The <strong>intercom:install</strong> rails generator will add <code>intercom_script_tag</code> to your application layout. It provides a great start that will work well for most people and is easily customised.
+
+<code>rails g intercom:install YOUR-APP-ID</code>
+
+=== manual install
+
 In your layout file:
 
   <% if logged_in? %>
@@ -29,13 +42,10 @@ In your layout file:
 :custom_data allows you to specify any app/user/situational data to associate with the current_user. It will be visible in Intercom, and you'll be able to search/filter/send messages based on it.
 
 e.g.
-
-  :plan => "Pro"
-
-or
+  :plan => "Pro",
   :dashboard_page => 'http://dashboard.example.com/user-id'
 
-See IntercomRails::ScriptTagHelper for more details.
+See {IntercomRails::ScriptTagHelper} for more details.
 
 == Contributors
 

data/lib/intercom-rails/script_tag_helper.rb

@@ -1,4 +1,5 @@
 require "active_support/json"
+require "active_support/core_ext/hash/indifferent_access"
 
 module IntercomRails
   # Helper methods for generating Intercom javascript script tags.
@@ -28,8 +29,9 @@ module IntercomRails
     #                             {:activator => "#Intercom"}
     #                          ) %>
     def intercom_script_tag(user_details, widget_options={})
-      intercom_settings = user_details.merge({:widget => widget_options})
+      intercom_settings = user_details.merge({:widget => widget_options}).with_indifferent_access
       intercom_settings_with_dates_as_timestamps = convert_dates_to_unix_timestamps(intercom_settings)
+      intercom_settings_with_dates_as_timestamps.reject! { |key, value| %w(email name user_id).include?(key.to_s) && value.nil? }
       intercom_script = <<-INTERCOM_SCRIPT
 <script id="IntercomSettingsScriptTag">
     var intercomSettings = #{ActiveSupport::JSON.encode(intercom_settings_with_dates_as_timestamps)};

data/lib/intercom-rails/version.rb

@@ -1,3 +1,3 @@
 module IntercomRails
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/intercom-rails/script_tag_helper_test.rb

@@ -13,4 +13,12 @@ class IntercomRailsTest < MiniTest::Unit::TestCase
     assert_match(/.created_at.\s*:\s*#{now.to_i}/, intercom_script_tag({:created_at => now}))
     assert_match(/.something.\s*:\s*#{now.to_i}/, intercom_script_tag({:custom_data => {"something" => now}}))
   end
+
+  def test_strips_out_nil_entries_for_standard_attributes
+    %w(name email user_id).each do |standard_attribute|
+      assert_match(/.#{standard_attribute}.\s*:\s*"value"/, intercom_script_tag({standard_attribute => 'value'}))
+      assert(!intercom_script_tag({standard_attribute.to_sym => nil}).include?("\"#{standard_attribute}\":"), "should strip #{standard_attribute} when nil")
+      assert(!intercom_script_tag({standard_attribute => nil}).include?("\"#{standard_attribute}\":"), "should strip #{standard_attribute} when nil")
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-27 00:00:00.000000000Z
+date: 2012-05-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70176105438820 !ruby/object:Gem::Requirement
+  requirement: &70285909407560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -23,10 +23,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70176105438820
+  version_requirements: *70285909407560
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70176105438140 !ruby/object:Gem::Requirement
+  requirement: &70285909407140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70176105438140
+  version_requirements: *70285909407140
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70176105437320 !ruby/object:Gem::Requirement
+  requirement: &70285909437140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,7 +45,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70176105437320
+  version_requirements: *70285909437140
 description: Intercom (https://www.intercom.io) is a customer relationship management
   and messaging tool for web app owners. This library makes it easier to use the correct
   javascript tracking code in your rails applications.