Module: AllscriptsApi

Defined in:
lib/allscripts_api.rb,
lib/allscripts_api/order.rb,
lib/allscripts_api/client.rb,
lib/allscripts_api/version.rb,
lib/allscripts_api/magic_params.rb,
lib/allscripts_api/configuration.rb,
lib/allscripts_api/ordering_methods.rb,
lib/allscripts_api/documents/document.rb,
lib/allscripts_api/named_magic_methods.rb,
lib/allscripts_api/utilities/validator.rb,
lib/allscripts_api/documents/document_sender.rb,
lib/allscripts_api/documents/document_methods.rb

Overview

Entry point for the AllscriptsApi gem.

Defined Under Namespace

Modules: Documents, NamedMagicMethods, OrderingMethods, Utilities Classes: Client, Configuration, GetTokenError, MagicError, MagicParams, MissingRequiredParamsError, NoConfigurationError, Order

Constant Summary collapse

VERSION =

gem version declaration

"0.5.0".freeze

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object

Returns the value of attribute configuration.



46
47
48
 
# File 'lib/allscripts_api.rb', line 46

def configuration
  @configuration
end

Class Method Details

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

a method that allows a configuration block to be passed to AllscriptsApi::Configuration#new

Yields:

See Also:



50
51
52
53
 
# File 'lib/allscripts_api.rb', line 50

def configure
  self.configuration ||= AllscriptsApi::Configuration.new
  yield(configuration)
end

.connect(unity_url) ⇒ AllscriptsApi::Client, AllscriptsApi::NoConfigurationError

The main entry point for a pre-configured client

Parameters:

  • unity_url (String) —

    Unity API endpoint to connect to

Returns:

See Also:



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/allscripts_api.rb', line 60

def connect(unity_url)
  unless AllscriptsApi.configuration
    raise NoConfigurationError, NoConfigurationError.error_message
  end
  app_name = AllscriptsApi.configuration.app_name
  app_username = AllscriptsApi.configuration.app_username
  app_password = AllscriptsApi.configuration.app_password

  Client.new(unity_url, app_name, app_username, app_password)
end