class ApipieBindings::API

Attributes

apidoc_cache_name[R]
dry_run[W]
fake_responses[R]
language[R]

Public Class Methods

new(config, options={}) click to toggle source

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 [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 [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 51
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(':/', '_'))
  @apidoc_cache_name = config[:apidoc_cache_name] || set_default_name
  @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}"

  resource_config = {
    :user     => config[:username],
    :password => config[:password],
    :oauth    => config[:oauth],
    :timeout  => config[:timeout],
    :headers  => headers
  }.merge(options)

  @client = RestClient::Resource.new(config[:uri], resource_config)
  @config = config
end

Public Instance Methods

apidoc() click to toggle source
# File lib/apipie_bindings/api.rb, line 107
def apidoc
  @apidoc = @apidoc || load_apidoc || retrieve_apidoc
  @apidoc
end
apidoc_cache_file() click to toggle source
# File lib/apipie_bindings/api.rb, line 95
def apidoc_cache_file
   File.join(@apidoc_cache_dir, "#{@apidoc_cache_name}#{cache_extension}")
end
call(resource_name, action_name, params={}, headers={}, options={}) click to toggle source

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

@example show user data

call(:users, :show, :id => 1)
# File lib/apipie_bindings/api.rb, line 146
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)
  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
check_cache() click to toggle source
# File lib/apipie_bindings/api.rb, line 228
def check_cache
  begin
    response = http_call('get', "/apidoc/apipie_checksum", {}, {:accept => "application/json"})
    response['checksum']
  rescue
    nil
  end
end
clean_cache() click to toggle source
# File lib/apipie_bindings/api.rb, line 223
def clean_cache
  @apidoc = nil
  Dir["#{@apidoc_cache_dir}/*#{cache_extension}"].each { |f| File.delete(f) }
end
dry_run?() click to toggle source
# File lib/apipie_bindings/api.rb, line 112
def dry_run?
  @dry_run ? true : false
end
has_resource?(name) click to toggle source
# File lib/apipie_bindings/api.rb, line 116
def has_resource?(name)
  apidoc[:docs][:resources].has_key? name
end
http_call(http_method, path, params={}, headers={}, options={}) click to toggle source

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.

@example show user data

http_call('get', '/api/users/1')
# File lib/apipie_bindings/api.rb, line 171
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
      response = @client[path].send(*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
load_apidoc() click to toggle source
# File lib/apipie_bindings/api.rb, line 99
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
log() click to toggle source
# File lib/apipie_bindings/api.rb, line 237
def log
  @logger
end
resource(name) click to toggle source
# File lib/apipie_bindings/api.rb, line 120
def resource(name)
  ApipieBindings::Resource.new(name, self)
end
resources() click to toggle source

List available resources @return [Array<ApipieBindings::Resource>]

# File lib/apipie_bindings/api.rb, line 126
def resources
  apidoc[:docs][:resources].keys.map { |res| resource(res) }
end
update_cache(cache_name) click to toggle source
# File lib/apipie_bindings/api.rb, line 215
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

cache_extension() click to toggle source
# File lib/apipie_bindings/api.rb, line 288
def cache_extension
  language ? ".#{language}.json" : ".json"
end
find_match(fakes, resource, action, params) click to toggle source
# File lib/apipie_bindings/api.rb, line 276
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
process_data(response) click to toggle source
# File lib/apipie_bindings/api.rb, line 301
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
retrieve_apidoc() click to toggle source
# File lib/apipie_bindings/api.rb, line 243
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
retrieve_apidoc_call(path, options={}) click to toggle source
# File lib/apipie_bindings/api.rb, line 267
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
set_default_name(default='default') click to toggle source
# File lib/apipie_bindings/api.rb, line 292
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