hisui 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: af55565557423055909d226c7e42fa826269a5e5
-  data.tar.gz: 164cc444aa1143b0b5c60e07a1582a49054bd409
+SHA256:
+  metadata.gz: 2f63cc587035f036777979c56d4d39fed2e9f512e126d3809b3a85a7487ff675
+  data.tar.gz: '08e8bea765cb07fae43410ce041ab2ff38bf4ea51c997240f4fac1b05aed0b83'
 SHA512:
-  metadata.gz: 1fdc7389ce7da297b307d14036fd5b5bc83228151fc428c6d24efe758fbf78f7b208df954ed10623b8993835bda3c86d86c01d13f2722881c5f55596f65e40f5
-  data.tar.gz: 957b5861d9ff9e41016cd4b73ccfd20b989e5ed98ce17f1adcf62f8c5cd04502a8c31562cad78e4d51e1e60da186b0d95efad4d859f9a52f11ef0e14b4d24ed3
+  metadata.gz: 4196498ee4b4985e30cbac8391115c78b3a43de0e8cb06273f89b12eaa4cfe27fd64c5357d0c5794a56d2ff0a1be5590aa6067a238c14c54a2890474ef178a6d
+  data.tar.gz: d69cf054f142c53fee1692253c6d9b4c6b5d8479fbe5aa80b90b10f5c6f669b280585d76645586a5e3ae0ac138795ccdd44ec76ba743b7131875c5af8beef4dd

data/README.md

@@ -44,22 +44,45 @@ end
 
 3. Get Google Analytics API response with `results` methods.
 Set `start_date` and `end_date` if you need.(defult period is past one month)
+Set `compare_start_date` and `compare_end_date` if you need.
 ```ruby
-response = DailySummary.results(profile: profile, start_date: Date.current - 7.days, end_date: Date.current)
+response = DailySummary.results(profile: profile, start_date: Date.current - 7.days, end_date: Date.current, compare_start_date: Date.current - 7.days - 1.month, compare_end_date: Date.current - 1.month)
 ```
 
 4. Use data.
 ```ruby
+# Deprecate
 response.raw_attributes
 
 #=> [#<OpenStruct date="20171122", pageviews="137", sessions="73", users="51", newUsers="43", bounceRate="69.56521739130434", pageviewsPerSession="2.608695652173913", avgSessionDuration="87.69565217391305">,
 # ...
 # #<OpenStruct date="20171129", pageviews="95", sessions="67", users="44", newUsers="32", bounceRate="80.0", pageviewsPerSession="2.25", avgSessionDuration="42.0">]
 
+response.primary
+
+#=> [#<OpenStruct date="20171122", pageviews="137", sessions="73", users="51", newUsers="43", bounceRate="69.56521739130434", pageviewsPerSession="2.608695652173913", avgSessionDuration="87.69565217391305">,
+# ...
+# #<OpenStruct date="20171129", pageviews="95", sessions="67", users="44", newUsers="32", bounceRate="80.0", pageviewsPerSession="2.25", avgSessionDuration="42.0">]
+
+response.comparing
+
+#=> [#<OpenStruct date="20171022", pageviews="130", sessions="69", users="45", newUsers="40", bounceRate="70.09567898751234", pageviewsPerSession="1.884057975234981", avgSessionDuration="85.02349863284283">,
+# ...
+# #<OpenStruct date="20171029", pageviews="95", sessions="67", users="44", newUsers="32", bounceRate="80.0", pageviewsPerSession="2.25", avgSessionDuration="42.0">]
+
+# Deprecate
 response.total_values
 
 #=> #<OpenStruct pageviews="646", sessions="308", users="223", newUsers="144", bounceRate="77.77777777777779", pageviewsPerSession="2.3518518518518519", avgSessionDuration="62.148148148148145">
 
+response.primary_total
+
+#=> #<OpenStruct pageviews="646", sessions="308", users="223", newUsers="144", bounceRate="77.77777777777779", pageviewsPerSession="2.3518518518518519", avgSessionDuration="62.148148148148145">
+
+response.comparing_total
+
+#=> #<OpenStruct pageviews="640", sessions="299", users="213", newUsers="138", bounceRate="75.97253924292489", pageviewsPerSession="2.1404682398523578", avgSessionDuration="60.814845134904329">
+
 response.data?
 
 #=> true

data/lib/hisui/request.rb

@@ -2,9 +2,9 @@ require 'google/apis/analyticsreporting_v4'
 
 module Hisui
   class Request
-    BASIC_OPTION_KEYS = [:start_date, :end_date, :limit]
+    BASIC_OPTION_KEYS = [:start_date, :end_date, :compare_start_date, :compare_end_date, :limit]
 
-    attr_accessor :profile, :model, :start_date, :end_date, :limit
+    attr_accessor :profile, :model, :start_date, :end_date, :compare_start_date, :compare_end_date, :limit
 
     def initialize(profile:, model:, **options)
       @profile = profile
@@ -21,14 +21,19 @@ module Hisui
       reporting_service = Google::Apis::AnalyticsreportingV4::AnalyticsReportingService.new
       reporting_service.authorization = profile.user.access_token.token
 
-      date_range = Google::Apis::AnalyticsreportingV4::DateRange.new(start_date: start_date.to_s, end_date: end_date.to_s)
+      date_ranges = []
+      date_ranges << Google::Apis::AnalyticsreportingV4::DateRange.new(start_date: start_date.to_s, end_date: end_date.to_s)
+
+      if compare_start_date && compare_end_date
+        date_ranges << Google::Apis::AnalyticsreportingV4::DateRange.new(start_date: compare_start_date.to_s, end_date: compare_end_date.to_s)
+      end
 
       request = Google::Apis::AnalyticsreportingV4::GetReportsRequest.new(
         report_requests: [Google::Apis::AnalyticsreportingV4::ReportRequest.new(
           view_id: profile.id,
           metrics: model.metrics,
           dimensions: model.dimensions,
-          date_ranges: [date_range],
+          date_ranges: date_ranges,
           order_bys: model.order_bys,
           page_size: limit
         )]

data/lib/hisui/response.rb

@@ -7,8 +7,13 @@ module Hisui
     end
 
     def raw_attributes
-      @raw_attributes ||= begin
-        raw_attributes = []
+      warn "[DEPRECATION] `raw_attributes` is deprecated. Please use `primary` instead."
+      primary
+    end
+
+    def primary
+      @primary ||= begin
+        primary = []
 
         data.rows.each do |row|
           row_data = []
@@ -20,15 +25,47 @@ module Hisui
             row_data << value
           end
 
-          raw_attributes << Hash[fields.zip(row_data)]
+          primary << Hash[fields.zip(row_data)]
+        end
+
+        primary.map { |attributes| OpenStruct.new(attributes) }
+      end
+    end
+
+    def comparing
+      @comparing ||= begin
+        comparing = []
+
+        data.rows.each do |row|
+          row_data = []
+          row.dimensions.each do |dimension|
+            row_data << dimension
+          end
+
+          if row.metrics.second
+            row.metrics.second.values.each do |value|
+              row_data << value
+            end
+          end
+
+          comparing << Hash[fields.zip(row_data)]
         end
 
-        raw_attributes.map { |attributes| OpenStruct.new(attributes) }
+        comparing.map { |attributes| OpenStruct.new(attributes) }
       end
     end
 
     def total_values
-      @total_values ||= OpenStruct.new(Hash[metrics.zip(data.totals.first.values)])
+      warn "[DEPRECATION] `total_values` is deprecated. Please use `primary_total` instead."
+      primary_total
+    end
+
+    def primary_total
+      @primary_total ||= OpenStruct.new(Hash[metrics.zip(data.totals.first.values)])
+    end
+
+    def comparing_total
+      @comparing_total ||= OpenStruct.new(Hash[metrics.zip(data.totals.try(:second).try(:values) || [])])
     end
 
     def data?
@@ -38,7 +75,7 @@ module Hisui
     private
 
     def column_header
-      @column_header = response.reports.first.column_header
+      @column_header ||= response.reports.first.column_header
     end
 
     def metrics
@@ -66,7 +103,7 @@ module Hisui
     end
 
     def data
-      @data = response.reports.first.data
+      @data ||= response.reports.first.data
     end
   end
 end

data/lib/hisui/version.rb

@@ -1,3 +1,3 @@
 module Hisui
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hisui
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - ikepon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-24 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Access the Google Analytics Reporting API v4 On Rails