ga_dashboard 0.1.0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ga_dashboard.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Saraswathy Renuga
+
+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,176 @@
+# GA Dashboard
+
+This gem helps you to import Google Analytics Dashboard into your Rails application.
+
+You can pull out the following stats from Google Analytics
+
+1. Most Popular Pages
+2. Geo Chart (Map) or Table which represents the following data for a given time period
+	* Users count from various countries across the world 
+	* Users count from various countries in a continent
+	* Users count from various cities of a country
+3. Overview of users and sessions for a given time period as line chart
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ga_dashboard'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ga_dashboard
+
+## Usage
+
+###Prerequisites
+
+You need to set up the following things before using this gem.
+
+1. Create Google Analytics account for your project, add the script with tracking code in all the view pages that you want to track.
+2. Create a project at [Google Developers Console](https://code.google.com/apis/console/)
+3. In Google Developers console, Select your Project -> API & auth -> Search for Analytics -> Enable API
+4. Under API & auth -> Credentials -> Add Credentials -> Service Account -> Select P12 and create
+5. Download the **Key file** and save it in your_project_folder/lib/keys
+6. Note down the **service email address** that is created. It should be something like ‘something-long@developer.gserviceaccount.com’
+7. Login into your Google Analytics account -> Admin -> User Management -> Add permission to your service email address.
+8. Open [Query Explorer](https://ga-dev-tools.appspot.com/query-explorer/), select your GA account for the project. Note down the number shown after ga. (e.g., ga:xxxxxxxxxx) which is the **GA Profile ID**
+
+
+###Configure your Rails application
+
+In your Rails application, create a file 'ga_dashboard.rb' inside config/initializers with the following lines
+
+```Ruby
+GA_SERVICE_EMAIL_ADDRESS="<Your Service Email Address>"
+GA_PROFILE_ID="<Ga Profile ID>"
+PATH_TO_KEY_FILE="#{Rails.root}/keys/<Your key file name>"
+```
+
+###Add code to your controller (e.g., reports_controller#index)
+
+```Ruby
+@ga_dashboard_api=GaDashboard::AnalyticsApi.new("your_project_name",version_no)
+```
+
+###Add the dashboard in your views
+
+In your view file (e.g., reports/index.html.erb) add this 
+
+```
+<script src='https://www.google.com/jsapi'></script>
+```
+* Create the division where you want the dashboard to be appear.
+* Use any of the helper methods listed below to generate the view.
+
+
+####1. Popular Pages
+
+```Ruby
+display_most_popular_pages(ga_dashboard_api,pages_starting_with,start_date,end_date,id_of_the_division)
+```
+#####Example:
+
+```Ruby
+<div id='popular_pages'></div>
+<%= display_most_popular_pages(@ga_dashboard_api,"home",DateTime.now-2.months,DateTime.now,'popular_pages') %>
+```
+
+#####Screenshot
+![ScreenShot](https://googledrive.com/host/0B-YetaqqmGclN1lzbm1KWGZCekE/popular_pages.png)
+
+####2. Users count from various countries across the world
+
+```Ruby
+display_users_from_countries_across_world(ga_dashboard_api,start_date,end_date,id_of_the_division,format="table",options={})
+```
+
+* format can be either "table" or "map"
+* options - google charts options. [Refer Google Charts Documentation](https://developers.google.com/chart/interactive/docs/customizing_charts)
+
+#####Example: Using Map
+
+```Ruby
+<div id='world'></div>
+<%= display_users_from_countries_across_world(@ga_dashboard_api,DateTime.now-2.months,DateTime.now,'world','map',{:title=>'Users Across world'}) %>
+```
+#####Screenshot
+![ScreenShot](https://googledrive.com/host/0B-YetaqqmGclN1lzbm1KWGZCekE/world.png)
+
+#####Example: Using Table
+
+```Ruby
+<div id='world1'></div>
+<%= display_users_from_countries_across_world(@ga_dashboard_api,DateTime.now-2.months,DateTime.now,'world1','table',{:title=>'Users Across world'}) %>
+```
+#####Screenshot
+![ScreenShot](https://googledrive.com/host/0B-YetaqqmGclN1lzbm1KWGZCekE/world_table.png)
+
+####3. Users count from various countries in a continent
+```Ruby
+display_users_from_countries_of_continent(ga_dashboard_api,continent,start_date,end_date,division_id,format="table",options={})
+```
+*Acceptable continent names are Africa,Europe,Americas,Asia and Oceania*
+
+#####Example: Using Map
+
+```Ruby
+<div id='continent'></div>
+<%= display_users_from_countries_of_continent(@ga_dashboard_api,"Asia",DateTime.now-2.months,DateTime.now,'continent','map',{:title=>"Users from Asia"}) %>
+```
+#####Screenshot
+![ScreenShot](https://googledrive.com/host/0B-YetaqqmGclN1lzbm1KWGZCekE/continent.png)
+
+####4. Users count from various cities of a country
+```Ruby
+display_users_from_cities_of_country(ga_dashboard_api,country,start_date,end_date,id_of_the_division,format="table",options={})
+```
+*Acceptable country names are listed [here](../Countries.txt?raw=true)*
+
+#####Example: Using Map
+
+```Ruby
+<div id='country'></div>
+<%= display_users_from_cities_of_country(@ga_dashboard_api,"India",DateTime.now-2.months,DateTime.now,'country','map',{:title=>"Users from India"}) %>
+```
+#####Screenshot
+![ScreenShot](https://googledrive.com/host/0B-YetaqqmGclN1lzbm1KWGZCekE/country.png)
+
+####5. Users Overview
+```Ruby
+display_users_overview(ga_dashboard_api,start_date,end_date,region_type,region,div_id,options={})
+```
+* Region Type - Acceptable values are country or continent
+* Region - continent names or countries names basis region type
+
+#####Example: Using Map
+
+```Ruby
+<div id='users_overview1'></div>
+<%= display_users_overview(@ga_dashboard_api,DateTime.now-2.months,DateTime.now,'country','India','users_overview1',{:title=>"Users Overview",:height=>'500'}) %>
+```
+#####Screenshot
+![ScreenShot](https://googledrive.com/host/0B-YetaqqmGclN1lzbm1KWGZCekE/users_overview1.png)
+
+```Ruby
+<div id='users_overview2'></div>
+<%= display_users_overview(@ga_dashboard_api,DateTime.now-1.months,DateTime.now,'country','India','users_overview2',{:title=>"Users Overview",:height=>'500'}) %>
+```
+#####Screenshot
+![ScreenShot](https://googledrive.com/host/0B-YetaqqmGclN1lzbm1KWGZCekE/users_overview2.png)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/renugasaraswathy/ga_dashboard. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ga_dashboard"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ga_dashboard.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ga_dashboard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ga_dashboard"
+  spec.version       = GaDashboard::VERSION
+  spec.authors       = ["Saraswathy Renuga"]
+  spec.email         = ["renugasaraswathy@gmail.com"]
+
+  spec.summary       = %q{Importing Google Analytics Dashboard into your rails application}
+  spec.description   = %q{Importing Google Analytics Dashboard into your rails application}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = ""
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "google-api-client"
+  spec.add_dependency "google_visualr"
+end

data/lib/ga_dashboard.rb

@@ -0,0 +1,7 @@
+require "ga_dashboard/version"
+require "ga_dashboard/ga_dashboard_helper"
+require "ga_dashboard/ga_dashboard_api"
+require 'ga_dashboard/railtie' if defined?(Rails)
+module GaDashboard
+  
+end

data/lib/ga_dashboard/version.rb

@@ -0,0 +1,3 @@
+module GaDashboard
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: ga_dashboard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Saraswathy Renuga
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !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: google_visualr
+  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: Importing Google Analytics Dashboard into your rails application
+email:
+- renugasaraswathy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ga_dashboard.gemspec
+- lib/ga_dashboard.rb
+- lib/ga_dashboard/version.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: 549719951
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 549719951
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Importing Google Analytics Dashboard into your rails application
+test_files: []