guardian_searcher 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd89428bf856036e8d19111810e1a8b0bab64c545db11b6b0779b1f7c7654016
-  data.tar.gz: f485ddd884db4a21c9f75a0961640f46143014cbb392ac7de6e894726964cbce
+  metadata.gz: e3df7ad5dba2bad5467f4f3b0b09dc360a7e8c2b097dfddbb6bbc126ba997af1
+  data.tar.gz: 700a5915369af7e4313b4e94601d5d68a3e83f164fd3e7f6ef702a26fae8f350
 SHA512:
-  metadata.gz: d67c795dca8079a6768b8ab9bfd44335fde907c110dac3a4fbd3be20cab9da5e0f2ebf125f41003c936b8d13bc486ce33eae3c0e1232f3bfd6b9cd66229ead45
-  data.tar.gz: 4868618271ecc78d2cfc66c1389bba17504072755a06dbdd563cfa5023450ad0bc5674f09416ca728e915c46f931a65c04a912577c84f4e80035f9a899293943
+  metadata.gz: 3f53981c222f1409b0541b555f07b59dd2aa64847d6680255008ac739f40e2a66669d6dc3be1fe6d012c86bac6fe15aef691577510715a3f573b3a5453bc1d67
+  data.tar.gz: 295dfad1a4a45d31543c264f24a0c76c4e0354fc0b666293b9f810e9727e0b5ea7c5fc4e909e22f8de89ac5e4749fa6d8316e6999d8d4cc082b12b948a0447f5

data/.github/workflows/gem-test.yml

@@ -0,0 +1,28 @@
+---
+name: Guardian Searcher gem test suite
+run-name: ${{ github.actor }} is running the test suite
+on:
+  push:
+    branches: [develop]
+  pull_request:
+    branches: [main]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', '3.3']
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake spec
+
+

data/.gitignore

@@ -13,3 +13,4 @@ Gemfile.lock
 .rspec_status
 .byebug_history
 .DS_Store
+project_context.txt

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
+- Parse results and return an exception based on the Guardian API response
 
+## [0.1.4] - 2026-06-28
+- Moved API key from URL query string to request header to prevent leakage in logs
 
 ## [0.1.0] - 2022-10-01
 

data/README.md

@@ -1,5 +1,6 @@
 # GuardianSearcher
 
+[![Gem Version](https://badge.fury.io/rb/guardian_searcher.svg)](https://badge.fury.io/rb/guardian_searcher)
 
 This is a work in progress, and its status is currently an alpha version. Tests needs to be implemented and the code is not optimal.
 The goal of this project is to provide a Ruby wrapper to query the Guardian Api and to experiment with some programming techniques.
@@ -60,7 +61,7 @@ results = searcher.search('your keyword', { from_date: '2022-10-01', page_size:
 
 If you add something unsupported it will throw an `OptionsNotSupportedError`
 
-The results of the search can be used as they are, a Farady response object or you can parse them using `GuardianSearcher::SearchResult` in the following way:
+The results of the search can be used as they are, a Farady response object or you can parse - remember to check for the response code first - them using `GuardianSearcher::SearchResult` in the following way:
 
 ```ruby
 response_body = searcher.search('your keyword', { from_date: '2022-10-01', page_size: 10 }).body
@@ -76,6 +77,22 @@ This will return a `SearchResult` object which the following attributes:
 @start # starting page
 ```
 
+However if you want the gem to take care of the response codes and use its built in errors just use
+
+```ruby
+response = searcher.search('your keyword', { from_date: '2022-10-01', page_size: 10 })
+results = GuardianSearcher::SearchResult.parse_with_codes(response)
+```
+
+This will return a `SearchResult` object or one of the following errors
+
+```ruby
+GuardianUnauthorizedError   # when a 401 is returned
+GuardianBadRequestError     # when a 400 is returned
+GuardianInternalServerError # when a 500 is returned
+GuardianUnknownError        # when an error code is not among the above ones
+```
+
 Of interest the structure of a single element of the results array, which is an Hash array similar to this
 
 ```ruby

data/lib/guardian_searcher/base.rb

@@ -16,22 +16,22 @@ module GuardianSearcher
     # Options needs to be passed following Guardian API docs
     def search(query, options = {})
       url = search_uri + query_string(query, options)
-      Faraday.get(url)
+      Faraday.get(url, nil, headers)
     end
 
     def search_sections(query, options = {})
       url = sections_uri + query_string(query, options)
-      Faraday.get(url)
+      Faraday.get(url, nil, headers)
     end
 
     def search_tags(query, options = {})
       url = tags_uri + query_string(query, options)
-      Faraday.get(url)
+      Faraday.get(url, nil, headers)
     end
 
     def search_editions(query, options = {})
       url = editions_uri + query_string(query, options)
-      Faraday.get(url)
+      Faraday.get(url, nil, headers)
     end
 
     private
@@ -58,11 +58,15 @@ module GuardianSearcher
 
     def query_string(q, options = {})
       opt = build_options(options)
-      "?q=#{q}&#{opt}&api-key=#{@api_key}"
+      "?q=#{q}&#{opt}"
     end
 
     def build_options(options)
       Options.new(options).build_options
     end
+
+    def headers
+      { "api-key" => @api_key }
+    end
   end
 end

data/lib/guardian_searcher/content.rb

@@ -7,11 +7,11 @@ module GuardianSearcher
       attributes.each do |key, attribute_value|
         attr_name = key
         attr_name = snakecase(key) unless key.is_a? Symbol
-        self.class.send(:define_method, "#{attr_name}=".to_sym) do |value|
+        define_singleton_method("#{attr_name}=".to_sym) do |value|
           instance_variable_set("@#{attr_name}", value)
         end
 
-        self.class.send(:define_method, attr_name.to_sym) do
+        define_singleton_method(attr_name.to_sym) do
           instance_variable_get("@#{attr_name}")
         end
 

data/lib/guardian_searcher/options.rb

@@ -1,16 +1,21 @@
 # frozen_string_literal: true
 
 module GuardianSearcher
+  # the class maps the options passed to the ones needed
+  # by the Guardian API for searching
   class Options < Hash
-    private attr_accessor :options
-
     def method_missing(method_name, *args, &blk)
       return options.[](method_name, &blk) if @options.key?(method_name)
 
       super(method_name, *args, &blk)
     end
 
+    def respond_to_missing?(method_name, *args)
+      @options.key?(method_name) || super(method_name, *args)
+    end
+
     def initialize(options)
+      super
       raise OptionsNotHashError unless options.is_a?(Hash)
 
       @options = options
@@ -24,6 +29,7 @@ module GuardianSearcher
         valid_option?(key)
         opt += "&#{map_option(key)}=#{value}"
       end
+      return opt
     end
 
     def valid_option?(option)
@@ -38,5 +44,9 @@ module GuardianSearcher
         page: "page"
       }[key]
     end
+
+    private
+
+    attr_accessor :options
   end
 end

data/lib/guardian_searcher/search_result.rb

@@ -4,24 +4,45 @@ require "json"
 
 module GuardianSearcher
   class SearchResult
-    attr_reader :results, :start, :page_size, :pages, :current_page
+    attr_reader :results, :start, :page_size, :pages, :current_page, :editions
 
     def initialize(
       current_page: nil,
       results: nil,
       page_size: nil,
       pages: nil,
-      start: nil
+      start: nil,
+      editions: nil
     )
-
       @current_page = current_page
       @results = results
       @page_size = page_size
       @pages = pages
       @start = start
+      @editions = editions
+    end
+
+    def self.parse_with_codes(response: nil)
+      raise GuardianSearcher::GuardianSearcherUndefinedResponse unless response
+
+      case response.status
+      when 200
+        parse_results(body: response.body)
+      when 400
+        message = JSON.parse(response.body)["message"]
+        raise GuardianSearcher::GuardianBadRequestError, message
+      when 401
+        message = JSON.parse(response.body)["message"]
+        raise GuardianSearcher::GuardianUnauthorizedError, message
+      when 500
+        message = JSON.parse(response.body)["message"]
+        raise GuardianSearcher::GuardianInternalServerError, message
+      else
+        raise GuardianSearcher::GuardianUnknownError, "Unknown error, check Faraday response"
+      end
     end
 
-    def self.parse_results(body: nil)
+    def self.parse_results(body:)
       return unless body
 
       body = JSON.parse(body)

data/lib/guardian_searcher/section_result.rb

@@ -3,18 +3,9 @@
 require "json"
 
 module GuardianSearcher
+  # The class parses the search results and creates a new
+  # SearchResults object with an editions variable
   class SectionResult
-    attr_reader :results, :editions
-
-    def initialize(
-      results: nil,
-      editions: nil
-    )
-
-      @results = results
-      @editions = editions
-    end
-
     def self.parse_results(body: nil)
       return unless body
 

data/lib/guardian_searcher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GuardianSearcher
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/guardian_searcher.rb

@@ -14,6 +14,11 @@ require_relative "guardian_searcher/options"
 module GuardianSearcher
   class Error < StandardError; end
   class GuardianApyKeyError < StandardError; end
+  class GuardianUnauthorizedError < StandardError; end
+  class GuardianBadRequestError < StandardError; end
+  class GuardianInternalServerError < StandardError; end
+  class GuardianUnknownError < StandardError; end
+  class GuardianSearcherUndefinedResponse < StandardError; end
   class OptionsNotHashError < StandardError; end
   class OptionsNotSupportedError < StandardError; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guardian_searcher
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Alain Mauri
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-23 00:00:00.000000000 Z
+date: 2026-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,9 +114,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -160,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: A wrapper to search articles from The Guardian, using its open API. You need