jirafe 0.1.0

data/lib/jirafe/resource/jirafe_resource.rb

@@ -0,0 +1,188 @@
+module Jirafe
+  module Resource
+    class JirafeResource
+      include HTTParty
+      base_uri Jirafe.config.url
+      format :json
+      default_params :token => Jirafe.config.token
+      debug_output Jirafe.config.logger if ENV["DEBUG_JIRAFE"]
+
+      class << self
+        def logger
+          Jirafe.config.logger
+        end
+
+        def attributes(attrs = {})
+          attrs.each do |attr|
+            attr_name, options = attr
+            attr_accessor attr_name
+            if options.include?(:identifier)
+              define_method attr_name do
+                ivar = instance_variable_get("@#{attr_name}")
+                ivar.nil? ? nil : ivar.to_i
+              end
+              alias_method :identifier, attr_name
+              alias_method :identifier=, "#{attr_name}="
+            end
+          end
+          @attributes ||= attrs
+        end
+
+        def path(path = nil)
+          return Jirafe.config.url unless superclass == JirafeResource
+          @path ||= path
+          @path || raise(Jirafe::Error::MissingResourcePath)
+        end
+        alias_method :url, :path
+
+        def parent(parent = nil)
+          return nil if self == Jirafe::Resource::JirafeResource
+          @parent ||= parent
+          @parent || Jirafe::Resource::JirafeResource
+        end
+
+        def parent_path(*parent_identifiers)
+          parent.nil? ? nil : parent.resource_url(*parent_identifiers)
+        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
+
+        def list(*parent_identifiers)
+          if parent_identifiers.last.is_a?(Hash)
+            options = {:query => parent_identifiers.pop }
+            options = parent_identifiers.pop
+          end
+          response = get(resource_url(nil, *parent_identifiers), options_with_token(options || {}))
+          check_response_for_exception(response)
+          response.parsed_response.map do |item|
+            self.new(item)
+          end
+        end
+
+        def retrieve(identifier = nil, *parent_identifiers)
+          if parent_identifiers.last.is_a?(Hash)
+            options = {:query => parent_identifiers.pop }
+          end
+          response = get(resource_url(identifier, *parent_identifiers), options_with_token(options || {}))
+          check_response_for_exception(response)
+          self.new(response.parsed_response)
+        end
+
+        def create(resource)
+          resource_id, parent_identifiers = identifiers_from_resource(resource)
+          response = post(resource_url(resource_id, *parent_identifiers), options_with_token({:body => resource.attributes_for_change(:create)}))
+          check_response_for_exception(response)
+          resource.reinitialize(response.parsed_response)
+        end
+
+        def update(resource)
+          resource_id, parent_identifiers = identifiers_from_resource(resource)
+          response = put(resource_url(resource_id, parent_identifiers), options_with_token({:body => resource.attributes_for_change(:update)}))
+          check_response_for_exception(response)
+          resource.reinitalize(response.parsed_response)
+        end
+
+        private
+
+        def identifiers_from_resource(resource)
+          return [] if resource.nil? || !resource.respond_to?(:identifier)
+          [resource.identifier] + identifiers_from_resource(resource.parent)
+        end
+
+        def options_with_token(options = {})
+          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 = {})
+        reinitialize(attributes)
+      end
+
+      def reinitialize(attributes = {})
+        attributes.each do |attr, value|
+          self.send("#{attr}=", value) if self.respond_to?("#{attr}=")
+        end
+        self
+      end
+
+      def attributes
+        self.class.attributes.keys.inject({}) do |hash, attr|
+          hash[attr] = self.send(attr)
+          hash
+        end
+      end
+
+      def create
+        self.class.create(self)
+      end
+
+      def update
+        self.class.update(self)
+      end
+
+      def parent
+        if self.class.parent == Jirafe::Resource::JirafeResource
+          self.class.parent
+        else
+          @parent
+        end
+      end
+
+      def parent=(parent_instance)
+        @parent = parent_instance
+      end
+
+      def parent_resource_url
+        parent.nil? ? nil : parent.resource_url
+      end
+
+      def identifier
+      end
+
+      def resource_url
+        [parent_resource_url, self.class.path, self.identifier].compact.join("/")
+      end
+
+      def attributes_for_change(key)
+        attrs = self.class.attributes.select do |attribute|
+          self.class.attributes[attribute].include?(key)
+        end
+        attrs.keys.inject({}) do |hash, attr|
+          hash[attr] = self.send(attr)
+          hash
+        end
+      end
+
+    end
+  end
+end

data/lib/jirafe/resource/site.rb

@@ -0,0 +1,21 @@
+module Jirafe
+  module Resource
+    class Site < JirafeResource
+      path "sites"
+      parent Application
+      attributes({
+        :site_id => [:identifier],
+        :app_id => [],
+        :description => [:create, :update],
+        :url => [:create, :update],
+        :timezone => [],
+        :currency => [],
+        :external_id => [],
+        :store_api_url => [:create, :update],
+        :timezone_diff => []
+      })
+
+    end
+  end
+end
+

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

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

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

@@ -0,0 +1,17 @@
+module Jirafe
+  module Resource
+    module Sites
+      class AbandonedAverageOrderValue < JirafeResource
+        include Jirafe::Resource::TimeSeries
+        count_keys "ab_aov"
+
+        path "abandoned/average/ordervalue"
+        parent Site
+        attributes({
+          :observe => []
+        })
+      end
+    end
+  end
+end
+

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,11 @@
+module Jirafe
+  module Resource
+    module Sites
+      class CartSegmentation < JirafeResource
+        path "cart/segmentation"
+        parent Site
+        attributes({})
+      end
+    end
+  end
+end

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

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

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

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

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

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

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

@@ -0,0 +1,27 @@
+module Jirafe
+  module Resource
+    module Sites
+      class Dashboard < JirafeResource
+        path "dashboard/freebird"
+        parent Site
+        attributes({
+          :observe => {
+            :visits => [],
+            :customers => [],
+            :referrer => [],
+            :keyword => [],
+            :origin => [],
+            :product => [],
+            :category => [],
+            :abandoned_product => [],
+            :abandoned_category => [],
+            :metrics => [],
+            :carts => [],
+            :sales => []
+          },
+          :tracked_customers => []
+        })
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Jirafe
+  module Resource
+    module Sites
+      class Keywords < JirafeResource
+        path "keywords"
+        parent Site
+        attributes({})
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Jirafe
+  module Resource
+    module Sites
+      class OrdersStatus < JirafeResource
+        path "orders/status"
+        parent Site
+        attributes({
+          :ok => [],
+          :version => [],
+          :errors => []
+        })
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Jirafe
+  module Resource
+    module Sites
+      class Origins < JirafeResource
+        path "origins"
+        parent Site
+        attributes({})
+      end
+    end
+  end
+end