lazy_google_analytics 0.0.1 → 0.1.0

data/README.md

@@ -6,7 +6,6 @@ Lazy google analytics for the lazy programmer. it´s an abstraction around googl
 
 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:
@@ -23,23 +22,38 @@ Or install it yourself as:
 
 ## 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"
+  setup options:
+
+    LazyGoogleAnalytics::Config.setup do |config|
+      config.pass_phrase = "notasecret"
+      config.key_file    = /location/to_your/key_file.p12
+      config.client_id   = "XXXXX.apps.googleusercontent.com"
+      config.scope       = "https://www.googleapis.com/auth/analytics.readonly"
+      config.profile_id  = "XXXXX"
+      config.email       = "XXXXXX@developer.gserviceaccount.com"
+    end
+
+  api calls:
+
+    @client = LazyGoogleAnalytics::Client.new()
 
-    @config = LazyGoogleAnalytics::Config.new(config_options)
+  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.
 
-    @auth   = LazyGoogleAnalytics::Auth.new(@config)
+  But you can extend that behavior passing and entire options_hash with specific parameters:
 
-    @auth.authorize
+    @client = LazyGoogleAnalytics::Client.new()
+    @client.parameters({'ids' => "ga:XXXXX",
+                      'start-date' => "2013-03-12",
+                      'end-date' => "2013-04-12",
+                      'dimensions' => "ga:day,ga:month",
+                      'metrics' => "ga:visits",
+                      'sort' => "ga:month,ga:day" })
 
-    @client = LazyGoogleAnalytics::Client.new({:config=>@config,
-                                              :auth=>@auth,
-                                              :client_options => {}
-                                              })
+## Rails 3
+
+  installs configuration initializer
+
+    rails g lazy_google_analytics:install
 
 ## GA How to:
 
@@ -50,7 +64,6 @@ If you follow this simple steps , you can´t fail.
   + 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
@@ -59,13 +72,3 @@ If you follow this simple steps , you can´t fail.
 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

@@ -1 +1,10 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Default: run unit specs.'
+task :default => :spec
+
+desc 'Test the lazy_high_charts plugin.'
+RSpec::Core::RakeTask.new('spec') do |t|
+    t.pattern = FileList['spec/**/*_spec.rb']
+end

data/lazy_google_analytics.gemspec

@@ -22,4 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_dependency "hash-deep-merge"
+  spec.add_dependency "activesupport"
+
 end

data/lib/generators/lazy_google_analytics/install/install_generator.rb

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+module LazyGoogleAnalytics
+  class InstallGenerator < ::Rails::Generators::Base
+
+    source_root File.expand_path("../../../templates", __FILE__)
+
+    desc "Creates a Lazy-Google-Analytics initializer."
+    #class_option :orm
+
+    def copy_initializer
+      say_status("installing", "Lazy google analytics", :green)
+      copy_file "lazy_google_analytics.rb.erb", "config/initializers/lazy_google_analytics.rb"
+    end
+
+    def show_readme
+      readme "README" if behavior == :invoke
+    end
+
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1,13 @@
+
+Hey, Thanks for install Lazy Google Analytics!
+In order to make Lazy GA work you will need to follow these steps:
+
+   1. register your api access in: google api console at https://code.google.com/apis/console/) and create a server key.
+
+   2. Download the p12 key. and save it in your app ie:. config/keys/xxx.p12
+
+   3. In order give permissions to the generated user to your GA profile you need to add the created @developer.gserviceaccount.com to your users list in the analytics profile user panel.
+
+   4. Configure options in config/initializers/lazy_google_analytics.rb
+
+Enjoy :)

data/lib/generators/templates/lazy_google_analytics.rb.erb

@@ -0,0 +1,8 @@
+LazyGoogleAnalytics::Config.setup do |config|
+  #config.pass_phrase = "notasecret"
+  #config.key_file    = Rails.root + "/config/XXXXkey_file.p12"
+  #config.client_id   = "XXXXX.apps.googleusercontent.com"
+  #config.scope       = "https://www.googleapis.com/auth/analytics.readonly"
+  #config.profile_id  = "XXXXX" # note that this number corresponds to profile id , not analytics UA-XXXXX number
+  #config.email       = "XXXXXX@developer.gserviceaccount.com" # you have to add email dev account to users list on analytics profile
+end

data/lib/lazy_google_analytics/auth.rb

@@ -3,7 +3,8 @@ module LazyGoogleAnalytics
 
     attr_accessor :analytics, :client
 
-    def initialize(config)
+    def initialize
+      config = LazyGoogleAnalytics::Config
       @key = Google::APIClient::PKCS12.load_key(config.key_file, config.pass_phrase)
       @asserter = Google::APIClient::JWTAsserter.new( config.email, config.scope, @key)
     end

data/lib/lazy_google_analytics/client.rb

@@ -1,37 +1,39 @@
 module LazyGoogleAnalytics
   class Client
 
+    CLIENT_OPTIONS = %w(api_method parameters ids start_date end_date dimensions metrics sort filters)
+    attr_accessor :options, :auth
+
     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"
+      @auth ||= LazyGoogleAnalytics::Auth.new
+      @auth.authorize # check expiration and cache ?
 
+      self.tap do |client|
+        client.options    ||= {}
+        client.defaults_options(opts)
+        client.options ||= opts
+        yield client if block_given?
+      end
     end
 
+    def defaults_options(opts)
 
-    def results
-
-      startDate = DateTime.now.prev_month.strftime("%Y-%m-%d")
-      endDate = DateTime.now.strftime("%Y-%m-%d")
+      start_date = opts[:start_date] ||= DateTime.now.prev_month.strftime("%Y-%m-%d")
+      end_date   = opts[:end_date]   ||= 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 }
-                }
+      self.api_method(@auth.analytics.data.ga.get)
+      self.parameters({'ids' => "ga:#{LazyGoogleAnalytics::Config.profile_id}",
+                      'start-date' => start_date,
+                      'end-date' => end_date,
+                      'dimensions' => "ga:day,ga:month",
+                      'metrics' => "ga:visits",
+                      'sort' => "ga:month,ga:day" })
+    end
 
-      @results = @auth.client.execute( options)
 
+    def results
+      @results = @auth.client.execute(@options)
     end
 
     def formatted_columns
@@ -46,6 +48,16 @@ module LazyGoogleAnalytics
       end
     end
 
+    def method_missing(meth, opts = {})
+      merge_options meth, opts
+    end
+
+  private
+
+    def merge_options(name, opts)
+      @options.merge!  name => opts
+    end
+
   end
 end
 

data/lib/lazy_google_analytics/config.rb

@@ -1,43 +1,17 @@
+require "active_support/core_ext/module/attribute_accessors"
+
 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?
+    def self.setup
+      yield self
     end
 
+    mattr_accessor  :pass_phrase,
+                    :key_file,
+                    :client_id,
+                    :scope,
+                    :profile_id,
+                    :email
   end
 end

data/lib/lazy_google_analytics/engine.rb

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+
+module LazyGoogleAnalytics
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/lazy_google_analytics/railtie.rb

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+module LazyGoogleAnalytics
+  class Railtie < ::Rails::Railtie
+    config.before_configuration do
+      #put some configuration here
+    end
+  end
+end

data/lib/lazy_google_analytics/version.rb

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

data/lib/lazy_google_analytics.rb

@@ -2,6 +2,7 @@
 $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 require "google/api_client"
+require "active_support"
 
 module LazyGoogleAnalytics
 
@@ -10,4 +11,9 @@ module LazyGoogleAnalytics
   autoload  :Auth,     'lazy_google_analytics/auth.rb'
   autoload  :Client,   'lazy_google_analytics/client.rb'
 
+  if defined?(::Rails::Railtie)
+    autoload  :Railtie, 'lazy_google_analytics/railtie.rb'
+    autoload  :Rails,   'lazy_google_analytics/engine.rb' if ::Rails.version >= '3.1'
+  end
+
 end

data/spec/functional/auth_spec.rb

@@ -2,8 +2,8 @@ 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)
+    config_setup
+    @auth = LazyGoogleAnalytics::Auth.new
   end
 
   it "authorization object" do

data/spec/functional/client_spec.rb

@@ -2,19 +2,21 @@ 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 => {}
-                                              })
+    config_setup
+    @client = LazyGoogleAnalytics::Client.new()
   end
 
   it "find objects object" do
-    #binding.pry
     @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

data/spec/functional/config_spec.rb

@@ -1,20 +1,24 @@
 require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
 
-describe "Config" do
+describe "Config class" do
   before(:all) do
-    @config = LazyGoogleAnalytics::Config.new(config_options)
 
-    @config2 = LazyGoogleAnalytics::Config.new({
-      :pass_phrase => "notasecret"
-    })
+    LazyGoogleAnalytics::Config.setup do |config|
+      config.pass_phrase = config_options["pass_phrase"]
+      config.key_file    = config_options["key_file"]
+      config.client_id   = config_options["client_id"]
+      config.scope       = config_options["scope"]
+      config.profile_id  = config_options["profile_id"]
+      config.email       =  config_options["email"]
+    end
   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
+    LazyGoogleAnalytics::Config.pass_phrase.should_not be_empty
+    LazyGoogleAnalytics::Config.key_file.should_not be_empty
+    LazyGoogleAnalytics::Config.scope.should_not be_empty
+    LazyGoogleAnalytics::Config.profile_id.should_not be_empty
+    LazyGoogleAnalytics::Config.email.should_not be_empty
   end
 
 end

data/spec/spec_helper.rb

@@ -18,4 +18,16 @@ RSpec.configure do |config|
     return config
   end
 
+  def config_setup
+    LazyGoogleAnalytics::Config.setup do |config|
+      config.pass_phrase = config_options["pass_phrase"]
+      config.key_file    = config_options["key_file"]
+      config.client_id   = config_options["client_id"]
+      config.scope       = config_options["scope"]
+      config.profile_id  = config_options["profile_id"]
+      config.email       =  config_options["email"]
+    end
+    LazyGoogleAnalytics::Config
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lazy_google_analytics
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-22 00:00:00.000000000 Z
+date: 2013-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-api-client
@@ -59,6 +59,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hash-deep-merge
+  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: activesupport
+  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'
 description: google analytics api access for the lazy ones
 email:
 - miguelmichelson@gmail.com
@@ -73,10 +105,19 @@ files:
 - README.md
 - Rakefile
 - lazy_google_analytics.gemspec
+- lib/.DS_Store
+- lib/generators/.DS_Store
+- lib/generators/lazy_google_analytics/.DS_Store
+- lib/generators/lazy_google_analytics/install/install_generator.rb
+- lib/generators/templates/README
+- lib/generators/templates/lazy_google_analytics.rb.erb
 - lib/lazy_google_analytics.rb
+- lib/lazy_google_analytics/.DS_Store
 - lib/lazy_google_analytics/auth.rb
 - lib/lazy_google_analytics/client.rb
 - lib/lazy_google_analytics/config.rb
+- lib/lazy_google_analytics/engine.rb
+- lib/lazy_google_analytics/railtie.rb
 - lib/lazy_google_analytics/version.rb
 - spec/.DS_Store
 - spec/fixtures/.DS_Store
@@ -99,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3802011328619793831
+      hash: -2207734988759702426
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -108,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3802011328619793831
+      hash: -2207734988759702426
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25