google_analytics_v4_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 00e78b59df928bfa8edea30095716394a73902e8b49e67dbf80d43a50bd0abae
+  data.tar.gz: ebb7c0c7726fcfd28692959614d11d5e47c5b35f468f353df1b157e6c6516023
+SHA512:
+  metadata.gz: 9cf3584d6552e6c46849ad878dc3a987d5b835d198f138a4f8125722e5c50b47466adc337999235adf8c1ec8ba4a5fa3ae70b454209b838e860da2c9e156938f
+  data.tar.gz: f12a6255bda5ce39749cd152f515d8fbc6e3fa99c3b5ae087dd356f582fdcff45b73ac49c278ec184dc7933df208e84353166bd2dec019d8cd812bb614af5f53

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tavo@hey.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0.6"
+gem "minitest", "~> 5.16.3"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    google_analytics_v4_api (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.16.3)
+    rake (13.0.6)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  google_analytics_v4_api!
+  minitest (~> 5.16.3)
+  rake (~> 13.0.6)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Gustavo Garcia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# Google Analytics v4 API Ruby Gem
+This is a simple wrapper to interact with the Google Analytics v4 API (currently in beta) with Ruby.
+It's based on the [API guide](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1beta)
+
+## Usage
+Add this gem to your Gemfile:
+```rb
+gem 'google_analytics_v4_api'
+```
+
+You will need a way to get a user's valid (and fresh) token (I personally use the `gem omnioauth`), and then:
+
+```rb
+client = GoogleAnalyticsV4Api::Client.new(token)
+# List all the accounts
+client.accounts
+# Or get one particular account
+client.account("account/24696xxx")
+
+# List all the properties for a particular account
+client.properties("accounts/24596xxx")
+# Or get one particular property
+client.property("properties/33783xxx")
+```
+
+The rest is still being defined.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dailytics/google_analytics_v4_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/dailytics/google_analytics_v4_api/blob/main/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PlausibleApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dailytics/google_analytics_v4_api/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "google_analytics_v4_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/google_analytics_v4_api.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/google_analytics_v4_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "google_analytics_v4_api"
+  spec.version       = GoogleAnalyticsV4Api::VERSION
+  spec.authors       = ["Gustavo Garcia"]
+  spec.email         = ["tavo@hey.com"]
+
+  spec.summary       = 'A simple Google Analytics V4 API wrapper for Ruby'
+  spec.description   = 'A very humble wrapper for the Google Analytics V4 API to be used in conjuntion with OAuth2'
+  spec.homepage      = "https://github.com/dailytics/google_analytics_v4_api"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/google_analytics_v4_api/account.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module GoogleAnalyticsV4Api
+  class Account
+    attr_accessor :name, :createTime, :updateTime, :displayName, :regionCode
+
+    def initialize(attributes = {})
+      attributes.each do |k, v|
+        self.send("#{k}=", v)
+      end
+    end
+
+    def properties
+
+    end
+
+    def self.parse_list(body)
+      JSON.parse(body)["accounts"].map do |attrs|
+        GoogleAnalyticsV4Api::Account.new(attrs)
+      end
+    end
+  end
+end

data/lib/google_analytics_v4_api/client.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'json'
+require "net/http"
+require "uri"
+
+module GoogleAnalyticsV4Api
+  class Client
+
+    BASE_URL = "https://analyticsadmin.googleapis.com/v1beta"
+
+    def initialize(access_token)
+      @access_token = access_token
+    end
+
+    def accounts
+      @accounts ||= GoogleAnalyticsV4Api::Account.parse_list get("/accounts").body
+    end
+
+    def account(account_name)
+      accounts.find { |account| account.name == account_name }
+    end
+
+    def properties(account_name)
+      @properties ||= GoogleAnalyticsV4Api::Property.parse_list get("/properties", { filter: "parent:#{account_name}"}).body
+    end
+
+    def property(property_name)
+      unless @properties.nil?
+        property = @properties.find { |property| property.name == property_name }
+        return property unless property.nil?
+      end
+
+      GoogleAnalyticsV4Api::Property.parse get("/#{property_name}").body
+    end
+
+    private
+    def get(path, params = {})
+      url = "#{BASE_URL}#{path}"
+      url += "?#{URI.encode_www_form params}" unless params.empty?
+      uri = URI(url)
+
+      response = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
+        request = Net::HTTP::Get.new uri
+        request["Authorization"] = "Bearer #{@access_token}"
+        request["Content-Type"] = "application/json"
+
+        http.request request
+      end
+      raise GoogleAnalyticsV4Api::Error.new(response) unless response.is_a?(Net::HTTPSuccess)
+
+      response
+    end
+  end
+end

data/lib/google_analytics_v4_api/error.rb

@@ -0,0 +1,4 @@
+module GoogleAnalyticsV4Api
+  class Error < StandardError
+  end
+end

data/lib/google_analytics_v4_api/property.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module GoogleAnalyticsV4Api
+  class Property
+    attr_accessor :name, :propertyType, :createTime, :updateTime, :parent, :displayName, :industryCategory, :timeZone, :currencyCode, :serviceLevel, :deleteTime, :expireTime, :account
+
+    def initialize(attributes = {})
+      attributes.each do |k, v|
+        self.send("#{k}=", v)
+      end
+    end
+
+    def self.parse_list(body)
+      JSON.parse(body)["properties"].map do |attrs|
+        GoogleAnalyticsV4Api::Property.new(attrs)
+      end
+    end
+
+    def self.parse(body)
+      GoogleAnalyticsV4Api::Property.new(JSON.parse(body))
+    end
+
+  end
+end

data/lib/google_analytics_v4_api/version.rb

@@ -0,0 +1,3 @@
+module GoogleAnalyticsV4Api
+  VERSION = "0.0.1"
+end

data/lib/google_analytics_v4_api.rb

@@ -0,0 +1,8 @@
+require 'google_analytics_v4_api/version'
+
+module GoogleAnalyticsV4Api
+  autoload :Client, "google_analytics_v4_api/client"
+  autoload :Account, "google_analytics_v4_api/account"
+  autoload :Property, "google_analytics_v4_api/property"
+  autoload :Error, "google_analytics_v4_api/error"
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: google_analytics_v4_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gustavo Garcia
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-20 00:00:00.000000000 Z
+dependencies: []
+description: A very humble wrapper for the Google Analytics V4 API to be used in conjuntion
+  with OAuth2
+email:
+- tavo@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- google_analytics_v4_api.gemspec
+- lib/google_analytics_v4_api.rb
+- lib/google_analytics_v4_api/account.rb
+- lib/google_analytics_v4_api/client.rb
+- lib/google_analytics_v4_api/error.rb
+- lib/google_analytics_v4_api/property.rb
+- lib/google_analytics_v4_api/version.rb
+homepage: https://github.com/dailytics/google_analytics_v4_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dailytics/google_analytics_v4_api
+  source_code_uri: https://github.com/dailytics/google_analytics_v4_api
+  changelog_uri: https://github.com/dailytics/google_analytics_v4_api
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A simple Google Analytics V4 API wrapper for Ruby
+test_files: []