Module: Zaig

Defined in:
lib/zaig.rb,
lib/zaig/version.rb,
lib/zaig/base_error.rb,
lib/zaig/connection.rb,
lib/zaig/registration.rb,
lib/zaig/server_error.rb,
lib/zaig/unexpected_error.rb,
lib/zaig/validation_error.rb,
lib/zaig/entities/response.rb,
lib/zaig/already_exists_error.rb,
lib/zaig/registration_payload.rb,
lib/zaig/server_timeout_error.rb,
lib/zaig/external_timeout_error.rb,
lib/zaig/field_validation_error.rb,
lib/zaig/unprocessable_entity_error.rb

Overview

Zaig integration module

Defined Under Namespace

Modules: Entities Classes: AlreadyExistsError, BaseError, Configuration, Connection, ExternalTimeoutError, FieldValidationError, Registration, RegistrationPayload, ServerError, ServerTimeoutError, UnexpectedError, UnprocessableEntityError, ValidationError

Constant Summary collapse

VERSION =

When updating version, keep in mind Semantic Versioning semver.org/ TL;DR; (Major.Minor.Patch) Releases before 1.0.0 are in active development and can change anytime 1.0.0 and up is indication and declaration of a stable public API Major - Incremented for incompatible changes with previous release (or big enough new features) Minor - Incremented for new backwards-compatible features + deprecations Patch - Incremented for backwards-compatible bug fixes

File.read(".version").strip

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configurationObject



35
36
37
# File 'lib/zaig.rb', line 35

def configuration
  @configuration ||= Configuration.new
end

Class Method Details

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

Yields:



40
41
42
43
44
# File 'lib/zaig.rb', line 40

def self.configure
  self.configuration ||= Configuration.new

  yield(configuration)
end