ga4-rails 0.1.3 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88422fef26dbe9e169835763cb45563b359efba57d20e0bd02daa9b63f68fc5e
-  data.tar.gz: 927a597128d23c71243f9f1ca01b177fcf899452468d73d42cb69c66b72a90cf
+  metadata.gz: ccebb95c15585bdcb7bbaae021ef88925592dfab178fa2d3aea4c7af630e4b7b
+  data.tar.gz: 3f905d8b8e986f6af1d16122c0312449995fbb792963f64e2f545d2a5141f52a
 SHA512:
-  metadata.gz: 84af038bc9f60d892334de1784b189ffd58716c2b8977a73dd9d87016497a32b8c0949570ed20e84a0d8709666cf7bb7761848c6748d60772af267d0018ebbad
-  data.tar.gz: 1f1dba9e79e87d27d03526d1c791af863c71ce88408d4cb8b7acc34218d268587e0569c4b105c45950a4f31f5f85ae5c781a731ed37d67ca77cfd302f62b2e0f
+  metadata.gz: 87996522ee691d58d75a51586211e97530c860d4e4bb8ad6c94fcff2ae932e39df39f2ea340b662b4832c7a7fe57768fe2fc9449df74b7e16d6f0adbdaba20c5
+  data.tar.gz: 01021a0c232f81948d53c461f49bfc91a17b2153a441b0c30dd228f5bcafde2434241889d9ede8051cc6d88641ec5c430e5e0f431d58b7dc8676f4c552376802

data/.rubocop.yml

@@ -491,7 +491,7 @@ Layout/TrailingEmptyLines:
 Naming/FileName:
   # File names listed in `AllCops:Include` are excluded by default. Add extra
   # excludes here.
-  Exclude: []
+  Exclude: ['lib/ga4-rails.rb']
   # When `true`, requires that each source file should define a class or module
   # with a name which matches the file name (converted to ... case).
   # It further expects it to be nested inside modules which match the names
@@ -1429,6 +1429,8 @@ Lint/UnusedMethodArgument:
   AllowUnusedKeywordArguments: false
   IgnoreEmptyMethods: true
 
+Lint/MissingSuper:
+  Enabled: false
 #################### Performance ###########################
 
 # Performance/DoubleStartEndWith:

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2] - 2023-02-01
+
+- Add wrapper for Google Analytics Data API
+- Add model to fetch results for better framework integration
+
 ## [0.1.0] - 2022-12-27
 
 - Initial release
@@ -7,5 +12,5 @@
 ## [0.1.1] - 2022-12-29
 - Implement basic wrapper for Google Analytics Admin API
 
-## [0.1.3] - 2023-01-03
+## [0.1.4] - 2023-01-03
 - Clean up the repository

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ga4-rails (0.1.2)
+    ga4-rails (0.1.4)
       google-apis-analyticsadmin_v1alpha
       google-apis-analyticsdata_v1beta
 
@@ -13,15 +13,15 @@ GEM
     ast (2.4.2)
     declarative (0.0.20)
     diff-lcs (1.5.0)
-    faraday (2.7.2)
+    faraday (2.7.4)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
     google-apis-analyticsadmin_v1alpha (0.44.0)
       google-apis-core (>= 0.9.1, < 2.a)
-    google-apis-analyticsdata_v1beta (0.21.0)
+    google-apis-analyticsdata_v1beta (0.22.0)
       google-apis-core (>= 0.9.1, < 2.a)
-    google-apis-core (0.9.2)
+    google-apis-core (0.9.5)
       addressable (~> 2.5, >= 2.5.1)
       googleauth (>= 0.16.2, < 2.a)
       httpclient (>= 2.8.1, < 3.a)
@@ -45,12 +45,12 @@ GEM
     multi_json (1.15.0)
     os (1.1.4)
     parallel (1.22.1)
-    parser (3.1.3.0)
+    parser (3.2.0.0)
       ast (~> 2.4.1)
     public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.1)
+    regexp_parser (2.6.2)
     representable (3.2.0)
       declarative (< 0.1.0)
       trailblazer-option (>= 0.1.1, < 0.2.0)
@@ -63,23 +63,23 @@ GEM
       rspec-mocks (~> 3.12.0)
     rspec-core (3.12.0)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.1)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.1)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.41.1)
+    rubocop (1.44.0)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
@@ -91,12 +91,11 @@ GEM
       multi_json (~> 1.10)
     trailblazer-option (0.1.2)
     uber (0.1.0)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.4.2)
     webrick (1.7.0)
 
 PLATFORMS
   arm64-darwin-21
-  ruby
 
 DEPENDENCIES
   ga4-rails!

data/README.md

@@ -1,4 +1,6 @@
-# Ga4::Rails
+# GA4 Rails
+
+<img src="https://pics.clipartpng.com/midle/Triangle_Under_Construction_Sign_PNG_Clipart-588.png" height=300/>
 
 This is a gem to simplify integration of Rails and Google Analytics 4.
 
@@ -15,7 +17,53 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic Usage
+
+Include Ga4Rails model somewhere in your code the following way:
+
+```ruby
+  class UserAnalyticsData 
+    include Ga4Rails::Model
+
+    metrics :new_users # Specify metrics
+    dimensions :browser, :country # Specify dimensions
+  end
+```
+
+Filters support coming soon!
+
+To fetch data, run the following code:
+
+```ruby
+    results = UserAnalyticsData.results(
+        access_token: '<access token obtained from Oauth flow'
+        property_id: 'properties/<id>',
+        start_date: 1.month.ago
+        end_date: Date.today
+    )
+```
+
+### Advanced usage
+
+You can call the API methods directly if you need to.
+
+1. Set up the client
+
+```ruby
+require 'ga4-rails/client'
+
+client = Ga4Rails::Client.new(access_token: access_token) # Access token from oauth flow
+
+```
+
+Then you can call methods on `data` or `admin` API directly:
+
+```ruby
+client.admin.list_property_data_streams
+client.admin.list_account_summaries
+
+client.data.run_property_report(property_id, request)
+```
 
 ## Development
 
@@ -23,6 +71,13 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Roadmap
+
+- [x] Implement wrapper for Google Analytics Admin API
+- [x] Implement wrapper for Google Analytics Data API
+- [x] Implement Rails model sync extenstion from Data API
+- [ ] Implement report filters
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Dark-Sun/ga4-rails.

data/lib/ga4-rails/api/analytics_data.rb

@@ -0,0 +1,50 @@
+require 'google/apis/analyticsdata_v1beta'
+
+# A class for interacting with the Google Analytics Data API.
+#
+# @attr_reader [OAuth2::AccessToken] access_token -
+#   the access token obtained from the Google OAuth2 flow
+#
+# @example
+#   Initialize service:
+#
+#   service = Ga4Rails::AnalyticsData.new(access_token: access_token).service
+#
+#   Get the metadata for a property
+#   service.get_property_metadata("properties/348443235/metadata")
+#
+#   Run a report for a property
+#    body = {
+#      "date_ranges": [
+#        {
+#          "start_date": "30daysAgo",
+#          "end_date": "today"
+#        }
+#      ],
+#      "metrics": [
+#        { name: "totalUsers" }
+#      ]
+#    }
+#
+#    request = Google::Apis::AnalyticsdataV1beta::RunReportRequest.new(body)
+#    service.run_property_report("properties/341194148", request)
+
+module Ga4Rails
+  class AnalyticsData
+    AnalyticsData = Google::Apis::AnalyticsdataV1beta
+
+    attr_accessor :access_token
+
+    def initialize(access_token:)
+      @access_token = access_token
+    end
+
+    def service
+      return @service if @service
+
+      @service = AnalyticsData::AnalyticsDataService.new
+      @service.authorization = access_token
+      @service
+    end
+  end
+end

data/lib/ga4-rails/client.rb

@@ -1,4 +1,5 @@
-require_relative 'analytics_admin'
+require_relative 'api/analytics_admin'
+require_relative 'api/analytics_data'
 
 # A client for interacting with the Google Analytics API.
 #
@@ -27,6 +28,71 @@ class Ga4Rails::Client
     analytics_admin_service
   end
 
+  def data
+    analytics_data_service
+  end
+
+  # Returns an array of available metrics for a property.
+  #
+  # @param property [String] -
+  #   the property ID
+  # Example: 'properties/341194148'
+  #
+  # @return [Array] -
+  #   an array of available metrics for a property
+  def available_metrics(property:)
+    Ga4Rails::GetPropertyMetadata.call(
+      data_service: analytics_data_service,
+      property_id: property
+    ).metrics
+  end
+
+  # Returns an array of available dimensions for a property.
+  #
+  # @param property [String] -
+  #   the property ID
+  # Example: 'properties/341194148'
+  #
+  # @return [Array] -
+  #   an array of available dimensions for a property
+  def available_dimensions(property:)
+    Ga4Rails::GetPropertyMetadata.call(
+      data_service: analytics_data_service,
+      property_id: property
+    ).dimensions
+  end
+
+  # Returns property report for a given property
+  # https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport
+  #
+  # @param property_id [String] -
+  #   the property ID. Example: 'properties/341194148'
+  #
+  # @param body [Hash] -
+  #   the report request body. Example:
+  #     body = {
+  #      "date_ranges": [
+  #        {
+  #          "start_date": "30daysAgo",
+  #          "end_date": "today"
+  #        }
+  #      ],
+  #      "metrics": [
+  #        { name: "totalUsers" }
+  #      ]
+  #    }
+  def run_property_report(property_id:, body:)
+    Ga4Rails::RunPropertyReport.call(
+      data_service: analytics_data_service,
+      property_id: property_id,
+      body: body
+    )
+  end
+
+  # TODO
+  def profiles
+  end
+
   private
 
   def analytics_admin_service
@@ -34,4 +100,10 @@ class Ga4Rails::Client
       access_token: access_token
     ).service
   end
-end
+
+  def analytics_data_service
+    @analytics_data_service ||= Ga4Rails::AnalyticsData.new(
+      access_token: access_token
+    ).service
+  end
+end

data/lib/ga4-rails/extensions/camelize.rb

@@ -0,0 +1,19 @@
+module Camelize
+  refine String do
+    def camelize(first_letter = :upper)
+      if first_letter == :upper
+        split('_').map(&:capitalize).join
+      else
+        split('_').map.with_index do |word, index|
+          index.zero? ? word : word.capitalize
+        end.join
+      end
+    end
+  end
+
+  refine Symbol do
+    def camelize(first_letter = :upper)
+      to_s.camelize(first_letter).to_sym
+    end
+  end
+end

data/lib/ga4-rails/model.rb

@@ -0,0 +1,57 @@
+module Ga4Rails::Model
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    using Camelize
+
+    DATE_FORMAT = '%Y-%m-%d'.freeze
+
+    def metrics(*metrics)
+      @metrics ||= metrics
+    end
+
+    def dimensions(*dimensions)
+      @dimensions ||= dimensions
+    end
+
+    def results(access_token:, property_id:, start_date:, end_date:, limit: 1000)
+      client = Ga4Rails::Client.new(access_token: access_token)
+
+      # TODO: Handle response
+      response = client.run_property_report(
+        property_id: property_id,
+        body: build_body(start_date: start_date, end_date: end_date, limit: limit)
+      ).response
+
+      beautify_response(response)
+    end
+
+    private
+
+    def build_body(start_date:, end_date:, limit:)
+      body = {}
+      body[:date_ranges] = [
+        {
+          start_date: start_date.strftime(DATE_FORMAT),
+          end_date: end_date.strftime(DATE_FORMAT)
+        }
+      ]
+      body[:metrics] = @metrics.map { |metric| { name: metric.camelize(:lower) } }
+      body[:dimensions] = @dimensions.map { |dimension| { name: dimension.camelize(:lower) } }
+      body[:limit] = limit
+
+      body
+    end
+
+    def beautify_response(response)
+      response.rows.map do |row|
+        {
+          dimensions: row.dimension_values.map(&:value).join(', '),
+          metrics: row.metric_values.map(&:value).join(', ')
+        }
+      end
+    end
+  end
+end

data/lib/ga4-rails/requests/get_property_metadata.rb

@@ -0,0 +1,40 @@
+# A class for running GA Data Api property report.
+#
+# @attr_reader [Ga4Rails::AnalyticsData] data_service -
+#   the data service wraper to run the report
+#
+# @attr_reader [String] property_id -
+#   the GA4 roperty ID, example: 'properties/341194148'
+#
+# Usage:
+# metrics = Ga4Rails::GetPropertyMetadata.new(
+#   data_service: data_service,
+#   property_id: property_id
+# ).metrics
+# dimensions = Ga4Rails::GetPropertyMetadata.new(
+#   data_service: data_service,
+#   property_id: property_id
+# ).dimensions
+
+class Ga4Rails::GetPropertyMetadata < Ga4Rails::Request
+  attr_accessor :data_service, :property_id, :response
+
+  def initialize(data_service:, property_id:)
+    @data_service = data_service
+    @property_id = property_id
+  end
+
+  def metrics
+    @metrics ||= JSON.parse(response.metrics.to_json)
+  end
+
+  def dimensions
+    @dimensions ||= JSON.parse(response.dimensions.to_json)
+  end
+
+  def call
+    @response = data_service.get_property_metadata("#{property_id}/metadata")
+
+    self
+  end
+end

data/lib/ga4-rails/requests/request.rb

@@ -0,0 +1,9 @@
+class Ga4Rails::Request
+  def self.call(*args)
+    new(*args).call
+  end
+
+  def call
+    raise NotImplementedError
+  end
+end

data/lib/ga4-rails/requests/run_property_report.rb

@@ -0,0 +1,45 @@
+# A class for running GA Data Api property report.
+#
+# @attr_reader [Ga4Rails::AnalyticsData] data_service -
+#   the data service wraper to run the report
+#
+# @attr_reader [String] property_id -
+#   the GA4 roperty ID, example: 'properties/341194148'
+#
+# @attr_reader [String] body -
+#   the report request body, example:
+#     body = {
+#      "date_ranges": [
+#        {
+#          "start_date": "30daysAgo",
+#          "end_date": "today"
+#        }
+#      ],
+#      "metrics": [
+#        { name: "totalUsers" }
+#      ]
+#    }
+#
+# Usage:
+# response = Ga4Rails::RunPropertyReport.new(
+#   data_service: data_service,
+#   property_id: property_id,
+#   body: body
+# ).response
+
+class Ga4Rails::RunPropertyReport < Ga4Rails::Request
+  attr_accessor :data_service, :property_id, :body, :response
+
+  def initialize(data_service:, property_id:, body:)
+    @data_service = data_service
+    @property_id = property_id
+    @body = body
+  end
+
+  def call
+    request = Google::Apis::AnalyticsdataV1beta::RunReportRequest.new(body)
+    @response = data_service.run_property_report(property_id, request)
+
+    self
+  end
+end

data/lib/ga4-rails/version.rb

@@ -1,3 +1,3 @@
 module Ga4Rails
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.2'.freeze
 end

data/lib/ga4-rails.rb

@@ -0,0 +1,9 @@
+require 'ga4-rails/extensions/camelize'
+require 'ga4-rails/client'
+require 'ga4-rails/version'
+require 'ga4-rails/api/analytics_admin'
+require 'ga4-rails/api/analytics_data'
+require 'ga4-rails/requests/request'
+require 'ga4-rails/requests/get_property_metadata'
+require 'ga4-rails/requests/run_property_report'
+require 'ga4-rails/model'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ga4-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: '0.2'
 platform: ruby
 authors:
 - Andriy Lukashchuk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-03 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-analyticsadmin_v1alpha
@@ -67,8 +67,15 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
-- lib/ga4-rails/analytics_admin.rb
+- lib/ga4-rails.rb
+- lib/ga4-rails/api/analytics_admin.rb
+- lib/ga4-rails/api/analytics_data.rb
 - lib/ga4-rails/client.rb
+- lib/ga4-rails/extensions/camelize.rb
+- lib/ga4-rails/model.rb
+- lib/ga4-rails/requests/get_property_metadata.rb
+- lib/ga4-rails/requests/request.rb
+- lib/ga4-rails/requests/run_property_report.rb
 - lib/ga4-rails/version.rb
 - sig/ga4/rails.rbs
 homepage: http://github.com/Dark-Sun/ga4-rails
@@ -93,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.5
 signing_key: 
 specification_version: 4
 summary: Efortlessly integrate Google Analytics 4 with your Rails app