hybiscus_pdf_report 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8661a6c187761886b7a0e41f3112957a31eff162cc42c3167bfeb2be793dcc4
+  data.tar.gz: 36465eed4413bcaa80b5d05893cd24cdeea139c1d1795b7526dd03c9d11b6de4
+SHA512:
+  metadata.gz: '0463680072442b123263ea823606daae30a64489babe71db6078731645a42d12847df20f390d16ddc09becc8400b48490d009ccf2208e5faaf9c108e52de7a64'
+  data.tar.gz: 690d63a2dd4e4414fc20e526b260c284560d393a33d5c6038f1f708812bddb24ac823c07710a315abc714b9049b7a09d07c2b57bb688cdd4c63b1eedc70fed97

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-23
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Philipp Baumann
+
+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,94 @@
+# Hybiscus API Ruby Wrapper
+
+This is the API Wrapper for the Hybiscus REST API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hybiscus_pdf_report'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hybiscus_pdf_report
+
+## Usage
+### Configure the client
+The Gem is configured by default to work with the public platform of Hybiscus at
+* API: `https://api.hybiscus.dev/api/v1/`
+
+### Instantiate a client
+```ruby
+# To connect to the default SaaS Instance of Adnexo: https://prod.api.ax-track.ch/api/v1
+client = HybiscusPdfReport::Client.new(api_key: your_api_key)
+# Or if you have set ENV['HIBISCUS_API_KEY'] set, you don't need to pass in the api key.
+client = HybiscusPdfReport::Client.new
+
+# The default time out is 10 seconds. To change the value, pass in the parameter
+client = HybiscusPdfReport::Client.new(api_key: your_api_key, timeout: 20)
+
+# If you have a Hybiscus in your private cloud and have a different URL, you can pass the URL as a parameter
+client = HybiscusPdfReport::Client.new(hibiskus_api_url: #URL#)
+# You can also set the URL as  ENV["HIBISCUS_API_URL"]
+```
+
+## Accessing the Endpoints
+### Submit to 'build-report'
+```ruby
+response = client.request.build_report(json)
+```
+The Response object is returned, containint the `task_id` AND the task `status`. These information are also stored and can be accessed as follows
+```ruby
+response = client.request.last_task_id
+response = client.request.last_task_status
+```
+
+### Submit to 'preview-report'
+```ruby
+response = client.request.preview_report(json)
+```
+### Submit to 'get-task-status'
+```ruby
+response = client.request.get_task_status(task_id)
+# if you previously already made a request, you can get the status of the last task directly without having to store and pass the task_id
+response = client.request.get_last_task_status
+```
+
+### Submit to 'get-report'
+```ruby
+response = client.request.get_report(task_id)
+# if you previously already made a request, you can get the status of the last task directly without having to store and pass the task_id
+response = client.request.get_last_report
+```
+
+## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+To test the application in the console
+```ruby
+client = HybiscusPdfReport::Client.new(api_key: _YOUR_API_KEY_)
+# to get a list of all trackers (just as an example)
+client.trackers.all
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Timly-Software-AG/HybiscusPdfReportRubyGem.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Open development
+* Pagination for development
+
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/hybiscus_pdf_report.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative "lib/hybiscus_pdf_report/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "hybiscus_pdf_report"
+  spec.version = HybiscusPdfReport::VERSION
+  spec.authors = ["Philipp Baumann"]
+  spec.email = ["philipp.baumann@timly.com"]
+
+  spec.summary = "API Wrapper for the Hybiscus.dev PDF reports generator"
+  spec.description = "This gem provides a simple access using Ruby to the Hybiscus.dev PDF reports generator API."
+  spec.homepage = "https://hybiscus.dev/"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["source_code_uri"] = "https://github.com/Timly-Software-AG/HybiscusPdfReportRubyGem"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .gitlab-ci.yml appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 1.10"
+  # base64 will no longer be part of the default gems after Ruby 3.4.0. Adding base64 gemspec.
+  spec.add_dependency "base64"
+  spec.add_development_dependency "pry"
+end

data/lib/hybiscus_pdf_report/client.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "faraday"
+require_relative "errors"
+
+module HybiscusPdfReport
+  # Client handling the Faraday connection to the Hybiscus PDF Reports API
+  class Client
+    attr_reader :api_key, :hibiskus_api_url, :adapter, :last_request, :email
+
+    BASE_URL_API = "https://api.hybiscus.dev/api/v1/"
+
+    def initialize(api_key: ENV["HIBISCUS_API_KEY"],
+                   hibiskus_api_url: ENV["HIBISCUS_API_URL"],
+                   timeout: nil,
+                   adapter: nil,
+                   stubs: nil)
+      @api_key            = api_key&.strip
+      # default to the main Adnexo production account
+      raise ArgumentError, "No API key defined. Check documentation on how to set the API key." if @api_key.nil?
+
+      @hibiskus_api_url   = hibiskus_api_url || BASE_URL_API
+      # default to the main Adnexo production account
+      @timeout            = timeout
+      # param made available for testing purposes: In the rspec tests the following adapter is used: :test
+      # https://www.rubydoc.info/gems/faraday/Faraday/Adapter/Test
+      @adapter            = adapter || Faraday.default_adapter
+      @stubs              = stubs
+    end
+
+    def request
+      @request ||= Request.new(self)
+    end
+
+    def connection(header = {})
+      @connection ||= build_connection(header)
+    end
+
+    private
+
+    # rubocop:disable Metrics/AbcSize
+    def build_connection(header)
+      Faraday.new do |conn|
+        conn.url_prefix = hibiskus_api_url ## typically the base URL
+        conn.request :json
+        conn.response :json, content_type: "application/json"
+        conn.adapter adapter, @stubs
+        conn.headers["X-API-KEY"] = api_key.to_s unless api_key.empty?
+        # adds additional header information to the connection
+        header.each { |key, value| conn.headers[key] = value }
+        conn.options.timeout = @timeout || 10
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+end

data/lib/hybiscus_pdf_report/errors.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Definition of all errors that can be raised by the Hybiscus PDF Reports API
+module HybiscusPdfReport
+  ApiError = Class.new(StandardError)
+  BadRequestError = Class.new(ApiError)
+  UnauthorizedError = Class.new(ApiError)
+  PaymentRequiredError = Class.new(ApiError)
+  ForbiddenError = Class.new(ApiError)
+  ApiRequestsQuotaReachedError = Class.new(ApiError)
+  NotFoundError = Class.new(ApiError)
+  UnprocessableEntityError = Class.new(ApiError)
+  RateLimitError = Class.new(ApiError)
+
+  HTTP_OK_CODE                    = 200
+
+  HTTP_BAD_REQUEST_CODE           = 400
+  HTTP_UNAUTHORIZED_CODE          = 401
+  HTTP_PAYMENT_REQUIRED_CODE      = 402
+  HTTP_FORBIDDEN_CODE             = 403
+  HTTP_NOT_FOUND_CODE             = 404
+  HTTP_UNPROCESSABLE_CONTENT_CODE = 422
+  HTTP_UNPROCESSABLE_ENTITY_CODE  = 429
+  HTTP_SERVICE_UNAVAILABLE_CODE   = 503
+end

data/lib/hybiscus_pdf_report/object.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module HybiscusPdfReport
+  # Base class for all objects returned by the Hybiscus PDF Reports API
+  class Object
+    def initialize(attributes)
+      @attributes = OpenStruct.new(attributes)
+    end
+
+    def method_missing(method, *args, &block)
+      attribute = @attributes.send(method, *args, &block)
+
+      return super if attribute.nil?
+      return Object.new(attribute) if attribute.is_a?(Hash)
+
+      attribute
+    end
+
+    def respond_to_missing?(method, _include_private = false)
+      @attributes.respond_to? method
+    end
+  end
+end

data/lib/hybiscus_pdf_report/objects/response.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module HybiscusPdfReport
+  class Response < Object
+  end
+end

data/lib/hybiscus_pdf_report/request.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require "json"
+require "base64"
+
+module HybiscusPdfReport
+  # Request Handler with the individual endpoints handling the communication with the Hybiscus PDF Reports API
+  class Request
+    attr_reader :client, :response, :last_request_time_counting_against_rate_limit, :last_task_id, :last_task_status,
+                :remaining_single_page_reports, :remaining_multi_page_reports
+
+    def initialize(client)
+      @client = client
+      @response = nil
+    end
+
+    # rubocop: disable Naming/AccessorMethodName
+    # method names are inline with the Hybiscus API endpoint names. This is more explicit and easier to understand
+    # than following rubocop conventions.
+    def build_report(report_request_as_json)
+      response_body = request(endpoint: "build-report", http_method: :post, body: report_request_as_json)
+      ## HANDLE 402 RESPONSE --> PAYMENT REQUIRED
+      update_last_request_information
+
+      response = Response.new(response_body.merge(
+                                remaining_single_page_reports: @response.headers["x-remaining-single-page-reports"],
+                                remaining_multi_page_reports: @response.headers["x-remaining-multi-page-reports"]
+                              ))
+
+      update_quota_information(response)
+      response
+    end
+
+    # POST
+    def preview_report(report_request_as_json)
+      response_body = request(endpoint: "preview-report", http_method: :post, body: report_request_as_json)
+      update_last_request_information
+      Response.new(response_body)
+    end
+
+    # GET
+    def get_task_status(task_id)
+      response_body = request(endpoint: "get-task-status", params: { task_id: task_id })
+      # The last task status is stored. If this method is called with the same task_id, the last task status is updated
+      # in the instance variable
+      @last_task_status = response.body["status"] if last_task_id == task_id
+      Response.new(response_body)
+    end
+
+    def get_last_task_status
+      raise ArgumentError, "No task_id available. Please call build_report or preview_report first." unless last_task_id
+
+      get_task_status(last_task_id)
+    end
+
+    def get_report(task_id)
+      response_body = request(endpoint: "get-report", http_method: :get, params: { task_id: task_id })
+      Response.new(satus: response.status, content: Base64.encode64(response_body))
+    end
+
+    def get_last_report
+      raise ArgumentError, "No task_id available. Please call build_report or preview_report first." unless last_task_id
+
+      get_report(last_task_id)
+    end
+
+    def get_remaining_quota
+      response_body = request(endpoint: "get-remaining-quota", http_method: :get)
+
+      Response.new response_body
+    end
+    # rubocop: enable Naming/AccessorMethodName
+
+    private
+
+    def request(endpoint:, http_method: :get, headers: {}, params: {}, body: {})
+      raise "Client not defined" unless defined? @client
+
+      @response = client.connection.public_send(http_method, endpoint, params.merge(body), headers)
+      raise_error unless response_successful? && no_json_error?
+
+      @last_request = Time.now
+
+      response.body
+    end
+
+    def update_last_request_information
+      @last_request_time_counting_against_rate_limit = Time.now
+      @last_task_id = response.body["task_id"]
+      @last_task_status = response.body["status"]
+    end
+
+    def update_quota_information(response_object)
+      @remaining_single_page_reports = response_object.remaining_single_page_reports
+      @remaining_multi_page_reports = response_object.remaining_multi_page_reports
+    end
+
+    def raise_error
+      pretty_print_json_response
+
+      raise error_class(response.status), "Code: #{response.status}, response: #{response.reason_phrase}"
+    end
+
+    # rubocop: disable Metrics/Metrics/MethodLength
+    def error_class(status)
+      case status
+      when HTTP_BAD_REQUEST_CODE
+        BadRequestError
+      when HTTP_UNAUTHORIZED_CODE
+        UnauthorizedError
+      when HTTP_NOT_FOUND_CODE, HTTP_FORBIDDEN_CODE
+        NotFoundError
+      when HTTP_UNPROCESSABLE_ENTITY_CODE
+        UnprocessableEntityError
+      when HTTP_PAYMENT_REQUIRED_CODE
+        PaymentRequiredError
+      when HTTP_SERVICE_UNAVAILABLE_CODE
+        # Hybiscus API returns 503 when the rate limit is reached
+        # https://hybiscus.dev/docs/api/rate-limitting
+        RateLimitError
+      else
+        ApiError
+      end
+    end
+    # rubocop: enable Metrics/Metrics/MethodLength
+
+    def response_successful?
+      response.status == HTTP_OK_CODE
+    end
+
+    def no_json_error?
+      response.status != HTTP_UNPROCESSABLE_CONTENT_CODE
+    end
+
+    def pretty_print_json_response
+      puts "Response Body:"
+      puts JSON.pretty_generate(response.body)
+    end
+  end
+end

data/lib/hybiscus_pdf_report/version.rb

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

data/lib/hybiscus_pdf_report.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "hybiscus_pdf_report/version"
+
+# Service to interact with the Hybiscus PDF Reports API
+module HybiscusPdfReport
+  autoload :Client, "hybiscus_pdf_report/client"
+  autoload :Request, "hybiscus_pdf_report/request"
+  autoload :Object, "hybiscus_pdf_report/object"
+  autoload :Response, "hybiscus_pdf_report/objects/response"
+end

data/sig/hybiscus_pdf_report.rbs

@@ -0,0 +1,4 @@
+module HybiscusPdfReport
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: hybiscus_pdf_report
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philipp Baumann
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides a simple access using Ruby to the Hybiscus.dev PDF
+  reports generator API.
+email:
+- philipp.baumann@timly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- hybiscus_pdf_report.gemspec
+- lib/hybiscus_pdf_report.rb
+- lib/hybiscus_pdf_report/client.rb
+- lib/hybiscus_pdf_report/errors.rb
+- lib/hybiscus_pdf_report/object.rb
+- lib/hybiscus_pdf_report/objects/response.rb
+- lib/hybiscus_pdf_report/request.rb
+- lib/hybiscus_pdf_report/version.rb
+- sig/hybiscus_pdf_report.rbs
+homepage: https://hybiscus.dev/
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/Timly-Software-AG/HybiscusPdfReportRubyGem
+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.3
+signing_key:
+specification_version: 4
+summary: API Wrapper for the Hybiscus.dev PDF reports generator
+test_files: []