jirafe 0.7.0 → 0.8.0

data/lib/jirafe.rb

@@ -14,12 +14,14 @@ end
 
 module Jirafe
   autoload :VERSION, "jirafe/version.rb"
+  autoload :LOCALES, "jirafe/locales.rb"
   autoload :Configuration, "jirafe/configuration.rb"
   autoload :Error, "jirafe/error.rb"
   autoload :ResponseParser, "jirafe/response_parser.rb"
   autoload :Model, "jirafe/model.rb"
   autoload :Asset, "jirafe/asset.rb"
   autoload :Tracker, "jirafe/tracker.rb"
+  autoload :Dashboard, "jirafe/dashboard.rb"
   module Resource
     autoload :JirafeResource, "jirafe/resource/jirafe_resource.rb"
     autoload :Version, "jirafe/resource/version.rb"

data/lib/jirafe/asset.rb

@@ -2,7 +2,7 @@ module Jirafe
   class Asset
     class << self
       def js_url_for(component, platform)
-        [base_url, component, "js", "#{platform}_namespaced_ui.js"].join("/")
+        [base_url, component, "js", "#{platform}_ui.js"].join("/")
       end
 
       def css_url_for(component, platform)

data/lib/jirafe/dashboard.rb

@@ -0,0 +1,50 @@
+module Jirafe
+  class Dashboard
+    class << self
+
+      def js_url(platform)
+        Jirafe::Asset.js_url_for(:dashboard, platform)
+      end
+
+      def css_url(platform)
+        Jirafe::Asset.css_url_for(:dashboard, platform)
+      end
+
+      def js_tag(api_token, app_id, version, locale, options = {})
+        target_id = options[:target_id] || "jirafe"
+        error_id = options[:error_id] || "messages"
+        error_html = options[:error_html] || default_error_html
+        timeout = options[:timeout] || 10000
+
+        <<-HTML
+<script type='text/javascript' defer='defer'>
+  jirafe.jQuery('##{target_id}').jirafe({
+    api_url: '#{Jirafe.config.url}',
+    api_token: '#{api_token}',
+    app_id: '#{app_id}',
+    version: '#{version}',
+    locale: '#{locale}' });
+  setTimeout(function() {
+    if ($('mod-jirafe') == undefined) {
+      $('#{error_id}').insert ("#{error_html}");
+    }
+  }, #{timeout});
+</script>
+        HTML
+      end
+
+      def default_error_html
+        <<-HTML
+        <ul class="messages">
+          <li class="error-msg">
+            We're unable to connect with the Jirafe service for the moment.
+            Please wait a few minutes and refresh this page later.
+          </li>
+        </ul>
+        HTML
+      end
+
+    end
+  end
+end
+

data/lib/jirafe/locales.rb

@@ -0,0 +1,8 @@
+module Jirafe
+  LOCALES = {
+    :english => 'en_US',
+    :french => 'fr_FR',
+    :german => 'de_DE',
+    :japanese => 'ja_JA'
+  }
+end

data/lib/jirafe/version.rb

@@ -1,3 +1,3 @@
 module Jirafe
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/spec/jirafe/asset_spec.rb

@@ -6,7 +6,7 @@ describe Jirafe::Asset do
 
     context "given a component and platform" do
       let(:component) { "dashboard" }
-      let(:platform) { "spree" }
+      let(:platform) { "spree_namespaced" }
 
       it { should == "https://test.jirafe.com/dashboard/js/spree_namespaced_ui.js" }
     end

data/spec/jirafe/dashboard_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe Jirafe::Dashboard do
+  describe ".js_url" do
+    subject { Jirafe::Dashboard.js_url(platform) }
+    let(:platform) { "spree_namespaced"}
+
+    it { should == "https://test.jirafe.com/dashboard/js/spree_namespaced_ui.js" }
+  end
+
+  describe ".css_url" do
+    subject { Jirafe::Dashboard.css_url(platform) }
+    let(:platform) { "spree"}
+
+    it { should == "https://test.jirafe.com/dashboard/css/spree_ui.css" }
+  end
+
+  describe ".js_tag" do
+    subject { Jirafe::Dashboard.js_tag(api_token, app_id, version, locale, options) }
+
+    context "given a valid API token, APP ID, platform version and locale" do
+      let(:api_token) { "MY_APP_TOKEN" }
+      let(:app_id) { 123 }
+      let(:version) { "myplatform-v1.0.1" }
+      let(:locale) { Jirafe::LOCALES[:english] }
+      let(:options) { { :error_html => "myerror" } }
+
+      let(:expected_html) do
+        <<-HTML
+<script type='text/javascript' defer='defer'>
+  jirafe.jQuery('#jirafe').jirafe({
+    api_url: 'http://api.jirafe.dev/v1',
+    api_token: 'MY_APP_TOKEN',
+    app_id: '123',
+    version: 'myplatform-v1.0.1',
+    locale: 'en_US' });
+  setTimeout(function() {
+    if ($('mod-jirafe') == undefined) {
+      $('messages').insert ("myerror");
+    }
+  }, 10000);
+</script>
+        HTML
+      end
+
+      it { should == expected_html }
+    end
+  end
+end
+

data/spec/jirafe/tracker_spec.rb

@@ -11,12 +11,12 @@ describe Jirafe::Tracker do
     subject { Jirafe::Tracker.js_tag(json_data, {:id => 'myid'}) }
 
     context "given some JSON data" do
-      let(:json_data) { { "foo" => "bar" }.to_json }
+      let(:json_data) { {}.to_json }
 
       let(:expected_html) do
         <<-HTML
 <script type='text/javascript' id='myid'>
-  var jirafe = {"baseUrl":"#{Jirafe.config.data_path}","foo":"bar"};
+  var jirafe = {"baseUrl":"#{Jirafe.config.data_path}"};
   (function(){
   var d=document,g=d.createElement('script'),s=d.getElementsByTagName('script')[0];
   g.type='text/javascript',g.defer=g.async=true;g.src=d.location.protocol+'//#{Jirafe.config.tracking_path}/jirafe.js';

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jirafe
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-17 00:00:00.000000000 Z
+date: 2012-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -225,7 +225,9 @@ files:
 - lib/jirafe/callback/events/refund.rb
 - lib/jirafe/callback/jirafe_callback.rb
 - lib/jirafe/configuration.rb
+- lib/jirafe/dashboard.rb
 - lib/jirafe/error.rb
+- lib/jirafe/locales.rb
 - lib/jirafe/model.rb
 - lib/jirafe/resource/application.rb
 - lib/jirafe/resource/jirafe_resource.rb
@@ -267,6 +269,7 @@ files:
 - spec/jirafe/callback/event_spec.rb
 - spec/jirafe/callback/events/data_helper_spec.rb
 - spec/jirafe/configuration_spec.rb
+- spec/jirafe/dashboard_spec.rb
 - spec/jirafe/jirafe_spec.rb
 - spec/jirafe/resource/application_spec.rb
 - spec/jirafe/resource/jirafe_resource_spec.rb
@@ -335,6 +338,7 @@ test_files:
 - spec/jirafe/callback/event_spec.rb
 - spec/jirafe/callback/events/data_helper_spec.rb
 - spec/jirafe/configuration_spec.rb
+- spec/jirafe/dashboard_spec.rb
 - spec/jirafe/jirafe_spec.rb
 - spec/jirafe/resource/application_spec.rb
 - spec/jirafe/resource/jirafe_resource_spec.rb