ariadna 1.0.0

data/lib/ariadna/web_property.rb

@@ -0,0 +1,40 @@
+module Ariadna
+  class WebProperty
+
+    class << self; 
+      attr_accessor :owner 
+    end
+    
+    def self.all
+      @properties ||= create_properties
+    end
+
+    def initialize(item)
+      item.each do |k,v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+
+    def profiles
+      Delegator.new(Profile, self)
+    end
+
+    private
+
+    def self.create_properties
+      properties = Ariadna.connexion.get_url("https://www.googleapis.com/analytics/v3/management/accounts/#{@owner.id}/webproperties")
+      if (properties["totalResults"].to_i > 0)
+        create_attributes(properties["items"])
+        properties["items"].map do |property|
+          WebProperty.new(property)
+        end
+      end
+    end
+
+    def self.create_attributes(items)
+      items.first.each do |k,v|
+        attr_reader k.to_sym
+      end
+    end
+  end
+end

data/lib/ariadna.rb

@@ -0,0 +1,16 @@
+module Ariadna
+  class << self
+    attr_accessor :connexion
+  end
+end
+
+require "ariadna/version"
+require "ariadna/account"
+require "ariadna/analytics"
+require "ariadna/connexion"
+require "ariadna/delegator"
+require "ariadna/profile"
+require "ariadna/result"
+require "ariadna/error"
+require "ariadna/error_code"
+require "ariadna/web_property"

data/spec/fixtures/accounts.yml

@@ -0,0 +1,13 @@
+account_111:
+  id: 111
+  name: 'name'
+  selfLink: 'www.example.com/self/111'
+  childLink:
+    href: 'www.example.com/child/111'
+
+account_222:
+  id: 222
+  name: 'name 222'
+  selfLink: 'www.example.com/self/222'
+  childLink:
+    href: 'https://www.googleapis.com/analytics/v3/management/accounts/111/webproperties/909090'    

data/spec/fixtures/errors.yml

@@ -0,0 +1,11 @@
+invalid_request_error:
+  error:
+    errors:
+      -
+        domain:       "global"
+        reason:       "invalidParameter"
+        message:      "Invalid value '-1' for max-results. Value must be within the range: [1, 1000]"
+        locationType: "parameter"
+        location:     "max-results"
+    code:    400
+    message: "Invalid value '-1' for max-results. Value must be within the range: [1, 1000]"

data/spec/fixtures/profiles.yml

@@ -0,0 +1,45 @@
+profile:
+  id:                           123456
+  kind:                         'analytics#profile'
+  selfLink:                     'selfLink'
+  accountId:                    111
+  webPropertyId:                909090
+  internalWebPropertyId:        4321432
+  name:                         'profile_name'
+  currency:                     'EUR'
+  timezone:                     'GMT'
+  defaultPage:                  'index.html'
+  excludeQueryParameters:       's'
+  siteSearchQueryParameters:    's,search'
+  siteSearchCategoryParameters: 'cat'
+  created:                      Date.today
+  updated:                      Date.today
+  parentLink:
+    type: 'analytics#webProperty'
+    href: 'https://www.googleapis.com/analytics/v3/management/accounts/111/webproperties/909090'
+  childLink:
+    type: 'analytics#goals'
+    href: 'https://www.googleapis.com/analytics/v3/management/accounts/111/webproperties/909090/profiles/123456/goals'
+
+profile2:
+  id:                           654321
+  kind:                         'analytics#profile'
+  selfLink:                     'selfLink'
+  accountId:                    111
+  webPropertyId:                909090
+  internalWebPropertyId:        4321432
+  name:                         'profile_name'
+  currency:                     'EUR'
+  timezone:                     'GMT'
+  defaultPage:                  ''
+  excludeQueryParameters:       ''
+  siteSearchQueryParameters:    ''
+  siteSearchCategoryParameters: ''
+  created:                      Date.today
+  updated:                      Date.today
+  parentLink:
+    type: 'analytics#webProperty'
+    href: 'https://www.googleapis.com/analytics/v3/management/accounts/111/webproperties/909090'
+  childLink:
+    type: 'analytics#goals'
+    href: 'https://www.googleapis.com/analytics/v3/management/accounts/111/webproperties/909090/profiles/654321/goals'    

data/spec/fixtures/results.yml

@@ -0,0 +1,51 @@
+result:
+  kind: "analytics#gaData"
+  id:   "https://www.googleapis.com/analytics/v3/data/ga?ids=ga:1174&dimensions=ga:country&metrics=ga:visits&sort=-ga:visits&start-date=2010-04-01&end-date=2010-04-20&max-results=5"
+  query: 
+    start-date: "2010-04-01"
+    end-date: "2010-04-20"
+    ids: "ga:1174"
+    dimensions: "ga:country"
+    metrics: "ga:visits"
+    sort: "-ga:visits"
+    max-results: 5
+    start-index: 1
+  itemsPerPage: 5
+  totalResults: 201
+  selfLink: "https://www.googleapis.com/analytics/v3/data/ga?ids=ga:1174&dimensions=ga:country&metrics=ga:visits&sort=-ga:visits&start-date=2010-04-01&end-date=2010-04-20&max-results=5"
+  nextLink: "https://www.googleapis.com/analytics/v3/data/ga?ids=ga:1174&dimensions=ga:country&metrics=ga:visits&sort=-ga:visits&start-date=2010-04-01&end-date=2010-04-20&start-index=6&max-results=5"
+  profileInfo:
+    profileId: "1174"
+    accountId: "30481"
+    webPropertyId: "UA-30481-1"
+    internalWebPropertyId: "3516338"
+    profileName: "www.googlestore.com - goals & ecomm"
+    tableId: "ga:1174"
+  containsSampledData: false
+  columnHeaders:
+    -
+      name: "ga:country"
+      columnType: "DIMENSION"
+      dataType: "STRING"
+    -
+      name: "ga:visits"
+      columnType: "METRIC"
+      dataType: "INTEGER"
+  totalsForAllResults:
+    "ga:visits": "241543"
+  rows:
+    - 
+      - "United States"
+      - "94351"
+    - 
+      - "Brazil"
+      - "15826"
+    - 
+      - "Spain"
+      - "13967"
+    - 
+      - "United Kingdom"
+      - "13234"
+    - 
+      - "Germany"
+      - "11347"

data/spec/fixtures/webProperties.yml

@@ -0,0 +1,16 @@
+property:
+  id:                    909090
+  kind:                  'analytics#webProperty'
+  selfLink:              'selfLink'
+  accountId:             111
+  internalWebPropertyId: 4321432
+  name:                  'web_property_name'
+  websiteUrl:            'http://www.url.com'
+  created:               Date.today
+  updated:               Date.today
+  parentLink:
+    type: 'analytics#account'
+    href: 'https://www.googleapis.com/analytics/v3/management/accounts/111'
+  childLink:
+    type: 'analytics#profiles'
+    href: 'https://www.googleapis.com/analytics/v3/management/accounts/111/webproperties/909090/profiles'

data/spec/lib/ariadna/account_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe "Accounts" do
+  before :each do
+    @conn     = Ariadna::Analytics.new("token")
+    @accounts = @conn.accounts.all
+  end
+
+  it "uses version 3 of the api" do
+    Ariadna::Account.url.should == "https://www.googleapis.com/analytics/v3/management/accounts"
+  end
+
+  context "A new account" do
+    before :each do
+      new_account = {
+        "id"         => 43214321, 
+        "name"       => "New account", 
+        "selfLink"   => "www.example.com/self", 
+        "childLink"  => {"href"=>"www.example.com/child/43214231"}
+      }
+
+      @account = Ariadna::Account.new(new_account)
+    end
+
+    it "should map each value into attributes" do
+      @account.name.should       == "New account"
+      @account.id.should         == 43214321
+      @account.selfLink          == "www.example.com/self"
+      @account.childLink["href"] == "www.example.com/child/43214231"
+    end
+  end
+
+  context :properties do
+    before :each do
+      @properties = @accounts.first.properties.all
+    end
+
+    it "gets a list of properties" do
+      @properties.size.should == 1
+    end
+
+    it "returns a list of WebProperty objects" do
+      @properties.first.class == Ariadna::WebProperty
+    end
+  end
+end

data/spec/lib/ariadna/analytics_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe "Analytics" do
+  before :each do
+    @conn = Ariadna::Analytics.new("token")
+  end
+
+  it "creates a new connexion" do
+    Ariadna.connexion.class.should == Ariadna::FakeConnector
+  end
+
+  context :accounts do
+    before :each do
+      @accounts = @conn.accounts.all
+    end
+
+    it "gets a list of accounts" do
+      @accounts.size.should == 2
+    end
+
+    it "returns a list of Account objects" do
+      @accounts.first.class == Ariadna::Account
+    end
+  end
+end

data/spec/lib/ariadna/error_code_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe "ErrorCode" do
+  context "A new error code" do
+    before :each do
+      new_error = {
+        "error" => {
+          "errors" => [
+           {
+            "domain"       => "global",
+            "reason"       => "invalidParameter",
+            "message"      => "Invalid value '-1' for max-results. Value must be within the range: [1, 1000]",
+            "locationType" => "parameter",
+            "location"     => "max-results"
+           }
+          ],
+          "code"           => 400,
+          "message"        => "Invalid value '-1' for max-results. Value must be within the range: [1, 1000]"
+         }
+      }
+
+      @error = Ariadna::Error.new(new_error)
+      @error_code = @error.errors.first
+    end
+
+    it "should have all information mapped as attributes" do
+      @error_code.domain.should  == "global"
+      @error_code.reason.should  == "invalidParameter"
+      @error_code.message.should == "Invalid value '-1' for max-results. Value must be within the range: [1, 1000]"
+    end
+  end
+end

data/spec/lib/ariadna/error_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe "Error" do
+
+  before :each do
+    new_error = {
+      "error" => {
+        "errors" => [
+         {
+          "domain"       => "global",
+          "reason"       => "invalidParameter",
+          "message"      => "Invalid value '-1' for max-results. Value must be within the range: [1, 1000]",
+          "locationType" => "parameter",
+          "location"     => "max-results"
+         }
+        ],
+        "code"           => 400,
+        "message"        => "Invalid value '-1' for max-results. Value must be within the range: [1, 1000]"
+       }
+    }
+
+    @error = Ariadna::Error.new(new_error)
+  end
+  
+  context "when a new error is created" do
+    it "should contain an array of errors" do
+      @error.errors.size.should == 1
+    end
+
+    it "should have an error code" do
+      @error.code.should == 400
+    end
+
+    it "should have an error message" do
+      @error.message.should == "Invalid value '-1' for max-results. Value must be within the range: [1, 1000]"
+    end
+  end
+
+  context "a bad request" do
+    it "should return an error object" do
+      conn   = Ariadna::Analytics.new("token")
+      Ariadna.connexion.stub(:get_url).with("error").and_return(["bad request", @error])
+      error  = Ariadna.connexion.get_url("error")
+      
+      error[1].class.should == Ariadna::Error
+    end
+  end
+end

data/spec/lib/ariadna/profile_spec.rb

@@ -0,0 +1,67 @@
+describe "Profile" do
+  before :each do
+    conn       = Ariadna::Analytics.new("token")
+    @account   = conn.accounts.all.first
+    @property  = @account.properties.all.first
+    @profiles  = @property.profiles.all
+  end
+
+  context "A new web_property" do
+    before :each do
+      new_profile = {
+        "id"                           => 888888,
+        "kind"                         => "analytics#profile",
+        "selfLink"                     => "selfLink",
+        "accountId"                    => @account.id,
+        "webPropertyId"                => 8383,
+        "internalWebPropertyId"        => 4321432,
+        "name"                         => "web_profile_name",
+        "currency"                     => "USD",
+        "timezone"                     => "CET",
+        "defaultPage"                  => "index.html",
+        "excludeQueryParameters"       => "s",
+        "siteSearchQueryParameters"    => "",
+        "siteSearchCategoryParameters" => "",
+        "created"                      => Date.today,
+        "updated"                      => Date.today,
+        "parentLink"                   => {
+          "type" => "analytics#webProperty",
+          "href" => "parentLink"
+        },
+        "childLink"             => {
+          "type" => "analytics#goals",
+          "href" => "childLink"
+        }
+      }
+
+      @profile = Ariadna::Profile.new(new_profile)
+    end
+
+    it "should map each value into attributes" do
+      @profile.timezone.should                == "CET"
+      @profile.excludeQueryParameters.should  == "s"
+      @profile.defaultPage.should             == "index.html"
+      @profile.childLink["href"].should       == "childLink"
+    end
+  end
+
+  context :properties do
+    it "returns a list of result objects" do
+      @profiles.first.class == Ariadna::Result
+    end
+  end
+
+  context :results do
+    before :each do
+      @profile = @profiles.first
+    end
+
+    it "gets a list of profiles" do
+      @profiles.size.should == 2
+    end
+
+    it "returns a list of profiles objects" do
+      @profile.class == Ariadna::Profile
+    end
+  end
+end

data/spec/lib/ariadna/result_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe "Result" do
+  before :each do
+    conn       = Ariadna::Analytics.new("token")
+    @account   = conn.accounts.all.first
+    @property  = @account.properties.all.first
+    @profile   = @property.profiles.all.first
+    @results   = @profile.results.all
+  end
+
+  context "Results from a query" do
+    it "should save dimensions and metrics as attributes" do
+      @results.first.country.should == "United States"
+      @results.first.visits.should  == 94351
+    end
+
+    it "should save general query information" do
+      @results.first.itemsPerPage.should == 5
+      @results.first.query["start-date"].should == "2010-04-01"
+    end
+
+    it "should return data" do
+      @results.size.should == 5
+    end
+
+    it "returns an array of results objects" do
+      @results.first.class.should == Ariadna::Result
+    end
+  end
+
+  context "generates a url following google api rules" do
+
+    before :each do
+      @profile.results.select(
+        :metrics    => [:visits, :bounces, :timeOnSite],
+        :dimensions => [:country]
+      )
+      .where(
+        :start_date => Date.today,
+        :end_date   => Date.today,
+        :browser    => "==Firefox"
+      )
+      .limit(100)
+      .offset(40)
+      .order([:visits, :bounces])
+      .all
+    end
+
+    it "should include google api v3" do
+      Ariadna::Result.url.include?("https://www.googleapis.com/analytics/v3/data/ga").should be
+    end
+
+    it "should include profile id" do
+      Ariadna::Result.url.include?("ga:#{@profile.id}").should be
+    end
+
+    it "should include start and end date" do
+      #Ariadna::Result.url.should == ""
+      Ariadna::Result.url.include?("start-date=#{Date.today.strftime("%Y-%m-%d")}").should be
+      Ariadna::Result.url.include?("end-date=#{Date.today.strftime("%Y-%m-%d")}").should be
+    end
+
+    it "should add metrics" do
+      Ariadna::Result.url.include?("metrics=ga:visits,ga:bounces,ga:timeOnSite").should be
+    end
+
+    it "should add dimensions" do
+      Ariadna::Result.url.include?("dimensions=ga:country").should be
+    end
+
+    it "should add max results" do
+      Ariadna::Result.url.include?("max-results=100").should be
+    end
+
+    it "should add an offset" do
+      Ariadna::Result.url.include?("start-index=40").should be
+    end
+
+    it "should add filters" do
+      Ariadna::Result.url.include?("filters=ga:browser%3D%3DFirefox").should be
+    end
+  end
+end

data/spec/lib/ariadna/web_property_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe "WebProperty" do
+  before :each do
+    conn        = Ariadna::Analytics.new("token")
+    @account    = conn.accounts.all.first
+    @properties = @account.properties.all
+  end
+
+  context "A new web_property" do
+    before :each do
+      new_property = {
+        "id"                    => 888888,
+        "kind"                  => "analytics#webProperty",
+        "selfLink"              => "selfLink",
+        "accountId"             => @account.id,
+        "internalWebPropertyId" => 4321432,
+        "name"                  => "web_property_name",
+        "websiteUrl"            => "http://www.url.com",
+        "created"               => Date.today,
+        "updated"               => Date.today,
+        "parentLink"            => {
+          "type" => "analytics#account",
+          "href" => "https://www.googleapis.com/analytics/v3/management/accounts/#{@account_id}"
+        },
+        "childLink"             => {
+          "type" => "analytics#profiles",
+          "href" => "https://www.googleapis.com/analytics/v3/management/accounts/#{@account_id}/webproperties/888888/profiles"
+        }
+      }
+
+      @property = Ariadna::WebProperty.new(new_property)
+    end
+
+    it "should map each value into attributes" do
+      @property.kind.should              == "analytics#webProperty"
+      @property.accountId.should         == @account.id
+      @property.selfLink.should          == "selfLink"
+      @property.childLink["href"].should == "https://www.googleapis.com/analytics/v3/management/accounts/#{@account_id}/webproperties/888888/profiles"
+    end
+  end
+
+  context :profiles do
+    before :each do
+      @profiles = @properties.first.profiles.all
+    end
+
+    it "gets a list of profiles" do
+      @profiles.size.should == 2
+    end
+
+    it "returns an array of profiles objects" do
+      @profiles.first.class == Ariadna::Profile
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'ariadna'
+
+module Ariadna
+  # The test of the api is made through an sqlite in memory database
+  # It is easier to test things than adding JSon stuff all over the place
+
+  class Analytics
+    def initialize(token, proxy_options=nil, refresh_info=nil)
+      Ariadna.connexion = FakeConnector.new(token, proxy_options, refresh_info)
+    end
+  end
+end
+
+Dir["#{File.dirname(__FILE__)}/../spec/support/*.rb"].sort.each { |ext| require ext }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

data/spec/support/fake_connector.rb

@@ -0,0 +1,55 @@
+require 'yaml'
+
+module Ariadna
+  #Sqlite3 in memoroy connector to simulate Zuora in test environments
+  class FakeConnector
+    def initialize(token, proxy_options, refresh_token_options)
+      #build_schema
+    end
+
+    def get_url(url)
+      if url.include? "data/ga"
+        load_results
+      elsif url.include? "goals"
+        #goals
+      elsif url.include? "profiles"
+        load_data('profiles')
+      elsif url.include? "webproperties"
+        load_data('webProperties')
+      elsif url.include? "accounts"
+        load_data('accounts')
+      elsif url.include? "error"
+        load_errors
+      end
+    end
+
+    private
+
+    def load_data(analytics_kind)
+      items = YAML.load_file("#{File.dirname(__FILE__)}/../../spec/fixtures/#{analytics_kind}.yml")
+      hashed_items = items.map do |name, item|
+        item
+      end
+      {
+        "kind"          => "analytics##{analytics_kind}",
+        "username"      => "string",
+        "totalResults"  => hashed_items.size,
+        "startIndex"    => 1,
+        "itemsPerPage"  => 1000,
+        "previousLink"  => "prev",
+        "nextLink"      => "next",
+        "items"         => hashed_items
+      }
+    end
+
+    def load_results
+      items = YAML.load_file("#{File.dirname(__FILE__)}/../../spec/fixtures/results.yml")
+      items.first[1]
+    end
+
+    def load_errors
+      items = YAML.load_file("#{File.dirname(__FILE__)}/../../spec/fixtures/errors.yml")
+      items.first[1]
+    end
+  end
+end