ariadna 1.0.0 → 1.1.0

data/README.md

@@ -29,7 +29,7 @@ Create a new connexion with your Oauth2 access token
 Get a list of all accounts available
 
 ```ruby
-  accounts    = analytics.accounts
+  accounts    = analytics.accounts.all
 ```
 
 Get a list of all web properties available for an account
@@ -44,7 +44,7 @@ Get a list of all profiles available for a web property
   profiles    = properties.first.profiles.all
 ```
 
-Create a query with your metrics and dimensions
+Create a query with metrics and dimensions
 
 ```ruby
   results  = profile.results.select(
@@ -65,10 +65,10 @@ Create a query with your metrics and dimensions
 All the metrics and dimensions returned by the query are mapped into attributes.
 
 ```ruby
-  @results.each do |result|
+  results.each do |result|
     puts result.visits
     puts result.bounces
-    puts result.timeonsite
+    puts result.timeOnSite
     puts result.country
   end
 ```
@@ -114,7 +114,7 @@ gem 'omniauth'
 gem 'omniauth-google-oauth2'
 ```
 
-Google Oauth2 tokens have a very short life.  To make things easy if the connexion gives a 401 error and there is a refresh token passed as a param Ariadna will try to get a new access token from Google and store it in the curren user info calling update_access_token_from_google.  If you want to use this feature you must create a method in your user model that saves this token.
+Google Oauth2 tokens have a very short life.  To make things easy if the connexion gives a 401 error and there is a refresh token passed as a param Ariadna will try to get a new access token from Google and store it in the current user info calling update_access_token_from_google.  If you want to use this feature you must create a method in your user model that saves this token.
 
 ```ruby
 def update_access_token_from_google(new_token)

data/lib/ariadna.rb

@@ -10,6 +10,7 @@ require "ariadna/analytics"
 require "ariadna/connexion"
 require "ariadna/delegator"
 require "ariadna/profile"
+require "ariadna/goal"
 require "ariadna/result"
 require "ariadna/error"
 require "ariadna/error_code"

data/lib/ariadna/account.rb

@@ -2,13 +2,10 @@ module Ariadna
   class Account
 
     class << self; 
-      attr_reader :url 
       attr_accessor :owner
     end
 
-    #attr_reader :id, :link, :name, :properties_url
-
-    @url = "https://www.googleapis.com/analytics/v3/management/accounts"
+    URL = "https://www.googleapis.com/analytics/v3/management/accounts"
     
     def initialize(item)
       item.each do |k,v|
@@ -20,6 +17,14 @@ module Ariadna
       @accounts ||= create_accounts
     end
 
+    def self.find(params)
+      return [] if params.empty?
+      all.each do |account|
+        return account if get_a_match(params, account)
+      end
+      []
+    end
+
     def properties
       Delegator.new(WebProperty, self)
     end
@@ -27,7 +32,7 @@ module Ariadna
     private
 
     def self.create_accounts
-      accounts = Ariadna.connexion.get_url(self.url)
+      accounts = Ariadna.connexion.get_url(get_url)
       if (accounts["totalResults"].to_i > 0)
         create_attributes(accounts["items"])
         accounts["items"].map do |account|
@@ -41,5 +46,23 @@ module Ariadna
         attr_reader k.to_sym
       end
     end
+
+    def self.get_a_match(params, account)
+      if params[:id]
+        return true if (account.id.to_i == params[:id].to_i) 
+      end
+      if params[:name]
+        return true if account.name.downcase.include? params[:name].downcase 
+      end
+      return false
+    end
+
+    def self.get_url
+      if @account_id
+        "#{URL}/#{@account_id}"
+      else
+        URL
+      end
+    end
   end
 end

data/lib/ariadna/connexion.rb

@@ -35,7 +35,7 @@ module Ariadna
     private
 
     def extract_proxy_options(proxy_options)
-      return unless proxy_options.present?
+      return if proxy_options.empty?
       @use_proxy  = true
       @proxy_host = proxy_options[:proxy_host]
       @proxy_port = proxy_options[:proxy_port]
@@ -44,7 +44,7 @@ module Ariadna
     end
 
     def extract_refresh_info(refresh_info)
-      return unless refresh_info.present?
+      return if refresh_info.empty?
       @refresh_token = refresh_info[:refresh_token]
       @client_id     = refresh_info[:client_id]
       @client_secret = refresh_info[:client_secret]

data/lib/ariadna/profile.rb

@@ -4,8 +4,6 @@ module Ariadna
     class << self; 
       attr_accessor :owner 
     end
-
-    attr_reader :id, :link, :name, :goals, :parent
     
     def initialize(item)
       item.each do |k,v|
@@ -17,6 +15,11 @@ module Ariadna
       @profiles ||= create_profiles
     end
 
+    def self.find(id)
+      @profile_id = id
+      all.first
+    end
+
     def results
       Delegator.new(Result, self)
     end
@@ -24,7 +27,7 @@ module Ariadna
     private
 
     def self.create_profiles
-      profiles = Ariadna.connexion.get_url(@owner.childLink["href"])
+      profiles = Ariadna.connexion.get_url(get_url)
       if (profiles["totalResults"].to_i > 0)
         create_attributes(profiles["items"])
         profiles["items"].map do |item|
@@ -38,5 +41,14 @@ module Ariadna
         attr_reader k.to_sym
       end
     end
+
+    def self.get_url
+      url = @owner.childLink["href"]
+      if @profile_id
+        "#{url}/#{@profile_id}"
+      else
+        url
+      end
+    end
   end
 end

data/lib/ariadna/result.rb

@@ -14,7 +14,6 @@ module Ariadna
     end
 
     # metrics and dimensions
-
     def self.select(params)
       get_metrics_and_dimensions(params)
       self
@@ -33,6 +32,13 @@ module Ariadna
       self
     end
 
+    #uses profile id for query
+    def self.profile(id)
+      @profile_id = id
+      self
+    end
+
+
     # number of results returned
     def self.limit(results)
       if ((results.to_i > 0) and (results.to_i < 1001))
@@ -64,7 +70,7 @@ module Ariadna
       header["name"].sub('ga:', '')
     end
 
-    # create attributes for each metric and dimension
+    # create attributes
     def self.create_attributes(results)
       summary_rows = Hash.new
       summary_rows.merge!(results)
@@ -128,7 +134,7 @@ module Ariadna
     end
 
     def self.generate_url
-      params = conditions.merge({"ids" => "ga:#{@owner.id}"})
+      params = conditions.merge(get_profile_id)
       "#{URL}?" + params.map{ |k,v| "#{k}=#{v}"}.join("&")
     end
 
@@ -145,6 +151,14 @@ module Ariadna
       end
     end
 
+    def self.get_profile_id
+      if @profile_id
+        {"ids" => "ga:#{@profile_id}"}
+      else
+        {"ids" => "ga:#{@owner.id}"}
+      end
+    end
+
     def self.api_compatible_names(values)
       values.collect {|e| "ga:#{e}"}.join(",")
     end

data/lib/ariadna/version.rb

@@ -1,3 +1,3 @@
 module Ariadna
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/ariadna/web_property.rb

@@ -9,6 +9,14 @@ module Ariadna
       @properties ||= create_properties
     end
 
+    def self.find(params)
+      return [] if params.empty?
+      all.each do |property|
+        return property if get_a_match(params, property)
+      end
+      []
+    end
+
     def initialize(item)
       item.each do |k,v|
         instance_variable_set("@#{k}", v)
@@ -22,7 +30,7 @@ module Ariadna
     private
 
     def self.create_properties
-      properties = Ariadna.connexion.get_url("https://www.googleapis.com/analytics/v3/management/accounts/#{@owner.id}/webproperties")
+      properties = Ariadna.connexion.get_url(get_url)
       if (properties["totalResults"].to_i > 0)
         create_attributes(properties["items"])
         properties["items"].map do |property|
@@ -36,5 +44,24 @@ module Ariadna
         attr_reader k.to_sym
       end
     end
+
+    def self.get_a_match(params, property)
+      if params[:id]
+        return true if property.id.downcase == params[:id].downcase
+      end
+      if params[:name]
+        return true if property.name.downcase.include? params[:name].downcase 
+      end
+      return false
+    end
+
+    def self.get_url
+      url = "https://www.googleapis.com/analytics/v3/management/accounts/#{@owner.id}/webproperties"
+      if @web_property_id
+        "#{url}/#{@web_property_id}"
+      else
+        url
+      end
+    end
   end
 end

data/spec/fixtures/accounts.yml

@@ -1,6 +1,6 @@
 account_111:
   id: 111
-  name: 'name'
+  name: 'my company account'
   selfLink: 'www.example.com/self/111'
   childLink:
     href: 'www.example.com/child/111'

data/spec/fixtures/webProperties.yml

@@ -1,5 +1,5 @@
 property:
-  id:                    909090
+  id:                    "UA-909090-1"
   kind:                  'analytics#webProperty'
   selfLink:              'selfLink'
   accountId:             111

data/spec/lib/ariadna/account_spec.rb

@@ -7,7 +7,7 @@ describe "Accounts" do
   end
 
   it "uses version 3 of the api" do
-    Ariadna::Account.url.should == "https://www.googleapis.com/analytics/v3/management/accounts"
+    Ariadna::Account::URL.should == "https://www.googleapis.com/analytics/v3/management/accounts"
   end
 
   context "A new account" do
@@ -43,4 +43,21 @@ describe "Accounts" do
       @properties.first.class == Ariadna::WebProperty
     end
   end
+
+  context "can find an account by id or name" do
+    it "should return an empty array if can not find anything" do
+      account = Ariadna::Account.find({})
+      account.size.should == 0
+    end
+
+    it "should return the requested account filtered by name" do
+      account = Ariadna::Account.find(:name => "my COMpany account")
+      account.id.should == 111
+    end
+
+    it "should return the requested account filtered by name" do
+      account = Ariadna::Account.find(:id => 222)
+      account.name.should == 'name 222'
+    end
+  end
 end

data/spec/lib/ariadna/profile_spec.rb

@@ -1,3 +1,5 @@
+require 'spec_helper'
+
 describe "Profile" do
   before :each do
     conn       = Ariadna::Analytics.new("token")
@@ -61,7 +63,14 @@ describe "Profile" do
     end
 
     it "returns a list of profiles objects" do
-      @profile.class == Ariadna::Profile
+      @profile.class.should == Ariadna::Profile
+    end
+  end
+
+  context "can find a profile by id" do
+    it "should return the requested profile" do
+      profile = @property.profiles.find(423423)
+      profile.class.should == Ariadna::Profile
     end
   end
 end

data/spec/lib/ariadna/result_spec.rb

@@ -81,4 +81,25 @@ describe "Result" do
       Ariadna::Result.url.include?("filters=ga:browser%3D%3DFirefox").should be
     end
   end
+
+  context "Generate results with a profile id" do
+    it "should include a profile id" do
+      Ariadna::Result.profile(998877)
+      .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
+
+      Ariadna::Result.url.include?("ga:998877").should be
+    end
+  end
 end

data/spec/lib/ariadna/web_property_spec.rb

@@ -10,7 +10,7 @@ describe "WebProperty" do
   context "A new web_property" do
     before :each do
       new_property = {
-        "id"                    => 888888,
+        "id"                    => "UA-888888-1",
         "kind"                  => "analytics#webProperty",
         "selfLink"              => "selfLink",
         "accountId"             => @account.id,
@@ -53,4 +53,21 @@ describe "WebProperty" do
       @profiles.first.class == Ariadna::Profile
     end
   end
+
+  context "can find a web property by id or name" do
+    it "should return an empty array if can not find anything" do
+      property = @account.properties.find({})
+      property.size.should == 0
+    end
+
+    it "should return the requested account filtered by name" do
+      property = @account.properties.find(:name => "web_property_name")
+      property.id.should == "UA-909090-1"
+    end
+
+    it "should return the requested account filtered by id" do
+      property = @account.properties.find(:id => "UA-909090-1")
+      property.name.should == 'web_property_name'
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ariadna
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-28 00:00:00.000000000 Z
+date: 2012-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry