hybiscus_pdf_report 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 688afeb6ab9c2d4cd50f375c6b3e3817d50f917ba2d489b7860f4afd5bbc1fb5
-  data.tar.gz: 57da67ca7e60bbcda279c5c9b23672d230e1116e34acf10a49c260df3edbbb66
+  metadata.gz: 0007a7c6d4494de9ca87ab92f259b192ad550d26172d225f5be109823a514298
+  data.tar.gz: ccc6a69f6c7d28b34b168a240b059c9e54c51a0802097ff829bb07111909ea53
 SHA512:
-  metadata.gz: 113df65983859e7e7cbb6dca38fe6abf720dd25522c1a1e45ccaf0ffbc5f56a2b78a64eaa29ab1a2b709327b7a707bd0ed88ed967b1837e949fe00d743cabb1c
-  data.tar.gz: 5aac878fc6d8ea65f6621e752b3f77edec8fb0ded23e8410473505070c2697212b3cc8836c69f60d3355ff041b875f61c795e396b8b65ab57a0455eee2b18cbf
+  metadata.gz: efbe50eb7882ce18576a146b77593e19364176b819973ded959f57d1f6a279982789839fb2503e34f66ca2022ff2bff5148d5c3c76d7f8ccb249cc68df756a4e
+  data.tar.gz: 63c0076efef641022cbf9be95a074bb0903b9386308ab7eb1541b6d2a456854c55831e4e17ab08171cf56fe41e4c33f4aa59605ff36edd937c2437cf5363f879

data/hybiscus_pdf_report.gemspec

@@ -23,7 +23,8 @@ Gem::Specification.new do |spec|
   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])
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .gitlab-ci.yml appveyor Gemfile]) ||
+        f.end_with?(".gem")
     end
   end
   spec.bindir = "exe"

data/lib/hybiscus_pdf_report/client.rb

@@ -5,11 +5,30 @@ require_relative "api_errors"
 require_relative "config"
 
 module HybiscusPdfReport
-  # Client handling the Faraday connection to the Hybiscus PDF Reports API
+  # HTTP client for the Hybiscus PDF Reports API.
+  #
+  # This class handles all HTTP communication with the Hybiscus API, including
+  # authentication, connection management, and request routing. It uses Faraday
+  # for HTTP requests and supports custom adapters for testing.
+  #
+  # @example Basic usage
+  #   client = HybiscusPdfReport::Client.new(api_key: "your_api_key")
+  #   response = client.request.build_report(report_data)
+  #
+  # @example Using environment variables
+  #   ENV["HYBISCUS_API_KEY"] = "your_api_key"
+  #   client = HybiscusPdfReport::Client.new
+  #
+  # @example Custom configuration
+  #   client = HybiscusPdfReport::Client.new(
+  #     api_key: "your_key",
+  #     api_url: "https://api.hybiscus.dev/api/v1/",
+  #     timeout: 30
+  #   )
   class Client
     attr_reader :api_key, :api_url, :adapter, :last_request
 
-    # rubocop:disable Metrics/CyclomaticComplexity)
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def initialize(api_key: nil, api_url: nil, timeout: nil, adapter: nil, stubs: nil)
       @api_key = (api_key || config.api_key)&.strip
       if @api_key.nil? || @api_key.empty?
@@ -25,7 +44,7 @@ module HybiscusPdfReport
       @adapter = adapter || config.adapter
       @stubs   = stubs || config.stubs
     end
-    # rubocop:enable Metrics/CyclomaticComplexity)
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     def request
       @request ||= Request.new(self)

data/lib/hybiscus_pdf_report/config.rb

@@ -2,11 +2,28 @@
 
 require "faraday"
 
+# Main module for the Hybiscus PDF Report gem
 module HybiscusPdfReport
+  # Configuration class for the Hybiscus PDF Report gem.
+  #
+  # This class manages all configuration settings including API credentials,
+  # URLs, timeouts, and connection adapters. Configuration can be set through
+  # environment variables or programmatically.
+  #
+  # @example Setting configuration programmatically
+  #   HybiscusPdfReport.configure do |config|
+  #     config.api_key = "your_api_key"
+  #     config.api_url = "https://api.hybiscus.dev/api/v1/"
+  #     config.timeout = 30
+  #   end
+  #
+  # @example Using environment variables
+  #   ENV["HYBISCUS_API_KEY"] = "your_api_key"
+  #   ENV["HYBISCUS_API_URL"] = "https://api.hybiscus.dev/api/v1/"
   class Config
     attr_accessor :api_key, :api_url, :timeout, :adapter, :stubs
 
-    DEFAULT_API_URL = "https://api.hybiscus.dev/api/v1/".freeze
+    DEFAULT_API_URL = "https://api.hybiscus.dev/api/v1/"
     DEFAULT_TIMEOUT = 10
 
     def initialize

data/lib/hybiscus_pdf_report/object.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Legacy placeholder file for backward compatibility
+# This file exists for historical reasons and may be removed in future versions.
+# Use HybiscusPdfReport::ResponseObject instead.
+module HybiscusPdfReport
+  # Placeholder for legacy compatibility
+  # @deprecated Use ResponseObject instead
+  module Object
+    # This module is deprecated
+  end
+end

data/lib/hybiscus_pdf_report/objects/response.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+# Response wrapper class for Hybiscus PDF Report API responses
 require_relative "../response_object"
+
 module HybiscusPdfReport
+  # Standard response object that inherits from ResponseObject
   class Response < HybiscusPdfReport::ResponseObject
   end
 end

data/lib/hybiscus_pdf_report/report_builder.rb

@@ -1,52 +1,99 @@
 # frozen_string_literal: true
 
+require "erb"
+require "pathname"
+
 module HybiscusPdfReport
-  # Base class for all objects returned by the Hybiscus PDF Reports API
+  # Base class for building PDF reports with JSON templates
+  #
+  # This class allows users to create custom report builders by inheriting from it.
+  # It provides a simple way to generate JSON structures for the Hybiscus API using ERB templates.
+  #
+  # Usage:
+  #   class InvoiceReport < HybiscusPdfReport::ReportBuilder
+  #     def initialize(invoice:, **options)
+  #       @invoice = invoice
+  #       super(report_name: "Invoice Report", **options)
+  #     end
+  #   end
+  #
+  #   report = InvoiceReport.new(invoice: my_invoice)
+  #   json_data = report.generate
   class ReportBuilder
     DEFAULT_TEMPLATE_DIR = File.dirname(__FILE__)
 
-    def initialize(report_name: nil, **template_params)
-      # Dynamically set all parameters as instance variables
-      @report_name = report_name ||  self.name.demodulize.humanize.titleize
+    attr_reader :report_name, :template_dir
 
+    def initialize(report_name: nil, template_dir: nil, **template_params)
+      # Set the report name - use provided name or derive from class name
+      @report_name = report_name || derive_report_name
+      @template_dir = template_dir || DEFAULT_TEMPLATE_DIR
+
+      # Dynamically set all parameters as instance variables
       template_params.each do |key, value|
         instance_variable_set("@#{key}", value)
       end
     end
 
-    # Main method to generate the report - similar to a controller action
+    # Main method to generate the report JSON
+    # Returns a JSON string that can be sent to the Hybiscus API
     def generate
-      # Render the JSON template with all instance variables available
       render_json
     end
 
-    def report_name
-      @report_name = @report_name.presence(name.demodulize.humanize.titleize)
-    end
-
+    # Returns the full path to the template file
     def template_path
-      Pathname.new(template_path || DEFAULT_TEMPLATE_DIR)
+      File.join(template_dir, template_name)
     end
 
+    # Returns the template filename (can be overridden in subclasses)
     def template_name
-      "#{name.demodulize.underscore}.json.erb"
+      "#{underscore(class_name)}.json.erb"
     end
 
     def load_configuration_first?
-      # By default, we assume the print doesn't have a configuration.
-      # This can be overridden in subclasses and will load the configuration first.
+      # By default, we assume the report doesn't require pre-loading configuration.
+      # This can be overridden in subclasses if configuration loading is needed.
       false
     end
 
     private
 
+    # Renders the ERB template with all instance variables available
     def render_json
-      # Use ERB to render the JSON template with all instance variables available
-      template_path = File.join(File.dirname(__FILE__), json_template)
-      template = ERB.new(File.read(template_path))
+      unless File.exist?(template_path)
+        raise "Template file not found: #{template_path}. " \
+              "Create a template file or override the render_json method."
+      end
+
+      template_content = File.read(template_path)
+      template = ERB.new(template_content)
 
-      # Render and return the JSON with all instance variables in scope
+      # Render the template with all instance variables in scope
       template.result(binding)
     end
+
+    # Derives a report name from the class name
+    def derive_report_name
+      humanize(class_name)
+    end
+
+    # Returns the class name without module prefix
+    def class_name
+      self.class.name.split("::").last
+    end
+
+    # Converts CamelCase to snake_case
+    def underscore(string)
+      string
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .downcase
+    end
+
+    # Converts CamelCase to human readable format
+    def humanize(string)
+      underscore(string).tr("_", " ").split.map(&:capitalize).join(" ")
+    end
   end
 end

data/lib/hybiscus_pdf_report/request.rb

@@ -76,10 +76,7 @@ module HybiscusPdfReport
         @response = client.connection.public_send(http_method, endpoint, params.merge(body), headers)
         raise_error unless response_successful? && no_json_error?
 
-<<<<<<< HEAD
-=======
         # Return raw body for binary data (no JSON parsing)
->>>>>>> updates
         @response.body
       end
 
@@ -95,11 +92,7 @@ module HybiscusPdfReport
     end
 
     def raise_error
-<<<<<<< HEAD
-      logger.debug response.body
-=======
       # logger.debug response.body
->>>>>>> updates
 
       raise error_class(response.status), "Code: #{response.status}, response: #{response.reason_phrase}"
     end

data/lib/hybiscus_pdf_report/request_retry_wrapper.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 
-<<<<<<< HEAD
-=======
 require "faraday"
 require_relative "api_errors"
 
->>>>>>> updates
 module HybiscusPdfReport
   # RequestRetryWrapper provides automatic retry logic for transient errors
   # when communicating with the Hybiscus API (e.g., rate limits, timeouts).

data/lib/hybiscus_pdf_report/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Version information for the Hybiscus PDF Report gem
 module HybiscusPdfReport
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

data/lib/hybiscus_pdf_report.rb

@@ -19,6 +19,9 @@ module HybiscusPdfReport
   # Error handling
   autoload :APIErrors, "hybiscus_pdf_report/api_errors"
 
+  # Report building
+  autoload :ReportBuilder, "hybiscus_pdf_report/report_builder"
+
   # Module-level configuration
   def self.config
     @config ||= Config.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hybiscus_pdf_report
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Philipp Baumann
@@ -66,7 +66,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- hybiscus_pdf_report.gem
 - hybiscus_pdf_report.gemspec
 - lib/hybiscus_pdf_report.rb
 - lib/hybiscus_pdf_report/api_errors.rb