jirafe 0.3.0 → 0.5.0

data/fixtures/responses/sync_reset_with_app_token.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.jirafe.dev/v1/applications/1/resources?token=secret_token
+    body:
+      encoding: US-ASCII
+      string: sites[0][description]=Test%20Site&sites[0][url]=http%3A%2F%2Fjirafe.com&sites[0][currency]=EUR&sites[0][timezone]=Europe%2FParis&sites[0][external_id]=1&sites[0][site_id]=1&users[0][email]=user%40example.com&users[0][first_name]=Test&users[0][last_name]=User
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.2
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Keep-Alive:
+      - timeout=10
+      X-Powered-By:
+      - PHP/5.3.15
+      Cache-Control:
+      - no-cache
+      Date:
+      - Wed, 12 Sep 2012 20:41:37 GMT
+      X-Debug-Token:
+      - 5050f3815203d
+    body:
+      encoding: US-ASCII
+      string: ! '{"sites":[{"site_id":1,"app_id":1,"description":"Test Site","url":"http:\/\/jirafe.com","timezone":"Europe\/Paris","currency":"EUR","external_id":"1","store_api_url":null,"store_cart_url":null}],"users":[{"email":"user@example.com","username":null,"first_name":"Test","last_name":"User","mobile_phone":null,"token":"c2785280dffad7835195b7a44829a103"}]}'
+    http_version: 
+  recorded_at: Wed, 12 Sep 2012 20:41:37 GMT
+recorded_with: VCR 2.2.4

data/lib/jirafe.rb

@@ -16,6 +16,7 @@ module Jirafe
   autoload :VERSION, "jirafe/version.rb"
   autoload :Configuration, "jirafe/configuration.rb"
   autoload :Error, "jirafe/error.rb"
+  autoload :ResponseParser, "jirafe/response_parser.rb"
   autoload :Asset, "jirafe/asset.rb"
   autoload :Tracker, "jirafe/tracker.rb"
   module Resource
@@ -58,6 +59,8 @@ module Jirafe
     autoload :JirafeCallback, "jirafe/callback/jirafe_callback.rb"
     autoload :Event, "jirafe/callback/event.rb"
     module Events
+      autoload :DataHelper, "jirafe/callback/events/data_helper.rb"
+      autoload :Item, "jirafe/callback/events/item.rb"
       autoload :Order, "jirafe/callback/events/order.rb"
       autoload :Refund, "jirafe/callback/events/refund.rb"
     end

data/lib/jirafe/callback/event.rb

@@ -23,6 +23,10 @@ module Jirafe
           check_response_for_exception(response)
           true
         end
+
+        def trust_callback?(token, confirmation_token, confirmation_hash)
+          Digest::SHA1.hexdigest(confirmation_token.to_s + token.to_s) == confirmation_hash
+        end
       end
 
       def action_map
@@ -45,11 +49,6 @@ module Jirafe
         }.to_json(*args)
       end
 
-      def initialize(attributes = {})
-        attributes.each do |attr, value|
-          self.send("#{attr}=", value) if self.respond_to?("#{attr}=")
-        end
-      end
     end
   end
 end

data/lib/jirafe/callback/events/data_helper.rb

@@ -0,0 +1,25 @@
+module Jirafe
+  module Callback
+    module Events
+      module DataHelper
+        def initialize(attributes = {})
+          attributes.each do |attr, value|
+            self.send("#{attr}=", value) if self.respond_to?("#{attr}=")
+          end
+        end
+
+        def format_amount(amount)
+          return nil if amount.nil?
+          "%01.4f" % amount
+        end
+
+        def format_discount_amount(amount)
+          return nil if amount.nil?
+          format_amount(amount.abs)
+        end
+      end
+    end
+  end
+end
+
+

data/lib/jirafe/callback/events/item.rb

@@ -0,0 +1,21 @@
+module Jirafe
+  module Callback
+    module Events
+      class Item
+        include DataHelper
+        attr_accessor :sku, :name, :price, :quantity, :category
+
+        def data
+          {
+            "sku" => sku,
+            "name" => name,
+            "price" => format_amount(price),
+            "quantity" => quantity,
+            "category" => category
+          }
+        end
+      end
+    end
+  end
+end
+

data/lib/jirafe/callback/events/order.rb

@@ -2,6 +2,7 @@ module Jirafe
   module Callback
     module Events
       class Order < Jirafe::Callback::Event
+        include DataHelper
         attr_accessor :identifier, :status, :customer, :visitor_identifier, :created_at,
           :grand_total, :sub_total, :tax_amount, :shipping_amount, :discount_amount, :items
 
@@ -34,12 +35,12 @@ module Jirafe
             "customerHash" => customer,
             "vistorId" => visitor_identifier,
             "time" => created_at || Time.now.to_i,
-            "grandTotal" => grand_total,
-            "subTotal" => sub_total,
-            "taxAmount" => tax_amount,
-            "shippingAmount" => shipping_amount,
-            "discountAmount" => discount_amount,
-            "items" => items
+            "grandTotal" => format_amount(grand_total),
+            "subTotal" => format_amount(sub_total),
+            "taxAmount" => format_amount(tax_amount),
+            "shippingAmount" => format_amount(shipping_amount),
+            "discountAmount" => format_discount_amount(discount_amount),
+            "items" => items.map { |item| item.data }
           }
         end
       end

data/lib/jirafe/callback/events/refund.rb

@@ -2,6 +2,7 @@ module Jirafe
   module Callback
     module Events
       class Refund < Jirafe::Callback::Event
+        include DataHelper
         attr_accessor :identifier, :order_identifier, :created_at,
           :grand_total, :sub_total, :tax_amount, :shipping_amount,
           :discount_amount, :items
@@ -18,12 +19,12 @@ module Jirafe
             "refundId" => identifier,
             "orderId" => order_identifier,
             "time" => created_at || Time.now.to_i,
-            "grandTotal" => grand_total,
-            "subTotal" => sub_total,
-            "taxAmount" => tax_amount
-            "shippingAmount" => shipping_amount,
-            "discountAmount" => discount_amount,
-            "items" => items
+            "grandTotal" => format_amount(grand_total),
+            "subTotal" => format_amount(sub_total),
+            "taxAmount" => format_amount(tax_amount),
+            "shippingAmount" => format_amount(shipping_amount),
+            "discountAmount" => format_discount_amount(discount_amount),
+            "items" => items.map { |item| item.data }
           }
         end
       end

data/lib/jirafe/callback/jirafe_callback.rb

@@ -2,6 +2,8 @@ module Jirafe
   module Callback
     class JirafeCallback
       include HTTParty
+      include Jirafe::ResponseParser
+
       base_uri Jirafe.config.callback_url
       format :html
       debug_output Jirafe.config.logger if ENV["DEBUG_JIRAFE"]
@@ -21,29 +23,6 @@ module Jirafe
           check_response_for_exception(response)
           true
         end
-
-        private
-
-        def check_response_for_exception(response)
-          return if (200..399).include?(response.code) # Allow any 2xx or 3xx
-          exception = case response.code.to_i
-          when 400 # NOTE: Being thrown for what should be 422's
-            Jirafe::Error::BadRequest
-          when 401
-            Jirafe::Error::Unauthorized
-          when 403
-            Jirafe::Error::Forbidden
-          when 404
-            Jirafe::Error::ResourceNotFound
-          when 405
-            Jirafe::Error::NotAllowed
-          when 500
-            Jirafe::Error::ServerError
-          else
-            Jirafe::Error::UnknownError
-          end
-          raise exception.new(response)
-        end
       end
     end
   end

data/lib/jirafe/resource/jirafe_resource.rb

@@ -2,6 +2,8 @@ module Jirafe
   module Resource
     class JirafeResource
       include HTTParty
+      include Jirafe::ResponseParser
+
       base_uri Jirafe.config.url
       format :json
       default_params :token => Jirafe.config.token
@@ -95,27 +97,6 @@ module Jirafe
           query_options = options.delete(:query) || {}
           {:query => { :token => Jirafe.config.token }.merge(query_options) }.merge(options)
         end
-
-        def check_response_for_exception(response)
-          return if (200..399).include?(response.code) # Allow any 2xx or 3xx
-          exception = case response.code.to_i
-          when 400 # NOTE: Being thrown for what should be 422's
-            Jirafe::Error::BadRequest
-          when 401
-            Jirafe::Error::Unauthorized
-          when 403
-            Jirafe::Error::Forbidden
-          when 404
-            Jirafe::Error::ResourceNotFound
-          when 405
-            Jirafe::Error::NotAllowed
-          when 500
-            Jirafe::Error::ServerError
-          else
-            Jirafe::Error::UnknownError
-          end
-          raise exception.new(response)
-        end
       end
 
       def initialize(attributes = {})

data/lib/jirafe/response_parser.rb

@@ -0,0 +1,30 @@
+module Jirafe
+  module ResponseParser
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def check_response_for_exception(response)
+        return if (200..399).include?(response.code) # Allow any 2xx or 3xx
+        exception = case response.code.to_i
+                    when 400 # NOTE: Being thrown for what should be 422's
+                      Jirafe::Error::BadRequest
+                    when 401
+                      Jirafe::Error::Unauthorized
+                    when 403
+                      Jirafe::Error::Forbidden
+                    when 404
+                      Jirafe::Error::ResourceNotFound
+                    when 405
+                      Jirafe::Error::NotAllowed
+                    when 500
+                      Jirafe::Error::ServerError
+                    else
+                      Jirafe::Error::UnknownError
+                    end
+        raise exception.new(response)
+      end
+    end
+  end
+end

data/lib/jirafe/version.rb

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

data/spec/jirafe/callback/event_spec.rb

@@ -7,9 +7,8 @@ describe Jirafe::Callback::Event do
 
   let(:cassette) { "#{resource_prefix}_post_event" }
 
-  before do
+  before :all do
     use_master_token
-    @query_capture = ENV['CALLTHROUGH'] ? [] : ["confirmToken=#{'a' * 16}"]
     @server = CallbackServer.run(@query_capture, 3333)
   end
 
@@ -17,29 +16,60 @@ describe Jirafe::Callback::Event 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.notify(@site.identifier)
-        while @query_capture.empty?
-          sleep 0.1
-        end
-        @token = @query_capture.last.split("&").detect {|param| param.match(/confirmToken/) }.split("=").last
+  before do
+    static_hash = "af5f436b948804627dc5641e309f54dc87a0f1c7"
+    @query_capture = ENV['CALLTHROUGH'] ? [] : ["confirmToken=#{'a' * 16}&hash=#{static_hash}"]
+    make_request("#{cassette}_fetch_token") do
+      use_master_token
+      app = Jirafe::Resource::Application.new(:name => "test app cmb")
+      created_app = app.create
+      @app_token = created_app.token
+      @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.notify(@site.identifier)
+      while @query_capture.empty?
+        sleep 0.1
       end
+      @confirm_token = @query_capture.last.split("&").detect {|param| param.match(/confirmToken/) }.split("=").last
+      @hash = @query_capture.last.split("&").detect {|param| param.match(/hash/) }.split("=").last
+    end
+  end
+
+  describe ".trust_callback?" do
+    subject { Jirafe::Callback::Event.trust_callback?(app_token, confirm_token, hash) }
+    let(:app_token) { @app_token }
+    let(:confirm_token) { @confirm_token }
+    let(:hash) { @hash }
+
+    context "given valid values" do
+
+      it { should be_true }
     end
+
+    context "given something that doesn't match" do
+      let(:app_token) { tokens[:invalid_token] }
+
+      it { should be_false }
+    end
+  end
+
+  describe ".send" do
     let(:version) { 1 }
 
+    let(:item) do
+      Jirafe::Callback::Events::Item.new(:sku => "1234",
+                                         :name => "Widget",
+                                         :price => 40,
+                                         :quantity => 2,
+                                         :category => "Things")
+    end
+
     let(:newly_created_order) do
       Jirafe::Callback::Events::Order.new(:version => version,
                                           :action => :create,
@@ -48,7 +78,8 @@ describe Jirafe::Callback::Event do
                                           :sub_total => 80.00,
                                           :tax_amount => 20.00,
                                           :discount_amount => 0.00,
-                                          :status => :pending)
+                                          :status => :pending,
+                                          :items => [item])
     end
 
     let(:completed_order) do
@@ -59,7 +90,8 @@ describe Jirafe::Callback::Event do
                                           :sub_total => 80.00,
                                           :tax_amount => 20.00,
                                           :discount_amount => 10.00,
-                                          :status => :complete)
+                                          :status => :complete,
+                                          :items => [item])
     end
 
     let(:refund) do
@@ -76,7 +108,7 @@ describe Jirafe::Callback::Event do
     it "sends events for processing" do
       events = [newly_created_order, completed_order]
       make_request(cassette) do
-        Jirafe::Callback::Event.send(@site.identifier, @token, events)
+        Jirafe::Callback::Event.send(@site.identifier, @confirm_token, events)
       end
     end
   end

data/spec/jirafe/callback/events/data_helper_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Jirafe::Callback::Events::DataHelper do
+  before do
+    class DataHelperTestClass
+      include Jirafe::Callback::Events::DataHelper
+    end
+  end
+
+  let(:instance) { DataHelperTestClass.new }
+
+  describe "#format_amount" do
+    subject { instance.format_amount(amount) }
+
+    context "given nil" do
+      let(:amount) { nil }
+
+      it { should be_nil }
+    end
+
+    context "given a whole number" do
+      let(:amount) { 23 }
+
+      it { should == "23.0000" }
+    end
+
+    context "given a float" do
+      let(:amount) { 12.34 }
+
+      it { should == "12.3400" }
+    end
+  end
+
+  describe "#format_discount_amount" do
+    subject { instance.format_discount_amount(amount) }
+
+    context "given nil" do
+      let(:amount) { nil }
+
+      it { should be_nil }
+    end
+
+    context "given a negative number" do
+      let(:amount) { -12.34 }
+
+      it { should == "12.3400" }
+    end
+  end
+end