Module: Pdfx

Defined in:
lib/pdfx.rb,
lib/pdfx/client.rb,
lib/pdfx/errors.rb,
lib/pdfx/version.rb

Overview

Main module for the Pdfx gem

Defined Under Namespace

Classes: AuthenticationError, Client, Error, NetworkError, RequestError, ServerError

Constant Summary collapse

VERSION = 
"0.1.1"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_key ⇒ Object

Returns the value of attribute api_key.



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

def api_key
  @api_key
end

.base_url ⇒ Object

Returns the value of attribute base_url.



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

def base_url
  @base_url
end

Class Method Details

.configure {|self| ... } ⇒ Object

Configure the Pdfx gem

Examples:

Configure with a block

Pdfx.configure do |config|
  config.api_key = "your-api-key"
  config.base_url = "https://pdfx.fr"
end

Yields:

  • (self) —

    Configuration block



21
22
23
 
# File 'lib/pdfx.rb', line 21

def configure
  yield self if block_given?
end