intercom-rails 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011- Intercom App, 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,31 @@
+= IntercomRails
+
+Rails helper for creating Intercom (https://www.intercom.io) javascript tags.
+
+For interacting with the Intercom API, use the intercom gem (https://github.com/intercom/intercom-ruby)
+
+== Installation
+Add this to your Gemfile:
+
+  gem "intercom-rails"
+
+<code>bundle install</code>
+
+== Usage
+In your layout file:
+
+  <% if logged_in? %>
+    <%= intercom_script_tag({
+      :app_id => 'your-app-id'
+      :user_id => current_user.id
+      :email => current_user.email
+      :name => current_user.name
+      :created_at => current_user.created_at
+      :custom_data => {:plan => "Pro"}}) %>
+  <% end %>
+
+See {IntercomRails::ScriptTagHelper} for more details.
+
+== License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,20 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new("test") do |test|
+  test.libs.push "lib"
+  test.libs.push "test"
+  test.test_files = FileList['test/**/*_test.rb']
+  test.warning = true
+  test.verbose = true
+end
+
+task :default => :test

data/lib/intercom-rails.rb

@@ -0,0 +1 @@
+require 'intercom-rails/railtie' if defined? Rails

data/lib/intercom-rails/railtie.rb

@@ -0,0 +1,9 @@
+require 'intercom-rails/script_tag_helper'
+
+module IntercomRails
+  class Railtie < Rails::Railtie
+    initializer "intercom_on_rails.script_tag_helper.rb" do |app|
+      ActionView::Base.send :include, ScriptTagHelper
+    end
+  end
+end

data/lib/intercom-rails/script_tag_helper.rb

@@ -0,0 +1,64 @@
+require "active_support/json"
+
+module IntercomRails
+  # Helper methods for generating Intercom javascript script tags.
+  module ScriptTagHelper
+    # @param user_details [Hash] a customizable hash of user details
+    # @param widget_options [Hash] an optional hash for widget customisation
+    # @option user_details [String] :app_id Your application id (get it here)
+    # @option user_details [String] :user_id unique id of this user within your application
+    # @option user_details [String] :email email address for this user
+    # @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. See
+    # @option widget_options [String] :activator a css selector for an element which when clicked should show the Intercom widget
+    # @return [String] Intercom script tag
+    # @example basic example
+    #   <%= intercom_script_tag({ :app_id => "your-app-id",
+    #                             :user_id => current_user.id,
+    #                             :email => current_user.email,
+    #                             :custom_data => { :plan => current_user.plan.name },
+    #                             :name => current_user.name }
+    #                           ) %>
+    # @example with widget activator for launching then widget when an element matching the css selector '#Intercom' is clicked.
+    #   <%= intercom_script_tag({ :app_id => "your-app-id",
+    #                             :user_id => current_user.id,
+    #                             :email => current_user.email,
+    #                             :custom_data => { :plan => current_user.plan.name },
+    #                             :name => current_user.name }
+    #                             {:activator => "#Intercom"}
+    #                          ) %>
+    def intercom_script_tag(user_details, widget_options={})
+      intercom_settings = user_details.merge({:widget => widget_options})
+      intercom_settings_with_dates_as_timestamps = convert_dates_to_unix_timestamps(intercom_settings)
+      intercom_script = <<-INTERCOM_SCRIPT
+<script id="IntercomSettingsScriptTag">
+    var intercomSettings = #{ActiveSupport::JSON.encode(intercom_settings_with_dates_as_timestamps)};
+</script>
+<script>
+(function() {
+  function async_load() {
+    var s = document.createElement('script');
+    s.type = 'text/javascript'; s.async = true;
+    s.src = 'https://api.intercom.io/api/js/library.js';
+    var x = document.getElementsByTagName('script')[0];
+    x.parentNode.insertBefore(s, x);
+  }
+  if (window.attachEvent) {
+    window.attachEvent('onload', async_load);
+  } else {
+    window.addEventListener('load', async_load, false);
+  }
+})();
+</script>
+      INTERCOM_SCRIPT
+      intercom_script.respond_to?(:html_safe) ? intercom_script.html_safe : intercom_script
+    end
+
+    private
+    def convert_dates_to_unix_timestamps(object)
+      return Hash[object.map { |k, v| [k, convert_dates_to_unix_timestamps(v)] }] if object.is_a?(Hash)
+      return object.strftime('%s').to_i if object.respond_to?(:strftime)
+      object
+    end
+  end
+end

data/lib/intercom-rails/version.rb

@@ -0,0 +1,3 @@
+module IntercomRails
+  VERSION = "0.0.1"
+end

data/test/intercom-rails/script_tag_helper_test.rb

@@ -0,0 +1,16 @@
+require "active_support/core_ext/string/output_safety"
+require 'intercom-rails/script_tag_helper'
+require 'minitest/autorun'
+
+class IntercomRailsTest < MiniTest::Unit::TestCase
+  include IntercomRails::ScriptTagHelper
+  def test_output_is_html_safe?
+    assert_equal true, intercom_script_tag({}).html_safe?
+  end
+
+  def test_converts_times_to_unix_timestamps
+    now = Time.now
+    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
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: intercom-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ben McRedmond
+- Ciaran Lee
+- Darragh Curran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70275093835120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70275093835120
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70275093834480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70275093834480
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70275093833620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70275093833620
+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.
+email:
+- ben@intercom.io
+- ciaran@intercom.io
+- darragh@intercom.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/intercom-rails/railtie.rb
+- lib/intercom-rails/script_tag_helper.rb
+- lib/intercom-rails/version.rb
+- lib/intercom-rails.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/intercom-rails/script_tag_helper_test.rb
+homepage: http://www.intercom.io
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: intercom-rails
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Rails helper for emitting javascript script tags for Intercom
+test_files:
+- test/intercom-rails/script_tag_helper_test.rb
+has_rdoc: