hisui 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b39bcdc510844184ee5b7115e3c5993498d596b022902ca9af4b7ad045847082
-  data.tar.gz: '094b0cfe1131f880dc85f65e555aa47f1b343e90927ee3b1e71ebbbce500b717'
+  metadata.gz: ed5550e23b11889424c0bf4ec332d655989f080ab442e78954e62342b9450a65
+  data.tar.gz: c4d88b0d28878e96196ba088db6b6610617cbeba5e3c7dd4f2c8c013bef708df
 SHA512:
-  metadata.gz: 8ccfbdb73e5904d98d776737c274a4195b83bbc118fe35fca914e09b47506d0aceeafedc99e08ecc468256310cf515c5fc0ec969c3e1052ffdad8ec5e413e634
-  data.tar.gz: 88c3098046b9dec4896f84702dc79ec9746a58188dab2a97be1ac2183c8b54fd4a4af438de18a3d0c4c13faf0db21cef56ef04620d0a35f50ac34e1e80968dea
+  metadata.gz: 1ab1c8635dd6023ca3778c47df5940d846e89ee02e701b66cbd2252bc15bb7a0e72cf3d0a2fc5be38985680e36b0798cb81cb2a653b21ae8d12da2ef7444e7bf
+  data.tar.gz: 8ec50ed5bdc40a0d28f86e90052323532c61ace7c8b71eba99232978066238dad326b1747e032ec78e5451252b16f6b39cd3b13d868f40a22f5a59f29c8972b1

data/README.md

@@ -88,6 +88,23 @@ response.data?
 #=> true
 ```
 
+#### Filtering
+When you set `filters_expression` method with `field_name`, `operator` and `value` params, you can filter Google Analytics Data.
+
+For example, this is filtered by organic.
+```ruby
+class OrganicMedium
+  extend Hisui::Model
+
+  metrics :pageviews, :sessions, :users, :new_users, :bounce_rate, :pageviews_per_session, :avg_session_duration
+  dimensions :medium
+  filters_expression({ field_name: 'medium', operator: '==', value: 'organic' })
+end
+```
+
+other `operator` s are [here](https://developers.google.com/analytics/devguides/reporting/core/v3/reference?hl=ja#filterOperators)
+
+
 ## Contributing
 Fork it, fix me, and send me your pull requests.
 

data/lib/hisui.rb

@@ -4,6 +4,7 @@ require 'hisui/user'
 require 'hisui/model'
 require 'hisui/request'
 require 'hisui/response'
+require 'hisui/filters_expression'
 
 require 'hisui/management/base'
 require 'hisui/management/account'

data/lib/hisui/filters_expression.rb

@@ -0,0 +1,13 @@
+module Hisui
+  class FiltersExpression
+    def initialize(field_name:, value:, operator:)
+      @field_name = field_name
+      @value = value
+      @operator = operator
+    end
+
+    def to_param
+      "#{Hisui.to_ga_string(@field_name)}#{@operator}#{@value}"
+    end
+  end
+end

data/lib/hisui/model.rb

@@ -34,6 +34,22 @@ module Hisui
       @order_bys
     end
 
+    # Adds filters_expression to the class for retrieval from GA
+    #
+    # @param field [Hash] options:
+    #   * field_name
+    #   * operator
+    #   * value
+    #
+    # operators are '==', '~=' and so on. cf: https://developers.google.com/analytics/devguides/reporting/core/v3/reference?hl=ja#filters
+    #
+    # @return concatenated string
+    def filters_expression(field = nil)
+      @filters_expression ||= ''
+      @filters_expression = Hisui::FiltersExpression.new(field).to_param if field
+      @filters_expression
+    end
+
     def results(profile:, **options)
       Hisui::Request.new(profile: profile, model: self, **options).fetch_data
     end

data/lib/hisui/request.rb

@@ -34,6 +34,7 @@ module Hisui
           metrics: model.metrics,
           dimensions: model.dimensions,
           date_ranges: date_ranges,
+          filters_expression: model.filters_expression,
           order_bys: model.order_bys,
           page_size: limit
         )]

data/lib/hisui/version.rb

@@ -1,3 +1,3 @@
 module Hisui
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hisui
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - ikepon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-01 00:00:00.000000000 Z
+date: 2018-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -161,6 +161,7 @@ files:
 - README.md
 - Rakefile
 - lib/hisui.rb
+- lib/hisui/filters_expression.rb
 - lib/hisui/management/account.rb
 - lib/hisui/management/account_summary.rb
 - lib/hisui/management/base.rb