kitaboo_service 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ce68852fb06fd8b5402a404b981476e7e35116f10b90381283b475965357a64
+  data.tar.gz: 9f3b644ef3111ccbab7eae7563ca99ce744de845c4f896c3d16b1bc2fa299a10
+SHA512:
+  metadata.gz: 2d45f2dd5e98c540a15f634f0bf3ee27b19ab962d51d624ba08c90e231efb4557ac980304785f61ec4cd28a4a503cf6778ead4141edb002c64620bb0de7ec1be
+  data.tar.gz: 30fc819b1b2707d756addd2a2a1d772dbe495b98f04be93cd753fce72aed729ce91cce1a28d0bf9e373ca91b382067edc849806716b43068525061953b10acd2

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-18
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 João Ferreira
+
+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,25 @@
+# KitabooService
+
+This repository contains an implementation of a Ruby service which encapsulates the usage of the API of [Kitaboo](https://kitaboo.com/).
+
+It implements some of the main HTTP methods to the available endpoints.
+
+## Installation
+
+## Usage
+
+You should only import and use the KitabooService class defining the necessary environment variables.
+
+## Development
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sophia_api_service. 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]/sophia_api_service/blob/master/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 SophiaApiService project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sophia_api_service/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/kitaboo_service/api_client.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module KitabooService
+  # Implement all Kitaboo API calls
+  class ApiClient
+    def initialize
+      # Initialize base configuration to retrieve information from Kitaboo's API
+      @kitaboo_routes = KitabooRoutes.new(base_url: KitabooService.configuration.base_url)
+      @is_kitaboo_production = KitabooService.configuration.is_kitaboo_production
+      @kitaboo_client_id = KitabooService.configuration.client_id
+      @kitaboo_client_secret = KitabooService.configuration.client_secret
+      @kitaboo_production_token = KitabooService.configuration.kitaboo_production_token
+      # The authentication method is different according to the Kitaboo environment to use, this why
+      # we have 2 different methods to authenticate and get the token to be used on following requests
+      @kitaboo_auth_token = authenticate
+    end
+
+    def remove_kitaboo_user_by_email(email)
+      url = URI(@kitaboo_routes.notification_route)
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+      request = Net::HTTP::Post.new(url)
+      request["Authorization"] = "Bearer #{@kitaboo_auth_token}"
+      request["Content-Type"] = "application/x-www-form-urlencoded"
+      request.body = "userID=#{email}&userDeleted=1"
+      KitabooResponse.new(https.request(request))
+    end
+
+    def remove_order(order_number)
+      url = URI("#{@kitaboo_routes.orders_route}?orderNo=#{order_number}")
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+      request = Net::HTTP::Delete.new(url)
+      request["Authorization"] = "Bearer #{@kitaboo_auth_token}"
+      request["Content-Type"] = "application/x-www-form-urlencoded"
+      KitabooResponse.new(https.request(request))
+    end
+
+    def create_order(order_number, course_code, student_email, password)
+      url = URI(@kitaboo_routes.orders_route)
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+      request = Net::HTTP::Post.new(url.path)
+      request["Authorization"] = "Bearer #{@kitaboo_auth_token}"
+      request["Content-Type"] = "application/x-www-form-urlencoded"
+      request.body = "orderNo=#{order_number}&bookID=#{course_code}&userID=#{student_email}&firstName=#{student_email}&lastName=#{student_email}&userName=#{student_email}&password=#{password}&email=#{student_email}"
+      KitabooResponse.new(https.request(request))
+    end
+
+    def is_production_environment
+      @is_kitaboo_production
+    end
+
+    private
+
+    def authenticate
+      url = URI(@kitaboo_routes.authentication_route)
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+      request = Net::HTTP::Post.new(url)
+      if @is_kitaboo_production
+        request["Authorization"] = @kitaboo_production_token
+        request["Content-Type"] = "application/x-www-form-urlencoded"
+      else
+        request["Content-Type"] = "application/x-www-form-urlencoded"
+        request.body = "grant_type=client_credentials&client_id=#{@kitaboo_client_id}&client_secret=#{@kitaboo_client_secret}"
+      end
+      KitabooResponse.new(https.request(request)).body["access_token"]
+    end
+  end
+end

data/lib/kitaboo_service/kitaboo_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Encapsulates an HTTP base response
+class KitabooResponse
+  attr_reader :body, :status_code
+
+  def initialize(http_response)
+    @status_code = http_response.code.to_i
+    @body = JSON.parse(http_response.read_body)
+  end
+end

data/lib/kitaboo_service/kitaboo_routes.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Class encapsulating all available Kitaboo Routes
+class KitabooRoutes
+  def initialize(base_url:)
+    @kitaboo_base_url = base_url
+    return unless @kitaboo_base_url.nil?
+
+    raise "The Kitaboo Base URL 'KITABOO_URL' may be defined as an environment variable"
+  end
+
+  def notification_route
+    "#{@kitaboo_base_url}/DistributionServices/ext/api/UpdateNotification"
+  end
+
+  def authentication_route
+    "#{@kitaboo_base_url}/DistributionServices/oauth2/authToken?grant_type=client_credentials"
+  end
+
+  def orders_route
+    "#{@kitaboo_base_url}/DistributionServices/ext/api/v3/order"
+  end
+end

data/lib/kitaboo_service/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module KitabooApiService
+  VERSION = "0.4.0"
+end

data/lib/kitaboo_service.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "kitaboo_service/version"
+
+# Implement all Sophia API calls
+module KitabooService
+  autoload :ApiClient, "kitaboo_service/api_client"
+  autoload :KitabooRoutes, "kitaboo_service/kitaboo_routes"
+  autoload :KitabooResponse, "kitaboo_service/kitaboo_response"
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  # Implement Kitaboo Service configuration
+  class Configuration
+    attr_reader :base_url, :is_kitaboo_production, :client_id, :client_secret, :kitaboo_production_token
+
+    def initialize
+      @base_url = ""
+      @client_id = ""
+      @client_secret = ""
+      @kitaboo_production_token = ""
+      @is_kitaboo_production = true
+    end
+
+    def set_configuration(base_url:, is_kitaboo_production:, client_id:, client_secret:, kitaboo_production_token:)
+      @base_url = base_url
+      @is_kitaboo_production = is_kitaboo_production
+      @kitaboo_production_token = kitaboo_production_token
+      @client_id = client_id
+      @client_secret = client_secret
+    end
+  end
+end

data/sig/api_client.rbs

@@ -0,0 +1,42 @@
+module KitabooService
+  VERSION: String
+
+  class ApiClient
+    @kitaboo_client_id: String
+    @kitaboo_client_secret: String
+    @kitaboo_production_token: String
+    @kitaboo_routes: KitabooRoutes
+    @is_kitaboo_production: (bool | nil)
+    @kitaboo_auth_token: String
+  end
+
+  class Configuration
+    @base_url: String
+    @client_id: String
+    @client_secret: String
+    @is_kitaboo_production: bool
+    @kitaboo_production_token: String
+
+    attr_reader base_url: String
+    attr_reader client_id: String
+    attr_reader client_secret: String
+    attr_reader is_kitaboo_production: bool
+    attr_reader kitaboo_production_token: String
+
+    def set_configuration: -> nil
+  end
+
+  def create_order: -> KitabooResponse
+
+  def is_production_environment: -> bool
+
+  def remove_kitaboo_user_by_email: -> KitabooResponse
+
+  def remove_order: -> KitabooResponse
+
+  private
+
+  def authenticate_production_environment: -> KitabooResponse
+
+  def authenticate_test_environment: -> KitabooResponse
+end

data/sig/kitaboo_response.rbs

@@ -0,0 +1,4 @@
+class KitabooResponse
+  attr_reader body: untyped
+  attr_reader status_code: int
+end

data/sig/kitaboo_routes.rbs

@@ -0,0 +1,9 @@
+class KitabooRoutes
+  @kitaboo_base_url: string
+
+  def authentication_route: -> String
+
+  def notification_route: -> String
+
+  def orders_route: -> String
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: kitaboo_service
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- João F.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-12-26 00:00:00.000000000 Z
+dependencies: []
+description: Implement Kitaboo API method access
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/kitaboo_service.rb
+- lib/kitaboo_service/api_client.rb
+- lib/kitaboo_service/kitaboo_response.rb
+- lib/kitaboo_service/kitaboo_routes.rb
+- lib/kitaboo_service/version.rb
+- sig/api_client.rbs
+- sig/kitaboo_response.rbs
+- sig/kitaboo_routes.rbs
+homepage: https://github.com/jpedroantunes/kitaboo-api-service
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/jpedroantunes/kitaboo-api-service
+  source_code_uri: https://github.com/jpedroantunes/kitaboo-api-service
+  changelog_uri: https://github.com/jpedroantunes/kitaboo-api-service
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key: 
+specification_version: 4
+summary: Implement Kitaboo API method access
+test_files: []