simple_ga_reporting 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f221a740b8c7c09dca3d7610864ec4d7593eb14ee85a7f263d76576880d5ee1c
-  data.tar.gz: 40473825da12f440658e5f140ab0f06cd4eb70632a7247f7fec06e65a7fdf58c
+  metadata.gz: fa9e0716b143f6bcd77b14b370d0be17a9cbb342b003112c1f751b3f62a77c28
+  data.tar.gz: 9365ff9c38abdd3843b655eed514561c2cc8b0f4d2023b2677d876cf0a9f3c54
 SHA512:
-  metadata.gz: 5fa0a15cde2dc0ee6df4b6f763a99bc4197c8315833398f079cee538cfd3ffdafe5aaf170299de50df2195dd81c0019980416c47eef463c2172d7d1c1673ddc2
-  data.tar.gz: a3029692fb6e0ebf7a2a7fbbef3d27318d1dfb82d7bdf9f7d15a2e57dda6530d821c4907ce4fa5a87eabe6fa98796884ed88ab1103e71fcb2ad57d6443143fa5
+  metadata.gz: 6c15749c7b62e206da384a60038efc2e68a4f7af05e3124b075c59c9db7dcfa63fa9343eba76bc9f95fbad299f95b28213b904dc22182f703832fa2675237cb9
+  data.tar.gz: 759044dc38c099c886fe41b8cc8f845e880fa5e5ab067651b878fdc3585761a6d19cadeae5d239ffb5f4b61ef25b69b525d93a786b6808298ff1737d51579a53

data/README.md

@@ -14,21 +14,30 @@ 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`.
+Therefore I developed this wrapper gem, `simple_ga_reporting`.
 
 # Get Started
 
 ## 1. Installation
 ```bash
-$ gem install simple-ga-reporting
+$ gem install simple_ga_reporting
 ```
 
-## 2. Create API configuration file
-- You must create `./config/key_and_email.yml`
+## 2. Set `private_key` and `client_email`
+- There are two ways to set `private_key` and `client_email`
+- How to get above two Key-Value sets is written later
+
+### 2-1. The first way: Create API configuration file
+- 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
+
+### 2-2. The second way: Set values as arguments
+- Set arguments of `SimpleGaReports.filtered_results` method
+- For example:
+    - `SimpleGaReports.filtered_results(private_key: 'FOO', client_email: 'BAR')`
+- Convenient when you set by environment variables
 
 ## 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.
@@ -49,7 +58,7 @@ $ gem install simple-ga-reporting
         - `SimpleGaReports.filtered_results`
     - Only three lines :-)
     - Note
-        - If you don't use filters, also use `SimpleGaReports.raw_results`
+        - If you don't use filters, use `SimpleGaReports.raw_results` too
         - when no filter is in configure file, `SimpleGaReports.raw_results` is the same as `SimpleGaReports.filtered_results`
 
 ```ruby
@@ -59,24 +68,28 @@ SimpleGaReports.configure
 SimpleGaReports.filtered_results #=> Legato::Query
 ```
 
-# Configuration files
+# Detail of configuration
 
-## 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
+## 1. Configuration of API account
+- You must set Google Analytics API configuration, `private_key` and `client_email`
+- There are two ways to set it
+    - The one is by arguments
+        - Set arguments of `SimpleGaReports.filtered_results` method
+    - The other is by YAML file
+        - Default filepath is `./config/key_and_email.yml`
+        - You can change filepath by argument
+- The sample of YAML file 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
+## 2. Google Analytics reporting configuration
 - 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
+    - You can change filepath by argument in `SimpleGaReports.configure` method
+- The sample of YAML file is below
 
 ```yaml
 profile_name: my_profile_name
@@ -98,12 +111,12 @@ filters:
 limit: 20
 ```
 
-- Please refer the official documents as configuration Key-Value sets
+- Please refer the official documents as 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
+- Though above official documents show many Key-Value sets, you can config only several sets as below
     - start-date
     - end-date
     - metrics
@@ -120,7 +133,7 @@ limit: 20
 - The type of `metrics`, `dimensions`, `sort` and `filters` is `Array`
     - The order of elements doesn't matter
 
-## Key-Value detail
+### 2-1. Key-Value detail
 
 #### profile_name
 - REQUIRED
@@ -154,7 +167,6 @@ limit: 20
 
 ![Dimensions & Metrics Explorer](images/dimensions_and_metrics_explorer.png)
 
-
 #### dimensions
 - optional
 - Official documents are below (very useful!)
@@ -188,7 +200,7 @@ limit: 20
 - Original Key name is `samplingLevel`
 - Default value is `HIGHER_PRECISION`
 
-## filters file
+## 3. filters file
 - You use filters function using `filters.rb` file
     - the filename `filters.rb` is determined
         - only filepath is optional
@@ -225,26 +237,42 @@ end
 ## Note
 **YOU MUST SPECIFY ARGUMENTS AS RELATIVE FILEPATH SO YOU MUST ADD './' (dot slash) AT BEGINNING**
 
+- Set arguments of `SimpleGaReports.filtered_results` method
+- For example:
+    - `SimpleGaReports.filtered_results(private_key: 'FOO', client_email: 'BAR')
+- Convenient when you set by environment variables
+
 ## `SimpleGaReports.filtered_results` method
-- take one argument
-- If you don't use filters, use `SimpleGaReports.raw_results` method
+- If you don't use filters, use `SimpleGaReports.raw_results` method instead of `SimpleGaReports.filtered_results` method
     - when no filter is in configure file, `SimpleGaReports.raw_results` is the same as `SimpleGaReports.filtered_results`
+- take three arguments
+    - All arguments are keyword ones
+    - You must set (`key_and_email_file`) or (`private_key` and `client_email`)
 
 1. `key_and_email_file`
     - default is `./config/key_and_email.yml`
 
+1. `private_key`
+    - default is `nil`
+
+1. `client_email`
+    - default is `nil`
+
 ## `SimpleGaReports.configure` method
 - take three arguments
+    - All arguments are keyword ones
 
-1. `yaml_file`
+1. `report_config`
     - first argument
+    - YAML file
     - default is `./config/ga_reporting_config.yml`
 
-1. `filters_file`
+2. `filters`
     - second argument
+    - filter file
     - default is `./config/filters.rb`
 
-1. `**options`
+3. `**options`
     - third argument
     - default is nil
     - if you set this argument, you can overwrite values in Google Analytics reporting configuration file
@@ -313,7 +341,7 @@ end
 require 'simple_ga_reporting'
 
 SimpleGaReports.configure(report_config: './bar/my_ga_reporting_config.yml', filters: './foobar/filters.rb', start_date: '2daysAgo', limit: 100)
-results = SimpleGaReports.filtered_results(key_and_email: './foo/my_key_and_email.yml')
+results = SimpleGaReports.filtered_results(key_and_email: './foo/my_key_and_email.yml') # or use arguments of 'private_key:' and 'client_email:'
 
 results.each do |result|
   puts '==================================='
@@ -330,6 +358,8 @@ private_key: "-----BEGIN PRIVATE KEY-----\nMIIE..........Eqw==\n-----END PRIVATE
 client_email: "your_account_name@foobar.iam.gserviceaccount.com"
 ```
 
+- You can set two key and value by not only YAML file but also arguments of `SimpleGaReports.filtered_results` method
+
 #### 3. `./bar/my_ga_reporting_config.yml`
 ```yaml
 profile_name: my_profile_name
@@ -390,6 +420,13 @@ HAPPY CHECK!
 ......
 ```
 
+# Rails
+When you use this gem on Rails, it's simple :)
+
+1. add this gem to `Gemfile`
+2. `$ bundle install`
+3. after it, the same way above
+
 # Very Awesome Reference Book (Recommended)
 - [わかばちゃんと学ぶ Googleアナリティクス (Let's study Google Analytics with Wakaba-Chan)](http://www.c-r.com/book/detail/1217)
 
@@ -419,7 +456,8 @@ HAPPY CHECK!
     - offset
     - quota_user
     - segment_id
-        - `segment` is the same as conbination of filters, so you can use 'filters' as alternative way
+        - ~~`segment` is the same as conbination of filters, so you can use 'filters' as alternative way~~
+        - `segment` is the first filter for initial population and it can't substitute
 
 # 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.

data/lib/simple_ga_reporting/legato_ga_user.rb

@@ -11,15 +11,18 @@ module LegatoGaUser
   TOKEN_URL             = 'https://accounts.google.com/o/oauth2/token'.freeze
 
   # private
-  def create_ga_user(key_and_email)
-    signing_key = OpenSSL::PKey::RSA.new(private_key(key_and_email))
+  def create_ga_user(key_and_email, private_key: nil, client_email: nil)
+    ga_user_private_key   = private_key.nil? ? private_key(key_and_email) : private_key
+    ga_user_client_email  = client_email.nil? ? client_email(key_and_email) : client_email
+
+    signing_key = OpenSSL::PKey::RSA.new(ga_user_private_key)
     auth_client = Signet::OAuth2::Client.new(
       token_credential_uri: TOKEN_CREDENTIAL_URI,
       audience: AUDIENCE,
       scope: SCOPE,
-      issuer: client_email(key_and_email),
+      issuer: ga_user_client_email,
       signing_key: signing_key,
-      sub: client_email(key_and_email),
+      sub: ga_user_client_email,
     )
     access_token = auth_client.fetch_access_token!
 

data/lib/simple_ga_reporting/simple_ga_reports.rb

@@ -20,14 +20,14 @@ class << SimpleGaReports
     query_parameters($model_config, options)
   end
 
-  def filtered_results(key_and_email: 'config/key_and_email.yml')
-    raw_results = raw_results(key_and_email)
+  def filtered_results(key_and_email: 'config/key_and_email.yml', private_key: nil, client_email: nil)
+    raw_results = raw_results(key_and_email, private_key: private_key, client_email: client_email)
     filtering(raw_results)
   end
 
-  def raw_results(key_and_email)
+  def raw_results(key_and_email, private_key:, client_email:)
     # 'legato_ga_model' method is generated by Model class automatically
-    query = ga_profile(key_and_email).legato_ga_model
+    query = ga_profile(key_and_email, private_key: private_key, client_email: client_email).legato_ga_model
 
     query.results(
       start_date: @start_date,
@@ -52,8 +52,8 @@ class << SimpleGaReports
   end
 
   # TODO: should specify by profile id, too
-  def ga_profile(key_and_email)
-    ga_user = create_ga_user(key_and_email)
+  def ga_profile(key_and_email, private_key:, client_email:)
+    ga_user = create_ga_user(key_and_email, private_key: private_key, client_email: client_email)
 
     ga_user.profiles.each do |profile|
       return profile if profile.name === @profile_name

data/lib/simple_ga_reporting/version.rb

@@ -1,3 +1,3 @@
 module SimpleGaReporting
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_ga_reporting
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Osamu Takiya
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-19 00:00:00.000000000 Z
+date: 2018-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: With simple configuration (YAML), you can obtain Google Analytics reporting