Class: Seahorse::Client::Base

Inherits:
Object
  • Object
show all
Includes:
HandlerBuilder
Defined in:
lib/seahorse/client/base.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from HandlerBuilder

#handle, #handle_request, #handle_response, #handler_for, #new_handler

Constructor Details

#initialize(plugins, options) ⇒ Base

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Base.



21
22
23
24
25
 
# File 'lib/seahorse/client/base.rb', line 21

def initialize(plugins, options)
  @config = build_config(plugins, options)
  @handlers = build_handler_list(plugins)
  after_initialize(plugins)
end

Instance Attribute Details

#config ⇒ Configuration<Struct> (readonly)

Returns:



28
29
30
 
# File 'lib/seahorse/client/base.rb', line 28

def config
  @config
end

#handlers ⇒ HandlerList (readonly)

Returns:



31
32
33
 
# File 'lib/seahorse/client/base.rb', line 31

def handlers
  @handlers
end

Class Method Details

.add_plugin(plugin) ⇒ void

This method returns an undefined value.

Registers a plugin with this client.

Examples:

Register a plugin


ClientClass.add_plugin(PluginClass)

Register a plugin by name


ClientClass.add_plugin('gem-name.PluginClass')

Register a plugin with an object


plugin = MyPluginClass.new(options)
ClientClass.add_plugin(plugin)

Parameters:

  • plugin (Class, Symbol, String, Object)

See Also:



127
128
129
 
# File 'lib/seahorse/client/base.rb', line 127

def add_plugin(plugin)
  @plugins.add(plugin)
end

.api ⇒ Model::Api

Returns:



171
172
173
 
# File 'lib/seahorse/client/base.rb', line 171

def api
  @api ||= Model::Api.new
end

.clear_plugins ⇒ void

This method returns an undefined value.

See Also:



145
146
147
 
# File 'lib/seahorse/client/base.rb', line 145

def clear_plugins
  @plugins.set([])
end

.define(options = {}) ⇒ Class<Client::Base> Also known as: extend

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :api (Model::Api, Hash) — default: {}
  • :plugins (Array<Plugin>) — default: [] —

    A list of plugins to add to the client class created.

Returns:



187
188
189
190
191
192
193
194
 
# File 'lib/seahorse/client/base.rb', line 187

def define(options = {})
  subclass = Class.new(self)
  subclass.set_api(options[:api] || api)
  Array(options[:plugins]).each do |plugin|
    subclass.add_plugin(plugin)
  end
  subclass
end

.new(options = {}) ⇒ Object 



97
98
99
100
101
102
103
104
 
# File 'lib/seahorse/client/base.rb', line 97

def new(options = {})
  plugins = build_plugins
  options = options.dup
  before_initialize(plugins, options)
  client = allocate
  client.send(:initialize, plugins, options)
  client
end

.plugins ⇒ Array<Plugin>

Returns the list of registered plugins for this Client. Plugins are inherited from the client super class when the client is defined.

Returns:

See Also:



166
167
168
 
# File 'lib/seahorse/client/base.rb', line 166

def plugins
  Array(@plugins).freeze
end

.remove_plugin(plugin) ⇒ void

This method returns an undefined value.

See Also:



136
137
138
 
# File 'lib/seahorse/client/base.rb', line 136

def remove_plugin(plugin)
  @plugins.remove(plugin)
end

.set_api(api) ⇒ Model::Api

Parameters:

Returns:



177
178
179
180
181
 
# File 'lib/seahorse/client/base.rb', line 177

def set_api(api)
  @api = api
  define_operation_methods
  @api
end

.set_plugins(plugins) ⇒ void

This method returns an undefined value.

Parameters:

See Also:



155
156
157
 
# File 'lib/seahorse/client/base.rb', line 155

def set_plugins(plugins)
  @plugins.set(plugins)
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Request

Builds and returns a Request for the named operation. The request will not have been sent.

Parameters:

  • operation_name (Symbol, String)

Returns:



37
38
39
40
41
 
# File 'lib/seahorse/client/base.rb', line 37

def build_request(operation_name, params = {})
  Request.new(
    @handlers.for(operation_name),
    context_for(operation_name, params))
end

#inspect ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



44
45
46
 
# File 'lib/seahorse/client/base.rb', line 44

def inspect
  "#<#{self.class.name}>"
end

#operation_names ⇒ Array<Symbol>

Returns a list of valid request operation names. These are valid arguments to #build_request and are also valid methods.

Returns:

  • (Array<Symbol>) —

    Returns a list of valid request operation names. These are valid arguments to #build_request and are also valid methods.



51
52
53
 
# File 'lib/seahorse/client/base.rb', line 51

def operation_names
  self.class.api.operation_names - self.class.api.async_operation_names
end