google_api 1.0.2 → 1.0.3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v1.0.3
+
+* GoogleApi::Ga::Data has now silent error, GoogleApi::Ga::Data.error(true) - raise error, GoogleApi::Ga::Data.error(false) - not error (default)
+* add GoogleApi::Ga::Data.use_cache
+* add GoogleApi::Ga::Data.clear_cache
+
 ## v1.0.2
 
 * ids is convert to integer

data/README.md

@@ -239,22 +239,73 @@ First you can play on the playground: http://ga-dev-tools.appspot.com/explorer/.
 ```ruby
 GoogleApi::Ga::Data
 ```
+
 <br>
+
+<table>
+  <thead>
+    <tr>
+      <th>method name</th>
+      <th>alias</th>
+    </tr>
+  </thead>
+  
+  <tbody>
+    <tr>
+      <td>ids</td>
+      <td>id</td>
+    </tr>
+    <tr>
+      <td>start_date</td>
+      <td>from</td>
+    </tr>
+    <tr>
+      <td>end_date</td>
+      <td>to</td>
+    </tr>
+    <tr>
+      <td>metrics</td>
+      <td>select</td>
+    </tr>
+    <tr>
+      <td>dimensions</td>
+      <td>with</td>
+    </tr>
+    <tr>
+      <td>sort</td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>filters</td>
+      <td>where</td>
+    </tr>
+    <tr>
+      <td>segment</td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>start_index</td>
+      <td>offset</td>
+    </tr>
+    <tr>
+      <td>max_results</td>
+      <td>offset</td>
+    </tr>
+  </tbody>
+</table>
+
+
 > ## ids 
 >
-> <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#ids" target="_blank" style="float:right">doc</a>
->
-> **alias:** id
+> **doc:** <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#ids" target="_blank">doc</a>
 >
 > Id of profile, by default is use id from GoogleApi::Ga.id.
 
 <br>
 
-> ## start_date
->
-> <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#startDate" target="_blank" style="float:right">doc</a>
+> ## start_date, &nbsp;&nbsp; end_date
 >
-> **alias:** from
+> **doc:** <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#startDate" target="_blank">start-date</a>, <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#startDate" target="_blank">end-date</a>
 >
 > **default:** _Date.today_<br>
 > **parameters:**<br>
@@ -263,59 +314,19 @@ GoogleApi::Ga::Data
 
 <br>
 
-> ## end_date
->
-> <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#startDate" target="_blank" style="float:right">doc</a>
+> ## metrics, &nbsp;&nbsp; dimensions, &nbsp;&nbsp; sort
 >
-> **alias:** from
->
-> **default:** _Date.today_<br>
-> **parameters:**<br>
-> &nbsp;&nbsp; _String_ in YYYY-MM-DD or _Date_ or _DateTime_ or _Time_<br>
-> &nbsp;&nbsp; _Integer_ for add or sub days from _Date.today_
-
-<br>
-
-> ## metrics
+> **doc:** <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#metrics" target="_blank">metrics</a>, <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#dimensions" target="_blank">dimensions</a>, <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#sort" target="_blank">sort</a>
 >
-> <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#metrics" target="_blank" style="float:right">doc</a>
->
-> required parameters
->
-> **alias:** select
->
-> you can also add or sub parameters with `.metrics_add` or `.metrics_sub`
->
-> **parameters:** Array with String or Symbol, String (not compiled, <i>"ga:visitors"</i>) or Symbol (compiled, <i>:visitors</i>)
-
-<br>
-
-> ## dimensions
->
-> <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#dimensions" target="_blank" style="float:right">doc</a>
->
-> **alias:** with
->
-> you can also add or sub parameters with `.dimensions_add` or `.dimensions_sub`
+> you can also add or sub parameters with `.method_add` or `.method_sub`
 >
 > **parameters:** Array with String or Symbol, String (not compiled, <i>"ga:visitors"</i>) or Symbol (compiled, <i>:visitors</i>)
 
 <br>
 
-> ## sort
+> ## filters, &nbsp;&nbsp; segment
 >
-> <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#sort" target="_blank" style="float:right">doc</a>
-> you can also add or sub parameters with `.sort_add` or `.sort_sub`
->
-> **parameters:** Array with String or Symbol, String (not compiled, <i>"ga:visitors"</i>) or Symbol (compiled, <i>:visitors</i>)
-
-<br>
-
-> ## filters
->
-> <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters" target="_blank" style="float:right">doc</a>
->
-> **alias:** where
+> **doc:** <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters" target="_blank">filters</a>, <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#segment" target="_blank">segment</a>
 >
 > **parameters:**<br>
 > {(attribute operator value) & (attribute operator value) | (attribute operator value)} or String (not compiled)
@@ -326,25 +337,9 @@ GoogleApi::Ga::Data
 
 <br>
 
-> ## segment
->
-> <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#segment" target="_blank" style="float:right">doc</a>
->
-> **parameters:**<br>
-> {(attribute operator value) & (attribute operator value) | (attribute operator value)} or String (not compiled) <br>
->  with {} automaticly add "dynamic::"
->
-> **operators:** ==, !=, >, <, >=, <=, =~, !~<br>
-> % &nbsp;&nbsp;&nbsp; _is &nbsp;=@_<br>
-> ** &nbsp;&nbsp;&nbsp; _is &nbsp;&nbsp;!@_
-
-<br>
-
 > ## start_index
 >
-> <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#startIndex" target="_blank" style="float:right">doc</a>
->
-> **alias:** offset
+> **doc:** <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#startIndex" target="_blank">start-index</a>
 >
 > **parameters:** Integer from 1. 
 
@@ -352,33 +347,49 @@ GoogleApi::Ga::Data
 
 > ## max_results
 >
-> <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#maxResults" target="_blank" style="float:right">doc</a>
->
-> **alias:** limit
+> **doc:** <a href="https://developers.google.com/analytics/devguides/reporting/core/v3/reference#maxResults" target="_blank">max-results</a>
 >
 > **parameters:** Integer from 1 to 10 000. 
 
-<br><br><br>
 
-> ## cache
-> 
-> For how long in minutes will be data cached. Use 0 for never expire.
+### Cache
 
-<br>
+For how long in minutes will be data cached. Use 0 for never expire.
+```ruby
+GoogleApi::Ga::Data.cache(minutes)
 
-> ## clear
->
-> Clear stored data.
+# you can also clear cache
+GoogleApi::Ga::Data.clear_cache
+
+# if you want clear cache and cache new
+GoogleApi::Ga::Data.select(:visits).clear_cache.cache(60)
+
+# orif you don't want use cache at all, default: true
+GoogleApi::Ga::Data.use_cache(false)
+```
+
+### Error
+
+What happen if parameters are wrong.
+```ruby
+# raise error with message
+GoogleApi::Ga::Data.error(true)
+
+# default, not raise error, just empty result
+GoogleApi::Ga::Data.error(false)
+```
 
 ### Fetch data
 
 You can use one of these. Data is stored in the class.
 
-`.all` - `[header, rows]`<br>
-`.rows` - rows returned by google analytics<br>
-`.header` - header of data, (`["ga:day", "ga:month", "ga:visitis"]`)<br>
-`.count` - number of rows<br>
-`.each` - each as you expected, (`|data|` or `|index, data|`)
+```
+.all    # [header, rows]
+.rows   # rows returned by google analytics
+.header # header of data, (["ga:day", "ga:month", "ga:visitis"])
+.count  # number of rows
+.each   # each as you expected, (`|data|` or `|index, data|`)
+```
 
 ### Clear stored data and fetch again
 

data/lib/google_api/ga/data.rb

@@ -8,6 +8,8 @@ module GoogleApi
         @metrics, @dimensions, @sort = [], [], []
         @filters, @segment = nil, nil
         @start_index, @max_results = nil, nil
+        @error = false
+        @use_cache = true
       end
 
       # Auto initialize data 
@@ -235,6 +237,39 @@ module GoogleApi
         end
       end
 
+      # -----------------------------------------------------------------------------------
+      # Type 5
+      #
+      # Error, use cache
+      #
+      TYPE_5 = { error:     nil,
+                 use_cache: nil }
+      TYPE_5.each do |key, value|
+        eval <<-METHOD
+          def #{key}(value = nil)
+            if value.nil?
+              return @#{key}
+            end
+
+            if !value.is_a?(TrueClass) && !value.is_a?(FalseClass)
+              raise GoogleApi::TypeError, "Value must be true of false"
+            end
+
+            self.#{key} = value
+            self
+          end
+
+          def #{key}=(value)
+            @#{key} = value
+          end
+        METHOD
+      end
+
+      def clear_cache
+        _cache.delete(parameters)
+        self
+      end
+
       # Add row!, header!, all!, count!. First clear and run method .
       [:rows, :header, :all, :count].each do |value|
         eval <<-METHOD
@@ -283,7 +318,7 @@ module GoogleApi
       private
 
         def data
-          @data ||= get.data
+          @data ||= get
         end
 
         def parameters
@@ -322,18 +357,22 @@ module GoogleApi
         end
 
         def get
-          if @cache && _cache.exists?(parameters)
+          if @use_cache && _cache.exists?(parameters)
             return _cache.read(parameters)
           end
 
           result = _session.client.execute( api_method: _session.api.data.ga.get,
                                             parameters: parameters )
 
-          if result.error?
+          if @error && result.error?
             raise GoogleApi::GaError, result.error_message
           end
 
-          _cache.write(parameters, result, @cache) if @cache.is_a?(Integer)
+          result = result.data
+
+          if @use_cache && !@cache.nil?
+            _cache.write(parameters, result, @cache)
+          end
 
           result
         end

data/lib/google_api/version.rb

@@ -1,3 +1,3 @@
 module GoogleApi
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_api
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors: