google_books_client 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d884c2141a5536e429672719521552ba1331bd1151add8dba8666ed4536a570
-  data.tar.gz: 9e86c525523b04978688a1b0ee89b1297565fccd9aafb17da9c6b1e21622917b
+  metadata.gz: 2bac51ecfda0f49e570394dd7357d508816e9d5ba8c63c0b562000aadfd8088e
+  data.tar.gz: 5ddd793c514d0e133d6c1ff8330443e046490f74a4e3e44ce1a8f898edb0211c
 SHA512:
-  metadata.gz: 6b6b10acfc4c84fb6b4d96290796281b4b9e36143f3237313b3201fdde035e677be91d2b3f69e4679fbf1bb8d24afa03b7dec39fea4978cd0d05a63060c86ef2
-  data.tar.gz: e508667463c914d9169933652c2f130ec90277980d57ba6fbd5266938875f6a35ad87a0fbcf1c998c8cc898fc3be0d944469c5c9f6dd73e0611fc266c16a8318
+  metadata.gz: 63aae522ffe2e99baf76ffb159adfcc6fb8cb552e38ea603eba9780873a393bc0dde04d345867ec568d31e0b94bae627cfc649f13cbbcc6929a0c419c060645d
+  data.tar.gz: 023bc6b3e62c79a3ac05a381979141b6db11dbbf936051364caf14631edbf6636b334c7ac76cf0f51551b44155eb68d8f2d510e3b7d8b0412c6b3a1dfe47c82d

data/.rubocop.yml

@@ -1,6 +1,9 @@
 AllCops:
   NewCops: enable
   TargetRubyVersion: 2.6
+  Exclude:
+    - 'spec/**/*'
+    - 'vendor/**/*'
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -1 +1,11 @@
 # Google Books Client
+
+## [v0.1.0](https://github.com/betosardinha/google_books_client/releases/tag/v0.1.0) (2023-12-29)
+
+### Features
+
+- Add support to models:
+  - Volume.
+  - SubscriptionConfig.
+- Add support to resources:
+  - Volumes.

data/README.md

@@ -1,34 +1,153 @@
-# Google::Books::Client
+<img src="https://github.com/betosardinha/google_books_client/assets/38788696/3137d5f7-d6a6-4f82-bd44-3ea334950e1f" width="250">
 
-TODO: Delete this and the text below, and describe your gem
+# GoogleBooksClient
+
+The Google Books client is a simple Ruby gem that centralizes requests and communications with the Google Books API.
+
+![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/betosardinha/google_books_client/ruby-ci.yml)
+![GitHub License](https://img.shields.io/github/license/betosardinha/google_books_client)
+![GitHub release (with filter)](https://img.shields.io/github/v/release/betosardinha/google_books_client)
+![Gem Total Downloads](https://img.shields.io/gem/dt/google_books_client)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/google/books/client`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Table of Contents
+1. [Installation](#installation)
+2. [Usage](#usage)
+    - [Configuration](#configuration)
+    - [Models](#models)
+    - [Resources](#resources)
+3. [Development](#development)
+4. [Tools](#tools)
+5. [Contributing](#contributing)
+6. [Versioning](#versioning)
+7. [License](#license)
+8. [Code of Conduct](#code-of-conduct)
+9. [Contact](#contact)
+
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```bash
+bundle add google_books_client
+```
+
+Or add it manually to the Gemfile:
+
+```ruby
+gem 'google_books_client'
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```bash
+gem install google_books_client
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuration
+To use the gem, you must first configure it in an initializer file at your project, for example:
+
+```ruby
+# frozen_string_literal: true
+
+require 'google_books_client'
+
+GoogleBooksClient.configure do |config|
+  config.api_version = 'v1'
+  config.max_results = 10
+  config.timeout = 20
+end
+```
+
+The configuration options are:
+- **api_version**: The version of the Google Books API to be used. The default is `v1`.
+- **cacher**: The cacher to be used. The default is `ActiveSupport::Cache::MemoryStore`.
+- **logger**: The logger to be used. The default is `Logger.new($stdout)`.
+- **max_results**: The maximum number of results to be returned by the API. The default is `10`.
+- **timeout**: The timeout in seconds to be used in the requests. The default is `20`.
+
+### Models
+
+The models objective is to centralize the attributes and methods of the Google Books API resources. And make it easy to serialize and validate the data returned by the API. The models are:
+
+- **Volume**: Represents a volume in the Google Books API.
+
+You can use the models to serialize the data returned by the API, for example:
+
+```ruby
+# frozen_string_literal: true
+
+module GoogleBooks
+  module Serializers
+    class Volume < GoogleBooksCLient::Models::Volume
+      def id
+        id
+      end
+
+      def kind
+        kind
+      end
+
+      def title
+        volume_info.title
+      end
+
+      def publisher
+        volume_info.publisher
+      end
+    end
+  end
+end
+
+GoogleBooks::Serializers::Volume.serialize(volume)
+```
+
+### Resources
+
+The resources objective is to centralize the requests and communications with the Google Books API. The resources are:
+
+- **Volumes**: Represents the volumes resource in the Google Books API.
+
+You can use the resources to make requests to the API, for example:
+
+```ruby
+GoogleBooksClient::Resources::Volumes.list_by_isbn('8532516262')
+
+GoogleBooksClient::Resources::Volumes.list_by_title('Coraline')
+```
+
+A full list of the available methods for each resource class can be found in the [resources documentation](doc/resources.md).
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```bash
+docker-compose build google_books_client # To build the image
+docker-compose up -d google_books_client # To start the container detached
+docker-compose exec google_books_client bash # To access the container
+```
+
+## Tools
 
-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).
+The tools can be used inside the container or locally.
+
+```bash
+./bin/setup # To install dependencies
+./bin/console # To start the pry with the gem loaded
+./bin/test # To run the tests, rubocop and coverage
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/google_books_client. 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/[USERNAME]/google_books_client/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/betosardinha/google_books_client. 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/betosardinha/google_books_client/blob/master/CODE_OF_CONDUCT.md).
+
+## Versioning
+
+This project uses [Semantic Versioning](https://semver.org/).
+
+For a new release, update the version number in `lib/google_books_client/version.rb`, and then create a new release on GitHub. It will automatically be published to [RubyGems](https://rubygems.org/gems/google_books_client).
 
 ## License
 
@@ -36,4 +155,17 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Google::Books::Client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/google_books_client/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Google::Books::Client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/betosardinha/google_books_client/blob/master/CODE_OF_CONDUCT.md).
+
+## Contact
+
+If you have any questions about the project, please contact me at:
+- Email: [sardinhabeto55@gmail.com](mailto:sardinhabeto55@gmail.com)
+- Linkedin: [betosardinha](https://www.linkedin.com/in/betosardinha/)
+- Twitter: [sardinhabeto](https://twitter.com/sardinhabeto)
+
+## Support
+
+If this project helped you, please consider giving it a star. It will mean a lot to me.
+
+And if you consider my work valuable for your projects, you can support me on [Buy Me a Coffee](https://www.buymeacoffee.com/betosardinha).

data/doc/resources.md

@@ -0,0 +1,128 @@
+# Volumes
+
+## `show`
+- Returns a Volume resource based on the ID.
+- **Parameters**:
+  - `volume_id`: The ID of the volume to be returned (mandatory).
+
+```ruby
+GoogleBooksClient::Resources::Volumes.show('id')
+```
+
+## `list`
+- Returns a list of Volume resources based on the parameters.
+- **Parameters**:
+  - `params`: The params query to be used in the search (mandatory).
+
+```ruby
+GoogleBooksClient::Resources::Volumes.list({ q: 'inauthor:tolkien+intitle:lord', startIndex: 0 })
+```
+
+## `list_by_query`
+- Returns a list of Volume resources based on the query.
+- **Parameters**:
+  - `query`: The query to be used in the search (mandatory).
+  - `start_index`: The index of the first result to return (optional, default: 0).
+  - `params`: Extra params to be used in the search (optional, default: {}).
+
+```ruby
+GoogleBooksClient::Resources::Volumes.list_by_query('inauthor:tolkien+intitle:lord', start_index: 0)
+```
+
+## `list_volumes`
+- Returns a list of Volume resources based on a search hash.
+- **Parameters**:
+  - `search_hash`: The search hash to be used in the search (mandatory).
+  - `start_index`: The index of the first result to return (optional, default: 0).
+  - `params`: Extra params to be used in the search (optional, default: {}).
+
+```ruby
+GoogleBooksClient::Resources::Volumes.list_volumes({ title: 'lord', author: 'tolkien' })
+```
+
+```ruby
+# search_hash available parameters
+{
+  title: 'lord',
+  author: 'tolkien',
+  publisher: 'harper',
+  subject: 'fantasy',
+  isbn: '9788532516264',
+  lccn: '2001025331',
+  oclc: '123456789',
+}
+```
+
+## `list_by_title`
+- Returns a list of Volume resources based on the title.
+- **Parameters**:
+  - `title`: The title to be used in the search (mandatory).
+  - `start_index`: The index of the first result to return (optional, default: 0).
+  - `params`: Extra params to be used in the search (optional, default: {}).
+
+```ruby
+GoogleBooksClient::Resources::Volumes.list_by_title('lord')
+```
+
+## `list_by_author`
+- Returns a list of Volume resources based on the author.
+- **Parameters**:
+  - `author`: The author to be used in the search (mandatory).
+  - `start_index`: The index of the first result to return (optional, default: 0).
+  - `params`: Extra params to be used in the search (optional, default: {}).
+
+```ruby
+GoogleBooksClient::Resources::Volumes.list_by_author('tolkien')
+```
+
+## `list_by_publisher`
+- Returns a list of Volume resources based on the publisher.
+- **Parameters**:
+  - `publisher`: The publisher to be used in the search (mandatory).
+  - `start_index`: The index of the first result to return (optional, default: 0).
+  - `params`: Extra params to be used in the search (optional, default: {}).
+
+```ruby
+GoogleBooksClient::Resources::Volumes.list_by_publisher('harper')
+```
+
+## `list_by_subject`
+- Returns a list of Volume resources based on the subject.
+- **Parameters**:
+  - `subject`: The subject to be used in the search (mandatory).
+  - `start_index`: The index of the first result to return (optional, default: 0).
+  - `params`: Extra params to be used in the search (optional, default: {}).
+
+```ruby
+GoogleBooksClient::Resources::Volumes.list_by_subject('fantasy')
+```
+
+## `list_by_isbn`
+- Returns a list of Volume resources based on the ISBN.
+- **Parameters**:
+  - `isbn`: The ISBN to be used in the search (mandatory).
+  - `params`: Extra params to be used in the search (optional, default: {}).
+
+```ruby
+GoogleBooksClient::Resources::Volumes.list_by_isbn('9788532516264')
+```
+
+## `list_by_lccn`
+- Returns a list of Volume resources based on the LCCN.
+- **Parameters**:
+  - `lccn`: The LCCN to be used in the search (mandatory).
+  - `params`: Extra params to be used in the search (optional, default: {}).
+
+```ruby
+GoogleBooksClient::Resources::Volumes.list_by_lccn('2001025331')
+```
+
+## `list_by_oclc`
+- Returns a list of Volume resources based on the OCLC.
+- **Parameters**:
+  - `oclc`: The OCLC to be used in the search (mandatory).
+  - `params`: Extra params to be used in the search (optional, default: {}).
+
+```ruby
+GoogleBooksClient::Resources::Volumes.list_by_oclc('123456789')
+```

data/lib/google_books_client/configuration.rb

@@ -1,21 +1,37 @@
 # frozen_string_literal: true
 
+require "logger"
+
 module GoogleBooksClient
   class Configuration
-    attr_accessor :token, :host, :api_version, :api_schema_registry
+    attr_writer :api_version, :cacher, :logger, :max_results, :timeout
+
+    def api_host
+      "#{host}/#{api_name}/#{api_version}"
+    end
 
-    attr_writer :cacher, :logger, :timeout
+    def api_name
+      default_api_name
+    end
+
+    def api_version
+      @api_version || default_api_version
+    end
 
     def cacher
       @cacher || default_cacher
     end
 
+    def host
+      default_host
+    end
+
     def logger
       @logger || default_logger
     end
 
-    def api_host
-      "#{host}/api/#{api_version}"
+    def max_results
+      @max_results || 10
     end
 
     def timeout
@@ -24,10 +40,22 @@ module GoogleBooksClient
 
     private
 
+    def default_api_name
+      "books"
+    end
+
+    def default_api_version
+      "v1"
+    end
+
     def default_cacher
       @default_cacher ||= ActiveSupport::Cache::MemoryStore.new
     end
 
+    def default_host
+      "https://www.googleapis.com"
+    end
+
     def default_logger
       @default_logger ||= Logger.new($stdout)
     end

data/lib/google_books_client/http_client_adapter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module GoogleBooksClient
+  class HttpClientAdapter
+    def get(url, params = {}, headers = {})
+      connection.get(url, base_params.merge(params), base_headers.merge(headers))
+    end
+
+    protected
+
+    def base_url
+      GoogleBooksClient.configuration.api_host
+    end
+
+    def max_results
+      GoogleBooksClient.configuration.max_results
+    end
+
+    def base_params
+      {
+        maxResults: max_results
+      }
+    end
+
+    def base_headers
+      {
+        "Content-Type" => "application/json",
+        "Accept" => "application/json"
+      }
+    end
+
+    def authentication
+      { type: :none }
+    end
+
+    def connection
+      @connection ||= Faraday.new do |faraday|
+        faraday_auth(faraday)
+        faraday_options(faraday)
+        faraday_request(faraday)
+        faraday_response(faraday)
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def faraday_auth(_faraday)
+      case authentication[:type]
+      when :none
+        nil
+      else
+        raise NotImplementedError, "Unknown authentication type: #{authentication[:type]}"
+      end
+    end
+
+    def faraday_options(faraday)
+      faraday.url_prefix = base_url
+      faraday.options.timeout = GoogleBooksClient.configuration.timeout
+      faraday.options.open_timeout = GoogleBooksClient.configuration.timeout
+    end
+
+    def faraday_request(faraday)
+      faraday.request :json
+    end
+
+    def faraday_response(faraday)
+      faraday.response :json
+      faraday.response :logger, GoogleBooksClient.configuration.logger, { headers: false, bodies: true }
+    end
+  end
+end

data/lib/google_books_client/models/base.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "delegate"
+
+module GoogleBooksClient
+  module Models
+    class Base < SimpleDelegator
+      def self.serialize(entity)
+        return serialize_all(entity) if entity.respond_to?(:each)
+
+        new(entity).as_json
+      end
+
+      def self.serialize_all(entities)
+        entities.map { |entity| serialize(entity) }
+      end
+
+      def as_json
+        required_fields_hash.tap do |hash|
+          hash.merge!(optional_fields)
+
+          default_additional_params.each do |key, value|
+            next hash[key].merge!(value) if hash[key].is_a?(Hash)
+
+            hash[key] = value
+          end
+        end.as_json
+      end
+
+      def required_fields
+        raise NoMethodError, "You must implement #{self.class}##{__method__}"
+      end
+
+      def optional_fields
+        {}
+      end
+
+      def default_additional_params
+        {}
+      end
+
+      private
+
+      def required_fields_hash
+        validate_presence_of_required_fields!
+        validate_presence_of_required_fields_values!
+
+        {}.tap do |hash|
+          required_fields.each do |field|
+            hash.store(field.to_sym, send(field.to_sym))
+          end
+        end
+      end
+
+      def validate_presence_of_required_fields!
+        required_fields.each do |field|
+          next if self.class.instance_methods(false).include?(field.to_sym)
+
+          raise NoMethodError, "Missing required field #{field} for #{self.class}"
+        end
+      end
+
+      def validate_presence_of_required_fields_values!
+        required_fields.each do |field|
+          next unless send(field.to_sym).nil?
+
+          raise NoMethodError, "Missing required field #{field} value for #{self.class}"
+        end
+      end
+    end
+  end
+end

data/lib/google_books_client/models/volume.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module GoogleBooksClient
+  module Models
+    class Volume < Base
+      def required_fields
+        %i[id kind volume_info]
+      end
+    end
+  end
+end

data/lib/google_books_client/models.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "models/base"
+require_relative "models/volume"

data/lib/google_books_client/resources/volumes.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module GoogleBooksClient
+  module Resources
+    class Volumes < HttpClientAdapter
+      def self.show(volume_id)
+        new.get("volumes/#{volume_id}")
+      end
+
+      def self.list(params = {})
+        new.get("volumes", params)
+      end
+
+      def self.list_by_query(query, params: {}, start_index: 0)
+        list(params.merge({ q: query, startIndex: start_index }))
+      end
+
+      def self.list_volumes(search_hash, params: {}, start_index: 0)
+        list_by_query(generate_query(search_hash), params: params, start_index: start_index)
+      end
+
+      def self.list_by_title(title, params: {}, start_index: 0)
+        list_volumes({ title: title }, params: params, start_index: start_index)
+      end
+
+      def self.list_by_author(author, params: {}, start_index: 0)
+        list_volumes({ author: author }, params: params, start_index: start_index)
+      end
+
+      def self.list_by_publisher(publisher, params: {}, start_index: 0)
+        list_volumes({ publisher: publisher }, params: params, start_index: start_index)
+      end
+
+      def self.list_by_subject(subject, params: {}, start_index: 0)
+        list_volumes({ subject: subject }, params: params, start_index: start_index)
+      end
+
+      def self.list_by_isbn(isbn, params: {})
+        list_volumes({ isbn: isbn }, params: params)
+      end
+
+      def self.list_by_lccn(lccn, params: {})
+        list_volumes({ lccn: lccn }, params: params)
+      end
+
+      def self.list_by_oclc(oclc, params: {})
+        list_volumes({ oclc: oclc }, params: params)
+      end
+
+      def self.generate_query(search_hash)
+        search_hash.map do |search_type, search_value|
+          case search_type
+          when :title, :author, :publisher
+            "in#{search_type}:#{search_value}"
+          when :subject, :isbn, :lccn, :oclc
+            "#{search_type}:#{search_value}"
+          else
+            raise ArgumentError, "Invalid search type"
+          end
+        end.join("+")
+      end
+    end
+  end
+end

data/lib/google_books_client/resources.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "resources/volumes"

data/lib/google_books_client/version.rb

@@ -2,5 +2,5 @@
 
 module GoogleBooksClient
   NAME = "google_books_client"
-  VERSION = "0.0.0"
+  VERSION = "0.1.0"
 end

data/lib/google_books_client.rb

@@ -6,6 +6,9 @@ require "active_support/core_ext/hash"
 
 require_relative "google_books_client/version"
 require_relative "google_books_client/configuration"
+require_relative "google_books_client/http_client_adapter"
+require_relative "google_books_client/models"
+require_relative "google_books_client/resources"
 
 module GoogleBooksClient
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_books_client
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Beto Sardinha
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-25 00:00:00.000000000 Z
+date: 2023-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -114,10 +114,17 @@ files:
 - Makefile
 - README.md
 - Rakefile
+- doc/resources.md
 - docker-compose.yml
 - google-books-client.gemspec
 - lib/google_books_client.rb
 - lib/google_books_client/configuration.rb
+- lib/google_books_client/http_client_adapter.rb
+- lib/google_books_client/models.rb
+- lib/google_books_client/models/base.rb
+- lib/google_books_client/models/volume.rb
+- lib/google_books_client/resources.rb
+- lib/google_books_client/resources/volumes.rb
 - lib/google_books_client/version.rb
 homepage: https://github.com/betosardinha/google_books_client
 licenses: