ramen-rails 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a15c33ea6b27c1c50f0fd07447be2ef4292e77f6
-  data.tar.gz: e285639be89f2f6c5571a9671f662f64aeeae013
+  metadata.gz: 0ee40bc6fca9b914f2858387ecb699be14f91d46
+  data.tar.gz: 37f05f73081f823fd3abf946e348d793e76627f8
 SHA512:
-  metadata.gz: 284b8b82a0cabbeacc989c8accfd407cb42e4b01cbe45923bda932cf757f72463f56635b103edf3873a5cf0c5ba4a5aa9b8db1f7a2cfd77f1215b5f0f36196a3
-  data.tar.gz: 1e2e1d87850827365dcf385fbcf0d281cbc85f2c30b438efe4eab258e6734be743d61de152f28ba0dd4e3d012e48ea716582dc01e72ac1aa8824ca33df5ad9e1
+  metadata.gz: 55ca55c3733132e9a258c15ac87b9a22b14c90048c920e97b4fe514e45bb17a12352aa6f655c36b24596bcbac0ffabf06b0d6d7822729df80bf6b2dc7364f090
+  data.tar.gz: 67f18b37beaa3b76a892f08bd2b2ee4a25d307fd5b6d8e0121badbaf5b11a7fbdbe4a2d0d9118548dcf12922489f7a731d052cb3e492f5efd90452b71150e741

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.1.2"
+
+script: bundle exec rspec

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    ramen-rails (0.0.1)
-      activesupport
+    ramen-rails (0.0.4)
+      activesupport (~> 4.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -64,6 +64,7 @@ GEM
       rspec-support (~> 3.2.0)
     rspec-support (3.2.2)
     thread_safe (0.3.5)
+    timecop (0.7.3)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
 
@@ -71,8 +72,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack
-  hashie
-  rake
+  actionpack (~> 4.2.0)
+  hashie (~> 3.4.0)
+  rake (~> 10.4.2)
   ramen-rails!
-  rspec
+  rspec (~> 3.2.0)
+  timecop (~> 0.7.3)

data/README.md

@@ -0,0 +1,39 @@
+# ramen-rails
+[![Build Status](https://travis-ci.org/ramen-dev/ramen-rails.svg)](https://travis-ci.org/ramen-dev/ramen-rails)
+
+This is a Rails helper for [Ramen](https://ramen.is). Ramen is a product that helps
+B2B SaaS product managers build better products by given them tools to better understand
+what their customers need, and how satisfied their customers are with the results.
+
+This gem will automatically inject the `ramen.js` script tag into pages.
+
+# Installation
+Add this to your Gemfile:
+
+```
+gem "ramen-rails"
+```
+
+Then run:
+
+```
+bundle install
+```
+
+# Usage
+
+The following command will add `ramen.rb` to your `config/initializers`.
+You can get your ID and SECRET in your Ramen Management Console.
+
+```
+rails g ramen:config ORGANIZATION_ID ORGANIZATION_SECRET
+```
+
+# Thanks
+This gem was heavily inspired by the [intercom-rails](https://github.com/intercom/intercom-rails)
+gem. We <3 Intercom at Ramen. If you're looking for a nice way to have conversations
+with your customers in your web application, give them a holler.
+
+
+# License
+MIT-LICENSE for life.

data/lib/ramen-rails/railtie.rb

@@ -4,13 +4,12 @@ require 'ramen-rails/ramen_after_filter'
 module RamenRails
   class Railtie < Rails::Railtie
     initializer "ramen_rails.script_tag_helper.rb" do |app|
-      ActionView::Base.send :include,
-        ScriptTagHelper
+      ActionView::Base.send :include, ScriptTagHelper
     end
 
     initializer "ramen_rails.auto_include_filter.rb" do |app|
-      ActionController::Base.send :after_filter, 
-        RamenAfterFilter
+      ActionController::Base.send :include, AutoInclude
+      ActionController::Base.send :after_filter, :add_ramen_script_tag
     end
   end
 end

data/lib/ramen-rails/ramen_after_filter.rb

@@ -1,6 +1,13 @@
 module RamenRails
 
+  module AutoInclude
+    def add_ramen_script_tag 
+      RamenAfterFilter.filter(self)
+    end
+  end
+
   class RamenAfterFilter
+   
     include ScriptTagHelper
     CLOSING_BODY_TAG = %r{</body>}
 
@@ -118,7 +125,8 @@ module RamenRails
 
       obj = {}
       [:url, :id, :value, :name].each do |attr|
-        obj[attr] = user.send(attr) if user.respond_to?(attr) && user.send(attr).present?
+        obj[attr] = company.send(attr) if company.respond_to?(attr) &&
+          company.send(attr).present?
       end
     
       obj
@@ -129,6 +137,7 @@ module RamenRails
       obj = {}
       obj[:organization_id] = ramen_org_id
       obj[:user] = {}
+      obj[:timestamp] = Time.now.to_i
 
       user = ramen_user_object
 

data/lib/ramen-rails/script_tag.rb

@@ -0,0 +1,63 @@
+require "active_support/json"
+require "active_support/core_ext/hash/indifferent_access"
+
+module RamenRails
+  class ScriptTag
+    class EmptySettings < StandardError; end
+
+    def self.generate(template, ramen_settings, options = {})
+      st = new(template, ramen_settings, options)
+      st.generate
+    end
+
+    attr_accessor :template, :ramen_settings, :options
+    def initialize(template, ramen_settings, options = {})
+      self.template = template
+      self.ramen_settings = ramen_settings
+      self.options = options
+    end
+
+    def generate
+      if ramen_settings.blank?
+        raise EmptySettings.new("need to pass ramen_script_tag a non-empty ramen_settings argument")
+      end
+
+      add_auth_hash!
+
+      ramen_script = <<-RAMEN_SCRIPT
+  <script id="RamenSettingsScriptTag">
+    window.ramenSettings = #{ActiveSupport::JSON.encode(ramen_settings)};
+  </script>
+  <script src="https://cdn.ramen.is/assets/ramen.js" async></script>
+      RAMEN_SCRIPT
+
+      if controller
+        controller.
+          instance_variable_set(RamenRails::SCRIPT_TAG_HELPER_CALLED_INSTANCE_VARIABLE, true)
+      end
+
+      ramen_script.respond_to?(:html_safe) ? ramen_script.html_safe : ramen_script
+    end
+
+    def add_auth_hash!
+      return unless ramen_settings[:user].present? &&
+        options[:organization_secret].present? &&
+        ramen_settings[:auth_hash].blank?
+
+      user = ramen_settings[:user]
+
+      if ramen_settings[:timestamp]
+        secret_string = "#{user[:email]}:#{user[:id]}:#{user[:name]}:#{ramen_settings[:timestamp]}:#{options[:organization_secret]}"
+      else
+        secret_string = "#{user[:email]}:#{user[:id]}:#{user[:name]}:#{options[:organization_secret]}"
+      end
+
+      ramen_settings[:auth_hash] = (Digest::SHA2.new << secret_string).to_s
+    end
+
+    def controller
+      template.try :controller
+    end
+
+  end
+end

data/lib/ramen-rails/script_tag_helper.rb

@@ -1,33 +1,11 @@
-require "active_support/json"
-require "active_support/core_ext/hash/indifferent_access"
+require "ramen-rails/script_tag"
 
 module RamenRails
   SCRIPT_TAG_HELPER_CALLED_INSTANCE_VARIABLE = :@_ramen_script_tag_helper_called
 
   module ScriptTagHelper
-
-    class EmptySettings < StandardError; end
-
     def ramen_script_tag(ramen_settings, options = {})
-      if ramen_settings.blank?
-        raise EmptySettings.new("need to pass ramen_script_tag a non-empty ramen_settings argument")
-      end
-
-      if ramen_settings[:user].present? && options[:organization_secret].present? && ramen_settings[:auth_hash].blank?
-        user_details = ramen_settings[:user]
-        secret_string = "#{user_details[:email]}:#{user_details[:id]}:#{user_details[:name]}:#{options[:organization_secret]}"
-        ramen_settings[:auth_hash] = (Digest::SHA2.new << secret_string).to_s
-      end
-
-      ramen_script = <<-RAMEN_SCRIPT
-<script id="RamenSettingsScriptTag">
-  var ramenSettings = #{ActiveSupport::JSON.encode(ramen_settings)};
-</script>
-<script src="https://cdn.ramen.is/assets/ramen.js" async></script>
-      RAMEN_SCRIPT
-
-      controller.instance_variable_set(RamenRails::SCRIPT_TAG_HELPER_CALLED_INSTANCE_VARIABLE, true) if defined?(controller)
-      ramen_script.respond_to?(:html_safe) ? ramen_script.html_safe : ramen_script
+      ScriptTag.generate(self, ramen_settings, options)
     end
   end
 end

data/lib/ramen-rails/version.rb

@@ -1,3 +1,3 @@
 module RamenRails
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/ramen-rails.gemspec

@@ -13,12 +13,13 @@ Gem::Specification.new do |s|
   s.description = %q{Ramen helps B2B SaaS product teams build better products through workflow-enhance customer development}
 
 
-  s.add_development_dependency "actionpack"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "hashie"
+  s.add_development_dependency "actionpack", "~>4.0.0"
+  s.add_development_dependency "rake", "~>10.4.2"
+  s.add_development_dependency "rspec", "~>3.2.0"
+  s.add_development_dependency "hashie", "~>3.4.0"
+  s.add_development_dependency "timecop", "~>0.7.3"
 
-  s.add_dependency "activesupport"
+  s.add_dependency "activesupport", "~>4.0.0"
 
   s.rubyforge_project = "ramen-rails"
 

data/spec/lib/ramen_after_filter_spec.rb

@@ -37,10 +37,19 @@ describe 'After filter' do
       end
 
       it "should attach tag" do
-        filter = RamenRails::RamenAfterFilter.filter(@dummy)
-        expect(@dummy.response.body).to include("script")
-        expect(@dummy.response.body).to include("Angilly")
-        expect(@dummy.response.body).to_not include("company")
+        Timecop.freeze do
+          ts = Time.now.to_i
+          auth_hash = (Digest::SHA2.new << "ryan@ramen.is:person-1234:Ryan Angilly:5678").to_s
+          ts_auth_hash = (Digest::SHA2.new << "ryan@ramen.is:person-1234:Ryan Angilly:#{ts}:5678").to_s
+          
+          filter = RamenRails::RamenAfterFilter.filter(@dummy)
+          
+          expect(@dummy.response.body).to_not include(auth_hash)
+          expect(@dummy.response.body).to include(ts_auth_hash)
+          expect(@dummy.response.body).to include("script")
+          expect(@dummy.response.body).to include("Angilly")
+          expect(@dummy.response.body).to_not include("company")
+        end
       end
 
       describe "and a company" do

data/spec/lib/script_tag_helper_spec.rb

@@ -22,7 +22,7 @@ describe 'Script Tag Helper' do
   it "should raise if the script tag helper is passed a blank object" do
     expect do
       @template.ramen_script_tag({})
-    end.to raise_error(RamenRails::ScriptTagHelper::EmptySettings)
+    end.to raise_error(RamenRails::ScriptTag::EmptySettings)
   end
 
   it "should render the tag" do
@@ -66,6 +66,32 @@ describe 'Script Tag Helper' do
     expect(output).to include(auth_hash)
   end
 
+  it "should work timestamp into hash if provided" do
+    ts = Time.now.to_i
+    ramen_settings = {
+      timestamp: ts,
+      organization_id: rand(1_000_000),
+      user: {
+        email: 'ryan@ramen.is',
+        name: 'Ryan Angilly',
+        id: '346656'
+      }
+    }
+
+    options = {organization_secret: "1234"}
+
+    not_auth_hash = (Digest::SHA2.new << "ryan@ramen.is:346656:Ryan Angilly:1234").to_s
+    auth_hash = (Digest::SHA2.new << "ryan@ramen.is:346656:Ryan Angilly:#{ts}:1234").to_s
+
+    output = @template.ramen_script_tag(ramen_settings, options)
+
+    expect(output).to include("Ryan Angilly")
+    expect(output).to include("auth_hash")
+    expect(output).not_to include(not_auth_hash)
+    expect(output).to include(auth_hash)
+ 
+  end
+
   it "should not override auth_hash if it is provided" do
     ramen_settings = {
       organization_id: rand(1_000_000),

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'rspec'
 require 'ramen-rails'
 require 'hashie/mash'
+require 'timecop'
 
 RSpec.configure do |config|
 

metadata

@@ -1,85 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: ramen-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ryan Angilly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
 description: Ramen helps B2B SaaS product teams build better products through workflow-enhance
   customer development
 email:
@@ -90,9 +104,11 @@ extra_rdoc_files: []
 files:
 - ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
+- README.md
 - Rakefile
 - lib/rails/generators/ramen/config/config_generator.rb
 - lib/rails/generators/ramen/config/ramen.rb.erb
@@ -100,6 +116,7 @@ files:
 - lib/ramen-rails/config.rb
 - lib/ramen-rails/railtie.rb
 - lib/ramen-rails/ramen_after_filter.rb
+- lib/ramen-rails/script_tag.rb
 - lib/ramen-rails/script_tag_helper.rb
 - lib/ramen-rails/version.rb
 - ramen-rails.gemspec