jirafe 0.1.0

data/fixtures/responses/version_get.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.jirafe.dev/v1/version?token=user_master_token
+    body:
+      encoding: US-ASCII
+      string: ''
+    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, 05 Sep 2012 19:49:54 GMT
+      X-Debug-Token:
+      - 5047ace2df0e1
+    body:
+      encoding: US-ASCII
+      string: ! '{"jirafe":"0.3.0","api":"1.1"}'
+    http_version: 
+  recorded_at: Wed, 05 Sep 2012 19:49:54 GMT
+recorded_with: VCR 2.2.4

data/jirafe.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jirafe"
+
+Gem::Specification.new do |s|
+  s.name        = "jirafe"
+  s.version     = Jirafe::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jirafe, Inc."]
+  s.email       = ["support@jirafe.com"]
+  s.homepage    = "https://github.com/jirafe/jirafe-ruby-client"
+  s.summary     = %q{Client for Jirafe analytics web service}
+  s.description = %q{Client for Jirafe analytics web service}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("httparty", ">= 0.8.3")
+
+  s.add_development_dependency("webmock")
+  s.add_development_dependency("vcr")
+  s.add_development_dependency("yard")
+  s.add_development_dependency("rspec", "2.11.0")
+  s.add_development_dependency("autotest")
+  s.add_development_dependency("travis-lint")
+  s.add_development_dependency("net-http-server")
+end

data/lib/jirafe.rb

@@ -0,0 +1,64 @@
+require "httparty"
+require "logger"
+
+module Jirafe
+  VERSION = "0.1.0"
+  autoload :Configuration, "jirafe/configuration.rb"
+  autoload :Error, "jirafe/error.rb"
+  module Resource
+    autoload :JirafeResource, "jirafe/resource/jirafe_resource.rb"
+    autoload :Version, "jirafe/resource/version.rb"
+    autoload :Status, "jirafe/resource/status.rb"
+    autoload :Application, "jirafe/resource/application.rb"
+    autoload :TimeSeries, "jirafe/resource/time_series.rb"
+    autoload :Site, "jirafe/resource/site.rb"
+    module Sites
+      autoload :AbandonRate, "jirafe/resource/sites/abandon_rate.rb"
+      autoload :AbandonedAverageOrderValue, "jirafe/resource/sites/abandoned_average_order_value.rb"
+      autoload :AbandonedCarts, "jirafe/resource/sites/abandoned_carts.rb"
+      autoload :AbandonedRevenue, "jirafe/resource/sites/abandoned_revenue.rb"
+      autoload :AverageOrderValue, "jirafe/resource/sites/average_order_value.rb"
+      autoload :BouncesRate, "jirafe/resource/sites/bounces_rate.rb"
+      autoload :CartSegmentation, "jirafe/resource/sites/cart_segmentation.rb"
+      autoload :ConversionRate, "jirafe/resource/sites/conversion_rate.rb"
+      autoload :Conversions, "jirafe/resource/sites/conversions.rb"
+      autoload :Customers, "jirafe/resource/sites/customers.rb"
+      autoload :Dashboard, "jirafe/resource/sites/dashboard.rb"
+      autoload :Keywords, "jirafe/resource/sites/keywords.rb"
+      autoload :OrdersStatus, "jirafe/resource/sites/orders_status.rb"
+      autoload :Origins, "jirafe/resource/sites/origins.rb"
+      autoload :PeriodData, "jirafe/resource/sites/period_data.rb"
+      autoload :Products, "jirafe/resource/sites/products.rb"
+      autoload :Referers, "jirafe/resource/sites/referers.rb"
+      autoload :Revenues, "jirafe/resource/sites/revenues.rb"
+      autoload :RevenuesAverage, "jirafe/resource/sites/revenues_average.rb"
+      autoload :SegmentsCarts, "jirafe/resource/sites/segments_carts.rb"
+      autoload :SegmentsSales, "jirafe/resource/sites/segments_sales.rb"
+      autoload :TotalCarts, "jirafe/resource/sites/total_carts.rb"
+      autoload :Translations, "jirafe/resource/sites/translations.rb"
+      autoload :VisitorsInterest, "jirafe/resource/sites/visitors_interest.rb"
+      autoload :Visits, "jirafe/resource/sites/visits.rb"
+    end
+  end
+  module Callback
+    autoload :JirafeCallback, "jirafe/callback/jirafe_callback.rb"
+    autoload :Event, "jirafe/callback/event.rb"
+    module Events
+      autoload :Order, "jirafe/callback/events/order.rb"
+      autoload :Refund, "jirafe/callback/events/refund.rb"
+    end
+  end
+
+  def self.configure
+    yield Configuration.instance if block_given?
+    logger.info "Initialized Jirafe Client to api: #{config.url} / callbacks: #{config.callback_url}"
+  end
+
+  def self.config
+    Configuration.instance
+  end
+
+  def self.logger
+    config.logger
+  end
+end

data/lib/jirafe/callback/event.rb

@@ -0,0 +1,57 @@
+require "json"
+
+module Jirafe
+  module Callback
+    class Event < JirafeCallback
+      attr_accessor :version, :action, :data
+
+      GLOBAL_ACTION = {
+        :noop => "noop"
+      }
+
+      class << self
+        def events_url
+          "/events"
+        end
+
+        def send(site_id, token, events)
+          raise Jirafe::Error::MissingSiteId if site_id.nil?
+          response = post(events_url, {:body => {
+            "siteId" => site_id,
+            "token" => token,
+            "timestamp" => Time.now.to_i,
+            "events" => events.to_json
+          }})
+          check_response_for_exception(response)
+          true
+        end
+      end
+
+      def action_map
+        {}
+      end
+
+      def action
+        action_map[@action] || GLOBAL_ACTION[:noop]
+      end
+
+      def data
+        {}
+      end
+
+      def to_json(*args)
+        {
+          "v" => version,
+          "a" => action,
+          "d" => data
+        }.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/order.rb

@@ -0,0 +1,48 @@
+module Jirafe
+  module Callback
+    module Events
+      class Order < Jirafe::Callback::Event
+        attr_accessor :identifier, :status, :customer, :visitor_identifier, :created_at,
+          :grand_total, :sub_total, :tax_amount, :shipping_amount, :discount_amount, :items
+
+        def status_map
+          {
+            :new => "new",
+            :payment_pending => "pendingPayment",
+            :processing => "processing",
+            :complete => "complete",
+            :closed => "closed",
+            :canceled => "canceled",
+            :held => "held",
+            :payment_review => "paymentReview",
+            :unknown => "unknown"
+          }
+        end
+
+        def action_map
+          {
+            :create => "orderCreate",
+            :update => "orderUpdate",
+            :import => "orderImport"
+          }
+        end
+
+        def data
+          {
+            "orderId" => identifier,
+            "status" => status_map[status],
+            "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
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Jirafe
+  module Callback
+    module Events
+      class Refund < Jirafe::Callback::Event
+        attr_accessor :identifier, :order_identifier, :created_at,
+          :grand_total, :sub_total, :tax_amount, :shipping_amount,
+          :discount_amount, :items
+
+        def action_map
+          {
+            :create => "refundCreate",
+            :import => "refundImport",
+          }
+        end
+
+        def data
+          {
+            "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
+          }
+        end
+      end
+    end
+  end
+end

data/lib/jirafe/callback/jirafe_callback.rb

@@ -0,0 +1,50 @@
+module Jirafe
+  module Callback
+    class JirafeCallback
+      include HTTParty
+      base_uri Jirafe.config.callback_url
+      format :html
+      debug_output Jirafe.config.logger if ENV["DEBUG_JIRAFE"]
+
+      class << self
+        def logger
+          Jirafe.config.logger
+        end
+
+        def establish_callback_url
+          "/cmb"
+        end
+
+        def establish(site_id)
+          raise Jirafe::Error::MissingSiteId if site_id.nil?
+          response = post(establish_callback_url, {:body => {"siteId" => site_id }})
+          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
+end

data/lib/jirafe/configuration.rb

@@ -0,0 +1,47 @@
+require 'singleton'
+
+module Jirafe
+  class Configuration
+    include Singleton
+    DEFAULT_URL = "https://api.jirafe.com/v1"
+    DEFAULT_CALLBACK_URL = "https://data.jirafe.com"
+    TEST_URL = "https://test-api.jirafe.com/v1"
+    TEST_CALLBACK_URL = "https://test-data.jirafe.com"
+    DEFAULT_CONTENT_TYPE = "application/json"
+    attr_accessor :token, :url, :callback_url, :logger, :test, :content_type
+
+    def initialize
+      @url = DEFAULT_URL
+      @callback_url = DEFAULT_CALLBACK_URL
+      @content_type = DEFAULT_CONTENT_TYPE
+      @token = nil
+      @test = false
+    end
+
+    def test=(value)
+      if value
+        self.url = TEST_URL if url == DEFAULT_URL
+        self.callback_url = TEST_CALLBACK_URL if callback_url == DEFAULT_CALLBACK_URL
+      end
+      @test = value == true
+    end
+
+    def token
+      raise Error::MissingToken if @token.nil?
+      @token
+    end
+
+    def logger
+      @logger ||= (defined?(Rails) ? Rails.logger : Logger.new(STDOUT))
+    end
+    def reset!
+      self.url = DEFAULT_URL
+      self.callback_url = DEFAULT_CALLBACK_URL
+      self.content_type = DEFAULT_CONTENT_TYPE
+      self.token = nil
+      self.test = false
+      self.logger = nil
+    end
+  end
+end
+

data/lib/jirafe/error.rb

@@ -0,0 +1,57 @@
+module Jirafe
+  module Error
+    class JirafeError < StandardError
+    end
+    class ResourceError < JirafeError
+      attr_reader :message
+      attr_reader :http_status
+      attr_reader :http_body
+      attr_reader :json_body
+
+      def initialize(response)
+        @message = JSON.parse(response.body)["error"]["message"] rescue response.body
+        @http_status = response.code
+        @http_body = response.body
+        @json_body = JSON.parse(response.body) rescue {}
+      end
+
+      def to_s
+        status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+        "#{status_string}#{@message}"
+      end
+    end
+
+    class MissingToken < JirafeError
+    end
+
+    class MissingSiteId < JirafeError
+    end
+
+    class MissingResourcePath < JirafeError
+    end
+
+    class NotImplemented < JirafeError
+    end
+
+    class UnknownError < ResourceError
+    end
+
+    class BadRequest < ResourceError
+    end
+
+    class ResourceNotFound < ResourceError
+    end
+
+    class Forbidden < ResourceError
+    end
+
+    class Unauthorized < ResourceError
+    end
+
+    class NotAllowed < ResourceError
+    end
+
+    class ServerError < ResourceError
+    end
+  end
+end

data/lib/jirafe/resource/application.rb

@@ -0,0 +1,18 @@
+module Jirafe
+  module Resource
+    class Application < JirafeResource
+      path "applications"
+      attributes({
+        :app_id => [:identifier],
+        :name => [:create, :update],
+        :url => [:create, :update],
+        :token => [],
+      })
+
+      def sites
+        Site.list(identifier)
+      end
+
+    end
+  end
+end