gaapi 0.0.0alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed1eec8428af3796678e4689d89342be081a5d65
+  data.tar.gz: d2053bd9f3239fefdaf3f61b60006a7ed6812a8a
+SHA512:
+  metadata.gz: 77e6411840c67a025016f15dd1f42222be5dcc57e5fde8470178236b4a7fc7fbe854ff56d49366535756f5af14009b6dcf9dc1fff2c49d38aab0bab9307805b7
+  data.tar.gz: 0f09fa129edc4792e5e3d8d30a705b410b16051ba75585560524d67b2a18c7c5bd13d88cd9a67354e97e584f49ff46b384ffffbb1450ad78b293ab807fc874ec

data/bin/gaapi

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require "gaapi"
+
+Main.call

data/lib/gaapi.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# http://www.rubydoc.info/github/google/google-api-ruby-client/
+require "google/apis/analyticsreporting_v4"
+require "googleauth"
+require "gaapi/main.rb"
+require "gaapi/query.rb"

data/lib/gaapi/main.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+##
+# Basic runner for nginx config file generation.
+module Main
+  class << self
+    def call
+      options = process_options
+
+      puts "options: #{options.inspect}" if options[:debug]
+
+      # return unless (result = Query.call(options))
+      query = Query.new((options[:query_file] || STDIN).read, options)
+
+      return if options[:dry_run]
+
+      result = query.execute
+
+      if result.code != "200"
+        puts "Request failed #{result.code}"
+        puts Query.pp(result.body)
+        return
+      end
+
+      case options[:output_format]
+      when :csv
+        puts Query.csv(result.body)
+      else
+        puts Query.pp(result.body)
+      end
+    end
+
+    def process_options
+      options = { credentials: File.join(Dir.home, ".gaapi/ga-api-key") }
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: [options] VIEW_ID"
+        opts.accept(Date)
+
+        opts.on("-a TOKEN",
+          "--access-token TOKEN",
+          "An access token obtained from https://developers.google.com/oauthplayground.") do |access_token|
+          options[:access_token] = access_token
+        end
+
+        opts.on("--csv",
+          "Output result as a csv file.") do
+          options[:output_format] = :csv
+        end
+
+        opts.on("-c CREDENTIALS",
+          "--credentials CREDENTIALS",
+          "Location of the credentials file. Default: #{options[:credentials]}.") do |credentials|
+            options[:credentials] = credentials
+          end
+
+        opts.on("-d", "--debug", "Print debugging information.") do
+          options[:debug] = true
+        end
+
+        opts.on("-e",
+          "--end-date END_DATE",
+          Date,
+          "Report including END_DATE.") do |end_date|
+          options[:end_date] = end_date
+        end
+
+        opts.on("-n", "--dry-run", "Don't actually send the query to Google.") do
+          options[:dry_run] = true
+        end
+
+        opts.on("-q QUERYFILE",
+          "--query-file QUERYFILE",
+          "File containing the query. Default STDIN.") do |query_file|
+            options[:query_file] = File.open(query_file)
+          end
+
+        opts.on("-s",
+          "--start-date START_DATE",
+          Date,
+          "Report including START_DATE.") do |start_date|
+          options[:start_date] = start_date
+        end
+      end
+      opts.parse!
+      opts.abort("You must provide a view ID. \n" + opts.to_s) unless ARGV.size == 1
+      options[:view_id] = ARGV[0]
+
+      if options[:end_date].nil? && !options[:start_date].nil?
+        options[:end_date] = options[:start_date]
+      elsif options[:start_date].nil? && !options[:end_date].nil?
+        options[:start_date] = options[:end_date]
+      elsif options[:start_date].nil? && options[:end_date].nil?
+        options[:end_date] = options[:start_date] = (Date.today - 1).to_s
+      end
+
+      options
+    end
+  end
+end
+
+# Some hints:
+# https://stackoverflow.com/a/41179467/3109926
+# http://www.daimto.com/google-service-accounts-with-json-file/
+# https://github.com/google/google-api-ruby-client/issues/489
+# The above gave some progress.

data/lib/gaapi/query.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require "csv"
+require "net/http"
+
+class Query
+  class << self
+    def call(options)
+      # http://www.rubydoc.info/github/google/google-api-ruby-client/toplevel
+      # https://github.com/google/google-auth-library-ruby
+      scopes = %w[
+        https://www.googleapis.com/auth/analytics
+        https://www.googleapis.com/auth/analytics.readonly
+      ]
+
+      authorization = Google::Auth::ServiceAccountCredentials.make_creds(
+        json_key_io: File
+                      .open(options[:credentials] || File.join(Dir.home,
+                        ".ga-credentials/ga-api-key")),
+        scope: scopes
+      )
+
+      service = Google::Apis::AnalyticsreportingV4::AnalyticsReportingService.new
+      service.authorization = authorization
+
+      request = Google::Apis::AnalyticsreportingV4::ReportRequest.new(
+        view_id: options[:view_id],
+        date_ranges: [Google::Apis::AnalyticsreportingV4::DateRange.new(
+          start_date: options[:start_date],
+          end_date: options[:end_date]
+        )],
+        # dimensions: [
+        #   Google::Apis::AnalyticsreportingV4::Dimension.new(name: "ga:segment")
+        #   # Google::Apis::AnalyticsreportingV4::Dimension.new(name: "ga:adContent"),
+        #   # Google::Apis::AnalyticsreportingV4::Dimension.new(name: "ga:campaign"),
+        #   # Google::Apis::AnalyticsreportingV4::Dimension.new(name: "ga:keyword"),
+        #   # Google::Apis::AnalyticsreportingV4::Dimension.new(name: "ga:medium"),
+        #   # Google::Apis::AnalyticsreportingV4::Dimension.new(name: "ga:socialNetwork"),
+        #   # Google::Apis::AnalyticsreportingV4::Dimension.new(name: "ga:source")
+        # ],
+        metrics: [
+          # Google::Apis::AnalyticsreportingV4::Metric.new(
+          #   expression: "ga:bounces"
+          # ),
+          Google::Apis::AnalyticsreportingV4::Metric.new(
+            expression: "ga:newUsers"
+          ),
+          Google::Apis::AnalyticsreportingV4::Metric.new(
+            expression: "ga:pageviewsPerSession"
+          ),
+          Google::Apis::AnalyticsreportingV4::Metric.new(
+            expression: "ga:sessions"
+          ),
+          Google::Apis::AnalyticsreportingV4::Metric.new(
+            expression: "ga:sessionDuration"
+          ),
+          # Google::Apis::AnalyticsreportingV4::Metric.new(
+          #   expression: "ga:organicSearches"
+          # ),
+          Google::Apis::AnalyticsreportingV4::Metric.new(
+            expression: "ga:users"
+          )
+        ],
+        metric_filter_clauses: [
+          Google::Apis::AnalyticsreportingV4::MetricFilterClause.new(
+            filters: [
+              Google::Apis::AnalyticsreportingV4::MetricFilter.new(
+                metric_name: "ga:pageviews",
+                comparison_value: "0",
+                operator: "GREATER_THAN"
+              )
+            ]
+          )
+        ],
+        include_empty_rows: true
+      )
+
+      # puts "request.to_json: #{JSON.pretty_generate(JSON.parse(request.to_json))}" if options[:debug]
+      get_reports_requests = Google::Apis::AnalyticsreportingV4::GetReportsRequest.new(report_requests: [request])
+      # puts get_reports_requests.to_json if options[:debug]
+      puts JSON.pretty_generate(JSON.parse(get_reports_requests.to_json)) if options[:debug]
+      return nil if options[:dry_run]
+
+      result = service.batch_get_reports(get_reports_requests)
+      puts "result: #{result.inspect}" if options[:debug]
+      result
+    end
+
+    def csv(result)
+      result = result.to_json if result.is_a?(Google::Apis::AnalyticsreportingV4::GetReportsResponse)
+      result = JSON.parse(result) if result.is_a?(String)
+      CSV.generate do |csv|
+        result["reports"].each do |report|
+          # puts report.column_header.dimensions.inspect
+          # puts report.column_header.metric_header.metric_header_entries.map(&:name).inspect
+          csv << csv_header_row(report)
+          report["data"]["rows"].each do |row|
+            csv << csv_data_row(row["dimensions"], row["metrics"])
+          end
+          csv << csv_data_row("Totals", report["data"]["totals"]) if report["data"]["totals"]
+        end
+      end
+    end
+
+    def csv_data_row(row_headers, metrics)
+      (Array(row_headers) || []) + metrics[0]["values"]
+    end
+
+    def csv_header_row(report)
+      (report["columnHeader"]["dimensions"] || []) + report["columnHeader"]["metricHeader"]["metricHeaderEntries"].map do |entry|
+        entry["name"]
+      end
+    end
+
+    def pp(result)
+      JSON.pretty_generate(JSON.parse(result))
+    end
+  end
+
+  def initialize(query_string, options)
+    # puts "query_string: #{query_string}"
+    puts "Initializing query. Options: #{options.inspect}" if options[:debug]
+
+    puts "options[:access_token]: #{options[:access_token]}"
+    @access_token = options[:access_token]
+    puts "options[:credentials]: #{options[:credentials]}"
+    @access_token ||= access_token_from_credentials(options[:credentials])
+    puts "Final access_token: #{access_token}"
+    @dry_run = options[:dry_run]
+
+    query_string = JSON.parse(query_string) unless query_string.is_a?(Hash)
+    @query = {}
+    @query["reportRequests"] = query_string["reportRequests"].map do |report_request|
+      report_request["viewId"] = options[:view_id]
+      report_request["dateRanges"] = [
+        "startDate": options[:start_date],
+        "endDate": options[:end_date]
+      ]
+      report_request
+    end
+    # puts "query: #{JSON.pretty_generate(query)}"
+  end
+
+  def execute
+    uri = URI.parse("https://analyticsreporting.googleapis.com/v4/reports:batchGet")
+    https = Net::HTTP.new(uri.host, uri.port)
+    https.use_ssl = true
+    # https.set_debug_output($stdout)
+    request = Net::HTTP::Post.new(uri.request_uri,
+      "Content-Type" => "application/json",
+      "Authorization" => "Bearer #{access_token}")
+    request.body = query.to_json
+    response = https.request(request)
+    response
+  end
+
+  private
+
+  attr_reader :access_token, :dry_run, :query
+
+  def access_token_from_credentials(credential_file_name)
+    stat = File::Stat.new(credential_file_name)
+    if stat.world_readable? || stat.world_writable?
+      raise "#{credential_file_name} must be readable and writable only by you."
+    end
+    authorization = Google::Auth::ServiceAccountCredentials.make_creds(
+      json_key_io: File.open(credential_file_name),
+      scope: "https://www.googleapis.com/auth/analytics.readonly"
+    )
+    token = authorization.fetch_access_token!
+    puts token
+    token["access_token"]
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: gaapi
+version: !ruby/object:Gem::Version
+  version: 0.0.0alpha1
+platform: ruby
+authors:
+- Larry Reid
+- Phil Carrillo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+description: |2
+      Submit queries expressed in JSON to Google Analytics. Can be run
+      from unattended scripts, batch jobs, etc.
+email: larry.reid@weenhanceit.com
+executables:
+- gaapi
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/gaapi
+- lib/gaapi.rb
+- lib/gaapi/main.rb
+- lib/gaapi/query.rb
+homepage: https://github.com/weenhanceit/gaapi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: Query Google Analytics from the command line.
+test_files: []