intercom-rails 0.0.6 → 0.0.7

data/Rakefile

@@ -1,4 +1,5 @@
 #!/usr/bin/env rake
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -10,10 +11,11 @@ Bundler::GemHelper.install_tasks
 require 'rake/testtask'
 
 Rake::TestTask.new("test") do |test|
-  test.libs.push "lib"
-  test.libs.push "test"
+  test.libs << 'lib'
+  test.libs << 'test'
+
   test.test_files = FileList['test/**/*_test.rb']
-  test.warning = true
+  test.warning = false
   test.verbose = true
 end
 

data/lib/intercom-rails.rb

@@ -1 +1,12 @@
-require 'intercom-rails/railtie' if defined? Rails
+require 'intercom-rails/script_tag_helper'
+require 'intercom-rails/auto_include_filter'
+require 'intercom-rails/config'
+require 'intercom-rails/railtie' if defined? Rails
+
+module IntercomRails
+
+  def self.config
+    block_given? ? yield(Config) : Config
+  end
+
+end

data/lib/intercom-rails/auto_include_filter.rb

@@ -0,0 +1,92 @@
+module IntercomRails
+
+  class AutoIncludeFilter
+
+    include ScriptTagHelper
+    CLOSING_BODY_TAG = %r{</body>}
+
+    def self.filter(controller)
+      auto_include_filter = new(controller)
+      return unless auto_include_filter.include_javascript?
+
+      auto_include_filter.include_javascript!
+    end
+
+    attr_reader :controller
+
+    def initialize(kontroller)
+      @controller = kontroller 
+    end
+
+    def include_javascript! 
+      response.body = response.body.gsub(CLOSING_BODY_TAG, intercom_script_tag + '\\0')
+    end
+
+    def include_javascript?
+      !intercom_script_tag_called_manually? &&
+      html_content_type? &&
+      response_has_closing_body_tag? &&
+      intercom_app_id.present? &&
+      intercom_user_object.present?
+    end
+
+    private
+    def response
+      controller.response
+    end
+
+    def html_content_type?
+      response.content_type == 'text/html'
+    end
+
+    def response_has_closing_body_tag?
+      !!(response.body[CLOSING_BODY_TAG])
+    end
+
+    def intercom_script_tag_called_manually?
+      controller.instance_variable_get(SCRIPT_TAG_HELPER_CALLED_INSTANCE_VARIABLE)
+    end
+
+    POTENTIAL_INTERCOM_USER_OBJECTS = [
+      Proc.new { instance_eval &IntercomRails.config.current_user if IntercomRails.config.current_user.present? },
+      Proc.new { current_user },
+      Proc.new { @user }
+    ]
+
+    def intercom_user_object
+      POTENTIAL_INTERCOM_USER_OBJECTS.each do |potential_user|
+        begin
+          user = controller.instance_eval &potential_user
+          return user if user.present? && 
+                         (user.email.present? || user.id.present?)
+        rescue NameError
+          next
+        end
+      end
+
+      nil
+    end
+
+    def intercom_app_id
+      return ENV['INTERCOM_APP_ID'] if ENV['INTERCOM_APP_ID'].present?
+      return IntercomRails.config.app_id if IntercomRails.config.app_id.present?
+      return 'abcd1234' if defined?(Rails) && Rails.env.development?
+
+      nil
+    end
+
+    def intercom_script_tag
+      user_details = {:app_id => intercom_app_id}
+      user = intercom_user_object
+
+      user_details[:user_id] = user.id if user.respond_to?(:id) && user.id.present?
+      [:email, :name, :created_at].each do |attribute|
+        user_details[attribute] = user.send(attribute) if user.respond_to?(attribute) && user.send(attribute).present?
+      end
+
+      super(user_details)
+    end
+
+  end
+
+end

data/lib/intercom-rails/config.rb

@@ -0,0 +1,24 @@
+module IntercomRails
+
+  module Config
+
+    def self.app_id=(value)
+      @app_id = value
+    end
+
+    def self.app_id
+      @app_id
+    end
+
+    def self.current_user=(value)
+      raise ArgumentError, "current_user should be a Proc" unless value.kind_of?(Proc)
+      @current_user = value
+    end
+
+    def self.current_user
+      @current_user
+    end
+
+  end
+
+end

data/lib/intercom-rails/railtie.rb

@@ -1,9 +1,11 @@
-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
+
+    initializer "intercom_on_rails.auto_include_filter.rb" do |app|
+      ActionController::Base.send :after_filter, AutoIncludeFilter 
+    end
   end
-end
+end

data/lib/intercom-rails/script_tag_helper.rb

@@ -3,6 +3,8 @@ require "active_support/core_ext/hash/indifferent_access"
 
 module IntercomRails
   # Helper methods for generating Intercom javascript script tags.
+  SCRIPT_TAG_HELPER_CALLED_INSTANCE_VARIABLE = :@_intercom_script_tag_helper_called
+
   module ScriptTagHelper
     # @param user_details [Hash] a customizable hash of user details
     # @param options [Hash] an optional hash for secure mode and widget customisation
@@ -57,6 +59,8 @@ module IntercomRails
 })();
 </script>
       INTERCOM_SCRIPT
+
+      controller.instance_variable_set(IntercomRails::SCRIPT_TAG_HELPER_CALLED_INSTANCE_VARIABLE, true) if defined?(controller)
       intercom_script.respond_to?(:html_safe) ? intercom_script.html_safe : intercom_script
     end
 

data/lib/intercom-rails/version.rb

@@ -1,3 +1,3 @@
 module IntercomRails
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

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

@@ -0,0 +1,18 @@
+module Intercom
+  module Generators
+    class ConfigGenerator < ::Rails::Generators::Base
+
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      argument :app_id, :desc => "Your Intercom app-id, which can be found here: https://www.intercom.io/apps/api_keys"
+
+      def create_config_file
+        @app_id = app_id
+        template("intercom.rb.erb", "config/initializers/intercom.rb")
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+IntercomRails.config do |config|
+  # Your Intercom app_id
+  config.app_id = "<%= @app_id %>"
+
+  # The method/variable that contains the logged in user in your controllers.
+  # If it is `current_user` or `@user`, then you can ignore this
+  # config.current_user = Proc.new { current_user }
+end

data/test/action_controller_test_setup.rb

@@ -0,0 +1,35 @@
+require 'test_setup'
+
+require 'pry'
+require 'action_controller'
+require 'action_controller/test_case'
+
+def dummy_user(options = {})
+  user = Struct.new(:email, :name).new
+  user.email = options[:email] || 'ben@intercom.io'
+  user.name = options[:name] || 'Ben McRedmond'
+  user
+end
+
+TestRoutes = ActionDispatch::Routing::RouteSet.new
+TestRoutes.draw do
+  get ':controller(/:action)'
+end
+
+class ActionController::Base
+
+  after_filter IntercomRails::AutoIncludeFilter
+
+  include TestRoutes.url_helpers
+  include TestRoutes.mounted_helpers
+
+end
+
+class ActionController::TestCase
+
+  def setup
+    super
+    @routes = TestRoutes
+  end
+  
+end

data/test/intercom-rails/auto_include_filter_test.rb

@@ -0,0 +1,102 @@
+require 'action_controller_test_setup'
+
+class TestController < ActionController::Base
+
+  def without_user 
+    render :text => params[:body], :content_type => 'text/html'
+  end
+
+  def with_user_instance_variable
+    @user = dummy_user
+    render :text => params[:body], :content_type => 'text/html'
+  end
+
+  def with_unusable_user_instance_variable
+    @user = Object.new
+    render :text => params[:body], :content_type => 'text/html'
+  end
+
+  def with_current_user_method
+    render :text => params[:body], :content_type => 'text/html'
+  end
+
+  def with_admin_instance_variable
+    @admin = dummy_user(:email => 'eoghan@intercom.io', :name => 'Eoghan McCabe')
+    render :text => params[:body], :content_type => 'text/html'
+  end
+
+  def current_user
+    raise NameError if params[:action] != 'with_current_user_method'
+    dummy_user(:email => 'ciaran@intercom.io', :name => 'Ciaran Lee')
+  end
+
+end
+
+class AutoIncludeFilterTest < ActionController::TestCase 
+
+  tests TestController
+
+  def setup
+    super
+    ENV['INTERCOM_APP_ID'] = 'my_app_id'
+  end
+  
+  def test_no_user_present
+    get :without_user, :body => "<body>Hello world</body>"
+    assert_equal @response.body, "<body>Hello world</body>"
+  end
+
+  def test_user_present_with_no_body_tag
+    get :with_user_instance_variable, :body => "Hello world"
+    assert_equal @response.body, "Hello world"
+  end
+
+  def test_user_present_but_unusuable
+    get :with_unusable_user_instance_variable, :body => "Hello world"
+    assert_equal @response.body, "Hello world"
+  end
+
+  def test_user_instance_variable_present_with_body_tag
+    get :with_user_instance_variable, :body => "<body>Hello world</body>"
+
+    assert_includes @response.body, "<script>"
+    assert_includes @response.body, ENV['INTERCOM_APP_ID']
+    assert_includes @response.body, "ben@intercom.io"
+    assert_includes @response.body, "Ben McRedmond"
+  end
+
+  def test_current_user_method_present_with_body_tag
+    get :with_current_user_method, :body => "<body>Hello world</body>"
+
+    assert_includes @response.body, "<script>"
+    assert_includes @response.body, "ciaran@intercom.io"
+    assert_includes @response.body, "Ciaran Lee"
+  end
+
+  def test_setting_current_user_with_intercom_config
+    IntercomRails.config.current_user = Proc.new { @admin }
+
+    get :with_admin_instance_variable, :body => "<body>Hello world</body>"
+
+    assert_includes @response.body, "<script>"
+    assert_includes @response.body, "eoghan@intercom.io"
+    assert_includes @response.body, "Eoghan McCabe"
+  end
+
+  def test_no_app_id_present
+    ENV.delete('INTERCOM_APP_ID')
+    get :with_current_user_method, :body => "<body>Hello world</body>"
+
+    assert_equal @response.body, "<body>Hello world</body>"
+  end
+
+  def test_manual_script_tag_helper_call
+    fake_action_view = fake_action_view_class.new
+    fake_action_view.instance_variable_set(:@controller, @controller)
+    fake_action_view.intercom_script_tag({})
+
+    get :with_current_user_method, :body => "<body>Hello world</body>"
+    assert_equal @response.body,  "<body>Hello world</body>"
+  end
+
+end

data/test/intercom-rails/config_test.rb

@@ -0,0 +1,30 @@
+require 'test_setup'
+
+class ConfigTest < MiniTest::Unit::TestCase 
+
+  def test_setting_app_id
+    IntercomRails.config.app_id = "1234"
+    assert_equal IntercomRails.config.app_id, "1234"
+  end
+
+  def test_setting_current_user
+    current_user = Proc.new { @blah }
+    IntercomRails.config.current_user = current_user
+    assert_equal IntercomRails.config.current_user, current_user
+  end
+
+  def test_setting_current_user_not_to_a_proc
+    assert_raises ArgumentError do
+      IntercomRails.config.current_user = 1
+    end
+  end
+
+  def test_configuring_intercom_with_block
+    IntercomRails.config do |config|
+      config.app_id = "4567"
+    end
+
+    assert_equal IntercomRails.config.app_id, "4567"
+  end
+
+end

data/test/intercom-rails/script_tag_helper_test.rb

@@ -1,8 +1,8 @@
-require "active_support/core_ext/string/output_safety"
-require 'intercom-rails/script_tag_helper'
-require 'minitest/autorun'
+require 'active_support/core_ext/string/output_safety'
+require 'test_setup'
+
+class ScriptTagHelperTest < MiniTest::Unit::TestCase
 
-class IntercomRailsTest < MiniTest::Unit::TestCase
   include IntercomRails::ScriptTagHelper
   def test_output_is_html_safe?
     assert_equal true, intercom_script_tag({}).html_safe?
@@ -27,4 +27,15 @@ class IntercomRailsTest < MiniTest::Unit::TestCase
     assert_match(/.user_hash.\s*:\s*"#{Digest::SHA1.hexdigest('abcdefgh' + '1234')}"/, intercom_script_tag({:user_id => 1234}, {:secret => 'abcdefgh'}))
     assert_match(/.user_hash.\s*:\s*"#{Digest::SHA1.hexdigest('abcdefgh' + '1234')}"/, intercom_script_tag({:user_id => 1234, :email => "ciaran@intercom.io"}, {:secret => 'abcdefgh'}))
   end
+
+  def test_sets_instance_variable
+    fake_action_view = fake_action_view_class.new
+    obj = Object.new
+
+    fake_action_view.instance_variable_set(:@controller, obj)
+
+    fake_action_view.intercom_script_tag({})
+    assert_equal obj.instance_variable_get(IntercomRails::SCRIPT_TAG_HELPER_CALLED_INSTANCE_VARIABLE), true
+  end
+
 end

data/test/test_setup.rb

@@ -0,0 +1,11 @@
+require 'intercom-rails'
+require 'minitest/autorun'
+
+def fake_action_view_class
+  klass = Class.new(ActionView::Base)
+  klass.class_eval do
+    include IntercomRails::ScriptTagHelper
+    attr_reader :controller
+  end
+  klass
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-28 00:00:00.000000000 Z
+date: 2012-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,7 +30,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -46,7 +46,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -72,15 +88,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/intercom-rails/auto_include_filter.rb
+- lib/intercom-rails/config.rb
 - lib/intercom-rails/railtie.rb
 - lib/intercom-rails/script_tag_helper.rb
 - lib/intercom-rails/version.rb
 - lib/intercom-rails.rb
+- lib/rails/generators/intercom/config/config_generator.rb
+- lib/rails/generators/intercom/config/intercom.rb.erb
 - lib/rails/generators/intercom/install/install_generator.rb
 - MIT-LICENSE
 - Rakefile
 - README.rdoc
+- test/action_controller_test_setup.rb
+- test/intercom-rails/auto_include_filter_test.rb
+- test/intercom-rails/config_test.rb
 - test/intercom-rails/script_tag_helper_test.rb
+- test/test_setup.rb
 homepage: http://www.intercom.io
 licenses: []
 post_install_message: 
@@ -95,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1146691025025650591
+      hash: -3817663782507976710
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -104,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1146691025025650591
+      hash: -3817663782507976710
 requirements: []
 rubyforge_project: intercom-rails
 rubygems_version: 1.8.23
@@ -112,4 +136,8 @@ signing_key:
 specification_version: 3
 summary: Rails helper for emitting javascript script tags for Intercom
 test_files:
+- test/action_controller_test_setup.rb
+- test/intercom-rails/auto_include_filter_test.rb
+- test/intercom-rails/config_test.rb
 - test/intercom-rails/script_tag_helper_test.rb
+- test/test_setup.rb