simple_ga_reporting 1.0.4 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5bdd2b6b626663dae4feb9dfb1f55c9a4cb408c00d9cac06c719e7f6127c0c9
-  data.tar.gz: 9cedf4ac77b7eebede41f4ce90e2ce040df67c4f97d774a95d515b834a659044
+  metadata.gz: 93f5bda8c264e442196ebdecc2f40f062a5edb040eccd07eb583642d060e12d8
+  data.tar.gz: 06411f48196f37897f11e104f7afcca247e268124f7e90d6861f80a0413eb2f0
 SHA512:
-  metadata.gz: d83595d8a9340353fbde1720c29ab48cf7fc62574b18c13e3dbd41dd1f2e0214371a355ccf92c7b34761246253f984f558aa802a23ed63e586b2b1ec514cc032
-  data.tar.gz: 173e4cac204fdb34e7d8dddb34b36075cafcc9583afeac1a207db94331108b43bf7841045ad791eef7daf627338cad429c9c5ab92e1fc7b61ce9a0dac8dd2e90
+  metadata.gz: 24886998f3a4548f1a03e242adb06e6d5f227a4703d8b72227d92e22307e4c76f0cccdfe88464690079ba92eabdbdf3c76d87c7cee4cb57d8099db269a2f239e
+  data.tar.gz: 7dccf9f673c5970bc38ba984ba3e9411ee58a4d5f03377c054858d0d1301edb1b45909957c05d2a5f469d50b637d12ef0c9aa2a028ea81bf5bc0335d528cc23d

data/.gitignore

@@ -54,4 +54,6 @@ build-iPhoneSimulator/
 
 Gemfile.lock
 Guardfile
-.idea/
+.idea/
+config/
+sample_app.rb

data/README.md

@@ -1,5 +1,9 @@
 [![Gem Version](https://badge.fury.io/rb/simple_ga_reporting.svg)](https://badge.fury.io/rb/simple_ga_reporting) [![CircleCI](https://circleci.com/gh/corselia/simple-ga-reporting.svg?style=svg)](https://circleci.com/gh/corselia/simple-ga-reporting)
 
+# Japanese Document
+- Japanese Document (my blog's article) is following
+    - [Google Analytics の API を用いて簡単にデータを取得できる gem を作りました](https://obel.hatenablog.jp/entry/20180409/1523282148)
+
 # What's this?
 This gem helps you to obtain `Google Analytics` reporting data with ease.
 
@@ -45,7 +49,7 @@ $ gem install simple-ga-reporting
         - `SimpleGaReports.filtered_results`
     - Only three lines :-)
     - Note
-        - If you don't use filters, use `SimpleGaReports.raw_results`
+        - If you don't use filters, also use `SimpleGaReports.raw_results`
         - when no filter is in configure file, `SimpleGaReports.raw_results` is the same as `SimpleGaReports.filtered_results`
 
 ```ruby
@@ -302,9 +306,8 @@ end
 ```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')
+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.each do |result|
   puts '==================================='
@@ -410,6 +413,7 @@ HAPPY CHECK!
     - offset
     - quota_user
     - segment_id
+        - `segment` is the conbination of filters actually, so you can use 'filters' as alternative way
 
 # 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_model.rb

@@ -1,4 +1,4 @@
-require $filters_file
+require File.expand_path("../../../#{$filters_file}", __FILE__) # TODO: not cool...?
 
 class LegatoGaModel
   extend Legato::Model

data/lib/simple_ga_reporting/legato_ga_user.rb

@@ -11,15 +11,15 @@ module LegatoGaUser
   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))
+  def create_ga_user(key_and_email)
+    signing_key = OpenSSL::PKey::RSA.new(private_key(key_and_email))
     auth_client = Signet::OAuth2::Client.new(
       token_credential_uri: TOKEN_CREDENTIAL_URI,
       audience: AUDIENCE,
       scope: SCOPE,
-      issuer: client_email(key_and_email_file),
+      issuer: client_email(key_and_email),
       signing_key: signing_key,
-      sub: client_email(key_and_email_file),
+      sub: client_email(key_and_email),
     )
     access_token = auth_client.fetch_access_token!
 
@@ -40,11 +40,11 @@ module LegatoGaUser
     ga_user
   end
 
-  def private_key(key_and_email_file)
-    YAML.load_file(key_and_email_file)['private_key']
+  def private_key(key_and_email)
+    YAML.load_file(key_and_email)['private_key']
   end
 
-  def client_email(key_and_email_file)
-    YAML.load_file(key_and_email_file)['client_email']
+  def client_email(key_and_email)
+    YAML.load_file(key_and_email)['client_email']
   end
 end

data/lib/simple_ga_reporting/simple_ga_reports.rb

@@ -6,23 +6,23 @@ class SimpleGaReports
 end
 
 class << SimpleGaReports
-  def configure(yaml_file, filters_file='simple_ga_reporting/config/filters.rb', **options)
+  def configure(report_config: 'config/ga_reporting_config.yml', filters: 'config/filters.rb', **options)
     # TODO: oh... global variable...
-    $model_config = YAML.load_file(yaml_file)
-    $filters_file = filters_file
+    $model_config = YAML.load_file(report_config)
+    $filters_file = filters
 
     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)
+  def filtered_results(key_and_email: 'config/key_and_email.yml')
+    raw_results = raw_results(key_and_email)
     filtering(raw_results)
   end
 
-  def raw_results(key_and_email_file)
+  def raw_results(key_and_email)
     # 'legato_ga_model' method is generated by Model class automatically
-    query = ga_profile(key_and_email_file).legato_ga_model
+    query = ga_profile(key_and_email).legato_ga_model
 
     query.results(
       start_date: @start_date,
@@ -47,8 +47,8 @@ class << SimpleGaReports
   end
 
   # TODO: should specify by profile id, too
-  def ga_profile(key_and_email_file)
-    ga_user = create_ga_user(key_and_email_file)
+  def ga_profile(key_and_email)
+    ga_user = create_ga_user(key_and_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.0.4'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_ga_reporting
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.1
 platform: ruby
 authors:
 - Osamu Takiya
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2018-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler