Module: PDFify

Defined in:
lib/pdfify.rb,
lib/pdfify/client.rb,
lib/pdfify/version.rb,
lib/pdfify/configuration.rb

Defined Under Namespace

Classes: APIError, AuthenticationError, Client, Configuration, ConfigurationError, ContentTooLargeError, NetworkError, QuotaExceededError, ServerError, ValidationError

Constant Summary collapse

VERSION = 
"0.1.1"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object

Get or initialize configuration



10
11
12
 
# File 'lib/pdfify.rb', line 10

def configuration
  @configuration ||= Configuration.new
end

Class Method Details

.configure {|configuration| ... } ⇒ Object

Configure PDFify with a block

Examples:

PDFify.configure do |config|
  config.api_key = "pfy_live_xxx"
  config.base_url = "https://pdfify.example.com"
end

Yields:



20
21
22
 
# File 'lib/pdfify.rb', line 20

def configure
  yield(configuration)
end

.convert(html:, **options) ⇒ String

Convenience method to convert HTML without instantiating a client

Parameters:

  • html (String) —

    The HTML content to convert

  • options (Hash) —

    Optional parameters

Returns:

  • (String) —

    Binary PDF data



33
34
35
36
 
# File 'lib/pdfify.rb', line 33

def convert(html:, **options)
  client = Client.new
  client.convert(html: html, **options)
end

.reset_configuration! ⇒ Object

Reset configuration (useful for testing)



25
26
27
 
# File 'lib/pdfify.rb', line 25

def reset_configuration!
  @configuration = Configuration.new
end