Module: HybiscusPdfReport

Defined in:

lib/hybiscus_pdf_report.rb,
lib/hybiscus_pdf_report/client.rb,
lib/hybiscus_pdf_report/config.rb,
lib/hybiscus_pdf_report/errors.rb,
lib/hybiscus_pdf_report/object.rb,
lib/hybiscus_pdf_report/request.rb,
lib/hybiscus_pdf_report/version.rb,
lib/hybiscus_pdf_report/api_errors.rb,
lib/hybiscus_pdf_report/report_builder.rb,
lib/hybiscus_pdf_report/response_object.rb,
lib/hybiscus_pdf_report/objects/response.rb,
lib/hybiscus_pdf_report/request_retry_wrapper.rb

Overview

These errors are automatically raised by the client based on HTTP status codes returned by the Hybiscus API. Extend or rescue these as needed in application code.

Defined Under Namespace

Modules: Object Classes: ApiError, ApiRequestsQuotaReachedError, BadRequestError, Client, Config, ForbiddenError, NotFoundError, PaymentRequiredError, RateLimitError, ReportBuilder, Request, RequestRetryWrapper, Response, ResponseObject, UnauthorizedError, UnprocessableContentError

Constant Summary

HTTP_ERROR_STATUS_CODES =

rubocop:enable Style/CommentedKeyword

{
  400 => BadRequestError,
  401 => UnauthorizedError,
  402 => PaymentRequiredError,
  403 => ForbiddenError,
  404 => NotFoundError,
  422 => UnprocessableContentError,
  429 => ApiRequestsQuotaReachedError,
  503 => RateLimitError
}.freeze

HTTP_OK_CODE =

200

VERSION =

"0.9.1"

Class Method Summary

• .config ⇒ Object

  returns the global config instance.

• .configure {|config| ... } ⇒ Object

  yields the global configuration.

Class Method Details

.config ⇒ Object

returns the global config instance

# File 'lib/hybiscus_pdf_report.rb', line 26

def self.config
  @config ||= Config.new
end

.configure {|config| ... } ⇒ Object

yields the global configuration

Yields:

• (config)

# File 'lib/hybiscus_pdf_report/config.rb', line 39

def self.configure
  yield(config) if block_given?
end