Module: AllscriptsApi

Defined in:
lib/allscripts_api.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/named_magic_methods.rb

Overview

Entry point for the AllscriptsApi gem.

Defined Under Namespace

Modules: NamedMagicMethods Classes: Client, Configuration, GetTokenError, MagicError, MagicParams, NoConfigurationError

Constant Summary collapse

VERSION =

gem version declaration

"0.3.0".freeze

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object

Returns the value of attribute configuration.



37
38
39
 
# File 'lib/allscripts_api.rb', line 37

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:



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

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:



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/allscripts_api.rb', line 51

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