lazy_google_analytics 0.1.2 → 0.1.5

data/README.md

@@ -1,10 +1,12 @@
 # LazyGoogleAnalytics
 
-Lazy google analytics for the lazy programmer. it´s an abstraction around google-analytics-client gem.
+Lazy google analytics it´s an abstraction around google-analytics-client gem, to make server to server api calls.
 
 ## Motivation
 
-google-analytics-client gem is a very powerfull tool to access the api resources on google. but for me it was not very straightforward , so i come around with a simple way to implement it. thats all. Hope you like it.
+google-analytics-client gem is a very powerfull tool to access the api resources on google. but for me it was not very straightforward, so I come around with a simple way to implement it. that's all.
+
+Hope you like it.
 
 ## Installation
 
@@ -22,7 +24,7 @@ Or install it yourself as:
 
 ## Simple Usage
 
-  setup options:
+### Configuration setup:
 
     LazyGoogleAnalytics::Config.setup do |config|
       config.pass_phrase = "notasecret"
@@ -33,13 +35,17 @@ Or install it yourself as:
       config.email       = "XXXXXX@developer.gserviceaccount.com"
     end
 
-  api calls:
+### Api calls:
 
     @client = LazyGoogleAnalytics::Client.new()
 
-  By default LazyGoogleAnalytics::Client is going to make a call for visits within 1 month timeline sorted by month & day, using the profile in config block.
+  By default LazyGoogleAnalytics::Client is going to make a call for visits within 1 month timeline sorted by month & day, using the profile_id in config block.
+
+  But you can override specific parameters like this:
+
+    @client = LazyGoogleAnalytics::Client.new({:ids => "ga:123456"})
 
-  But you can extend that behavior passing and entire options_hash with specific parameters:
+  Also you can extend the options after initialization, passing and entire options_hash overriding all default parameters:
 
     @client = LazyGoogleAnalytics::Client.new()
     @client.parameters({'ids' => "ga:XXXXX",
@@ -49,20 +55,40 @@ Or install it yourself as:
                       'metrics' => "ga:visits",
                       'sort' => "ga:month,ga:day" })
 
+#### Results
+
+  To get the results of the initialized client you have to call .results method
+
+    @results = @client.results
+    @results.columns
+    @results.rows
+
+  Also this class have 2 convenience methods to output data:
+
+  To get the queried columns:
+
+    @results.formatted_columns
+
+  To get the rows:
+
+    @results.formatted_rows
+
+
 ## Rails 3
 
-  installs configuration initializer
+  Installs configuration initializer
 
     rails g lazy_google_analytics:install
 
-## GA How to:
+## Google Analytics How to:
 
 If you follow this simple steps , you can´t fail.
 
   + First, you have to register your api access in: [google api console](https://code.google.com/apis/console/) and create a server key.
   + Download the p12 key.
-  + Add the created @developer.gserviceaccount.com to your users list in the analytics user panel.
-  + Configure options based on server key and analytics profile id, not the (UA-something) account id!
+  + Add the created @developer.gserviceaccount.com to your users list in the analytics user panel of the profile you want to retrieve the data, otherwise it wont work.
+  + Note that the profile_id of the configuration object is not the UA-XXXXX number , is the Google Analytics profile number.
+  + To play with the api to tests different options (without write any code) you can use [Google Analytics Query Explorer 2](https://ga-dev-tools.appspot.com/explorer/)
 
 ## Contributing
 

data/lazy_google_analytics.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["miguel michelson"]
   spec.email         = ["miguelmichelson@gmail.com"]
   spec.description   = %q{google analytics api access for the lazy ones}
-  spec.summary       = %q{google analytics api access for the lazy ones}
+  spec.summary       = %q{google analytics api access server 2 server for the lazy ones}
   spec.homepage      = ""
   spec.license       = "MIT"
 

data/lib/lazy_google_analytics/client.rb

@@ -19,22 +19,27 @@ module LazyGoogleAnalytics
 
     def defaults_options(opts)
 
+      api_method = opts[:api_method] ||= @auth.analytics.data.ga.get
       start_date = opts[:start_date] ||= DateTime.now.prev_month.strftime("%Y-%m-%d")
       end_date   = opts[:end_date]   ||= DateTime.now.strftime("%Y-%m-%d")
+      ids        = opts[:ids]        ||= "ga:#{LazyGoogleAnalytics::Config.profile_id}"
+      dimensions = opts[:dimensions] ||= "ga:day,ga:month"
+      metrics    = opts[:metrics]    ||= "ga:visits"
+      sort       = opts[:sort]       ||= "ga:month,ga:day"
 
-      self.api_method(@auth.analytics.data.ga.get)
-      self.parameters({'ids' => "ga:#{LazyGoogleAnalytics::Config.profile_id}",
+      self.api_method(api_method)
+      self.parameters({'ids' => ids,
                       'start-date' => start_date,
                       'end-date' => end_date,
-                      'dimensions' => "ga:day,ga:month",
-                      'metrics' => "ga:visits",
-                      'sort' => "ga:month,ga:day" })
+                      'dimensions' => dimensions,
+                      'metrics' => metrics,
+                      'sort' => sort })
     end
 
 
     def results
       @results = @auth.client.execute(@options)
-      raise_detected_errors
+      raise_detected_errors if @results.status > 200
     end
 
     def formatted_columns
@@ -61,11 +66,7 @@ module LazyGoogleAnalytics
 
     def raise_detected_errors
       body = JSON.parse(@results.body)
-      if body.keys.include?("error")
-        raise body["error"]["errors"].collect{|e| e["reason"] + e["message"] }.join(", ")
-      else
-        @results
-      end
+      raise body["error"]["errors"].collect{|e| "#{e["reason"]}: #{e["message"]}" }.join(", ") if body.keys.include?("error")
     end
 
   end

data/lib/lazy_google_analytics/version.rb

@@ -1,3 +1,3 @@
 module LazyGoogleAnalytics
-  VERSION = "0.1.2"
+  VERSION = "0.1.5"
 end

data/spec/functional/client_spec.rb

@@ -1,43 +1,87 @@
 require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
 
 
-describe "errors" do
+describe "Client" do
   before :each do
     config_setup
-    @error_report = LazyGoogleAnalytics::Client.new()
-    @error_report.parameters({'ids' => "ga:#{LazyGoogleAnalytics::Config.profile_id}",
-                      'start-date' => DateTime.now.prev_month.strftime("%Y-%m-%d"),
-                      'end-date' => DateTime.now.strftime("%Y-%m-%d"),
-                      'dimensions' => "ga:year,ga:month",
-                      'metrics' => "ga:visits,ga:bounces,ga:entranceBounceRate",
-                      'sort' => "ga:month,ga:day" })
-
   end
 
-  it "should raise and error" do
-    lambda { @error_report.results }.should raise_error
-  end
-end
 
-describe "Client" do
-  before(:all) do
-    config_setup
-    @client = LazyGoogleAnalytics::Client.new()
+  describe "errors" do
+    before :each do
+      @error_report = LazyGoogleAnalytics::Client.new()
+      @error_report.parameters({'ids' => "ga:#{LazyGoogleAnalytics::Config.profile_id}",
+                                'start-date' => DateTime.now.prev_month.strftime("%Y-%m-%d"),
+                                'end-date' => DateTime.now.strftime("%Y-%m-%d"),
+                                'dimensions' => "ga:year,ga:month",
+                                'metrics' => "ga:visits,ga:bounces,ga:entranceBounceRate",
+                                'sort' => "ga:month,ga:day" })
+
+    end
+
+    it "should raise and error" do
+      lambda { @error_report.results }.should raise_error
+    end
   end
 
-  it "find objects object" do
-    @client.results
+  describe "override entire options" do
+    before :each do
+      @report = LazyGoogleAnalytics::Client.new()
+      @report.parameters({'ids' => "ga:123456",
+                                'dimensions' => "ga:year,ga:month",
+                                'sort' => "ga:month,ga:day" })
+
+    end
+
+    it "options should have new options" do
+      @report.options[:parameters].keys.should == ["ids", "dimensions", "sort"]
+      @report.options[:parameters]["ids"].should == "ga:123456"
+    end
+
   end
 
-  it "headers" do
-    @client.formatted_columns.should == "ga:day\tga:month\tga:visits"
+  describe "initialize with specific options without overriding defaults" do
+    before :each do
+      @report = LazyGoogleAnalytics::Client.new({:ids => "ga:123"})
+    end
+
+    it "options should have new options" do
+      @report.options[:parameters].keys.should == ["ids", "start-date", "end-date", "dimensions", "metrics", "sort"]
+      @report.options[:parameters]["ids"].should == "ga:123"
+    end
+
   end
 
-  it "rows" do
-    @client.formatted_rows.class.should == Array
-    @client.formatted_rows.should_not be_empty
+  describe "block initialization" do
+    before :each do
+      @report = LazyGoogleAnalytics::Client.new do |client|
+        client.parameters({ "ids" => "ga:123456"})
+      end
+    end
+    it "options should have new options" do
+      @report.options[:parameters].keys.should == ["ids"]
+      @report.options[:parameters]["ids"].should == "ga:123456"
+    end
   end
 
-end
+  describe "Client" do
+    before(:all) do
+      @client = LazyGoogleAnalytics::Client.new()
+    end
+
+    it "find objects object" do
+      @client.results
+    end
 
+    it "headers" do
+      @client.formatted_columns.should == "ga:day\tga:month\tga:visits"
+    end
 
+    it "rows" do
+      @client.formatted_rows.class.should == Array
+      @client.formatted_rows.should_not be_empty
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lazy_google_analytics
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-23 00:00:00.000000000 Z
+date: 2013-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-api-client
@@ -100,6 +100,7 @@ extra_rdoc_files: []
 files:
 - .DS_Store
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -140,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3670511021453100152
+      hash: 3806553411161090089
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -149,13 +150,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3670511021453100152
+      hash: 3806553411161090089
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: google analytics api access for the lazy ones
+summary: google analytics api access server 2 server for the lazy ones
 test_files:
 - spec/.DS_Store
 - spec/fixtures/.DS_Store