jirafe 0.2.0 → 0.3.0

data/lib/jirafe.rb

@@ -16,6 +16,8 @@ module Jirafe
   autoload :VERSION, "jirafe/version.rb"
   autoload :Configuration, "jirafe/configuration.rb"
   autoload :Error, "jirafe/error.rb"
+  autoload :Asset, "jirafe/asset.rb"
+  autoload :Tracker, "jirafe/tracker.rb"
   module Resource
     autoload :JirafeResource, "jirafe/resource/jirafe_resource.rb"
     autoload :Version, "jirafe/resource/version.rb"
@@ -23,6 +25,7 @@ module Jirafe
     autoload :Application, "jirafe/resource/application.rb"
     autoload :TimeSeries, "jirafe/resource/time_series.rb"
     autoload :Site, "jirafe/resource/site.rb"
+    autoload :Resources, "jirafe/resource/resources.rb"
     module Sites
       autoload :AbandonRate, "jirafe/resource/sites/abandon_rate.rb"
       autoload :AbandonedAverageOrderValue, "jirafe/resource/sites/abandoned_average_order_value.rb"

data/lib/jirafe/asset.rb

@@ -0,0 +1,19 @@
+module Jirafe
+  class Asset
+    class << self
+      def js_url_for(component, platform)
+        [base_url, component, "js", "#{platform}_namespaced_ui.js"].join("/")
+      end
+
+      def css_url_for(component, platform)
+        [base_url, component, "css", "#{platform}_ui.css"].join("/")
+      end
+
+      private
+
+      def base_url
+        Jirafe.config.assets_url
+      end
+    end
+  end
+end

data/lib/jirafe/configuration.rb

@@ -5,14 +5,20 @@ module Jirafe
     include Singleton
     DEFAULT_URL = "https://api.jirafe.com/v1"
     DEFAULT_CALLBACK_URL = "https://data.jirafe.com"
+    DEFAULT_ASSETS_URL = "https://jirafe.com"
+    DEFAULT_TRACKING_URL = "https://c.jirafe.com"
     TEST_URL = "https://test-api.jirafe.com/v1"
     TEST_CALLBACK_URL = "https://test-data.jirafe.com"
+    TEST_ASSETS_URL = "https://test.jirafe.com"
+    TEST_TRACKING_URL = "https://test-c.jirafe.com"
     DEFAULT_CONTENT_TYPE = "application/json"
-    attr_accessor :token, :url, :callback_url, :logger, :test, :content_type
+    attr_accessor :token, :url, :callback_url, :assets_url, :tracking_url, :logger, :test, :content_type
 
     def initialize
       @url = DEFAULT_URL
       @callback_url = DEFAULT_CALLBACK_URL
+      @assets_url = DEFAULT_ASSETS_URL
+      @tracking_url = DEFAULT_TRACKING_URL
       @content_type = DEFAULT_CONTENT_TYPE
       @token = nil
       @test = false
@@ -22,6 +28,8 @@ module Jirafe
       if value
         self.url = TEST_URL if url == DEFAULT_URL
         self.callback_url = TEST_CALLBACK_URL if callback_url == DEFAULT_CALLBACK_URL
+        self.assets_url = TEST_ASSETS_URL if assets_url == DEFAULT_ASSETS_URL
+        self.tracking_url = TEST_TRACKING_URL if tracking_url == DEFAULT_TRACKING_URL
       end
       @test = value == true
     end
@@ -34,9 +42,17 @@ module Jirafe
     def logger
       @logger ||= (defined?(Rails) ? Rails.logger : Logger.new(STDOUT))
     end
+
+    def tracking_path
+      uri = URI.parse(tracking_url)
+      [uri.host, uri.path].join("")
+    end
+
     def reset!
       self.url = DEFAULT_URL
       self.callback_url = DEFAULT_CALLBACK_URL
+      self.assets_url = DEFAULT_ASSETS_URL
+      self.tracking_url = DEFAULT_TRACKING_URL
       self.content_type = DEFAULT_CONTENT_TYPE
       self.token = nil
       self.test = false

data/lib/jirafe/error.rb

@@ -9,15 +9,19 @@ module Jirafe
       attr_reader :json_body
 
       def initialize(response)
-        @message = JSON.parse(response.body)["error"]["message"] rescue response.body
+        parsed_error = JSON.parse(response.body) rescue response.body
+        parsed_message = parsed_error["error"]["message"] rescue parsed_error
+        parsed_message_data = parsed_error["error"]["data"].join(', ') rescue nil
+        @message_data = JSON.parse(response.body)["error"]["data"] rescue nil
         @http_status = response.code
         @http_body = response.body
         @json_body = JSON.parse(response.body) rescue {}
+        status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+        @message = "#{status_string}#{parsed_message} #{parsed_message_data}"
       end
 
       def to_s
-        status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
-        "#{status_string}#{@message}"
+        @message
       end
     end
 

data/lib/jirafe/resource/jirafe_resource.rb

@@ -46,12 +46,6 @@ module Jirafe
         end
 
         def resource_url(identifier = nil, *parent_identifiers)
-          # puts "#{self} START"
-          # p parent_path(*parent_identifiers)
-          # p parent_identifiers
-          # p path
-          # puts "ID: #{identifier.inspect}"
-          # puts "#{self} END"
           [parent_path(*parent_identifiers), path, identifier].compact.join("/")
         end
 

data/lib/jirafe/resource/resources.rb

@@ -0,0 +1,31 @@
+module Jirafe
+  module Resource
+    class Resources < JirafeResource
+      path "resources"
+      parent Application
+      attributes({
+        :sites => [:create, :update],
+        :users => [:create, :update]
+      })
+
+      class << self
+        def sync(app_id, sites, users)
+          resource = self.new(:sites => array_to_hash(sites), :users => array_to_hash(users))
+          resource.parent = Application.new(:identifier => app_id)
+          resource.create
+        end
+
+        private
+
+        def array_to_hash(array)
+          index = 0
+          array.inject({}) do |hash, entry|
+            hash[index] = entry
+            index += 1
+            hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jirafe/resource/user.rb

@@ -1,6 +1,3 @@
-# post_users_authenticate                           POST   /v1/users/{email}/authenticate.{_format}
-# post_users_register                               POST   /v1/users/{email}/register.{_format}
-# post_users                                        POST   /v1/users.{_format}
 module Jirafe
   module Resource
     class Site < JirafeResource
@@ -14,19 +11,3 @@ module Jirafe
   end
 end
 
-
-# CREATE TABLE users (
-  # user_id SERIAL NOT NULL PRIMARY KEY,
-  # email varchar(255) NOT NULL,
-  # name varchar(64) NOT NULL,
-  # surname varchar(64),
-  # password varchar(88),
-  # salt varchar(32),
-  # confirmation_token varchar(64),
-  # is_hosted_user boolean NOT NULL DEFAULT 'f',
-  # is_confirmed boolean NOT NULL DEFAULT 'f',
-  # created_t_stamp timestamptz NOT NULL DEFAULT NOW(),
-  # updated_t_stamp timestamptz NOT NULL DEFAULT NOW(),
-  # UNIQUE (email),
-  # CONSTRAINT lowercase_emails CHECK (email !~ '[A-Z]')
-# );

data/lib/jirafe/tracker.rb

@@ -0,0 +1,24 @@
+module Jirafe
+  class Tracker
+    class << self
+
+      def js_path
+        [Jirafe.config.tracking_path, "jirafe.js"].join("/")
+      end
+
+      def js_tag(json_data = "{}", html_options = {})
+        tag_id = html_options[:id] || "jirafe_analytics"
+        <<-HTML
+<script type='text/javascript' id='#{tag_id}'>
+  var jirafe = #{json_data};
+  (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+'//#{js_path}';
+  s.parentNode.insertBefore(g, s);
+  })();
+</script>
+        HTML
+      end
+    end
+  end
+end

data/lib/jirafe/version.rb

@@ -1,3 +1,3 @@
 module Jirafe
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/jirafe/asset_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Jirafe::Asset do
+  describe ".js_url_for" do
+    subject { Jirafe::Asset.js_url_for(component, platform) }
+
+    context "given a component and platform" do
+      let(:component) { "dashboard" }
+      let(:platform) { "spree" }
+
+      it { should == "https://test.jirafe.com/dashboard/js/spree_namespaced_ui.js" }
+    end
+  end
+
+  describe ".css_url_for" do
+    subject { Jirafe::Asset.css_url_for(component, platform) }
+
+    context "given a component and platform" do
+      let(:component) { "dashboard" }
+      let(:platform) { "spree" }
+
+      it { should == "https://test.jirafe.com/dashboard/css/spree_ui.css" }
+    end
+  end
+end

data/spec/jirafe/configuration_spec.rb

@@ -27,6 +27,8 @@ describe Jirafe::Configuration do
         instance.test.should be_true
         instance.url.should == "https://test-api.jirafe.com/v1"
         instance.callback_url.should == "https://test-data.jirafe.com"
+        instance.assets_url.should == "https://test.jirafe.com"
+        instance.tracking_url.should == "https://test-c.jirafe.com"
       end
     end
 
@@ -40,6 +42,8 @@ describe Jirafe::Configuration do
         instance.test.should be_false
         instance.url.should == "https://api.jirafe.com/v1"
         instance.callback_url.should == "https://data.jirafe.com"
+        instance.assets_url.should == "https://jirafe.com"
+        instance.tracking_url.should == "https://c.jirafe.com"
       end
     end
   end
@@ -56,13 +60,13 @@ describe Jirafe::Configuration do
     subject { instance.url }
     before { instance.reset! }
 
-    it { should == "https://api.jirafe.com/v1"}
+    it { should == "https://api.jirafe.com/v1" }
 
     context "overriding the url" do
       before { instance.url = "http://myurl" }
       after { instance.reset! }
 
-      it { should == "http://myurl"}
+      it { should == "http://myurl" }
     end
   end
 
@@ -70,16 +74,51 @@ describe Jirafe::Configuration do
     subject { instance.callback_url }
     before { instance.reset! }
 
-    it { should == "https://data.jirafe.com"}
+    it { should == "https://data.jirafe.com" }
 
     context "overriding the url" do
       before { instance.callback_url = "http://myurl" }
       after { instance.reset! }
 
-      it { should == "http://myurl"}
+      it { should == "http://myurl" }
     end
   end
 
+  describe "#assets_url" do
+    subject { instance.assets_url }
+    before { instance.reset! }
+
+    it { should == "https://jirafe.com" }
+
+    context "overriding the url" do
+      before { instance.assets_url = "http://myurl" }
+      after { instance.reset! }
+
+      it { should == "http://myurl" }
+    end
+  end
+
+  describe "#tracking_url" do
+    subject { instance.tracking_url }
+    before { instance.reset! }
+
+    it { should == "https://c.jirafe.com" }
+
+    context "overriding the url" do
+      before { instance.tracking_url = "http://myurl" }
+      after { instance.reset! }
+
+      it { should == "http://myurl" }
+    end
+  end
+
+  describe "#tracking_path" do
+    subject { instance.tracking_path }
+    before { instance.tracking_url = "https://myurl.onsomedomain.com/withdir" }
+
+    it { should == "myurl.onsomedomain.com/withdir" }
+  end
+
   describe "#token" do
     subject { instance.token }
 

data/spec/jirafe/resource/resources_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe Jirafe::Resource::Resources do
+  let(:resource_class) { Jirafe::Resource::Resources }
+  let(:application_id) { 1 }
+  let(:sites) do
+    [{:description => "My Store",
+      :url => "http://mynewurl.com",
+      :currency => "EUR",
+      :timezone => "Europe/Paris",
+      :external_id => 1,
+      :site_id => 1
+    }]
+  end
+
+  let(:users) do
+    [{:email => "user@example.com",
+      :first_name => "Test",
+      :last_name => "User"
+    }]
+  end
+
+  before { use_app_token }
+
+  describe ".sync" do
+    let(:response) { make_request(cassette) { resource_class.sync(application_id, sites, users) } }
+    subject { response }
+
+    let(:cassette) { "sync_post_with_app_token" }
+
+    its(:class) { should == resource_class }
+
+    context "the sites hash" do
+      let(:site) { response.sites.first }
+
+      it "matches the updated values" do
+        site["site_id"].should == sites.first[:site_id]
+        site["description"].should == sites.first[:description]
+        site["url"].should == sites.first[:url]
+        site["store_api_url"].should be_nil
+        site["store_cart_url"].should be_nil
+      end
+    end
+
+    context "the users hash" do
+      let(:user) { response.users.first }
+
+      it "matches the updated values" do
+        user["email"].should == users.first[:email]
+        user["first_name"].should == users.first[:first_name]
+        user["last_name"].should == users.first[:last_name]
+        user["token"].should_not be_nil
+      end
+    end
+  end
+end

data/spec/jirafe/tracker_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe Jirafe::Tracker do
+  describe ".js_path" do
+    subject { Jirafe::Tracker.js_path }
+
+    it { should == "test-c.jirafe.com/jirafe.js" }
+  end
+
+  describe ".js_tag" do
+    subject { Jirafe::Tracker.js_tag(json_data, {:id => 'myid'}) }
+
+    context "given some JSON data" do
+      let(:json_data) { { "foo" => "bar" }.to_json }
+
+      let(:expected_html) do
+        <<-HTML
+<script type='text/javascript' id='myid'>
+  var jirafe = {"foo":"bar"};
+  (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+'//test-c.jirafe.com/jirafe.js';
+  s.parentNode.insertBefore(g, s);
+  })();
+</script>
+        HTML
+      end
+
+      it { should == expected_html }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jirafe
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-07 00:00:00.000000000 Z
+date: 2012-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -211,10 +211,12 @@ files:
 - fixtures/responses/site_visits_get_with_master_token.yml
 - fixtures/responses/status_get.yml
 - fixtures/responses/status_get_500.yml
+- fixtures/responses/sync_post_with_app_token.yml
 - fixtures/responses/test.yml
 - fixtures/responses/version_get.yml
 - jirafe.gemspec
 - lib/jirafe.rb
+- lib/jirafe/asset.rb
 - lib/jirafe/callback/event.rb
 - lib/jirafe/callback/events/order.rb
 - lib/jirafe/callback/events/refund.rb
@@ -223,6 +225,7 @@ files:
 - lib/jirafe/error.rb
 - lib/jirafe/resource/application.rb
 - lib/jirafe/resource/jirafe_resource.rb
+- lib/jirafe/resource/resources.rb
 - lib/jirafe/resource/site.rb
 - lib/jirafe/resource/sites/abandon_rate.rb
 - lib/jirafe/resource/sites/abandoned_average_order_value.rb
@@ -250,16 +253,18 @@ files:
 - lib/jirafe/resource/sites/visitors_interest.rb
 - lib/jirafe/resource/sites/visits.rb
 - lib/jirafe/resource/status.rb
-- lib/jirafe/resource/sync_service.rb
 - lib/jirafe/resource/time_series.rb
 - lib/jirafe/resource/user.rb
 - lib/jirafe/resource/version.rb
+- lib/jirafe/tracker.rb
 - lib/jirafe/version.rb
+- spec/jirafe/asset_spec.rb
 - spec/jirafe/callback/event_spec.rb
 - spec/jirafe/configuration_spec.rb
 - spec/jirafe/jirafe_spec.rb
 - spec/jirafe/resource/application_spec.rb
 - spec/jirafe/resource/jirafe_resource_spec.rb
+- spec/jirafe/resource/resources_spec.rb
 - spec/jirafe/resource/site_spec.rb
 - spec/jirafe/resource/sites/abandon_rate_spec.rb
 - spec/jirafe/resource/sites/abandoned_average_order_value_spec.rb
@@ -288,6 +293,7 @@ files:
 - spec/jirafe/resource/sites/visits_spec.rb
 - spec/jirafe/resource/status_spec.rb
 - spec/jirafe/resource/version_spec.rb
+- spec/jirafe/tracker_spec.rb
 - spec/spec_helper.rb
 - spec/support/callback_server.rb
 - spec/support/response_helper.rb
@@ -319,11 +325,13 @@ signing_key:
 specification_version: 3
 summary: Client for Jirafe analytics web service
 test_files:
+- spec/jirafe/asset_spec.rb
 - spec/jirafe/callback/event_spec.rb
 - spec/jirafe/configuration_spec.rb
 - spec/jirafe/jirafe_spec.rb
 - spec/jirafe/resource/application_spec.rb
 - spec/jirafe/resource/jirafe_resource_spec.rb
+- spec/jirafe/resource/resources_spec.rb
 - spec/jirafe/resource/site_spec.rb
 - spec/jirafe/resource/sites/abandon_rate_spec.rb
 - spec/jirafe/resource/sites/abandoned_average_order_value_spec.rb
@@ -352,6 +360,7 @@ test_files:
 - spec/jirafe/resource/sites/visits_spec.rb
 - spec/jirafe/resource/status_spec.rb
 - spec/jirafe/resource/version_spec.rb
+- spec/jirafe/tracker_spec.rb
 - spec/spec_helper.rb
 - spec/support/callback_server.rb
 - spec/support/response_helper.rb