jirafe 0.1.0

data/lib/jirafe/resource/sites/period_data.rb

@@ -0,0 +1,16 @@
+module Jirafe
+  module Resource
+    module Sites
+      class PeriodData < JirafeResource
+        path "period/data"
+        parent Site
+        attributes({
+          :observe => {
+            :visits => [],
+            :carts => [],
+            :sales => []
+        }})
+      end
+    end
+  end
+end

data/lib/jirafe/resource/sites/products.rb

@@ -0,0 +1,12 @@
+module Jirafe
+  module Resource
+    module Sites
+      class Products < JirafeResource
+        path "products"
+        parent Site
+        attributes({})
+      end
+    end
+  end
+end
+

data/lib/jirafe/resource/sites/referers.rb

@@ -0,0 +1,12 @@
+module Jirafe
+  module Resource
+    module Sites
+      class Referers < JirafeResource
+        path "referers"
+        parent Site
+        attributes({})
+      end
+    end
+  end
+end
+

data/lib/jirafe/resource/sites/revenues.rb

@@ -0,0 +1,16 @@
+module Jirafe
+  module Resource
+    module Sites
+      class Revenues < JirafeResource
+        include Jirafe::Resource::TimeSeries
+        count_keys "revenue"
+
+        path "revenues"
+        parent Site
+        attributes({
+          :observe => []
+        })
+      end
+    end
+  end
+end

data/lib/jirafe/resource/sites/revenues_average.rb

@@ -0,0 +1,16 @@
+module Jirafe
+  module Resource
+    module Sites
+      class RevenuesAverage < JirafeResource
+        include Jirafe::Resource::TimeSeries
+        count_keys "rpv"
+
+        path "revenues/average"
+        parent Site
+        attributes({
+          :observe => []
+        })
+      end
+    end
+  end
+end

data/lib/jirafe/resource/sites/segments_carts.rb

@@ -0,0 +1,14 @@
+module Jirafe
+  module Resource
+    module Sites
+      class SegmentsCarts < JirafeResource
+        path "segments/carts"
+        parent Site
+        attributes({
+          :observe => [],
+          :highlights => []
+        })
+      end
+    end
+  end
+end

data/lib/jirafe/resource/sites/segments_sales.rb

@@ -0,0 +1,14 @@
+module Jirafe
+  module Resource
+    module Sites
+      class SegmentsSales < JirafeResource
+        path "segments/sales"
+        parent Site
+        attributes({
+          :observe => [:origin, :search_query, :referrer_name, :product, :category],
+          :highlights => [:increase, :decrease]
+        })
+      end
+    end
+  end
+end

data/lib/jirafe/resource/sites/total_carts.rb

@@ -0,0 +1,16 @@
+module Jirafe
+  module Resource
+    module Sites
+      class TotalCarts < JirafeResource
+        include Jirafe::Resource::TimeSeries
+        count_keys "tot_carts"
+
+        path "total/carts"
+        parent Site
+        attributes({
+          :observe => []
+        })
+      end
+    end
+  end
+end

data/lib/jirafe/resource/sites/translations.rb

@@ -0,0 +1,18 @@
+module Jirafe
+  module Resource
+    module Sites
+      class Translations < JirafeResource
+        path "sites/translations"
+        parent Application
+        attributes({
+          :sites => [],
+          :translations => []
+        })
+
+        def self.locale(application_id, locale = "en")
+          retrieve(nil, application_id, {:locale => locale})
+        end
+      end
+    end
+  end
+end

data/lib/jirafe/resource/sites/visitors_interest.rb

@@ -0,0 +1,14 @@
+module Jirafe
+  module Resource
+    module Sites
+      class VisitorsInterest < JirafeResource
+        path "visitors/interest"
+        parent Site
+        attributes({
+          :observe => []
+        })
+      end
+    end
+  end
+end
+

data/lib/jirafe/resource/sites/visits.rb

@@ -0,0 +1,16 @@
+module Jirafe
+  module Resource
+    module Sites
+      class Visits < JirafeResource
+        include Jirafe::Resource::TimeSeries
+        count_keys "visits"
+
+        path "visits"
+        parent Site
+        attributes({
+          :observe => []
+        })
+      end
+    end
+  end
+end

data/lib/jirafe/resource/status.rb

@@ -0,0 +1,19 @@
+module Jirafe
+  module Resource
+    class Status < JirafeResource
+      path "status"
+      attributes({ :status => [] })
+
+      class << self
+        def ok?
+          retrieve.status == "ok"
+        rescue => exception
+          logger.error(exception.to_s)
+          false
+        end
+      end
+    end
+  end
+end
+
+

data/lib/jirafe/resource/sync_service.rb

@@ -0,0 +1 @@
+

data/lib/jirafe/resource/time_series.rb

@@ -0,0 +1,29 @@
+module Jirafe
+  module Resource
+    module TimeSeries
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def count_keys(*keys)
+          @count_keys ||= if keys.respond_to?(:to_ary)
+            keys.to_ary || [keys]
+          else
+            [keys]
+          end
+        end
+      end
+
+      def observation_totals
+        self.class.count_keys.inject({}) do |hash, key|
+          hash[key] = observe.inject(0) do |sum, observation|
+            sum += observation[key]
+          end
+          hash
+        end
+      end
+    end
+  end
+end
+

data/lib/jirafe/resource/user.rb

@@ -0,0 +1,32 @@
+# 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
+      path "users"
+      attributes({
+        :site_id => [:identifier],
+        :description => [:create, :update],
+      })
+
+    end
+  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/resource/version.rb

@@ -0,0 +1,9 @@
+module Jirafe
+  module Resource
+    class Version < JirafeResource
+      path "version"
+      attributes({ :jirafe => [], :api => [] })
+    end
+  end
+end
+

data/spec/jirafe/callback/event_spec.rb

@@ -0,0 +1,85 @@
+require "spec_helper"
+
+describe Jirafe::Callback::Event do
+  let(:callback_class) { Jirafe::Callback::Event }
+  let(:site_id) { 1 }
+  let(:resource_prefix) { "callback_event" }
+
+  let(:cassette) { "#{resource_prefix}_post_event" }
+
+  before do
+    use_master_token
+    @query_capture = ENV['CALLTHROUGH'] ? [] : ["confirmToken=#{'a' * 16}"]
+    @server = CallbackServer.run(@query_capture, 3333)
+  end
+
+  after do
+    @server.shutdown
+  end
+
+  describe ".send" do
+    before do
+      make_request("#{cassette}_fetch_token") do
+        use_master_token
+        app = Jirafe::Resource::Application.new(:name => "test app cmb")
+        app.create
+        @site = Jirafe::Resource::Site.new(:app_id => app.identifier,
+                                          :description => "test site cmb",
+                                          :url => "http://testsitecmb.example.com",
+                                          :store_api_url =>"http://127.0.0.1:3333") # SF2 validator doesn't like 'localhost'
+        @site.parent = app
+
+        use_app_token(app)
+        @site.create
+        Jirafe::Callback::Event.establish(@site.identifier)
+        while @query_capture.empty?
+          sleep 0.1
+        end
+        @token = @query_capture.last.split("&").detect {|param| param.match(/confirmToken/) }.split("=").last
+      end
+    end
+    let(:version) { 1 }
+
+    let(:newly_created_order) do
+      Jirafe::Callback::Events::Order.new(:version => version,
+                                          :action => :create,
+                                          :identifier => 1,
+                                          :grand_total => 100.00,
+                                          :sub_total => 80.00,
+                                          :tax_amount => 20.00,
+                                          :discount_amount => 0.00,
+                                          :status => :pending)
+    end
+
+    let(:completed_order) do
+      Jirafe::Callback::Events::Order.new(:version => version + 1,
+                                          :action => :update,
+                                          :identifier => 1,
+                                          :grand_total => 100.00,
+                                          :sub_total => 80.00,
+                                          :tax_amount => 20.00,
+                                          :discount_amount => 10.00,
+                                          :status => :complete)
+    end
+
+    let(:refund) do
+      Jirafe::Callback::Events::Refund.new(:version => version + 2,
+                                          :action => :create,
+                                          :identifier => 1,
+                                          :order_identifier => 1,
+                                          :grand_total => 100.00,
+                                          :sub_total => 80.00,
+                                          :tax_amount => 20.00,
+                                          :discount_amount => 10.00)
+    end
+
+    it "sends events for processing" do
+      events = [newly_created_order, completed_order]
+      make_request(cassette) do
+        Jirafe::Callback::Event.send(@site.identifier, @token, events)
+      end
+    end
+  end
+end
+
+

data/spec/jirafe/configuration_spec.rb

@@ -0,0 +1,150 @@
+require "spec_helper"
+
+describe Jirafe::Configuration do
+  let(:instance) { Jirafe::Configuration.instance }
+
+  it "cannot be initialized again" do
+    expect {
+      Jirafe::Configuration.new
+    }.to raise_error(NoMethodError)
+  end
+
+  describe "#test" do
+    subject { instance.test }
+    after { instance.reset! }
+
+    context "the default for the test suite" do
+      it { should be_true }
+    end
+
+    context "when it is set to true" do
+      before do
+        instance.reset!
+        instance.test = true
+      end
+
+      it "should use the test url" do
+        instance.test.should be_true
+        instance.url.should == "https://test-api.jirafe.com/v1"
+        instance.callback_url.should == "https://test-data.jirafe.com"
+      end
+    end
+
+    context "when it is set to false" do
+      before do
+        instance.reset!
+        instance.test = false
+      end
+
+      it "should not change the url" do
+        instance.test.should be_false
+        instance.url.should == "https://api.jirafe.com/v1"
+        instance.callback_url.should == "https://data.jirafe.com"
+      end
+    end
+  end
+
+  describe "#content_type" do
+    subject { instance.content_type }
+
+    context "the default" do
+      it { should == "application/json" }
+    end
+  end
+
+  describe "#url" do
+    subject { instance.url }
+    before { instance.reset! }
+
+    it { should == "https://api.jirafe.com/v1"}
+
+    context "overriding the url" do
+      before { instance.url = "http://myurl" }
+      after { instance.reset! }
+
+      it { should == "http://myurl"}
+    end
+  end
+
+  describe "#callback_url" do
+    subject { instance.callback_url }
+    before { instance.reset! }
+
+    it { should == "https://data.jirafe.com"}
+
+    context "overriding the url" do
+      before { instance.callback_url = "http://myurl" }
+      after { instance.reset! }
+
+      it { should == "http://myurl"}
+    end
+  end
+
+  describe "#token" do
+    subject { instance.token }
+
+    context "when it is not set" do
+      before { instance.reset! }
+
+      it "should raise an error" do
+        expect {
+          subject
+        }.to raise_error(Jirafe::Error::MissingToken)
+      end
+    end
+
+    context "when it is set" do
+      before { instance.token = "mytoken" }
+      after { instance.reset! }
+      it { should == "mytoken" }
+    end
+  end
+
+  describe "#logger" do
+    subject { instance.logger }
+
+    context "when it is not set" do
+      it { should be_instance_of(Logger) }
+
+      context "but Rails is loaded" do
+        before do
+          class MyLogger
+            def self.logger
+              :something_constant
+            end
+          end
+          Object.const_set :Rails, MyLogger
+          instance.reset!
+        end
+
+        after do
+          Object.send :remove_const, :Rails
+        end
+
+        it { should == Rails.logger }
+      end
+    end
+
+    context "when it is set" do
+      before { instance.logger = :my_logger }
+
+      it { should == :my_logger }
+    end
+  end
+
+  describe "#reset!" do
+    before do
+      instance.url = "http://myurl"
+      instance.callback_url = "http://myurl"
+      instance.token = "123abc"
+    end
+
+    it "restores the url back the default setting" do
+      instance.reset!
+      instance.url.should == "https://api.jirafe.com/v1"
+      instance.callback_url.should == "https://data.jirafe.com"
+      expect { instance.token }.to raise_error(Jirafe::Error::MissingToken)
+    end
+  end
+end
+