Module: Clicksign

Defined in:
lib/clicksign.rb,
lib/clicksign/client.rb,
lib/clicksign/errors.rb,
lib/clicksign/version.rb,
lib/clicksign/resource.rb,
lib/clicksign/configuration.rb,
lib/clicksign/error_handler.rb,
lib/clicksign/resources/user.rb,
lib/clicksign/json_api/parser.rb,
lib/clicksign/resources/group.rb,
lib/clicksign/resources/folder.rb,
lib/clicksign/resources/webhook.rb,
lib/clicksign/resources/template.rb,
lib/clicksign/json_api/operations.rb,
lib/clicksign/json_api/serializer.rb,
lib/clicksign/resources/membership.rb,
lib/clicksign/json_api/query_builder.rb,
lib/clicksign/resources/notarial/event.rb,
lib/clicksign/resources/template_field.rb,
lib/clicksign/resources/notarial/signer.rb,
lib/clicksign/resources/notarial/document.rb,
lib/clicksign/resources/notarial/envelope.rb,
lib/clicksign/resources/access_control_list.rb,
lib/clicksign/resources/auto_signature/term.rb,
lib/clicksign/json_api/atomic_results_parser.rb,
lib/clicksign/resources/notarial/requirement.rb,
lib/clicksign/json_api/bulk_operations_client.rb,
lib/clicksign/resources/envelope_bulk_creation.rb,
lib/clicksign/resources/acceptance_term/whatsapp.rb,
lib/clicksign/resources/notarial/bulk_requirement.rb,
lib/clicksign/json_api/operations/bulk_requirement.rb,
lib/clicksign/resources/notarial/signature_watcher.rb

Defined Under Namespace

Modules: ErrorHandler, JsonApi, Resources Classes: AuthenticationError, Client, Configuration, ConflictError, Error, NotFoundError, RateLimitError, Resource, ServerError, TimeoutError, ValidationError

Constant Summary collapse

VERSION = 
'0.1.0'

Class Method Summary collapse

Class Method Details

.bulk_operations_client ⇒ Object 



45
46
47
48
49
50
 
# File 'lib/clicksign.rb', line 45

def bulk_operations_client
  @bulk_operations_client ||= JsonApi::BulkOperationsClient.new(
    api_key: configuration.api_key,
    base_url: configuration.base_url,
  )
end

.client ⇒ Object 



38
39
40
41
42
43
 
# File 'lib/clicksign.rb', line 38

def client
  @client ||= Client.new(
    api_key: configuration.api_key,
    base_url: configuration.base_url,
  )
end

.configuration ⇒ Object 



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

def configuration
  @configuration ||= Configuration.new
end

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

Must be called once at application startup, before any threads are spawned. Module-level memoisation (@client, @configuration) is not thread-safe for concurrent first-access; subsequent calls are safe once initialised.

Yields:



30
31
32
 
# File 'lib/clicksign.rb', line 30

def configure
  yield configuration
end

.reset! ⇒ Object 



52
53
54
55
56
 
# File 'lib/clicksign.rb', line 52

def reset!
  @configuration = nil
  @client                  = nil
  @bulk_operations_client  = nil
end