1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
|
# frozen_string_literal: true
module Seahorse
module Client
class Base
include HandlerBuilder
# default plugins
# @api private
@plugins = PluginList.new([
Plugins::Endpoint,
Plugins::NetHttp,
Plugins::RaiseResponseErrors,
Plugins::ResponseTarget,
Plugins::RequestCallback
])
# @api private
def initialize(plugins, options)
@config = build_config(plugins, options)
@handlers = build_handler_list(plugins)
after_initialize(plugins)
end
# @return [Configuration<Struct>]
attr_reader :config
# @return [HandlerList]
attr_reader :handlers
# Builds and returns a {Request} for the named operation. The request
# will not have been sent.
# @param [Symbol, String] operation_name
# @return [Request]
def build_request(operation_name, params = {})
Request.new(
@handlers.for(operation_name),
context_for(operation_name, params))
end
# @api private
def inspect
"#<#{self.class.name}>"
end
# @return [Array<Symbol>] Returns a list of valid request operation
# names. These are valid arguments to {#build_request} and are also
# valid methods.
def operation_names
self.class.api.operation_names - self.class.api.async_operation_names
end
private
# Constructs a {Configuration} object and gives each plugin the
# opportunity to register options with default values.
def build_config(plugins, options)
config = Configuration.new
config.add_option(:api)
config.add_option(:plugins)
plugins.each do |plugin|
plugin.add_options(config) if plugin.respond_to?(:add_options)
end
config.build!(options.merge(api: self.class.api))
end
# Gives each plugin the opportunity to register handlers for this client.
def build_handler_list(plugins)
plugins.inject(HandlerList.new) do |handlers, plugin|
if plugin.respond_to?(:add_handlers)
plugin.add_handlers(handlers, @config)
end
handlers
end
end
# Gives each plugin the opportunity to modify this client.
def after_initialize(plugins)
plugins.reverse.each do |plugin|
plugin.after_initialize(self) if plugin.respond_to?(:after_initialize)
end
end
# @return [RequestContext]
def context_for(operation_name, params)
RequestContext.new(
operation_name: operation_name,
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
end
class << self
def new(options = {})
options = options.dup
plugins = build_plugins(self.plugins + options.fetch(:plugins, []))
plugins = before_initialize(plugins, options)
client = allocate
client.send(:initialize, plugins, options)
client
end
# Registers a plugin with this client.
#
# @example Register a plugin
#
# ClientClass.add_plugin(PluginClass)
#
# @example Register a plugin by name
#
# ClientClass.add_plugin('gem-name.PluginClass')
#
# @example Register a plugin with an object
#
# plugin = MyPluginClass.new(options)
# ClientClass.add_plugin(plugin)
#
# @param [Class, Symbol, String, Object] plugin
# @see .clear_plugins
# @see .set_plugins
# @see .remove_plugin
# @see .plugins
# @return [void]
def add_plugin(plugin)
@plugins.add(plugin)
end
# @see .clear_plugins
# @see .set_plugins
# @see .add_plugin
# @see .plugins
# @return [void]
def remove_plugin(plugin)
@plugins.remove(plugin)
end
# @see .set_plugins
# @see .add_plugin
# @see .remove_plugin
# @see .plugins
# @return [void]
def clear_plugins
@plugins.set([])
end
# @param [Array<Plugin>] plugins
# @see .clear_plugins
# @see .add_plugin
# @see .remove_plugin
# @see .plugins
# @return [void]
def set_plugins(plugins)
@plugins.set(plugins)
end
# Returns the list of registered plugins for this Client. Plugins are
# inherited from the client super class when the client is defined.
# @see .clear_plugins
# @see .set_plugins
# @see .add_plugin
# @see .remove_plugin
# @return [Array<Plugin>]
def plugins
Array(@plugins).freeze
end
# @return [Model::Api]
def api
@api ||= Model::Api.new
end
# @param [Model::Api] api
# @return [Model::Api]
def set_api(api)
@api = api
define_operation_methods
@api
end
# @option options [Model::Api, Hash] :api ({})
# @option options [Array<Plugin>] :plugins ([]) A list of plugins to
# add to the client class created.
# @return [Class<Client::Base>]
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
alias extend define
private
def define_operation_methods
operations_module = Module.new
@api.operation_names.each do |method_name|
operations_module.send(:define_method, method_name) do |*args, &block|
params = args[0] || {}
options = args[1] || {}
build_request(method_name, params).send_request(options, &block)
end
end
include(operations_module)
end
def build_plugins(plugins)
plugins.map { |plugin| plugin.is_a?(Class) ? plugin.new : plugin }
end
def before_initialize(plugins, options)
queue = Queue.new
plugins.each { |plugin| queue.push(plugin) }
until queue.empty?
plugin = queue.pop
next unless plugin.respond_to?(:before_initialize)
plugins_before = options.fetch(:plugins, [])
plugin.before_initialize(self, options)
plugins_after = build_plugins(options.fetch(:plugins, []) - plugins_before)
# Plugins with before_initialize can add other plugins
plugins_after.each { |p| queue.push(p); plugins << p }
end
plugins
end
def inherited(subclass)
super
subclass.instance_variable_set('@plugins', PluginList.new(@plugins))
end
end
end
end
end
|