gareadonly 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55a1743ecea3acf4037cb39f654b8f29321f9492
+  data.tar.gz: eae62a04cb8eb27ae531f59eda3ff19e3db721da
+SHA512:
+  metadata.gz: 03362b01db04512e257c4b5b117679cf0551f943785a5b038847a7ceca76f08348f1aee546703487a31740ecc99568382f18b3b692d2ef3e41a58299b1638cc1
+  data.tar.gz: 335c566b63439414ddc3f34264c5c6ad40f1c04c81ebc3c90ce386e1c0dbb1fa138756fa8b71f2137a873440b013768f35b32e06174264e05baaba5e9459cda6

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in GAReadonly.gemspec
+gemspec
+google-api-client

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 theo
+
+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,47 @@
+# Google Analytics API Read-only
+
+GAReadOnly is a simple wrapper to get the data out of google analytics using the API.
+
+In order to make the gem works, you'll few configuration steps to do in your Google API Console.
+
+Currently only one method works(The only one I really needed so bad) but I'll add more method). Eventually the gem might became a full wrapper with write/delete/modify actions
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gareadonly'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gareadonly
+
+## Configuration
+
+To install the initializer file execute:
+
+    $ rails g gareadonly
+
+## Usage
+
+    GAReadonly.connect
+    pageviews = GAReadonly.get_analytics_data({'start-date' => '2014-01-01', 'end-date' => 'yesterday', 'metrics' => 'ga:pageviews', 'dimensions' => 'ga:date'})
+    puts "We had #{pageviews.totalsForAllResults['ga:pageviews']} since the 2014-01-01'
+    
+To connect to the Google API, you'll  need to run `GAReadonly.connect`. In therory you only need to run it ounce. The connection is persistant.
+
+Currently the only query available is `get_analytics_data`. It takes an hash as argument. The following hash will retrieve all the page views since the begining of the year 2014 `GAReadonly.get_analytics_data({'start-date' => '2014-01-01', 'end-date' => 'yesterday', 'metrics' => 'ga:pageviews', 'dimensions' => 'ga:date'})`
+
+## Contributing
+
+If You want more features, please let me know. Thanks.
+
+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

data/Rakefile

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

data/gareadonly.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'GAReadonly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gareadonly"
+  spec.version       = GAReadonly::VERSION
+  spec.authors       = ["theo negri"]
+  spec.email         = ["theo.negri@gmail.com"]
+  spec.description   = %q{Simple read-only wrapper for the Google Analytics API}
+  spec.summary       = %q{Simple read-only wrapper for the Google Analytics API}
+  spec.homepage      = "http://github.com/theonegri/gareadonly"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'google-api-client'
+  spec.add_dependency('google-api-client')
+  spec.add_development_dependency 'oauth2'
+  spec.add_dependency('oauth2')
+end

data/lib/gareadonly/configuration.rb

@@ -0,0 +1,33 @@
+module GAReadonly
+  class Configuration
+    attr_accessor :api_scope
+    attr_accessor :application_name
+    attr_accessor :application_version
+    attr_accessor :key
+    attr_accessor :signing_key
+    attr_accessor :issuer
+    attr_accessor :id
+    attr_accessor :client
+    attr_accessor :analytics
+    attr_accessor :discovered_api_name
+    attr_accessor :discovered_api_version
+    attr_accessor :google_url
+    attr_accessor :debug
+
+    API_SCOPE = "https://www.googleapis.com/auth/analytics.readonly"
+    ANALYTICS = 'analytics'
+    VERSION = 'v3'
+    GOOGLE_URL = "https://accounts.google.com/o/oauth2/token"
+
+    def initialize
+      # Set up the defaults
+      self.api_scope = API_SCOPE
+      self.discovered_api_name = ANALYTICS
+      self.discovered_api_version = VERSION
+      self.analytics = ""
+      self.client = ""
+      self.google_url = GOOGLE_URL
+      self.signing_key = ""
+    end
+  end
+end

data/lib/gareadonly/connection.rb

@@ -0,0 +1,20 @@
+require "google/api_client"
+require "google/api_client/client_secrets"
+require "google/api_client/auth/installed_app"
+require "OAuth2"
+
+module GAReadonly
+  class Connection
+    def initialize
+      GAReadonly.configuration.client = Google::APIClient.new(:application_name => GAReadonly.configuration.application_name,:application_version => GAReadonly.configuration.application_version)
+      GAReadonly.configuration.signing_key = Google::APIClient::KeyUtils.load_from_pkcs12(GAReadonly.configuration.key, 'notasecret')
+      GAReadonly.configuration.client.authorization = Signet::OAuth2::Client.new(:token_credential_uri => GAReadonly.configuration.google_url,
+      :audience => GAReadonly.configuration.google_url,
+      :scope => GAReadonly.configuration.api_scope,
+      issuer: GAReadonly.configuration.issuer, 
+      signing_key: GAReadonly.configuration.signing_key)
+      GAReadonly.configuration.client.authorization.fetch_access_token!
+      GAReadonly.configuration.analytics = GAReadonly.configuration.client.discovered_api(GAReadonly.configuration.discovered_api_name,GAReadonly.configuration.discovered_api_version)
+    end
+  end
+end

data/lib/gareadonly/debug.rb

@@ -0,0 +1,7 @@
+module GAReadonly
+  class Debug
+    def initialize
+      Rails.logger.debug "My debugging message"
+    end
+  end
+end

data/lib/gareadonly/version.rb

@@ -0,0 +1,3 @@
+module GAReadonly
+  VERSION = "0.1.2"
+end

data/lib/gareadonly.rb

@@ -0,0 +1,47 @@
+require "rubygems"
+require 'json'
+require 'ostruct'
+
+require "GAReadonly/version"
+require "GAReadonly/configuration"
+require "GAReadonly/connection"
+require "GAReadonly/debug"
+
+module GAReadonly
+  LOG_PREFIX = "** [GAReadonly] "
+
+  class << self
+    # Configure the GAReadonly notifier application-wide settings.
+    def configure(config_hash=nil)
+      if config_hash
+        config_hash.each do |k,v|
+          configuration.send("#{k}=", v) rescue nil if configuration.respond_to?("#{k}=")
+        end
+      end
+
+      yield(configuration) if block_given?
+    end
+
+    # Connect to the GA API
+    def connect
+      Connection.new
+    end
+
+    # Debug logs
+    def debug(message)
+      Debug.new("#{LOG_PREFIX}#{message}") if configuration.debug
+    end
+
+    # Configuration getters
+    def configuration
+      @configuration ||= GAReadonly::Configuration.new
+    end
+
+    def get_analytics_data(options = {})
+      #TODO: check the return co and use the debug when return code says so
+      options = options.merge({'ids' => GAReadonly.configuration.id })
+      data = GAReadonly.configuration.client.execute(:api_method => GAReadonly.configuration.analytics.data.ga.get,:parameters => options)
+      return OpenStruct.new(JSON.parse data.body)
+    end
+  end
+end

data/lib/generators/gareadonly/gareadonly_generator.rb

@@ -0,0 +1,12 @@
+require 'rails/generators'
+
+class GareadonlyGenerator < Rails::Generators::Base
+  source_root File.expand_path("../../templates", __FILE__)
+  desc "Creates GAReadonly initializer for your application"
+
+  def copy_initializer
+    template "gareadonly_initializer.rb", "config/initializers/gareadonly.rb"
+
+    puts "Install complete! Thanks!"
+  end
+end

data/lib/generators/templates/gareadonly_initializer.rb

@@ -0,0 +1,9 @@
+GAReadonly.configure do |config|
+  # Set this options to what makes sense for you
+  # config.application_name = 'My App v1'
+  # config.application_version = '1.0'
+  # config.key = 'path_to_your_p12_key'
+  # config.issuer = 'someone@developer.gserviceaccount.com'
+  # config.id = 'ga:XXXX'
+  
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: gareadonly
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- theo negri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple read-only wrapper for the Google Analytics API
+email:
+- theo.negri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gareadonly.gemspec
+- lib/gareadonly.rb
+- lib/gareadonly/configuration.rb
+- lib/gareadonly/connection.rb
+- lib/gareadonly/debug.rb
+- lib/gareadonly/version.rb
+- lib/generators/gareadonly/gareadonly_generator.rb
+- lib/generators/templates/gareadonly_initializer.rb
+homepage: http://github.com/theonegri/gareadonly
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: Simple read-only wrapper for the Google Analytics API
+test_files: []