ramen-rails 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cb736f36bad50e4c22b9379354fe0a1b3c9b012
-  data.tar.gz: df380aa7ae3534a9cc8d7cc31f6b0358909dc264
+  metadata.gz: 0304673a1479bb4520012e46b5b5c3bcc04b0921
+  data.tar.gz: ac116b3c00a3f5f47ddafc7d03e2e4bef8712a4d
 SHA512:
-  metadata.gz: 98def56c695d1dbac82f9855541fa8a8a3bfe4914bf68e1cbba883f3ce634223d6b68aefd488be79bfc4abce3c505e66e50c70d05d5dead10d130427deaa39a9
-  data.tar.gz: a16d8186bb9cea6f3a6fd490fd9f7aaaa1bdb3bbf99f4dc853b34b35ede18ba7f3dc400513a669e14918c06bb37c706e9e28e020800db27742e1c0fb84c6c431
+  metadata.gz: baf021f697ff2ed7a24b52feb9598a87f7180dac43ad3966186af524d5bbaa5ec02006f17689cbcff23a660547bf63e75315c8479637918c81536f9fddcb2a4c
+  data.tar.gz: bc3321d94ebc3f498492a316cdd016a452433d526bcf94dd07920afe0aa6b0eca14270cca73ae3c029c962037320ff599688034aa25ee82cbc80c0743465ca4a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ramen-rails (0.0.6)
+    ramen-rails (0.0.7)
       activesupport (~> 4.0)
 
 GEM

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

@@ -37,12 +37,20 @@ RamenRails.config do |config|
   # config.current_user_value = Proc.new { current_user_value }
 
 
-  ## How we access the current company in user. This object
-  ## must respond to #id(string), #name(string), #url(string).
-  ## It MAY respond to #value (a float)
-  ##
-  ## If config.current_user is empty, this will be ignored
+  ## Custom Links to add to the Ramen Tray
+  ## You can add up to 3. Each requires a `title`.
+  ## Each requires a `callback` or an `href`.
+  ## Links w/ `href` will have target="_blank".
+  ## Callbacks are *strings* not JS functions.
   #
-  # config.current_company = Proc.new { current_company }
-
+  # config.custom_links = [
+  #   {
+  #     title: "Submit a bug",
+  #     callback: "$('#submit_bug').modal('show')"  #<-- String!
+  #   },
+  #   {
+  #     title: "Knowledge Base",
+  #     href: "/knowedge_base"
+  #   }
+  # ]
 end

data/lib/ramen-rails/config.rb

@@ -4,7 +4,12 @@ module RamenRails
 
     class << self
 
-      attr_accessor :manual_opt_in, :return_url, :return_label
+      attr_accessor :manual_opt_in,
+        :environment,
+        :return_url,
+        :return_label,
+        :ramen_js_asset_uri,
+        :custom_links
     
       def ensure_not_lambda!(v)
         if v.lambda?

data/lib/ramen-rails/ramen_after_filter.rb

@@ -127,30 +127,10 @@ module RamenRails
       nil
     end
 
-    def ramen_company
-      return nil unless ramen_user_object
-      
-      begin
-        company = controller.instance_eval(&RamenRails.config.current_company) if RamenRails.config.current_company.present?
-      rescue NameError => e
-        Rails.logger.debug "Swallowing NameError. We're probably in an Engine or some other context like Devise."
-        Rails.logger.debug e
-
-        company = nil
-      end
-      
-      return nil unless company
-
-      obj = {}
-      [:url, :id, :value, :name].each do |attr|
-        obj[attr] = company.send(attr) if company.respond_to?(attr) &&
-          company.send(attr).present?
-      end
-    
-      obj
+    def ramen_custom_links
+      RamenRails.config.custom_links
     end
 
-
     def ramen_script_tag
       obj = {}
       obj[:organization_id] = ramen_org_id
@@ -170,8 +150,7 @@ module RamenRails
       
       obj[:user][:value] = ramen_user_value if ramen_user_value.present?
       obj[:user][:labels] = ramen_user_labels unless ramen_user_labels.nil?
-      
-      obj[:company] = ramen_company if ramen_company.present?
+      obj[:custom_links] = ramen_custom_links if ramen_custom_links.present?
 
       super(obj, organization_secret: ramen_org_secret)
     end

data/lib/ramen-rails/script_tag.rb

@@ -17,18 +17,24 @@ module RamenRails
       self.options = options
     end
 
+    def ramen_js_asset_uri
+      RamenRails.config.ramen_js_asset_uri || "https://cdn.ramen.is/assets/ramen.js"
+    end
+
     def generate
       if ramen_settings.blank?
         raise EmptySettings.new("need to pass ramen_script_tag a non-empty ramen_settings argument")
       end
 
+      ramen_settings[:timestamp] ||= Time.now.to_i
+      
       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>
+  <script src="#{ramen_js_asset_uri}" async></script>
       RAMEN_SCRIPT
 
       if controller
@@ -46,11 +52,7 @@ module RamenRails
 
       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
+      secret_string = "#{user[:email]}:#{user[:id]}:#{user[:name]}:#{ramen_settings[:timestamp]}:#{options[:organization_secret]}"
 
       ramen_settings[:auth_hash] = (Digest::SHA2.new << secret_string).to_s
     end

data/lib/ramen-rails/version.rb

@@ -1,3 +1,3 @@
 module RamenRails
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/ramen-rails.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Ryan Angilly"]
   s.email       = ["ryan@ramen.is"]
   s.homepage    = "https://ramen.is"
-  s.summary     = %q{Rails gem for Ramen}
-  s.description = %q{Ramen helps B2B SaaS product teams build better products through workflow-enhance customer development}
+  s.summary     = %q{Rails gem for Ramen (https://ramen.is)}
+  s.description = %q{Ramen helps B2B SaaS product teams build better products through workflow-enhanced customer development}
 
 
   s.add_development_dependency "actionpack", "~>4.0"

data/spec/lib/config_spec.rb

@@ -4,7 +4,6 @@ describe "RamenRails::Config" do
 
   before :each do
     @user = Hashie::Mash.new(name: 'Ryan', email: 'ryan@ramen.is', id: '1234')
-    @company = Hashie::Mash.new(name: 'Scrubber', url: 'http://scrubber.social', id: 'comp-1234')
     @organization_id = rand(1_000_000)
     @organization_secret = rand(1_000_000)
   end
@@ -14,14 +13,11 @@ describe "RamenRails::Config" do
       config.organization_id = @organization_id
       config.organization_secret = @organization_secret
       config.current_user = Proc.new { @user }
-      config.current_company = Proc.new { @company }
     end
 
     expect(instance_eval(&RamenRails.config.current_user).id).to eq('1234')
-    expect(instance_eval(&RamenRails.config.current_company).id).to eq('comp-1234')
     
     expect(RamenRails.config.current_user.call.id).to eq('1234')
-    expect(RamenRails.config.current_company.call.id).to eq('comp-1234')
     expect(RamenRails.config.organization_id).to eq(@organization_id)
     expect(RamenRails.config.organization_secret).to eq(@organization_secret)
   end

data/spec/lib/ramen_after_filter_spec.rb

@@ -5,13 +5,13 @@ describe 'After filter' do
   before :each do
     @dummy = Hashie::Mash.new({
       request: {
-        original_url: "http://hiryan.com",
-      },
+      original_url: "http://hiryan.com",
+    },
 
-      response: {
-        content_type: 'text/html',
-        body: "<html><body>hi</body>"
-      }
+    response: {
+      content_type: 'text/html',
+      body: "<html><body>hi</body>"
+    }
     })
   end
 
@@ -45,19 +45,57 @@ describe 'After filter' 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 include("hiryan.com")
           expect(@dummy.response.body).to_not include("company")
+          expect(@dummy.response.body).to_not include("custom_links")
+        end
+      end
+
+      context "and custom links" do
+        before :each do
+          RamenRails.config do |c|
+            c.custom_links = [
+              {
+              title: "Submit a bug",
+              callback: "$('#submit_bug').modal('show')"
+            },
+
+              {
+              title: "Knowledge Base",
+              href: "/knowedge_base"
+            }
+            ]
+          end
+        end
+
+        it "should attach tag" do
+          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 include("hiryan.com")
+            expect(@dummy.response.body).to_not include("company")
+            expect(@dummy.response.body).to include("custom_links")
+          end
+
         end
       end
 
-      describe "and a company" do
+      context "and a company" do
         before :each do
           RamenRails.config do |c|
             c.current_company = Proc.new { Hashie::Mash.new(name: 'Scrubber', url: 'https://scrubber.social') }
@@ -65,7 +103,7 @@ describe 'After filter' do
           end
         end
 
-        it "should attach user & company" do
+        pending "should attach user & company" do
           filter = RamenRails::RamenAfterFilter.filter(@dummy)
           expect(@dummy.response.body).to include("script")
           expect(@dummy.response.body).to include("Angilly")

data/spec/lib/script_tag_helper_spec.rb

@@ -46,26 +46,62 @@ describe 'Script Tag Helper' do
   end
 
   it "should calculate auth_hash correctly" do
+    ts = Time.now.to_i
     ramen_settings = {
       organization_id: rand(1_000_000),
       user: {
         email: 'ryan@ramen.is',
         name: 'Ryan Angilly',
         id: '346656'
-      }
+      },
+      timestamp: ts
     }
 
     options = {organization_secret: "1234"}
 
-    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("https://cdn.ramen.is/assets/ramen.js")
     expect(output).to include("Ryan Angilly")
     expect(output).to include("auth_hash")
     expect(output).to include(auth_hash)
   end
 
+  context "with a changed asset config" do
+    before :each do
+      @js_uri = "http://cdn.ramen.dev/assets/ramen.js"
+      RamenRails.config do |c|
+        c.ramen_js_asset_uri = @js_uri
+      end
+    end
+    
+    it "should calculate auth_hash correctly" do
+      ts = Time.now.to_i
+      ramen_settings = {
+        organization_id: rand(1_000_000),
+        user: {
+          email: 'ryan@ramen.is',
+          name: 'Ryan Angilly',
+          id: '346656'
+        },
+        timestamp: ts
+      }
+
+      options = {organization_secret: "1234"}
+
+      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(@js_uri)
+      expect(output).to include("Ryan Angilly")
+      expect(output).to include("auth_hash")
+      expect(output).to include(auth_hash)
+    end
+  end
+
   it "should work timestamp into hash if provided" do
     ts = Time.now.to_i
     ramen_settings = {
@@ -105,14 +141,11 @@ describe 'Script Tag Helper' do
 
     options = {organization_secret: "1234"}
 
-    auth_hash = (Digest::SHA2.new << "ryan@ramen.is:346656:Ryan Angilly: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).to include("hello")
-    expect(output).to_not include(auth_hash)
 
     expect(@template.controller.instance_variable_get(RamenRails::SCRIPT_TAG_HELPER_CALLED_INSTANCE_VARIABLE)).to eq(true)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ramen-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Ryan Angilly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-03 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: Ramen helps B2B SaaS product teams build better products through workflow-enhance
+description: Ramen helps B2B SaaS product teams build better products through workflow-enhanced
   customer development
 email:
 - ryan@ramen.is
@@ -146,7 +146,7 @@ rubyforge_project: ramen-rails
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Rails gem for Ramen
+summary: Rails gem for Ramen (https://ramen.is)
 test_files:
 - spec/lib/config_spec.rb
 - spec/lib/ramen_after_filter_spec.rb