gaapi 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffff326579e103303525b129d3befd2c26304126a20bb7c1f3f54b1aa6d0c7bd
-  data.tar.gz: cef8c48c415155959499cb1c8faec0a422c8cb592ef4159fba906afcbeb47297
+  metadata.gz: 6c7d609f4d8f0c6c08af4d55afaf5f0b55f29f04ee94cd5d8b3acad4cbcbd8c2
+  data.tar.gz: d3c177187c100d3eeb148250be4369cfe1bcd93fc757f9549b6e25bc793a304f
 SHA512:
-  metadata.gz: edf53d316f4c32fadddf748770779f6ab56dd26192b2a3683d42c938e63ae79f2310460cbc7aa87bae516d7ae8fe3166093c5933907ab786e7573cca476eef0d
-  data.tar.gz: 5d67cb658c49b4b883cf75c09d0fb08089d1662ff40ed1a11adfa2e50c0a4bc79299f150f0876e1009a22fe9e8c4b5376db87c06dec7be02b7cd004567a74691
+  metadata.gz: e35b82cfa37eccb1381b79c074898311d2510e99afa6a19b57d83ff2a4c3e967eec516ada71c740afe8620113cfd54ee1b05910f921cdbb55cc58d2b6c3c08fd
+  data.tar.gz: 24806c984d60d18cec432a8f9858f6badf6882ea4ab08679256111abcbf082f83713de296662cf694237f2d8c95742d23366c834a24eacd213ece72ce676df16

data/bin/gaapi

@@ -4,5 +4,4 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
 require "gaapi"
 
-GAAPI::Main.call
-# FIXME: This doesn't seem to return the status to the shell the way we want.
+exit GAAPI::Main.call

data/lib/gaapi/access_token.rb

@@ -4,12 +4,15 @@ module GAAPI
   # An access token generated from a credential file provided by Google Analystics.
   # The credential file is suitable for using in applications where humans aren't
   # involved, such as scheduled jobs. To obtain a credential file, follow the instructions
-  #   at https://developers.google.com/identity/protocols/OAuth2ServiceAccount.
+  # at https://developers.google.com/identity/protocols/OAuth2ServiceAccount.
   class AccessToken
     # Get a new access token. The actual token is lazily-generated, so no call is
-    # made to Google Analytics until #token is called.
+    # made to Google Analytics until {#token} is called.
     # @param credential_file [String] File name of a credential file provided by
-    #   Google Analytics.
+    #   Google Analytics. If `credential_file` is missing or `nil`, this method
+    #   looks for credentials in `~/.gaapi/ga-api-key`.
+    # @raise [StandardError] Throws an exception if the credential file is readable
+    #   or writable by other than the current user.
     def initialize(credential_file = nil)
       @credential_file = credential_file || File.expand_path("~/.gaapi/ga-api-key")
       stat = File::Stat.new(@credential_file)

data/lib/gaapi/main.rb

@@ -7,7 +7,7 @@ module GAAPI
     class << self
       def call
         begin
-          return 1 if (options = process_options).nil?
+          return false if (options = process_options).nil?
 
           puts "options: #{options.inspect}" if options[:debug]
 
@@ -20,10 +20,10 @@ module GAAPI
           puts "query: #{query.inspect}" if options[:debug]
         rescue StandardError => e
           $stderr.puts e.message # rubocop:disable Style/StderrPuts
-          return 1
+          return false
         end
 
-        return 0 if options[:dry_run]
+        return true if options[:dry_run]
 
         result = query.execute
         puts "result: #{result.inspect}" if options[:debug]
@@ -32,7 +32,7 @@ module GAAPI
           # Show the output unformatted, because we don't know what we're going
           # to get back.
           puts result.body
-          return 1
+          return false
         end
 
         case options[:output_format]
@@ -42,7 +42,7 @@ module GAAPI
           puts result.pp
         end
 
-        0
+        true
       end
 
       def process_options
@@ -76,7 +76,7 @@ module GAAPI
           opts.on("-e",
             "--end-date END_DATE",
             Date,
-            "Report including END_DATE.") do |end_date|
+            "Report including END_DATE (yyyy-mm-dd).") do |end_date|
             options[:end_date] = end_date
           end
 
@@ -93,7 +93,7 @@ module GAAPI
           opts.on("-s",
             "--start-date START_DATE",
             Date,
-            "Report including START_DATE.") do |start_date|
+            "Report including START_DATE (yyyy-mm-dd).") do |start_date|
             options[:start_date] = start_date
           end
         end

data/lib/gaapi/query.rb

@@ -14,7 +14,7 @@ module GAAPI
     # @param view_id [String] The view ID of the property for which to submit the
     #   query.
     def initialize(query_string, view_id, access_token, start_date, end_date)
-      @access_token = access_token
+      @access_token = access_token.to_s
       query_string = JSON.parse(query_string) unless query_string.is_a?(Hash)
       @query = {}
       @query["reportRequests"] = query_string["reportRequests"].map do |report_request|
@@ -29,7 +29,7 @@ module GAAPI
     end
 
     # Send the requested query to Google Analytics and return the response.
-    # @return [HTTPResponse] The response from the request.
+    # @return [GAAPI::Response] The response from the request.
     def execute
       uri = URI.parse("https://analyticsreporting.googleapis.com/v4/reports:batchGet")
       https = Net::HTTP.new(uri.host, uri.port)

data/lib/gaapi/response.rb

@@ -7,11 +7,13 @@ module GAAPI
     attr_reader :response
 
     # Raw body of the response. Typically only used for diagnostic purposes.
+    # @return [String] The unformatted body of the response.
     def body
       response.body
     end
 
-    # Raw code of the response. Typically only used for diagnostic purposes.
+    # Raw HTTP status code of the response. Typically only used for diagnostic purposes.
+    # @return [String] The HTTP response code.
     def code
       response.code
     end

data/lib/gaapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GAAPI
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gaapi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Larry Reid