jirafe 0.1.0

data/spec/jirafe/resource/sites/visits_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe Jirafe::Resource::Sites::Visits do
+  let(:resource_class) { Jirafe::Resource::Sites::Visits }
+  let(:application_id) { 1 }
+  let(:site_id) { 1 }
+  let(:resource_prefix) { "site_visits" }
+
+  it_behaves_like "a time series resource"
+end
+

data/spec/jirafe/resource/status_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe Jirafe::Resource::Status do
+  let(:resource_class) { Jirafe::Resource::Status }
+  describe ".ok?" do
+    subject { make_request(cassette) { resource_class.ok? } }
+
+    context "when the service is up" do
+      let(:cassette) { "status_get" }
+
+      it { should be_true }
+    end
+
+    context "when the service is down" do
+      let(:cassette) { "status_get_500" }
+
+      before do
+        @original_parameters = resource_class.default_params
+        resource_class.default_params(resource_class.default_params.merge({:return => 500}))
+      end
+
+      after do
+        resource_class.default_params(@original_parameters)
+      end
+
+      it { should be_false }
+    end
+  end
+end
+
+

data/spec/jirafe/resource/version_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe Jirafe::Resource::Version do
+  let(:resource_class) { Jirafe::Resource::Version }
+
+  describe ".retrieve" do
+    subject { make_request(cassette) { resource_class.retrieve } }
+
+    let(:cassette) { "version_get" }
+    its(:class) { should == Jirafe::Resource::Version }
+    its(:jirafe) { should == "0.3.0" }
+    its(:api) { should == "1.1" }
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,58 @@
+require "rubygems"
+require "rspec"
+require "vcr"
+
+$:.push File.expand_path("../lib", __FILE__)
+require "jirafe"
+Dir[File.join(File.dirname(__FILE__), "support/shared_examples/*.rb")].each do |file|
+  load file
+end
+
+require "test_configuration"
+jirafe_test_configuration
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.before(:each) do
+    jirafe_test_configuration
+  end
+
+  def use_master_token
+    Jirafe.configure { |config| config.token = "user_master_token" }
+  end
+
+  def use_app_token(application = nil)
+    token = application ? application.token : "secret_token"
+    Jirafe.configure { |config| config.token = token }
+  end
+
+  def use_reporting_token
+    Jirafe.configure { |config| config.token = "user_reporting_app_token" }
+  end
+
+  def use_cloud_token
+    Jirafe.configure { |config| config.token = "user_cloud_app_token" }
+  end
+
+  def use_invalid_token
+    Jirafe.configure { |config| config.token = "__invalid_token__" }
+  end
+
+  def make_request(cassette)
+    record_mode = ENV["CALLTHROUGH"] ? :all : :none
+    VCR.use_cassette(cassette, :record => record_mode) do
+      yield
+    end
+  end
+
+  require "support/response_helper"
+  include ResponseHelper
+end
+require "support/callback_server"
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'fixtures/responses'
+  c.hook_into :webmock
+end
+

data/spec/support/callback_server.rb

@@ -0,0 +1,11 @@
+require 'net/http/server'
+
+class CallbackServer
+  def self.run(query_capture, port)
+    server = Net::HTTP::Server.run(:background => true, :port => port) do |request,stream|
+      query_capture << request[:uri][:query].to_s
+      [200, {'Content-Type' => 'text/plain'}, ["OK"]]
+    end
+  end
+end
+

data/spec/support/response_helper.rb

@@ -0,0 +1,31 @@
+module ResponseHelper
+  def http_ok
+    200
+  end
+
+  def http_unauthorized
+    401
+  end
+
+  def response_unauthorized
+    { "error" => { "code" => http_unauthorized, "message" => "Jirafe API authentication failed using token '__invalid_token__'." } }
+  end
+
+  def http_forbidden
+    403
+  end
+
+  def response_access_denied
+    { "error" => { "code" => http_forbidden, "message" => "Access denied." } }
+  end
+
+  def http_not_found
+    404
+  end
+
+  def response_not_found
+    { "error" => { "code" => http_not_found, "message" => "Application with id '-1' not found." } }
+  end
+
+
+end

data/spec/support/shared_examples/empty_resource.rb

@@ -0,0 +1,17 @@
+# Placeholder test for resources with no test data to exercise
+shared_examples_for "an empty resource" do
+
+  describe ".retrieve" do
+    let(:cassette) { "#{resource_prefix}_get_with_master_token" }
+    let(:request) { make_request(cassette) { resource_class.retrieve(nil, site_id, application_id) } }
+
+    context "after making a request" do
+      describe "#attributes" do
+        subject { request.attributes }
+
+        it { should == {} }
+      end
+    end
+  end
+end
+

data/spec/support/shared_examples/time_series.rb

@@ -0,0 +1,31 @@
+shared_examples_for "a time series resource" do
+
+  describe ".retrieve" do
+    let(:cassette) { "#{resource_prefix}_get_with_master_token" }
+    let(:request) { make_request(cassette) { resource_class.retrieve(nil, site_id, application_id) } }
+
+    context "after making a request" do
+      describe "#observe" do
+        subject { request.observe }
+        its(:class) { should == Array }
+        its(:length) { should > 1 }
+
+        it "has the correct keys" do
+          request.observe.first.keys.sort.should == ["hour", resource_class.count_keys].flatten.sort
+        end
+
+        it "contains parsable timestamps" do
+          request.observe.all? do |observation|
+            Date.parse(observation["hour"])
+          end
+        end
+      end
+
+      describe "#observation_totals" do
+        subject { request.observation_totals }
+
+        it { should == resource_class.count_keys.inject({}) {|hash, key| hash[key] = 0; hash } }
+      end
+    end
+  end
+end

data/spec/test_configuration.rb

@@ -0,0 +1,15 @@
+def jirafe_test_configuration
+  Jirafe::Configuration.instance.reset!
+  Jirafe.configure do |config|
+    config.url = "http://api.jirafe.dev/v1"
+    config.callback_url = "http://data.jirafe.dev"
+    config.token = "user_master_token"
+    config.test = true
+    if ENV["DEBUG_JIRAFE"]
+      config.logger = $STDERR
+    else
+      config.logger = Logger.new('/dev/null')
+    end
+  end
+end
+

metadata

@@ -0,0 +1,360 @@
+--- !ruby/object:Gem::Specification
+name: jirafe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jirafe, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: travis-lint
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-http-server
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Client for Jirafe analytics web service
+email:
+- support@jirafe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .autotest
+- .gitignore
+- .rbenv-version
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fixtures/responses/application_get_with_cloud_token.yml
+- fixtures/responses/application_get_with_invalid_token.yml
+- fixtures/responses/application_get_with_master_token.yml
+- fixtures/responses/application_get_with_reporting_token.yml
+- fixtures/responses/application_post_with_app_token.yml
+- fixtures/responses/application_post_with_cloud_token.yml
+- fixtures/responses/application_post_with_invalid_token.yml
+- fixtures/responses/application_post_with_master_token.yml
+- fixtures/responses/application_post_with_master_token_blank_name.yml
+- fixtures/responses/application_post_with_master_token_dupe_name.yml
+- fixtures/responses/application_post_with_master_token_no_name.yml
+- fixtures/responses/application_post_with_reporting_token.yml
+- fixtures/responses/application_put_with_cloud_token.yml
+- fixtures/responses/application_put_with_invalid_token.yml
+- fixtures/responses/application_put_with_master_token.yml
+- fixtures/responses/application_put_with_reporting_token.yml
+- fixtures/responses/application_sites_get_with_master_token.yml
+- fixtures/responses/callback_event_post_event.yml
+- fixtures/responses/callback_event_post_event_fetch_token.yml
+- fixtures/responses/jirafe_resource_get_status_url.yml
+- fixtures/responses/jirafe_resource_get_status_url_with_query_param.yml
+- fixtures/responses/site_abandon_rate_get_with_master_token.yml
+- fixtures/responses/site_abandoned_average_ordervalue_get_with_master_token.yml
+- fixtures/responses/site_abandoned_carts_get_with_master_token.yml
+- fixtures/responses/site_abandoned_revenue_get_with_master_token.yml
+- fixtures/responses/site_average_order_value_get_with_master_token.yml
+- fixtures/responses/site_bounces_rate_get_with_master_token.yml
+- fixtures/responses/site_cart_segmentation_get_with_master_token.yml
+- fixtures/responses/site_conversion_rate_get_with_master_token.yml
+- fixtures/responses/site_conversions_get_with_master_token.yml
+- fixtures/responses/site_customers_get_with_master_token.yml
+- fixtures/responses/site_dashboard_get_with_master_token.yml
+- fixtures/responses/site_get_with_master_token.yml
+- fixtures/responses/site_keywords_get_with_master_token.yml
+- fixtures/responses/site_orders_status_get_with_master_token.yml
+- fixtures/responses/site_origins_get_with_master_token.yml
+- fixtures/responses/site_period_data_get_with_master_token.yml
+- fixtures/responses/site_post_with_app_token.yml
+- fixtures/responses/site_post_with_master_token.yml
+- fixtures/responses/site_products_get_with_master_token.yml
+- fixtures/responses/site_referers_get_with_master_token.yml
+- fixtures/responses/site_revenues_average_get_with_master_token.yml
+- fixtures/responses/site_revenues_get_with_master_token.yml
+- fixtures/responses/site_segments_carts_get_with_admin_token.yml
+- fixtures/responses/site_segments_sales_get_with_admin_token.yml
+- fixtures/responses/site_total_carts_get_with_master_token.yml
+- fixtures/responses/site_translations__get_with_master_token.yml
+- fixtures/responses/site_translations_de_get_with_master_token.yml
+- fixtures/responses/site_translations_es_get_with_master_token.yml
+- fixtures/responses/site_translations_fr_get_with_master_token.yml
+- fixtures/responses/site_translations_german_get_with_master_token.yml
+- fixtures/responses/site_translations_get_with_master_token.yml
+- fixtures/responses/site_translations_xx_get_with_master_token.yml
+- fixtures/responses/site_visits_get_with_master_token.yml
+- fixtures/responses/status_get.yml
+- fixtures/responses/status_get_500.yml
+- fixtures/responses/test.yml
+- fixtures/responses/version_get.yml
+- jirafe.gemspec
+- lib/jirafe.rb
+- lib/jirafe/callback/event.rb
+- lib/jirafe/callback/events/order.rb
+- lib/jirafe/callback/events/refund.rb
+- lib/jirafe/callback/jirafe_callback.rb
+- lib/jirafe/configuration.rb
+- lib/jirafe/error.rb
+- lib/jirafe/resource/application.rb
+- lib/jirafe/resource/jirafe_resource.rb
+- lib/jirafe/resource/site.rb
+- lib/jirafe/resource/sites/abandon_rate.rb
+- lib/jirafe/resource/sites/abandoned_average_order_value.rb
+- lib/jirafe/resource/sites/abandoned_carts.rb
+- lib/jirafe/resource/sites/abandoned_revenue.rb
+- lib/jirafe/resource/sites/average_order_value.rb
+- lib/jirafe/resource/sites/bounces_rate.rb
+- lib/jirafe/resource/sites/cart_segmentation.rb
+- lib/jirafe/resource/sites/conversion_rate.rb
+- lib/jirafe/resource/sites/conversions.rb
+- lib/jirafe/resource/sites/customers.rb
+- lib/jirafe/resource/sites/dashboard.rb
+- lib/jirafe/resource/sites/keywords.rb
+- lib/jirafe/resource/sites/orders_status.rb
+- lib/jirafe/resource/sites/origins.rb
+- lib/jirafe/resource/sites/period_data.rb
+- lib/jirafe/resource/sites/products.rb
+- lib/jirafe/resource/sites/referers.rb
+- lib/jirafe/resource/sites/revenues.rb
+- lib/jirafe/resource/sites/revenues_average.rb
+- lib/jirafe/resource/sites/segments_carts.rb
+- lib/jirafe/resource/sites/segments_sales.rb
+- lib/jirafe/resource/sites/total_carts.rb
+- lib/jirafe/resource/sites/translations.rb
+- 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
+- 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/site_spec.rb
+- spec/jirafe/resource/sites/abandon_rate_spec.rb
+- spec/jirafe/resource/sites/abandoned_average_order_value_spec.rb
+- spec/jirafe/resource/sites/abandoned_carts_spec.rb
+- spec/jirafe/resource/sites/abandoned_revenue_spec.rb
+- spec/jirafe/resource/sites/average_order_value_spec.rb
+- spec/jirafe/resource/sites/bounces_rate_spec.rb
+- spec/jirafe/resource/sites/cart_segmentation_spec.rb
+- spec/jirafe/resource/sites/conversion_rate_spec.rb
+- spec/jirafe/resource/sites/conversions_spec.rb
+- spec/jirafe/resource/sites/customers_spec.rb
+- spec/jirafe/resource/sites/dashboard_spec.rb
+- spec/jirafe/resource/sites/keywords_spec.rb
+- spec/jirafe/resource/sites/orders_status_spec.rb
+- spec/jirafe/resource/sites/origins_spec.rb
+- spec/jirafe/resource/sites/period_data_spec.rb
+- spec/jirafe/resource/sites/products_spec.rb
+- spec/jirafe/resource/sites/referers_spec.rb
+- spec/jirafe/resource/sites/revenues_average_spec.rb
+- spec/jirafe/resource/sites/revenues_spec.rb
+- spec/jirafe/resource/sites/segments_carts_spec.rb
+- spec/jirafe/resource/sites/segments_sales_spec.rb
+- spec/jirafe/resource/sites/total_carts_spec.rb
+- spec/jirafe/resource/sites/translations_spec.rb
+- spec/jirafe/resource/sites/visitors_interest_spec.rb
+- spec/jirafe/resource/sites/visits_spec.rb
+- spec/jirafe/resource/status_spec.rb
+- spec/jirafe/resource/version_spec.rb
+- spec/spec_helper.rb
+- spec/support/callback_server.rb
+- spec/support/response_helper.rb
+- spec/support/shared_examples/empty_resource.rb
+- spec/support/shared_examples/time_series.rb
+- spec/test_configuration.rb
+homepage: https://github.com/jirafe/jirafe-ruby-client
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Client for Jirafe analytics web service
+test_files:
+- 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/site_spec.rb
+- spec/jirafe/resource/sites/abandon_rate_spec.rb
+- spec/jirafe/resource/sites/abandoned_average_order_value_spec.rb
+- spec/jirafe/resource/sites/abandoned_carts_spec.rb
+- spec/jirafe/resource/sites/abandoned_revenue_spec.rb
+- spec/jirafe/resource/sites/average_order_value_spec.rb
+- spec/jirafe/resource/sites/bounces_rate_spec.rb
+- spec/jirafe/resource/sites/cart_segmentation_spec.rb
+- spec/jirafe/resource/sites/conversion_rate_spec.rb
+- spec/jirafe/resource/sites/conversions_spec.rb
+- spec/jirafe/resource/sites/customers_spec.rb
+- spec/jirafe/resource/sites/dashboard_spec.rb
+- spec/jirafe/resource/sites/keywords_spec.rb
+- spec/jirafe/resource/sites/orders_status_spec.rb
+- spec/jirafe/resource/sites/origins_spec.rb
+- spec/jirafe/resource/sites/period_data_spec.rb
+- spec/jirafe/resource/sites/products_spec.rb
+- spec/jirafe/resource/sites/referers_spec.rb
+- spec/jirafe/resource/sites/revenues_average_spec.rb
+- spec/jirafe/resource/sites/revenues_spec.rb
+- spec/jirafe/resource/sites/segments_carts_spec.rb
+- spec/jirafe/resource/sites/segments_sales_spec.rb
+- spec/jirafe/resource/sites/total_carts_spec.rb
+- spec/jirafe/resource/sites/translations_spec.rb
+- spec/jirafe/resource/sites/visitors_interest_spec.rb
+- spec/jirafe/resource/sites/visits_spec.rb
+- spec/jirafe/resource/status_spec.rb
+- spec/jirafe/resource/version_spec.rb
+- spec/spec_helper.rb
+- spec/support/callback_server.rb
+- spec/support/response_helper.rb
+- spec/support/shared_examples/empty_resource.rb
+- spec/support/shared_examples/time_series.rb
+- spec/test_configuration.rb
+has_rdoc: