lazy_google_analytics 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/fixtures/configs/account_config.yml
+spec/fixtures/keys/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lazy_google_analytics.gemspec
+gemspec
+
+gem "debugger"
+gem "rspec"
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 miguel michelson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# LazyGoogleAnalytics
+
+Lazy google analytics for the lazy programmer. it´s an abstraction around google-analytics-client gem.
+
+## 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.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lazy_google_analytics'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lazy_google_analytics
+
+## Simple Usage
+
+    config_options = pass_phrase: "notasecret",
+                     key_file: /location/to_your/key_file.p12,
+                     client_id: "XXXXX.apps.googleusercontent.com",
+                     scope: "https://www.googleapis.com/auth/analytics.readonly",
+                     profile_id: "XXXXX",
+                     email: "XXXXXX@developer.gserviceaccount.com"
+
+    @config = LazyGoogleAnalytics::Config.new(config_options)
+
+    @auth   = LazyGoogleAnalytics::Auth.new(@config)
+
+    @auth.authorize
+
+    @client = LazyGoogleAnalytics::Client.new({:config=>@config,
+                                              :auth=>@auth,
+                                              :client_options => {}
+                                              })
+
+## GA 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!
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+### TODO
+
+  + Needs some refactor on client options.
+  + Needs more specs on client options.
+  + Config Generators for ruby on rails for the laziest ones.
+
+
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lazy_google_analytics.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lazy_google_analytics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lazy_google_analytics"
+  spec.version       = LazyGoogleAnalytics::VERSION
+  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.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("google-api-client")
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/lazy_google_analytics/auth.rb

@@ -0,0 +1,19 @@
+module LazyGoogleAnalytics
+  class Auth
+
+    attr_accessor :analytics, :client
+
+    def initialize(config)
+      @key = Google::APIClient::PKCS12.load_key(config.key_file, config.pass_phrase)
+      @asserter = Google::APIClient::JWTAsserter.new( config.email, config.scope, @key)
+    end
+
+    def authorize
+      @client = Google::APIClient.new()
+      @client.authorization = @asserter.authorize()
+      @analytics = @client.discovered_api("analytics",'v3')
+    end
+
+  end
+end
+

data/lib/lazy_google_analytics/client.rb

@@ -0,0 +1,52 @@
+module LazyGoogleAnalytics
+  class Client
+
+    def initialize(opts = {})
+      @config = opts[:config]
+      @auth   = opts[:auth]
+
+      @api_method = opts[:client_options][:api_method] ||= @auth.analytics.data.ga.get
+      @ids        = opts[:client_options][:ids]        ||= "ga:#{@config.profile_id}"
+      @start_date = opts[:client_options][:start_date] ||= DateTime.now.prev_month.strftime("%Y-%m-%d")
+      @end_date   = opts[:client_options][:end_date]   ||= DateTime.now.strftime("%Y-%m-%d")
+      @dimensions = opts[:client_options][:dimensions] ||= "ga:day,ga:month"
+      @metrics    = opts[:client_options][:metrics]    ||= "ga:visits"
+      @sort       = opts[:client_options][:sort]       ||= "ga:month,ga:day"
+
+    end
+
+
+    def results
+
+      startDate = DateTime.now.prev_month.strftime("%Y-%m-%d")
+      endDate = DateTime.now.strftime("%Y-%m-%d")
+
+      options = { :api_method => @api_method,
+                  :parameters => {'ids' => @ids,
+                                  'start-date' => @start_date,
+                                  'end-date' => @end_date,
+                                  'dimensions' => @dimensions,
+                                  'metrics' => @metrics,
+                                  'sort' => @sort }
+                }
+
+      @results = @auth.client.execute( options)
+
+    end
+
+    def formatted_columns
+      (@results || self.results).data.column_headers.map { |c|
+        c.name
+      }.join("\t")
+    end
+
+    def formatted_rows
+      (@results || self.results).data.rows.each do |r|
+        print r.join("\t"), "\n"
+      end
+    end
+
+  end
+end
+
+

data/lib/lazy_google_analytics/config.rb

@@ -0,0 +1,43 @@
+module LazyGoogleAnalytics
+  class Config
+
+    class WrongConfig < StandardError; end
+
+    def initialize(data={})
+      @data = {}
+      update!(data)
+    end
+
+    def update!(data)
+      data.each do |key, value|
+        self[key] = value
+      end
+    end
+
+    def [](key)
+      @data[key.to_sym]
+    end
+
+    def []=(key, value)
+      if value.class == Hash
+        @data[key.to_sym] = LazyGoogleAnalytics::Config.new(value)
+      else
+        @data[key.to_sym] = value
+      end
+    end
+
+    def method_missing(sym, *args)
+      if sym.to_s =~ /(.+)=$/
+        self[$1] = args.first
+      else
+        self[sym]
+      end
+    end
+
+    def has_required_keys?
+      res = @data.keys - [:pass_phrase, :key_file, :client_id, :scope, :profile_id, :email]
+      raise LazyGoogleAnalytics::Config::WrongConfig unless res.empty?
+    end
+
+  end
+end

data/lib/lazy_google_analytics/version.rb

@@ -0,0 +1,3 @@
+module LazyGoogleAnalytics
+  VERSION = "0.0.1"
+end

data/lib/lazy_google_analytics.rb

@@ -0,0 +1,13 @@
+
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require "google/api_client"
+
+module LazyGoogleAnalytics
+
+  autoload  :VERSION,  'lazy_google_analytics/version.rb'
+  autoload  :Config,   'lazy_google_analytics/config.rb'
+  autoload  :Auth,     'lazy_google_analytics/auth.rb'
+  autoload  :Client,   'lazy_google_analytics/client.rb'
+
+end

data/spec/functional/auth_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+
+describe "Config" do
+  before(:all) do
+    @config = LazyGoogleAnalytics::Config.new(config_options)
+    @auth   = LazyGoogleAnalytics::Auth.new(@config)
+  end
+
+  it "authorization object" do
+    @auth.authorize
+    @auth.analytics.class.should be Google::APIClient::API
+  end
+
+end
+
+
+
+
+
+

data/spec/functional/client_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+
+describe "Client" do
+  before(:all) do
+    @config = LazyGoogleAnalytics::Config.new(config_options)
+    @auth   = LazyGoogleAnalytics::Auth.new(@config)
+    @auth.authorize
+    @client = LazyGoogleAnalytics::Client.new({
+                                              :config=>@config,
+                                              :auth=>@auth,
+                                              :client_options => {}
+                                              })
+  end
+
+  it "find objects object" do
+    #binding.pry
+    @client.results
+  end
+
+end

data/spec/functional/config_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+
+describe "Config" do
+  before(:all) do
+    @config = LazyGoogleAnalytics::Config.new(config_options)
+
+    @config2 = LazyGoogleAnalytics::Config.new({
+      :pass_phrase => "notasecret"
+    })
+  end
+
+  it "has all the keys required" do
+    @config.pass_phrase.should_not be_empty
+    @config.key_file.should_not be_empty
+    @config.scope.should_not be_empty
+    @config.profile_id.should_not be_empty
+    @config.email.should_not be_empty
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'debugger'
+require File.join(File.dirname(__FILE__), '../lib', 'lazy_google_analytics')
+require 'stringio'
+require "pry"
+
+RSpec.configure do |config|
+
+  def fixture_key(type, filename)
+    dir_name = type.to_s + "s"
+    File.dirname(__FILE__) + "/fixtures/#{dir_name}/#{filename}"
+  end
+
+  def config_options
+    config = YAML.load( File.open(fixture_key("config", "account_config.yml")) )
+    config["key_file"]  = fixture_key("key", config["pem"])
+    return config
+  end
+
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: lazy_google_analytics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- miguel michelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: google analytics api access for the lazy ones
+email:
+- miguelmichelson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lazy_google_analytics.gemspec
+- lib/lazy_google_analytics.rb
+- lib/lazy_google_analytics/auth.rb
+- lib/lazy_google_analytics/client.rb
+- lib/lazy_google_analytics/config.rb
+- lib/lazy_google_analytics/version.rb
+- spec/.DS_Store
+- spec/fixtures/.DS_Store
+- spec/functional/auth_spec.rb
+- spec/functional/client_spec.rb
+- spec/functional/config_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3802011328619793831
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3802011328619793831
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: google analytics api access for the lazy ones
+test_files:
+- spec/.DS_Store
+- spec/fixtures/.DS_Store
+- spec/functional/auth_spec.rb
+- spec/functional/client_spec.rb
+- spec/functional/config_spec.rb
+- spec/spec_helper.rb