search_console_api 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cd291d9d52be7af01d919c485db008c77e102cc7a11b91cb47bed9da882b1e5
-  data.tar.gz: '09f0b97510c12afb3adf85b3969a8526b5b3e15a7ffa4209cc4dc62800617313'
+  metadata.gz: 3968aa346b7e66d1096c29eef5dbcfab5814196b722fe2890dfcc2f671d70d63
+  data.tar.gz: 9267710cb171c3974dc6d136ea3d2dc1429ae61e2606f0df0d167590338b0883
 SHA512:
-  metadata.gz: f2c2ae2790058ea42f01533493ab8f6e11c4a9e6f1ac6a1917cb4189317cbe8385e2c07c465303fef3c03f325711ecd1724f5ed07d6c73f8645760c178a01726
-  data.tar.gz: 77fc275c283e23aa72a9611d2a82963436dc9e4900bdbd600b32e8f56f714f872f218ef728e36c3eec6913c763e736e80c4540ad1ebb7f904784ecce6677bdb0
+  metadata.gz: 0c9905e38e8a5a0d891b52cd692e99fdd395380962d4b65adfb6d790fa944b01e761876b4c78c0c7834f432f2f0f2ecb394042bd3e41d085a974f0b111db1e23
+  data.tar.gz: bef1b28a7ee2fcf906ae732152762b300e37f67beb387b56c7eca6eabb7d8ce7235839436e9d7d2e5cd4195e93b55961f2ababeeb651dbea1f182ffaf62fe812

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    search_console_api (0.0.1)
+    search_console_api (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -45,7 +45,7 @@ You will probably want to add the `dimensions` parameters (like in the second ex
 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:
+# a more complex 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
@@ -69,6 +69,9 @@ response = client.query(site: my_site, start_date: "2024/03/01", end_date: "2024
   @keys=["location agreement template"],
   @position=5.392857142857143,
   @query="location agreement template">]
+
+# You can also use a simple url instead of a Site object in the parameters:
+response = client.query(site: "https://example.com", start_date: "2024/03/01", end_date: "2024/04/01", dimensions: ["query"], row_limit: 3)
 ```
 
 The response will be an array of `SearchConsoleApi::Objects::QueryResponseRow` objects, representing each row of the original response.

data/lib/search_console_api/request.rb

@@ -21,7 +21,7 @@ module SearchConsoleApi
 
         http.request request
       end
-      raise SearchConsoleApi::Error.new(response) unless response.is_a?(Net::HTTPSuccess)
+      raise SearchConsoleApi::Error.new(response.body) unless response.is_a?(Net::HTTPSuccess)
 
       JSON.parse response.body
     end
@@ -38,7 +38,7 @@ module SearchConsoleApi
       request.body = payload
 
       response = https.request(request)
-      raise SearchConsoleApi::Error.new(response) unless response.is_a?(Net::HTTPSuccess)
+      raise SearchConsoleApi::Error.new(response.body) unless response.is_a?(Net::HTTPSuccess)
 
       JSON.parse response.body
     end

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

@@ -1,3 +1,5 @@
+require "date"
+
 module SearchConsoleApi
   module Resources
     module SearchAnalytics
@@ -5,8 +7,8 @@ module SearchConsoleApi
         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
+          @start_date = DateTime.parse(start_date).strftime("%Y-%m-%d")
+          @end_date = DateTime.parse(end_date).strftime("%Y-%m-%d")
           @dimensions = dimensions
           @type = type
           @dimension_filter_groups = dimension_filter_groups
@@ -14,6 +16,10 @@ module SearchConsoleApi
           @row_limit = row_limit
           @start_row = start_row
           @data_state = data_state
+
+          unless @site.is_a?(SearchConsoleApi::Objects::Site)
+            @site = SearchConsoleApi::Objects::Site.new({"siteUrl" => @site})
+          end
         end
 
         def call
@@ -22,12 +28,16 @@ module SearchConsoleApi
           end
         end
 
+        def request_path
+          "/sites/#{@site.encoded_site_url}/searchAnalytics/query"
+        end
+
         private
 
         def response
           Request.post(
             access_token: @access_token,
-            path: "/sites/#{@site.encoded_site_url}/searchAnalytics/query",
+            path: request_path,
             payload: payload
           )
         end
@@ -49,4 +59,4 @@ module SearchConsoleApi
       end
     end
   end
-end
+end

data/lib/search_console_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_console_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Gustavo Garcia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-10 00:00:00.000000000 Z
+date: 2024-03-12 00:00:00.000000000 Z
 dependencies: []
 description: A very humble wrapper for the Google Search Console API to be used in
   conjuntion with OAuth2