simple_ga_reporting 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e88b845d1465d10bcc1ca4933003986f08a4dc3feaba25a134773e91dfb4ed4
+  data.tar.gz: 95f7c6475a6c0ef348114fd924760ff5e88a83e645d8d5aadd0c9977f15e92f0
+SHA512:
+  metadata.gz: '062738c24349613449247506a27c93da82d44239e5895937ef3b4f5ad19baf69dd8dce1fe6dc4021d83daea8f530e7bd77e10b233fb8aae7a3858a8facc827df'
+  data.tar.gz: 8c21dc84064814dfe06f1b23cc7521965b8d7655b0b83b8adac23ad02b6a0004abfbcfcba41b901b645131c6f89a3375ce1d353d9350f5fb6d89d616897bba5b

data/.circleci/config.yml

@@ -0,0 +1,61 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.5.0-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      # - restore_cache:
+      #     keys:
+      #     - v1-dependencies-{{ checksum "Gemfile.lock" }}
+      #     # fallback to using the latest cache if no exact match is found
+      #     - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      # - save_cache:
+      #     paths:
+      #       - ./vendor/bundle
+      #     key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # Database setup
+      # - run: bundle exec rake db:create
+      # - run: bundle exec rake db:schema:load
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+Guardfile

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at takiya@toran.sakura.ne.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in simple_ga_reporting.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Osamu Takiya
+
+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,427 @@
+[![CircleCI](https://circleci.com/gh/corselia/simple-ga-reporting.svg?style=svg)](https://circleci.com/gh/corselia/simple-ga-reporting)
+
+# What's this?
+This gem helps you to obtain `Google Analytics` reporting data with ease.
+
+First of all, you create configuration YAML file as Google Analytics API. Then execute the simple Ruby code, and you obtain Google Analytics reporting data.
+
+Yeah, very simple :)
+
+## Wrapper gem of Legato
+This gem is a wrapper of [Legato gem](https://github.com/tpitale/legato). `Legato` is very coooooooool and full-stack gem, so complicated as a beginner (me!).
+
+Therefore I developed this wrapper gem, `simple-ga-reporting`.
+
+# Get Started
+
+## 1. Installation
+```bash
+$ gem install simple-ga-reporting
+```
+
+## 2. Create API configuration file
+- You must create `config/key_and_email.yml`
+- This YAML file must contain two Key-Value sets
+    - `private_key` and its value
+    - `client_email` and its value
+- How to get above two Key-Value sets is written later
+
+## 3. Create Google Analytics reporting configuration file
+- You must create the YAML file which contains Google Analytics reporting configuration such as `start-date`, `end-date`, `metrics`, `demensions`, `filters` and etc.
+- filepath is `config/ga_reporting_config.yml`
+- This YAML file format is shown later
+
+## 4. Create filters file (Optional)
+- If you wanna use filters function, please create `config/filters.rb`
+- the filters configuration on GUI is below
+
+![filter configuration on GUI](images/config_filter_by_gui.png)
+
+## 5. Write your app
+- Write your application used this gem
+- The sample code is below
+    - Use only two class methods
+        - `SimpleGaReports.configure`
+        - `SimpleGaReports.filtered_results`
+    - Only three lines :-)
+    - Note
+        - If you don't use filters, use `SimpleGaReports.raw_results`
+        - when no filter is in configure file, `SimpleGaReports.raw_results` is the same as `SimpleGaReports.filtered_results`
+
+```ruby
+require 'simple_ga_reporting'
+
+SimpleGaReports.configure
+SimpleGaReports.filtered_results #=> Legato::Query
+```
+
+# Configuration files
+
+## API configuration file
+- You must create Google Analytics API configuration file
+- Default filepath is `config/key_and_email.yml`
+    - You can change filepath by argument with `create_ga_user` method
+- Sample is below
+
+```yaml
+private_key: "-----BEGIN PRIVATE KEY-----\nMIIE..........Eqw==\n-----END PRIVATE KEY-----\n"
+client_email: "your_account_name@foobar.iam.gserviceaccount.com"
+```
+
+## Google Analytics reporting configuration file
+- You must create the YAML file which contains Google Analytics reporting configuration
+- Default filepath is `config/ga_reporting_config.yml`
+    - You can change filepath by argument with `configure` method
+- Sample is below
+
+```yaml
+profile_name: my_profile_name
+start_date: 2018-04-01
+end_date: 2018-04-05
+metrics:
+  - users
+  - pageviews
+dimensions:
+  - pagePath
+  - pageTitle
+sort:
+  - -pageviews
+  - -users
+filters:
+  - my_awesome_filter
+  - his_awesome_filter
+  - her_awesome_filter
+limit: 20
+```
+
+- Please refer the official documents as configuration Key-Value sets
+    - https://developers.google.com/analytics/devguides/reporting/core/v3/reference
+
+![ga_query_parametes_summary.png](images/ga_query_parametes_summary.png)
+
+- Though that documents show many Key-Value sets, you can config only several sets as below
+    - start-date
+    - end-date
+    - metrics
+    - dimensions
+    - sort
+    - filters
+    - max-results
+    - samplingLevel
+- Some Key names in configure file are different from ones in official document
+    - `start_date` in configure file (not `start-date`)
+    - `end_date` in configure file (not `end-date`)
+    - `limit` in configure file (instead of `max-results`)
+    - `sampling_level` in configure file (not `samplingLevel`)
+- The type of `metrics`, `dimensions`, `sort` and `filters` is `Array`
+    - The order of elements doesn't matter
+
+## Key-Value detail
+
+#### profile_name
+- REQUIRED
+- It was called `view (view name)` before
+    - but in Japanese page, still `ビュー名`
+
+![View or Profile](images/ga_profile(view).png)
+
+#### start_date
+- REQUIRED
+- Original Key name is `start-date`
+- Value examples
+    - `2018-04-01`
+    - `today` or `yesterday`
+    - `14daysAgo`
+        - use `daysAgo` phrase even if `1day`
+
+#### end_date
+- REQUIRED
+- Original Key name is `end-date`
+- Value examples are the same as `start-date`
+
+#### metrics
+- REQUIRED
+- `指標` in Japanese
+- Official documents are below (very useful!)
+    - [Dimensions & Metrics Explorer](https://developers.google.com/analytics/devguides/reporting/core/dimsmets)
+- Value examples
+    - `users`
+    - `uniquePageviews`
+
+![Dimensions & Metrics Explorer](images/dimensions_and_metrics_explorer.png)
+
+
+#### dimensions
+- optional
+- Official documents are below (very useful!)
+    - [Dimensions & Metrics Explorer](https://developers.google.com/analytics/devguides/reporting/core/dimsmets)
+- Value examples
+    - `pagePath`
+    - `sessionCount`
+
+#### sort
+- optional
+- prefix
+    - `-` sign means descending
+    - no sign means ascending
+        - Don't use `+` sign
+- Value examples
+  - `-pageviews`
+  - `users`
+
+#### filters
+- optional
+- Value is method name you named in `filters.rb`
+
+#### limit
+- optional
+- Original Key name is `max-results`
+- Value is max amount of returned rows
+- Default value is `100`
+
+#### sampling_level
+- optional
+- Original Key name is `samplingLevel`
+- Default value is `HIGHER_PRECISION`
+
+## filters file
+- You use filters function using `filters.rb` file
+    - the filename `filters.rb` is determined
+        - only filepath is optional
+    - the module name `Filters` is determined
+    - Default filepath is `config/filters.rb`
+        - You can change it by argument with `configure` method
+- Examples
+
+```ruby
+module Filters
+  def chrome_or_fx
+    filter :chrome_or_fx, &lambda { contains(:browser, 'Chrome|Firefox') }
+  end
+
+  def awesome_page
+    filter :awesome_page, &lambda { contains(:pagePath, '\A.*awesome.*\z') }
+  end
+end
+```
+
+- `chrome_or_fx` method filters the results
+    - pick up data which contains 'Google Chrome' or 'Firefox' as browser
+- the convention of filter method is below
+    - define method name
+    - define filter name by symbol which is the same as method name
+    - define filter behavior by block object
+- Usage of multiple filters
+    - If you want to apply AND-chain, only specify each filter in Google Analytics reporting configuration file
+    - If you want to apply OR-chain, use regexp in block object as `chrome_or_fx` method
+- Adding refer [Legato's Documents](https://github.com/tpitale/legato#google-analytics-supported-filtering-methods)
+
+# Arguments of method
+
+## `SimpleGaReports.filtered_results` method
+- take one argument
+- If you don't use filters, use `SimpleGaReports.raw_results` method
+    - when no filter is in configure file, `SimpleGaReports.raw_results` is the same as `SimpleGaReports.filtered_results`
+
+1. `key_and_email_file`
+    - default is `config/key_and_email.yml`
+
+## `SimpleGaReports.configure` method
+- take three arguments
+
+1. `yaml_file`
+    - first argument
+    - default is `config/ga_reporting_config.yml`
+
+1. `filters_file`
+    - second argument
+    - default is `config/filters.rb`
+
+1. `**options`
+    - third argument
+    - default is nil
+    - if you set this argument, you can overwrite values in Google Analytics reporting configuration file
+    - example
+        - `start_date: '90daysAgo', end_date: '60daysAgo', limit: 100`
+
+# How to get `private_key` and `client_email`
+
+#### 1. Access to [Google Cloud Platform Console](https://console.cloud.google.com/)
+
+#### 2. Create new project
+- name new project as you like
+
+#### 3. Create service account for Google Analytics API and select `API and Service` from menu
+
+![Google Cloud Platform API menu](images/gcp_api_menu.png)
+
+#### 4. Create authentication information
+- Select `Service Account Key`
+
+![Google Cloud Platform API Auth Info](images/gcp_api_auth_info.png)
+
+#### 5. Select Service Account and download JSON Key
+
+![Google Cloud Platform JSON Key](images/gcp_download_json_key.png)
+
+#### 6. Open JSON Key file by editor and pick up `"private_key"` and `"client_email"`
+
+![Google Cloud Platform private_key and client_email](images/gcp_private_key_and_client_email.png)
+
+#### 7. They are the very Key-Value sets you want
+- Deal with them carefully
+
+#### 8. They are the very Key-Value sets you want
+- Deal with them carefully
+
+#### 9. Activate Analytics API
+- NOT `Google Analytics Reporting API` BUT `Analytics API`
+
+![GCP Activate API 01](images/gcp_activate_api_01.png)
+
+![GCP Activate API 02](images/gcp_activate_api_02.png)
+
+![GCP Activate API 03](images/gcp_activate_api_03.png)
+
+#### 10. Add API user to Google Analytics
+- In Google Analytics, add mail address of API user
+- Only `Display and Analytics` authority needs
+
+![ga_add_api_user.png](images/ga_add_api_user.png)
+
+# Sample App
+
+## Prepare files
+
+1. `./my_sample_app.rb`
+1. `./foo/my_key_and_email.yml`
+1. `./bar/my_ga_reporting_config.yml`
+1. `./foobar/filters.rb`
+
+#### 1. `./my_sample_app.rb`
+```ruby
+require 'simple_ga_reporting'
+
+SimpleGaReports.configure('./bar/my_ga_reporting_config.yml','./foobar/filters.rb', start_date:
+'2daysAgo', limit: 100)
+results = SimpleGaReports.filtered_results('./foo/my_key_and_email.yml')
+
+results.each do |result|
+  puts '==================================='
+  puts result['pagePath']
+  puts result['pageTitle']
+  puts result['pageviews']
+  puts result['users']
+end
+```
+
+#### 2. `./foo/my_key_and_email.yml`
+```yaml
+private_key: "-----BEGIN PRIVATE KEY-----\nMIIE..........Eqw==\n-----END PRIVATE KEY-----\n"
+client_email: "your_account_name@foobar.iam.gserviceaccount.com"
+```
+
+#### 3. `./bar/my_ga_reporting_config.yml`
+```yaml
+profile_name: my_profile_name
+start_date: 2018-04-01
+end_date: 2018-04-05
+metrics:
+  - users
+  - pageviews
+dimensions:
+  - pagePath
+  - pageTitle
+sort:
+  - -pageviews
+  - -users
+filters:
+  - chrome_or_fx
+  - happy_page
+limit: 20
+```
+
+#### 4. `./foobar/filters.rb`
+```ruby
+module Filters
+  def chrome_or_fx
+    filter :chrome_or_fx, &lambda { contains(:browser, 'Chrome|Firefox') }
+  end
+
+  def happy_page
+    filter :happy_page, &lambda { contains(:pagePath, '\A.*happy.*\z') }
+  end
+end
+```
+
+## execute script
+```bash
+$ ruby ./my_sample_app.rb
+===================================
+/i_am_happy.html
+I am HAPPY!
+10000
+1000
+===================================
+/happy/index.html
+HAPPY TOP
+9000
+900
+===================================
+/path/to/happy.html
+Are You Happy?
+8000
+800
+===================================
+/happy.php
+HAPPY CHECK!
+7000
+700
+===================================
+......
+```
+
+# Very Awesome Reference Book (Recommended)
+- [わかばちゃんと学ぶ Googleアナリティクス (Let's study Google Analytics with Wakaba-Chan)](http://www.c-r.com/book/detail/1217)
+
+![わかばちゃんと学ぶ Googleアナリティクス](http://www.c-r.com/book/images/x/86354-232-7_x.jpg)
+
+- Created by [Ai Minatogawa](https://llminatoll.github.io/)
+    - She is an energetic creator!
+- Japanese version only
+    - English version will...?
+
+# Official documents
+## Core Reporting API - Reference Guide
+- https://developers.google.com/analytics/devguides/reporting/core/v3/reference
+
+## Dimensions & Metrics Explorer
+- https://developers.google.com/analytics/devguides/reporting/core/dimsmets
+
+## Query Explorer
+- https://ga-dev-tools.appspot.com/query-explorer/
+
+## API Rate Limits
+- https://developers.google.com/analytics/devguides/reporting/core/v3/limits-quotas
+
+# TODO
+- can input not only `profile_name` but also `profile id (view id)`
+- implement following query parametes
+    - offset
+    - quota_user
+    - segment_id
+
+# Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+# Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/corselia/simple-ga-reporting. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+# License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+# Code of Conduct
+Everyone interacting in the SimpleGaReporting project’s codebases, issue trackers, chat rooms and mailing lists is
+expected to follow the [code of conduct](https://github.com/corselia/simple-ga-reporting/blob/master/CODE_OF_CONDUCT.md).

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 "simple_ga_reporting"
+
+# 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(__FILE__)

data/bin/setup

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

data/config/filters.rb

@@ -0,0 +1,19 @@
+module Filters
+  def my_awesome_filter
+  end
+
+  def his_awesome_filter
+  end
+
+  def her_awesome_filter
+  end
+
+  def chrome_or_fx
+    filter :chrome_or_fx, &lambda { contains(:browser, 'Chrome|Firefox') }
+    # filter :chrome_or_fx, &lambda { ['Chrome', 'Firefox'].map { |browser| matches(:browser, browser) } }
+  end
+
+  def over_one_thousand_search_sessions
+    filter :over_one_thousand_search_sessions, &lambda { gte(:searchSessions, 1000) }
+  end
+end

data/config/sample_ga_reporting_config.yml

@@ -0,0 +1,17 @@
+profile_name: my_profile_name
+start_date: 2018-04-01
+end_date: 2018-04-05
+metrics:
+  - users
+  - pageviews
+dimensions:
+  - pagePath
+  - pageTitle
+sort:
+  - -pageviews
+  - -users
+filters:
+  - my_awesome_filter
+  - his_awesome_filter
+  - her_awesome_filter
+limit: 20

data/config/sample_key_and_email.yml

@@ -0,0 +1,2 @@
+private_key: "-----BEGIN PRIVATE KEY-----\nMIIE..........Eqw==\n-----END PRIVATE KEY-----\n"
+client_email: "your_account_name@foobar.iam.gserviceaccount.com"

data/lib/simple_ga_reporting.rb

@@ -0,0 +1,2 @@
+require "simple_ga_reporting/version"
+require 'simple_ga_reporting/simple_ga_reports'

data/lib/simple_ga_reporting/legato_ga_model.rb

@@ -0,0 +1,15 @@
+require $filters_file
+
+class LegatoGaModel
+  extend Legato::Model
+  extend Filters
+
+  # TODO: oh...global variable...
+  dimensions(*$model_config['dimensions'])
+  metrics(*$model_config['metrics'])
+
+  # TODO: 'Filters' is hard coding
+  Filters.instance_methods.each do |symbol_method_name|
+    send(symbol_method_name.to_s)
+  end
+end

data/lib/simple_ga_reporting/legato_ga_user.rb

@@ -0,0 +1,49 @@
+require 'legato'
+require 'oauth2'
+require 'signet/oauth_2/client'
+
+module LegatoGaUser
+  SCOPE                 = 'https://www.googleapis.com/auth/analytics.readonly'.freeze
+  TOKEN_CREDENTIAL_URI  = 'https://accounts.google.com/o/oauth2/token'.freeze
+  AUDIENCE              = 'https://accounts.google.com/o/oauth2/token'.freeze
+  AUTHORIZE_URL         = 'https://accounts.google.com/o/oauth2/auth'.freeze
+  TOKEN_URL             = 'https://accounts.google.com/o/oauth2/token'.freeze
+
+  # private
+  def create_ga_user(key_and_email_file='config/key_and_email.yml')
+    signing_key = OpenSSL::PKey::RSA.new(private_key(key_and_email_file))
+    auth_client = Signet::OAuth2::Client.new(
+      token_credential_uri: TOKEN_CREDENTIAL_URI,
+      audience: AUDIENCE,
+      scope: SCOPE,
+      issuer: client_email(key_and_email_file),
+      signing_key: signing_key,
+      sub: client_email(key_and_email_file),
+    )
+    access_token = auth_client.fetch_access_token!
+
+    oauth_client = OAuth2::Client.new('', '', {
+      authorize_url: AUTHORIZE_URL,
+      token_url: TOKEN_URL,
+    })
+
+    token = OAuth2::AccessToken.new(
+      oauth_client,
+      access_token['access_token'],
+      expires_in: access_token['expires_in'],
+    )
+
+    ga_user = Legato::User.new(token)
+    ga_user.access_token.expired?
+
+    ga_user
+  end
+
+  def private_key(key_and_email_file)
+    YAML.load_file(key_and_email_file)['private_key']
+  end
+
+  def client_email(key_and_email_file)
+    YAML.load_file(key_and_email_file)['client_email']
+  end
+end

data/lib/simple_ga_reporting/simple_ga_reports.rb

@@ -0,0 +1,84 @@
+require 'simple_ga_reporting/legato_ga_user'
+
+class SimpleGaReports
+  extend LegatoGaUser
+end
+
+class << SimpleGaReports
+  def configure(yaml_file='config/ga_reporting_config.yml', filters_file='config/filters.rb', **options)
+    # TODO: oh... global variable...
+    $model_config = YAML.load_file(yaml_file)
+    $filters_file = filters_file
+
+    require 'simple_ga_reporting/legato_ga_model'
+    query_parameters($model_config, options)
+  end
+
+  def filtered_results(key_and_email_file)
+    raw_results = raw_results(key_and_email_file)
+    filtering(raw_results)
+  end
+
+  def raw_results(key_and_email_file)
+    # 'legato_ga_model' method is generated by Model class automatically
+    query = ga_profile(key_and_email_file).legato_ga_model
+
+    query.results(
+      start_date: @start_date,
+      end_date: @end_date,
+      limit: @limit,
+      # offset: @offset,
+      sort: @sort,
+      # quota_user: @quota_user,
+      sampling_level: @sampling_level,
+      # segment_id: @segment_id,
+    )
+  end
+
+  def filtering(results)
+    if @filters
+      @filters.each do |filter_symbol_name|
+        results = results.send(filter_symbol_name) # TODO: oh... send method...
+      end
+    end
+
+    results
+  end
+
+  # TODO: should specify by profile id, too
+  def ga_profile(key_and_email_file)
+    ga_user = create_ga_user(key_and_email_file)
+
+    ga_user.profiles.each do |profile|
+      return profile if profile.name === @profile_name
+    end
+  end
+
+  # HACK: not cool descriptions
+  def query_parameters(model_config, **options)
+    @start_date     = options[:start_date] ? options[:start_date] : model_config['start_date']
+    @end_date       = options[:end_date] ? options[:end_date] : model_config['end_date']
+    @limit          = options[:limit] ? options[:limit] : model_config['limit']
+    # @offset         = options[:offset] ? options[:offset] : model_config['offset']
+    @sort           = options[:sort] ? options[:sort] : model_config['sort'] # Array
+    # @quota_user     = options[:quota_user] ? options[:quota_user] : model_config['quota_user']
+    @sampling_level = options[:sampling_level] ? options[:sampling_level] : 'HIGHER_PRECISION'
+    # @segment_id     = options[:segment_id] ? options[:segment_id] : model_config['segment_id']
+    @filters        = options[:filters] ? options[:filters] : model_config['filters'] # Array
+    @profile_name   = options[:profile_name] ? options[:profile_name] : model_config['profile_name']
+
+    # for RSpec (ummm... not good)
+    {
+      start_date: @start_date,
+      end_date: @end_date,
+      limit: @limit,
+      offset: @offset,
+      sort: @sort,
+      quota_user: @quota_user,
+      sampling_level: @sampling_level,
+      segment_id: @segment_id,
+      filters: @filters,
+      profile_name: @profile_name,
+    }
+  end
+end

data/lib/simple_ga_reporting/version.rb

@@ -0,0 +1,3 @@
+module SimpleGaReporting
+  VERSION = '1.0.0'
+end

data/simple_ga_reporting.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simple_ga_reporting/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_ga_reporting"
+  spec.version       = SimpleGaReporting::VERSION
+  spec.authors       = ["Osamu Takiya"]
+  spec.email         = ["takiya@toran.sakura.ne.jp"]
+
+  spec.summary       = %q{With simple configuration (YAML), you can obtain Google Analytics reporting data}
+  spec.description   = %q{This gem is powered by Legato gem. First of all, you create configuration YAML file as Google Analytics API. Then execute the simple Ruby code, and you obtain Google Analytics Reporting Data. Very simple.}
+  spec.homepage      = "https://github.com/corselia/simple-ga-reporting"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rspec_junit_formatter" # 'cannot load such file -- rspec_junit_formatter'
+
+  spec.add_dependency "legato"
+  spec.add_dependency "oauth2"
+  spec.add_dependency "signet"
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: simple_ga_reporting
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Osamu Takiya
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: rspec
+  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: guard-rspec
+  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: rspec_junit_formatter
+  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: legato
+  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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: signet
+  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: This gem is powered by Legato gem. First of all, you create configuration
+  YAML file as Google Analytics API. Then execute the simple Ruby code, and you obtain
+  Google Analytics Reporting Data. Very simple.
+email:
+- takiya@toran.sakura.ne.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/filters.rb
+- config/sample_ga_reporting_config.yml
+- config/sample_key_and_email.yml
+- images/config_filter_by_gui.png
+- images/dimensions_and_metrics_explorer.png
+- images/ga_add_api_user.png
+- images/ga_profile(view).png
+- images/ga_query_parametes_summary.png
+- images/gcp_activate_api_01.png
+- images/gcp_activate_api_02.png
+- images/gcp_activate_api_03.png
+- images/gcp_api_auth_info.png
+- images/gcp_api_menu.png
+- images/gcp_download_json_key.png
+- images/gcp_private_key_and_client_email.png
+- lib/simple_ga_reporting.rb
+- lib/simple_ga_reporting/legato_ga_model.rb
+- lib/simple_ga_reporting/legato_ga_user.rb
+- lib/simple_ga_reporting/simple_ga_reports.rb
+- lib/simple_ga_reporting/version.rb
+- simple_ga_reporting.gemspec
+homepage: https://github.com/corselia/simple-ga-reporting
+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.7.3
+signing_key: 
+specification_version: 4
+summary: With simple configuration (YAML), you can obtain Google Analytics reporting
+  data
+test_files: []