class ApipieBindings::API
Attributes
Public Class Methods
Creates new API bindings instance @param [Hash] config API bindings configuration @option config [String] :uri base URL of the server @option config [String] :username username to access the API @option config [String] :password username to access the API @option config [Hash] :oauth options to access API using OAuth
* *:consumer_key* (String) OAuth key * *:consumer_secret* (String) OAuth secret * *:options* (Hash) options passed to OAuth
@option config [AbstractCredentials] :credentials object implementing {AbstractCredentials}
interface e.g. {https://github.com/theforeman/hammer-cli-foreman/blob/master/lib/hammer_cli_foreman/credentials.rb HammerCLIForeman::BasicCredentials} This is prefered way to pass credentials. Credentials acquired form :credentials object take precedence over explicite params
@option config [Hash] :headers additional headers to send with the requests @option config [String] :api_version ('1') version of the API @option config [String] :language prefered locale for the API description @option config [String] :apidoc_cache_base_dir ('~/.cache/apipie_bindings') base
directory for building apidoc_cache_dir
@option config [String] :apidoc_cache_dir (apidoc_cache_base_dir+'/<URI>') where
to cache the JSON description of the API
@option config [String] :apidoc_cache_name ('default.json') name of te cache file.
If there is cache in the :apidoc_cache_dir, it is used.
@option config [String] :apidoc_authenticated (true) whether or not does the call to
obtain API description use authentication. It is useful to avoid unnecessary prompts for credentials
@option config [Hash] :fake_responses ({}) responses to return if used in dry run mode @option config [Bool] :dry_run (false) dry run mode allows to test your scripts
and not touch the API. The results are taken form exemples in the API description or from the :fake_responses
@option config [Bool] :aggressive_cache_checking (false) check before every request
if the local cache of API description (JSON) is up to date. By default it is checked *after* each API request
@option config [Object] :logger (Logger.new(STDERR)) custom logger class
@option config [Number] :timeout API request timeout
in seconds @param [Hash] options params that are passed to ResClient as-is
@raise [ApipieBindings::ConfigurationError] when no :uri
or
:apidoc_cache_dir
is provided @example connect to a server
ApipieBindings::API.new({:uri => 'http://localhost:3000/', :username => 'admin', :password => 'changeme', :api_version => '2', :aggressive_cache_checking => true})
@example connect with a local API description
ApipieBindings::API.new({:apidoc_cache_dir => 'test/unit/data', :apidoc_cache_name => 'architecture'})
# File lib/apipie_bindings/api.rb, line 58 def initialize(config, options={}) if config[:uri].nil? && config[:apidoc_cache_dir].nil? raise ApipieBindings::ConfigurationError.new('Either :uri or :apidoc_cache_dir needs to be set') end @uri = config[:uri] @api_version = config[:api_version] || 1 @language = config[:language] apidoc_cache_base_dir = config[:apidoc_cache_base_dir] || File.join(File.expand_path('~/.cache'), 'apipie_bindings') @apidoc_cache_dir = config[:apidoc_cache_dir] || File.join(apidoc_cache_base_dir, @uri.tr(':/', '_'), "v#{@api_version}") @apidoc_cache_name = config[:apidoc_cache_name] || set_default_name @apidoc_authenticated = (config[:apidoc_authenticated].nil? ? true : config[:apidoc_authenticated]) @dry_run = config[:dry_run] || false @aggressive_cache_checking = config[:aggressive_cache_checking] || false @fake_responses = config[:fake_responses] || {} @logger = config[:logger] unless @logger @logger = Logger.new(STDERR) @logger.level = Logger::ERROR end config = config.dup headers = { :content_type => 'application/json', :accept => "application/json;version=#{@api_version}" } headers.merge!({ "Accept-Language" => language }) if language headers.merge!(config[:headers]) unless config[:headers].nil? headers.merge!(options.delete(:headers)) unless options[:headers].nil? log.debug "Global headers: #{headers.ai}" @credentials = config[:credentials] if config[:credentials] && config[:credentials].respond_to?(:to_params) @resource_config = { :timeout => config[:timeout], :headers => headers }.merge(options) @config = config end
Public Instance Methods
# File lib/apipie_bindings/api.rb, line 113 def apidoc @apidoc = @apidoc || load_apidoc || retrieve_apidoc @apidoc end
# File lib/apipie_bindings/api.rb, line 101 def apidoc_cache_file File.join(@apidoc_cache_dir, "#{@apidoc_cache_name}#{cache_extension}") end
Call an action in the API. It finds most fitting route based on given parameters with other attributes neccessary to do an API call. If in #dry_run mode {#initialize} it finds fake response data in examples or user provided data. At the end when the response format is JSON it is parsed and returned as ruby objects. If server supports checksum sending the internal cache with API description is checked and updated if needed @param [Symbol] resource_name name of the resource @param [Symbol] action_name name of the action @param [Hash] params parameters to be send in the request @param [Hash] headers extra headers to be sent with the request @param [Hash] options options to influence the how the call is processed
* *:response* (Symbol) *:raw* - skip parsing JSON in response * *:with_authentication* (Bool) *true* - use rest client with/without auth configuration * *:skip_validation* (Bool) *false* - skip validation of parameters
@example show user data
call(:users, :show, :id => 1)
# File lib/apipie_bindings/api.rb, line 154 def call(resource_name, action_name, params={}, headers={}, options={}) check_cache if @aggressive_cache_checking resource = resource(resource_name) action = resource.action(action_name) route = action.find_route(params) action.validate!(params) unless options[:skip_validation] options[:fake_response] = find_match(fake_responses, resource_name, action_name, params) || action.examples.first if dry_run? return http_call( route.method, route.path(params), params.reject { |par, _| route.params_in_path.include? par.to_s }, headers, options) end
# File lib/apipie_bindings/api.rb, line 240 def check_cache begin response = http_call('get', "/apidoc/apipie_checksum", {}, { :accept => "application/json" }) response['checksum'] rescue nil end end
# File lib/apipie_bindings/api.rb, line 235 def clean_cache @apidoc = nil Dir["#{@apidoc_cache_dir}/*#{cache_extension}"].each { |f| File.delete(f) } end
# File lib/apipie_bindings/api.rb, line 118 def dry_run? @dry_run ? true : false end
# File lib/apipie_bindings/api.rb, line 122 def has_resource?(name) apidoc[:docs][:resources].has_key? name end
Low level call to the API. Suitable for calling
actions not covered by apipie documentation. For all other cases use
{#call} @param [String] http_method one of get
,
put
, post
, destroy
,
patch
@param [String] path URL path that should be called
@param [Hash] params parameters to be send in the request @param [Hash]
headers extra headers to be sent with the request @param [Hash] options
options to influence the how the call is processed
* *:response* (Symbol) *:raw* - skip parsing JSON in response * *:reduce_response_log* (Bool) - do not show response content in the log. * *:with_authentication* (Bool) *true* - use rest client with/without auth configuration
@example show user data
http_call('get', '/api/users/1')
# File lib/apipie_bindings/api.rb, line 180 def http_call(http_method, path, params={}, headers={}, options={}) headers ||= { } args = [http_method] if %w[post put].include?(http_method.to_s) #If using multi-part forms, the paramaters should not be json if ((headers.include?(:content_type)) and (headers[:content_type] == "multipart/form-data")) args << params else args << params.to_json end else headers[:params] = params if params end log.info "#{http_method.to_s.upcase} #{path}" log.debug "Params: #{params.ai}" log.debug "Headers: #{headers.ai}" args << headers if headers if dry_run? empty_response = ApipieBindings::Example.new('', '', '', 200, '') ex = options[:fake_response ] || empty_response net_http_resp = Net::HTTPResponse.new(1.0, ex.status, "") response = RestClient::Response.create(ex.response, net_http_resp, args) else begin apidoc_without_auth = (path =~ /\/apidoc\//) && !@apidoc_authenticated authenticate = options[:with_authentication].nil? ? !apidoc_without_auth : options[:with_authentication] client = authenticate ? authenticated_client : unauthenticated_client response = call_client(client, path, args) update_cache(response.headers[:apipie_checksum]) rescue => e log.debug e.message + "\n" + (e.respond_to?(:response) ? process_data(e.response).ai : e.ai) raise end end result = options[:response] == :raw ? response : process_data(response) log.debug "Response: %s" % (options[:reduce_response_log] ? "Received OK" : result.ai) log.debug "Response headers: #{response.headers.ai}" if response.respond_to?(:headers) result end
# File lib/apipie_bindings/api.rb, line 105 def load_apidoc check_cache if @aggressive_cache_checking if File.exist?(apidoc_cache_file) JSON.parse(File.read(apidoc_cache_file), :symbolize_names => true) end end
# File lib/apipie_bindings/api.rb, line 273 def log @logger end
# File lib/apipie_bindings/api.rb, line 126 def resource(name) ApipieBindings::Resource.new(name, self) end
List available resources @return [Array<ApipieBindings::Resource>]
# File lib/apipie_bindings/api.rb, line 132 def resources apidoc[:docs][:resources].keys.map { |res| resource(res) } end
# File lib/apipie_bindings/api.rb, line 249 def retrieve_apidoc FileUtils.mkdir_p(@apidoc_cache_dir) unless File.exists?(@apidoc_cache_dir) if language response = retrieve_apidoc_call("/apidoc/v#{@api_version}.#{language}.json", :safe => true) language_family = language.split('_').first if !response && language_family != language response = retrieve_apidoc_call("/apidoc/v#{@api_version}.#{language_family}.json", :safe => true) end end unless response begin response = retrieve_apidoc_call("/apidoc/v#{@api_version}.json") rescue raise ApipieBindings::DocLoadingError.new( "Could not load data from #{@uri}\n" " - is your server down?\n" " - was rake apipie:cache run when using apipie cache? (typical production settings)") end end File.open(apidoc_cache_file, "w") { |f| f.write(response.body) } log.debug "New apidoc loaded from the server" load_apidoc end
# File lib/apipie_bindings/api.rb, line 227 def update_cache(cache_name) if !cache_name.nil? && (cache_name != @apidoc_cache_name) clean_cache log.debug "Cache expired. (#{@apidoc_cache_name} -> #{cache_name})" @apidoc_cache_name = cache_name end end
Private Instance Methods
# File lib/apipie_bindings/api.rb, line 283 def authenticated_client unless @client_with_auth resource_config = @resource_config.merge({ :user => @config[:username], :password => @config[:password], :oauth => @config[:oauth], }) resource_config.merge!(@credentials.to_params) if @credentials @client_with_auth = RestClient::Resource.new(@config[:uri], resource_config) end @client_with_auth end
# File lib/apipie_bindings/api.rb, line 321 def cache_extension language ? ".#{language}.json" : ".json" end
# File lib/apipie_bindings/api.rb, line 279 def call_client(client, path, args) client[path].send(*args) end
# File lib/apipie_bindings/api.rb, line 309 def find_match(fakes, resource, action, params) resource = fakes[[resource, action]] if resource if resource.has_key?(params) return resource[params] elsif resource.has_key?(:default) return resource[:default] end end return nil end
# File lib/apipie_bindings/api.rb, line 334 def process_data(response) data = begin JSON.parse((response.respond_to?(:body) ? response.body : response) || '') rescue JSON::ParserError response.respond_to?(:body) ? response.body : response || '' end return data end
# File lib/apipie_bindings/api.rb, line 300 def retrieve_apidoc_call(path, options={}) begin http_call('get', path, {}, {:accept => "application/json"}, {:response => :raw, :reduce_response_log => true}) rescue raise unless options[:safe] end end
# File lib/apipie_bindings/api.rb, line 325 def set_default_name(default='default') cache_file = Dir["#{@apidoc_cache_dir}/*#{cache_extension}"].first if cache_file File.basename(cache_file, cache_extension) else default end end
# File lib/apipie_bindings/api.rb, line 296 def unauthenticated_client @client_without_auth ||= RestClient::Resource.new(@config[:uri], @resource_config) end