search_console_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5cd291d9d52be7af01d919c485db008c77e102cc7a11b91cb47bed9da882b1e5
+  data.tar.gz: '09f0b97510c12afb3adf85b3969a8526b5b3e15a7ffa4209cc4dc62800617313'
+SHA512:
+  metadata.gz: f2c2ae2790058ea42f01533493ab8f6e11c4a9e6f1ac6a1917cb4189317cbe8385e2c07c465303fef3c03f325711ecd1724f5ed07d6c73f8645760c178a01726
+  data.tar.gz: 77fc275c283e23aa72a9611d2a82963436dc9e4900bdbd600b32e8f56f714f872f218ef728e36c3eec6913c763e736e80c4540ad1ebb7f904784ecce6677bdb0

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:
+    search_console_api (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.16.3)
+    rake (13.0.6)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  minitest (~> 5.16.3)
+  rake (~> 13.0.6)
+  search_console_api!
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 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,96 @@
+# Google Search Console API Ruby Gem [WIP]
+This is a simple wrapper to interact with the Google Search Console API with Ruby.
+It's based on the [Official API reference](https://developers.google.com/webmaster-tools/v1/api_reference_index).
+
+The first version is intended for read access only, not adding sites, sitemaps, etc.
+
+## Usage
+Add this gem to your Gemfile:
+```rb
+gem 'search_console_api'
+```
+
+You will need a way to get a user's valid (and fresh) token (I personally use the `gem omnioauth`).
+Make sure you added the following scope:
+
+```
+https://www.googleapis.com/auth/webmasters.readonly
+```
+
+### Initialize a Client
+```rb
+client = SearchConsoleApi::Client.new(token)
+```
+
+### List all the sites
+```rb
+# List all the sites
+sites = client.sites
+=>
+[#<SearchConsoleApi::Objects::Site:0x0000000109194e98 @permission_level="siteOwner", @site_url="https://dailytics.com/">,
+ #<SearchConsoleApi::Objects::Site:0x0000000109194e48 @permission_level="siteUnverifiedUser", @site_url="http://www.anothersite.com/">,
+ #<SearchConsoleApi::Objects::Site:0x0000000109194e20 @permission_level="siteOwner", @site_url="sc-domain:anothersite2.com">,
+ #<SearchConsoleApi::Objects::Site:0x0000000109194df8 @permission_level="siteOwner", @site_url="sc-domain:anothersite3.com">]
+ my_site = sites[0]
+```
+The response will be an array of `SearchConsoleApi::Objects::Site` objects, you will need to set one of them as a variable (let's call it `my_site`)
+for the next step.
+
+### Search Analytics API
+The `query` method will receive the `site` parameter plus all the allowed parameters according to the [Google documentation](https://developers.google.com/webmaster-tools/v1/api_reference_index).
+The 2 required parameters are `start_date` and `end_date`.
+You will probably want to add the `dimensions` parameters (like in the second example).
+```rb
+# a basic query:
+response = client.query(site: my_site, start_date: "2024/03/01", end_date: "2024/04/01")
+=> [#<SearchConsoleApi::Objects::QueryResponseRow:0x000000010929d510 @clicks=69, @ctr=0.04542462146148782, @impressions=1519, @keys=nil, @position=15.596445029624753>]
+
+# a more compled query:
+response = client.query(site: my_site, start_date: "2024/03/01", end_date: "2024/04/01", dimensions: ["query"], row_limit: 3)
+=>
+[#<SearchConsoleApi::Objects::QueryResponseRow:0x0000000109324c18
+  @clicks=7,
+  @ctr=0.21212121212121213,
+  @impressions=33,
+  @keys=["crew release form"],
+  @position=2.0606060606060606,
+  @query="crew release form">,
+ #<SearchConsoleApi::Objects::QueryResponseRow:0x0000000109324b78
+  @clicks=3,
+  @ctr=0.16666666666666666,
+  @impressions=18,
+  @keys=["filming notice template"],
+  @position=1.5,
+  @query="filming notice template">,
+ #<SearchConsoleApi::Objects::QueryResponseRow:0x0000000109324ad8
+  @clicks=3,
+  @ctr=0.10714285714285714,
+  @impressions=28,
+  @keys=["location agreement template"],
+  @position=5.392857142857143,
+  @query="location agreement template">]
+```
+
+The response will be an array of `SearchConsoleApi::Objects::QueryResponseRow` objects, representing each row of the original response.
+In case you added the `dimensions` parameter, each `QueryResponseRow` object will have the same dimensions as attributes for a
+simpler manipulation.
+
+
+## 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/search_console_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/search_console_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/search_console_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 "search_console_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/lib/search_console_api/client.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SearchConsoleApi
+  class Client
+
+    attr_accessor :access_token
+
+    def initialize(access_token)
+      @access_token = access_token
+    end
+
+    def sites
+      @sites ||= Resources::Sites::List.new(access_token: @access_token).call
+    end
+
+    def query(site:, start_date:, end_date:, dimensions: [], type: nil, dimension_filter_groups: [], aggregation_type: nil, row_limit: nil, start_row: nil, data_state: nil)
+      Resources::SearchAnalytics::Query.new(
+        access_token: @access_token, site: site, start_date: start_date, end_date: end_date,
+        dimensions: dimensions, type: type, dimension_filter_groups: dimension_filter_groups,
+        aggregation_type: aggregation_type, row_limit: row_limit, start_row: start_row,
+        data_state: data_state
+      ).call
+    end
+  end
+end

data/lib/search_console_api/error.rb

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

data/lib/search_console_api/objects/query_response_row.rb

@@ -0,0 +1,20 @@
+module SearchConsoleApi
+  module Objects
+    class QueryResponseRow
+      attr_accessor :keys, :clicks, :impressions, :ctr, :position,
+        :date, :device, :page, :query, :country, :search_appearance
+
+      def initialize(attributes = {}, dimensions = [])
+        @keys = attributes["keys"]
+        @clicks = attributes["clicks"]
+        @impressions = attributes["impressions"]
+        @ctr = attributes["ctr"]
+        @position = attributes["position"]
+
+        dimensions.each_with_index do |dimension, index|
+          instance_variable_set("@#{dimension}", @keys[index])
+        end
+      end
+    end
+  end
+end

data/lib/search_console_api/objects/site.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "json"
+require "uri"
+
+module SearchConsoleApi
+  module Objects
+    class Site
+      attr_accessor :site_url, :permission_level
+
+      def initialize(attributes = {})
+        @site_url = attributes["siteUrl"]
+        @permission_level = attributes["permissionLevel"]
+      end
+
+      def encoded_site_url
+        URI.encode_www_form_component(@site_url)
+      end
+    end
+  end
+end

data/lib/search_console_api/request.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+
+module SearchConsoleApi
+  class Request
+
+    BASE_URL = "https://www.googleapis.com/webmasters/v3"
+
+    def self.get(access_token:, 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 SearchConsoleApi::Error.new(response) unless response.is_a?(Net::HTTPSuccess)
+
+      JSON.parse response.body
+    end
+
+    def self.post(access_token:, path:, payload: nil)
+      url = URI("#{BASE_URL}#{path}")
+
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+
+      request = Net::HTTP::Post.new(url)
+      request["Authorization"] = "Bearer #{access_token}"
+      request["Content-Type"] = "application/javascript"
+      request.body = payload
+
+      response = https.request(request)
+      raise SearchConsoleApi::Error.new(response) unless response.is_a?(Net::HTTPSuccess)
+
+      JSON.parse response.body
+    end
+
+  end
+end

data/lib/search_console_api/resources/search_analytics/query.rb

@@ -0,0 +1,52 @@
+module SearchConsoleApi
+  module Resources
+    module SearchAnalytics
+      class Query
+        def initialize(access_token:, site: nil, start_date: nil, end_date: nil, dimensions: [], type: nil, dimension_filter_groups: [], aggregation_type: nil, row_limit: nil, start_row: nil, data_state: nil)
+          @access_token = access_token
+          @site = site
+          @start_date = start_date
+          @end_date = end_date
+          @dimensions = dimensions
+          @type = type
+          @dimension_filter_groups = dimension_filter_groups
+          @aggregation_type = aggregation_type
+          @row_limit = row_limit
+          @start_row = start_row
+          @data_state = data_state
+        end
+
+        def call
+          response["rows"].each_with_object([]) do |attrs, rows|
+            rows << Objects::QueryResponseRow.new(attrs, @dimensions)
+          end
+        end
+
+        private
+
+        def response
+          Request.post(
+            access_token: @access_token,
+            path: "/sites/#{@site.encoded_site_url}/searchAnalytics/query",
+            payload: payload
+          )
+        end
+
+        def payload
+          output = {
+            startDate: @start_date,
+            endDate: @end_date
+          }
+          output[:dimensions] = @dimensions if @dimensions.any?
+          output[:type] = @type if @type
+          output[:dimensionFilterGroups] = @dimension_filter_groups if @dimension_filter_groups.any?
+          output[:aggregationType] = @aggregation_type if @aggregation_type
+          output[:rowLimit] = @row_limit if @row_limit
+          output[:startRow] = @start_row if @start_row
+          output[:dataState] = @data_state if @data_state
+          output.to_json
+        end
+      end
+    end
+  end
+end

data/lib/search_console_api/resources/sites/list.rb

@@ -0,0 +1,23 @@
+module SearchConsoleApi
+  module Resources
+    module Sites
+      class List
+        def initialize(access_token:)
+          @access_token = access_token
+        end
+
+        def call
+          response["siteEntry"].each_with_object([]) do |attrs, sites|
+            sites << Objects::Site.new(attrs)
+          end
+        end
+
+        private
+
+        def response
+          Request.get(access_token: @access_token, path: "/sites")
+        end
+      end
+    end
+  end
+end

data/lib/search_console_api/version.rb

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

data/lib/search_console_api.rb

@@ -0,0 +1,23 @@
+require "search_console_api/version"
+
+module SearchConsoleApi
+  autoload :Client, "search_console_api/client"
+  autoload :Request, "search_console_api/request"
+
+  module Objects
+    autoload :Site, "search_console_api/objects/site"
+    autoload :QueryResponseRow, "search_console_api/objects/query_response_row"
+  end
+
+  module Resources
+    module Sites
+      autoload :List, "search_console_api/resources/sites/list"
+    end
+
+    module SearchAnalytics
+      autoload :Query, "search_console_api/resources/search_analytics/query"
+    end
+  end
+
+  autoload :Error, "search_console_api/error"
+end

data/search_console_api.gemspec

@@ -0,0 +1,27 @@
+require_relative "lib/search_console_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "search_console_api"
+  spec.version = SearchConsoleApi::VERSION
+  spec.authors = ["Gustavo Garcia"]
+  spec.email = ["tavo@hey.com"]
+
+  spec.summary = "A simple Google Search Console API wrapper for Ruby"
+  spec.description = "A very humble wrapper for the Google Search Console API to be used in conjuntion with OAuth2"
+  spec.homepage = "https://github.com/dailytics/search_console_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

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: search_console_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gustavo Garcia
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-10 00:00:00.000000000 Z
+dependencies: []
+description: A very humble wrapper for the Google Search Console 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
+- lib/search_console_api.rb
+- lib/search_console_api/client.rb
+- lib/search_console_api/error.rb
+- lib/search_console_api/objects/query_response_row.rb
+- lib/search_console_api/objects/site.rb
+- lib/search_console_api/request.rb
+- lib/search_console_api/resources/search_analytics/query.rb
+- lib/search_console_api/resources/sites/list.rb
+- lib/search_console_api/version.rb
+- search_console_api.gemspec
+homepage: https://github.com/dailytics/search_console_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dailytics/search_console_api
+  source_code_uri: https://github.com/dailytics/search_console_api
+  changelog_uri: https://github.com/dailytics/search_console_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 Search Console API wrapper for Ruby
+test_files: []