intercom-rails 0.2.8 → 0.2.9

data/README.mdown

@@ -28,7 +28,7 @@ To make installing Intercom as easy as possible, where possible a `<script>` tag
 To disable automatic insertion for a particular controller or action you can:
 
 ```ruby
-  skip_after_filter IntercomRails::AutoIncludeFilter
+  skip_after_filter :intercom_rails_auto_include
 ```
 
 ### Troubleshooting

data/lib/intercom-rails/auto_include_filter.rb

@@ -1,52 +1,59 @@
 module IntercomRails
 
-  class AutoIncludeFilter
+  module AutoInclude
+    def intercom_rails_auto_include
+      Filter.filter(self)
+    end
 
-    CLOSING_BODY_TAG = %r{</body>}
+    class Filter
 
-    def self.filter(controller)
-      auto_include_filter = new(controller)
-      return unless auto_include_filter.include_javascript?
+      CLOSING_BODY_TAG = %r{</body>}
 
-      auto_include_filter.include_javascript!
-    end
+      def self.filter(controller)
+        auto_include_filter = new(controller)
+        return unless auto_include_filter.include_javascript?
 
-    attr_reader :controller
+        auto_include_filter.include_javascript!
+      end
 
-    def initialize(kontroller)
-      @controller = kontroller 
-    end
+      attr_reader :controller
 
-    def include_javascript! 
-      response.body = response.body.gsub(CLOSING_BODY_TAG, intercom_script_tag.output + '\\0')
-    end
+      def initialize(kontroller)
+        @controller = kontroller 
+      end
 
-    def include_javascript?
-      !intercom_script_tag_called_manually? &&
-      html_content_type? &&
-      response_has_closing_body_tag? &&
-      intercom_script_tag.valid?
-    end
+      def include_javascript! 
+        response.body = response.body.gsub(CLOSING_BODY_TAG, intercom_script_tag.output + '\\0')
+      end
 
-    private
-    def response
-      controller.response
-    end
+      def include_javascript?
+        !intercom_script_tag_called_manually? &&
+        html_content_type? &&
+        response_has_closing_body_tag? &&
+        intercom_script_tag.valid?
+      end
 
-    def html_content_type?
-      response.content_type == 'text/html'
-    end
+      private
+      def response
+        controller.response
+      end
 
-    def response_has_closing_body_tag?
-      !!(response.body[CLOSING_BODY_TAG])
-    end
+      def html_content_type?
+        response.content_type == 'text/html'
+      end
 
-    def intercom_script_tag_called_manually?
-      controller.instance_variable_get(SCRIPT_TAG_HELPER_CALLED_INSTANCE_VARIABLE)
-    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
+
+      def intercom_script_tag
+        @script_tag ||= ScriptTag.new(:find_current_user_details => true, :find_current_company_details => true, :controller => controller)
+      end
 
-    def intercom_script_tag
-      @script_tag ||= ScriptTag.new(:find_current_user_details => true, :find_current_company_details => true, :controller => controller)
     end
 
   end

data/lib/intercom-rails/config.rb

@@ -1,39 +1,64 @@
-class Module
+require 'active_support/inflector'
 
-  def config_accessor(*args, &block)
-    config_reader(*args)
-    config_writer(*args, &block)
-  end
+module IntercomRails
+
+  class ConfigSingleton 
 
-  def config_reader(name)
-    self.send(:define_singleton_method, name) do
-      instance_variable_get("@#{name}")
+    def self.config_accessor(*args, &block)
+      config_reader(*args)
+      config_writer(*args, &block)
     end
-  end
 
-  def config_writer(name, &block)
-    self.send(:define_singleton_method, "#{name}=") do |value|
-      block.call(value) if block
-      instance_variable_set("@#{name}", value)
+    def self.config_reader(name)
+      self.send(:define_singleton_method, name) do
+        instance_variable_get("@#{name}")
+      end
     end
-  end
 
-  def config_group(name, &block)
-    camelized_name = name.to_s.split('_').map { |s| s[0].upcase + s[1..-1] }.join('')
-    group = self.const_set(camelized_name, Module.new)
+    def self.config_writer(name, &block)
+      self.send(:define_singleton_method, "#{name}=") do |value|
+        block.call(value) if block && (block.arity <= 1)
+
+        if block && (block.arity > 1)
+          field_name = underscored_class_name ? "#{underscored_class_name}.#{name}" : name
+          block.call(value, field_name) 
+        end
 
-    self.send(:define_singleton_method, name) do
-      group
+        instance_variable_set("@#{name}", value)
+      end
+    end
+
+    def self.config_group(name, &block)
+      camelized_name = name.to_s.classify
+      group = self.const_set(camelized_name, Class.new(self))
+
+      self.send(:define_singleton_method, name) do
+        group
+      end
+
+      group.send(:instance_variable_set, :@underscored_class_name, name)
+      group.instance_eval(&block)
+    end
+
+    private
+    def self.underscored_class_name
+      @underscored_class_name
     end
 
-    group.instance_eval(&block)
   end
 
-end
+  class Config < ConfigSingleton
 
-module IntercomRails
+    CUSTOM_DATA_VALIDATOR = Proc.new do |custom_data, field_name|
+      raise ArgumentError, "#{field_name} custom_data should be a hash" unless custom_data.kind_of?(Hash)
+      unless custom_data.values.all? { |value| value.kind_of?(Proc) || value.kind_of?(Symbol) }
+        raise ArgumentError, "all custom_data attributes should be either a Proc or a symbol"
+      end
+    end
 
-  module Config
+    IS_PROC_VALIDATOR = Proc.new do |value, field_name|
+      raise ArgumentError, "#{field_name} is not a proc" unless value.kind_of?(Proc)
+    end
 
     def self.reset!
       to_reset = self.constants.map {|c| const_get c}
@@ -52,42 +77,21 @@ module IntercomRails
     config_accessor :library_url
 
     config_group :user do
-      config_accessor :current do |value|
-        raise ArgumentError, "user.current should be a Proc" unless value.kind_of?(Proc)
-      end
-
-      config_accessor :model do |value|
-        raise ArgumentError, "user.model should be a Proc" unless value.kind_of?(Proc)
-      end
-
-      config_accessor :company_association do |value|
-        raise ArgumentError, "company_association should be a Proc" unless value.kind_of?(Proc)
-      end
-
-      config_accessor :custom_data do |value|
-        raise ArgumentError, "user.custom_data should be a hash" unless value.kind_of?(Hash)
-        unless value.reject { |_,v| v.kind_of?(Proc) || v.kind_of?(Symbol) }.count.zero?
-          raise ArgumentError, "all custom_data attributes should be either a Proc or a symbol"
-        end
-      end
+      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 do |value|
-        raise ArgumentError, "company.current should be a Proc" unless value.kind_of?(Proc)
-      end
-
-      config_accessor :custom_data do |value|
-        raise ArgumentError, "company.custom_data should be a hash" unless value.kind_of?(Hash)
-        unless value.reject { |_,v| v.kind_of?(Proc) || v.kind_of?(Symbol) }.count.zero?
-          raise ArgumentError, "all custom_data attributes should be either a Proc or a symbol"
-        end
-      end
+      config_accessor :current, &IS_PROC_VALIDATOR
+      config_accessor :plan, &IS_PROC_VALIDATOR 
+      config_accessor :monthly_spend, &IS_PROC_VALIDATOR
+      config_accessor :custom_data, &CUSTOM_DATA_VALIDATOR
     end
 
     config_group :inbox do
       config_accessor :counter
-
       config_accessor :style do |value|
         raise ArgumentError, "inbox.style must be one of :default or :custom" unless [:default, :custom].include?(value)
       end

data/lib/intercom-rails/proxy.rb

@@ -25,16 +25,26 @@ module IntercomRails
         standard_data.merge custom_data
       end
 
+      def standard_data
+        proxied_values = self.class.standard_data_proxy_attributes.reduce({}) do |hsh, attribute_name|
+          hsh[attribute_name] = send(attribute_name) if send(attribute_name).present?
+          hsh
+        end
+
+        configured_values = self.class.standard_data_config_attributes.reduce({}) do |hsh, attribute_name|
+          next(hsh) unless config_variable_set?(attribute_name)
+          hsh.merge(attribute_name => send(attribute_name))
+        end
+
+        proxied_values.merge(configured_values)
+      end
+
       def custom_data
         custom_data_from_config.merge custom_data_from_request
       end
 
       protected
 
-      def attribute_present?(attribute)
-        proxied_object.respond_to?(attribute) && proxied_object.send(attribute).present?
-      end
-
       def self.type
         self.class_string.downcase.to_sym
       end
@@ -51,6 +61,58 @@ module IntercomRails
         self.class.config(type_override)
       end
 
+      def config_variable_set?(variable_name)
+        config.send(variable_name).present?
+      end
+
+      def identity_present?
+        self.class.identity_attributes.any? { |attribute_name| proxied_object.respond_to?(attribute_name) && proxied_object.send(attribute_name).present? }
+      end
+
+      def self.proxy_delegator(attribute_name, options = {})
+        instance_variable_name = :"@_proxy_#{attribute_name}_delegated_value"
+        standard_data_proxy_attributes << attribute_name
+        identity_attributes << attribute_name if options[:identity]
+
+        send(:define_method, attribute_name) do
+          return nil unless proxied_object.respond_to?(attribute_name) 
+
+          current_value = instance_variable_get(instance_variable_name)
+          return current_value if current_value
+
+          value = proxied_object.send(attribute_name)
+          instance_variable_set(instance_variable_name, value)
+        end
+      end
+
+      def self.config_delegator(attribute_name)
+        instance_variable_name = :"@_config_#{attribute_name}_delegated_value"
+        standard_data_config_attributes << attribute_name
+
+        send(:define_method, attribute_name) do
+          return nil unless config.send(attribute_name).present?
+
+          current_value = instance_variable_get(instance_variable_name)
+          return current_value if current_value
+
+          getter = config.send(attribute_name)
+          value = getter.call(proxied_object)
+          instance_variable_set(instance_variable_name, value)
+        end
+      end
+
+      def self.identity_attributes
+        @_identity_attributes ||= []
+      end
+
+      def self.standard_data_proxy_attributes
+        @_standard_data_proxy_attributes ||= []
+      end
+
+      def self.standard_data_config_attributes
+        @_standard_data_config_attributes ||= []
+      end
+
       private
 
       def custom_data_from_request 

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

@@ -4,6 +4,13 @@ module IntercomRails
 
     class Company < Proxy
 
+      proxy_delegator :id, :identity => true
+      proxy_delegator :name
+      proxy_delegator :created_at
+
+      config_delegator :plan
+      config_delegator :monthly_spend
+
       def self.companies_for_user(user)
         return unless config(:user).company_association.present?
         companies = config(:user).company_association.call(user.user)
@@ -25,15 +32,7 @@ module IntercomRails
       end
 
       def valid?
-        company.present? && company.respond_to?(:id) && company.id.present?
-      end
-
-      def standard_data
-        hsh = {}
-        hsh[:id] = company.id
-        hsh[:name] = company.name if attribute_present?(:name) 
-        hsh[:created_at] = company.created_at.to_i if attribute_present?(:created_at) 
-        hsh
+        company.present? && identity_present? 
       end
 
     end

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

@@ -4,6 +4,11 @@ module IntercomRails
 
     class User < Proxy
 
+      proxy_delegator :id, :identity => true
+      proxy_delegator :email, :identity => true
+      proxy_delegator :name
+      proxy_delegator :created_at
+
       PREDEFINED_POTENTIAL_USER_OBJECTS = [
         Proc.new { current_user },
         Proc.new { @user }
@@ -31,21 +36,14 @@ module IntercomRails
       end
 
       def standard_data
-        hsh = {}
-
-        hsh[:user_id] = user.id if attribute_present?(:id) 
-        [:email, :name, :created_at].each do |attribute|
-          hsh[attribute] = user.send(attribute) if attribute_present?(attribute)
+        super.tap do |hsh|
+          hsh[:user_id] = hsh.delete(:id) if hsh.has_key?(:id)
         end
-
-        hsh
       end
 
       def valid?
         return false if user.blank? || user.respond_to?(:new_record?) && user.new_record?
-        return true if user.respond_to?(:id) && user.id.present?
-        return true if user.respond_to?(:email) && user.email.present?
-        false
+        identity_present?
       end
 
     end

data/lib/intercom-rails/railtie.rb

@@ -3,7 +3,8 @@ module IntercomRails
     initializer "intercom-rails" do |app|
       ActionView::Base.send :include, ScriptTagHelper
       ActionController::Base.send :include, CustomDataHelper
-      ActionController::Base.send :after_filter, AutoIncludeFilter
+      ActionController::Base.send :include, AutoInclude
+      ActionController::Base.after_filter, :intercom_rails_auto_include
     end
 
     rake_tasks do

data/lib/intercom-rails/version.rb

@@ -1,3 +1,3 @@
 module IntercomRails
-  VERSION = "0.2.8"
+  VERSION = "0.2.9"
 end

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

@@ -67,6 +67,19 @@ IntercomRails.config do |config|
   #   :number_of_messages => Proc.new { |app| app.messages.count },
   #   :is_interesting => :is_interesting?
   # }
+
+  # == 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
+  # This is the amount the company spends each month on your app. If your company
+  # has a plan, it will set the 'total value' of that plan appropriately.
+  #
+  # 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) }
   <%- end -%>
  
   # == Inbox Style

data/test/action_controller_test_setup.rb

@@ -11,7 +11,8 @@ end
 class ActionController::Base
 
   include IntercomRails::CustomDataHelper
-  after_filter IntercomRails::AutoIncludeFilter
+  include IntercomRails::AutoInclude
+  after_filter :intercom_rails_auto_include
 
   include TestRoutes.url_helpers
   include TestRoutes.mounted_helpers

data/test/intercom-rails/auto_include_filter_test.rb

@@ -2,6 +2,8 @@ require 'action_controller_test_setup'
 
 class TestController < ActionController::Base
 
+  skip_after_filter :intercom_rails_auto_include, :only => :with_user_instance_variable_after_filter_skipped
+
   def without_user 
     render :text => params[:body], :content_type => 'text/html'
   end
@@ -11,6 +13,10 @@ class TestController < ActionController::Base
     render :text => params[:body], :content_type => 'text/html'
   end
 
+  def with_user_instance_variable_after_filter_skipped
+    with_user_instance_variable
+  end
+
   def with_user_and_app_instance_variables
     @user = dummy_user
     @app = dummy_company
@@ -153,4 +159,9 @@ class AutoIncludeFilterTest < ActionController::TestCase
     assert_includes @response.body, "6"
   end
 
+  def test_skip_after_filter
+    get :with_user_instance_variable_after_filter_skipped, :body => "<body>Hello world</body>"
+    assert_equal @response.body, "<body>Hello world</body>"
+  end
+
 end

data/test/intercom-rails/config_test.rb

@@ -50,6 +50,15 @@ class ConfigTest < MiniTest::Unit::TestCase
     assert_equal custom_data_config, IntercomRails.config.user.custom_data
   end
 
+  def test_setting_company_custom_data
+    custom_data_config = {
+      'the_local' => Proc.new { 'club 93' }
+    }
+
+    IntercomRails.config.company.custom_data = custom_data_config
+    assert_equal custom_data_config, IntercomRails.config.company.custom_data
+  end
+
   def test_setting_inbox_style
     IntercomRails.config.inbox.style = :custom
     assert_equal :custom, IntercomRails.config.inbox.style

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-18 00:00:00.000000000 Z
+date: 2013-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -179,12 +179,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3627757893855353112
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3627757893855353112
 requirements: []
 rubyforge_project: intercom-rails
 rubygems_version: 1.8.23