apii 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce6f4fc3f84231b335c3af2e506282b8bd721f5e
+  data.tar.gz: 7e0db9b90e07bb5e0a7df48c404775d39a7a7884
+SHA512:
+  metadata.gz: e7b547658b29e81fec0cc00db093677d7962fa127457db37e98f45f0503da3814b667ea130c40358873b6c22fcdb28fac88f00e4d21d2ef177516b5a637dbe84
+  data.tar.gz: 6801bb1509b05649f9fe668820adbad05a4ceee77526191a475aed4e0805bad0cf77e8c0190864709e6a3cfa788ab442e669a6bf40e6888e31e8b674be3ebd15

data/.gitignore

@@ -0,0 +1,10 @@
+pkg/*
+doc/*
+rdoc/*
+*.gem
+.bundle
+Gemfile.lock
+.gh_pages
+coverage/
+*#*
+*~

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,36 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-06-01 12:18:38 +0200 using RuboCop version 0.22.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+ClassLength:
+  Max: 142
+
+# Offense count: 1
+CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 5
+Documentation:
+  Enabled: false
+
+# Offense count: 53
+LineLength:
+  Max: 704
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+MethodLength:
+  Max: 19
+
+# Offense count: 2
+MultilineBlockChain:
+  Enabled: false
+
+# Offense count: 5
+RescueModifier:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+
+notifications:
+  email: false
+
+rvm:
+  - 2.0
+  - 2.1
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+before_install:
+  - gem install fakeweb
+
+script:
+  - "bundle exec rake spec"

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+group 'gem' do
+  guard 'rspec', :cmd => "bundle exec rspec", :all_on_start => false, :all_after_pass => false, :failed_mode => :focus do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/api/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  end
+end

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2015 Paul Bonaud
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,69 @@
+# API wrapper
+
+## Description
+
+This gem is a generic client for HTTP based APIs.
+
+## Installation
+
+You can use this gem in your project by specifying it in your `Gemfile`:
+
+```
+gem "api"
+```
+
+or simply install it via the CLI:
+
+```
+gem install api
+```
+
+## Usage
+
+Create your own API client my inheriting from the Api::Client class and defining all mandatory defaults attributes in a Namespace::Default module as such:
+
+```
+module ExampleApi
+  class Client < Api::Client
+    # Include mandatory modules
+    include Api::Configurable
+    include Api::Connection
+    include Api::Authentication
+  end
+
+  module Default
+    API_ENDPOINT = "http://example.org".freeze
+
+    class << self
+
+      # Include mandatory module
+      include Api::DefaultOptions
+
+      def api_endpoint
+        API_ENDPOINT
+      end
+
+    end
+ end
+end
+```
+
+Now get started requesting stuff from your api:
+
+```
+c = ExampleApi::Client.new
+ => ...
+
+c.root
+ => "<!doctype html>\n..."
+
+c.last_response.data == c.get("/")
+ => true
+
+c.get("/boom")
+ raises Api::NotFound: #<Sawyer::Response:0x000000029bb908>
+```
+
+## License
+
+Code licensed under [MIT-LICENSE](https://github.com/paulrbr/api/blob/master/MIT-LICENSE)

data/Rakefile

@@ -0,0 +1,25 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+require 'api/version'
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Api #{Api::VERSION} documentation"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << '--webcvs=http://github.com/paulrbr/api/tree/master/'
+end
+
+require 'gokdok'
+Gokdok::Dokker.new do |gd|
+  gd.repo_url = 'git@github.com:paulrbr/api.git'
+  gd.doc_home = 'rdoc'
+  gd.remote_path = '.'
+end

data/api.gemspec

@@ -0,0 +1,37 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'api/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'apii'
+  s.licenses    = ['MIT']
+  s.version     = Api::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Paul Bonaud']
+  s.email       = ['paul+gh@bonaud.fr']
+  s.homepage    = 'http://github.com/paulrbr/api'
+  s.summary     = %q(Easily build your API client.)
+  s.description = %q(This gem provides a generic API client to interact with any HTTP hypermedia APIs.)
+
+  s.rubyforge_project = 'api'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'hashie'
+  s.add_dependency 'faraday'
+  s.add_dependency 'sawyer'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'multi_json'
+  s.add_development_dependency 'gokdok'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'rdoc'
+  s.add_development_dependency 'fakeweb'
+  s.add_development_dependency 'coveralls'
+end

data/lib/api.rb

@@ -0,0 +1,45 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__)) unless
+  $LOAD_PATH.include?(File.dirname(__FILE__)) || $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'json'
+
+require 'api/errors'
+require 'api/default'
+require 'api/configurable'
+require 'api/client'
+require 'api/version'
+
+
+# Ruby toolkit to build API clients
+module Api
+
+  # class << self
+  #   include Api::Configurable
+
+  #   # API client based on configured options {Configurable}
+  #   #
+  #   # @return [Api::Client] API wrapper
+  #   def client
+  #     return @client if defined?(@client) && @client.same_options?(options)
+  #     @client = Api::Client.new(options)
+  #   end
+
+  #   private
+
+  #   def respond_to_missing?(method_name, include_private=false)
+  #     client.respond_to?(method_name, include_private)
+  #   end
+
+  #   def method_missing(method_name, *args, &block)
+  #     if client.respond_to?(method_name)
+  #       return client.send(method_name, *args, &block)
+  #     end
+
+  #     super
+  #   end
+
+  # end
+end
+
+# Api.reset!

data/lib/api/authentication.rb

@@ -0,0 +1,24 @@
+module Api
+
+  # Authentication methods for {Api::Client}
+  module Authentication
+
+    # Indicates if the client was supplied an
+    # access token
+    #
+    # @return [Boolean]
+    def token_authenticated?
+      !@access_token.nil? && !@access_token.empty?
+    end
+
+    # Indicates if the client was supplied basic auth
+    # credentials
+    #
+    # @return [Boolean]
+    def basic_authenticated?
+      !@basic_login.nil? && !@basic_login.empty? &&
+        !@basic_password.nil? && !@basic_password.empty?
+    end
+
+  end
+end

data/lib/api/client.rb

@@ -0,0 +1,38 @@
+require 'api/authentication'
+require 'api/configurable'
+require 'api/connection'
+
+module Api
+
+  # Client for an API
+  class Client
+
+    include Api::Authentication
+    include Api::Configurable
+    include Api::Connection
+
+     # Header keys that can be passed in options hash to {#get}
+    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+
+    def initialize(options = {})
+      reset!(options)
+    end
+
+    # Text representation of the client, masking tokens and passwords
+    #
+    # @return [String]
+    def inspect
+      inspected = super
+
+      # mask password
+      inspected = inspected.gsub! @basic_password, "*******" if @basic_password
+      # Only show last 4 of token, secret
+      if @access_token
+        inspected = inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}"
+      end
+
+      inspected
+    end
+
+  end
+end

data/lib/api/configurable.rb

@@ -0,0 +1,110 @@
+module Api
+
+  # Configuration options for {Client}, defaulting to values
+  # in {Default}
+  module Configurable
+    # @!attribute [w] access_token
+    #   @return [String] access token for authentication
+    # @!attribute [w] access_token_prefix
+    #   @return [String] access token prefix used before token in Authorization header
+    # @!attribute api_endpoint
+    #   @return [String] Base URL for API requests.
+    # @!attribute api_version
+    #   @return [String] Version of the api. default: v1
+    # @!attribute [w] basic_login
+    #   @return [String] login for basic authentication
+    # @!attribute [w] basic_password
+    #   @return [String] password for basic authentication
+    # @!attribute connection_options
+    #   @see https://github.com/lostisland/faraday
+    #   @return [Hash] Configure connection options for Faraday
+    # @!attribute sawyer_options
+    #   @see https://github.com/lostisland/sawyer
+    #   @return [Hash] Configure sawyer options
+    # @!attribute user_agent
+    #   @return [String] Configure User-Agent header for requests.
+    # @!attribute auto_paginate
+    #   @return [Boolean] Auto fetch next page of results until rate limit reached. Will only work with an Hypermedia API.
+    # @!attribute per_page
+    #   @return [String] Configure page size for paginated results. API default: 30
+
+    attr_accessor :access_token, :access_token_prefix, :basic_login, :basic_password, :connection_options, :sawyer_options, :user_agent, :auto_paginate, :per_page
+    attr_writer :api_endpoint, :api_version
+
+    class << self
+
+      # List of configurable keys for {Api::Client}
+      # @return [Array] of option keys
+      def keys
+        @keys ||= [
+          :access_token,
+          :access_token_prefix,
+          :api_endpoint,
+          :api_version,
+          :auto_paginate,
+          :basic_login,
+          :basic_password,
+          :connection_options,
+          :sawyer_options,
+          :per_page,
+          :user_agent,
+        ]
+      end
+    end
+
+    # Set configuration options using a block
+    def configure
+      yield self
+    end
+
+    # Compares client options to a Hash of requested options
+    #
+    # @param opts [Hash] Options to compare with current client options
+    # @return [Boolean]
+    def same_options?(opts)
+      opts.hash == options.hash
+    end
+
+    # Reset configuration options to default values
+    def reset!(options = {})
+      default_class = module_defaults || class_defaults
+      Api::Configurable.keys.each do |key|
+        value = options[key] || default_class.options[key] || Api::Default.options[key]
+        instance_variable_set(:"@#{key}", value)
+      end
+      self
+    end
+
+    def api_endpoint
+      File.join(@api_endpoint, "")
+    end
+
+    def api_version
+      if @api_version.nil?
+        ""
+      else
+        File.join(@api_version, "")
+      end
+    end
+
+    private
+
+    def options
+      Hash[Api::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+    end
+
+    def module_defaults
+      try_defaults("#{self}::Default")
+    end
+
+    def class_defaults
+      try_defaults("#{self.class.to_s.split("::").first}::Default")
+    end
+
+    def try_defaults(object_name)
+      Object.const_get(object_name)
+    rescue NameError => _e
+      nil
+    end
+  end
+end

data/lib/api/connection.rb

@@ -0,0 +1,186 @@
+require 'api/response/raise_error'
+require 'sawyer'
+
+module Api
+
+  # Network layer for API clients.
+  module Connection
+
+     # Header keys that can be passed in options hash to {#get},{#head}
+    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+
+    # Make a HTTP GET request
+    #
+    # @param url [String] The path, relative to {#api_endpoint/#api_version}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def get(url, options = {})
+      request :get, url, parse_query_and_convenience_headers(options)
+    end
+
+    # Make a HTTP POST request
+    #
+    # @param url [String] The path, relative to {#api_endpoint/#api_version}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def post(url, options = {})
+      request :post, url, options
+    end
+
+    # Make a HTTP PUT request
+    #
+    # @param url [String] The path, relative to {#api_endpoint/#api_version}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def put(url, options = {})
+      request :put, url, options
+    end
+
+    # Make a HTTP PATCH request
+    #
+    # @param url [String] The path, relative to {#api_endpoint/#api_version}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def patch(url, options = {})
+      request :patch, url, options
+    end
+
+    # Make a HTTP DELETE request
+    #
+    # @param url [String] The path, relative to {#api_endpoint/#api_version}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def delete(url, options = {})
+      request :delete, url, options
+    end
+
+    # Make a HTTP HEAD request
+    #
+    # @param url [String] The path, relative to {#api_endpoint/#api_version}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def head(url, options = {})
+      request :head, url, parse_query_and_convenience_headers(options)
+    end
+
+    # Make one or more HTTP GET requests, optionally fetching
+    # the next page of results from URL in Link response header based
+    # on value in {#auto_paginate}.
+    #
+    # @param url [String] The path, relative to {#api_endpoint/#api_version}
+    # @param options [Hash] Query and header params for request
+    # @param block [Block] Block to perform the data concatination of the
+    #   multiple requests. The block is called with two parameters, the first
+    #   contains the contents of the requests so far and the second parameter
+    #   contains the latest response.
+    # @return [Sawyer::Resource]
+    def paginate(url, options = {}, &block)
+      opts = parse_query_and_convenience_headers(options.dup)
+      if @auto_paginate || @per_page
+        opts[:query][:per_page] ||=  @per_page || (@auto_paginate ? 100 : nil)
+      end
+
+      data = request(:get, url, opts.dup)
+
+      if @auto_paginate
+        while @last_response.rels[:next] && rate_limit.remaining > 0
+          @last_response = @last_response.rels[:next].get(:headers => opts[:headers])
+          if block_given?
+            yield(data, @last_response)
+          else
+            data.concat(@last_response.data) if @last_response.data.is_a?(Array)
+          end
+        end
+
+      end
+
+      data
+    end
+
+    # Hypermedia agent for the API
+    #
+    # @return [Sawyer::Agent]
+    def agent
+      @agent ||= Sawyer::Agent.new(endpoint, sawyer_options) do |http|
+        http.headers[:content_type] = "application/json"
+        http.headers[:user_agent] = user_agent
+        if basic_authenticated?
+          http.basic_auth(@basic_login, @basic_password)
+        elsif token_authenticated?
+          http.authorization @access_token_prefix, @access_token
+        end
+      end
+    end
+
+    # Fetch the root resource for the API
+    #
+    # @return [Sawyer::Resource]
+    def root
+      get "/"
+    end
+
+    # Response for last HTTP request
+    #
+    # @return [Sawyer::Response]
+    def last_response
+      @last_response if defined? @last_response
+    end
+
+    protected
+
+    def endpoint
+      api_endpoint
+    end
+
+    private
+
+    def reset_agent
+      @agent = nil
+    end
+
+    def request(method, path, data, options = {})
+      if data.is_a?(Hash)
+        options[:query]   = data.delete(:query) || {}
+        options[:headers] = data.delete(:headers) || {}
+        if accept = data.delete(:accept)
+          options[:headers][:accept] = accept
+        end
+      end
+
+      if api_version
+        path = File.join(api_version, path)
+      end
+
+      @last_response = response = agent.call(method, URI::Parser.new.escape(path.to_s), data, options)
+      raise_on_unsuccessful_status(response)
+      response.data
+    end
+
+    def raise_on_unsuccessful_status(response)
+      Response::RaiseError.try(response)
+    end
+
+    def sawyer_options
+      opts = @sawyer_options
+      conn_opts = @connection_options
+      opts[:faraday] = Faraday.new(conn_opts)
+
+      opts
+    end
+
+    def parse_query_and_convenience_headers(options)
+      headers = options.delete(:headers) { Hash.new }
+      CONVENIENCE_HEADERS.each do |h|
+        if header = options.delete(h)
+          headers[h] = header
+        end
+      end
+      query = options.delete(:query)
+      opts = {:query => options}
+      opts[:query].merge!(query) if query && query.is_a?(Hash)
+      opts[:headers] = headers unless headers.empty?
+
+      opts
+    end
+  end
+end

data/lib/api/default.rb

@@ -0,0 +1,90 @@
+require "api/default_options"
+
+module Api
+
+  # Default configuration options for {Client}
+  module Default
+
+    USER_AGENT = "Ruby toolkit API gem"
+
+    class << self
+
+      include Api::DefaultOptions
+
+      # Default access token from ENV
+      # @return [String]
+      def access_token
+        ENV['API_ACCESS_TOKEN']
+      end
+
+      # Default access token prefix
+      # @return [String]
+      def access_token_prefix
+        "token"
+      end
+
+     # Default API endpoint from ENV
+      # @return [String]
+      def api_endpoint
+        ENV['API_ENDPOINT']
+      end
+
+      # Default API version from ENV
+      # @return [String]
+      def api_version
+        ENV['API_VERSION']
+      end
+
+      # Default pagination preference from ENV
+      # @return [String]
+      def auto_paginate
+        ENV['API_AUTO_PAGINATE']
+      end
+
+      # Default login for basic auth from ENV
+      # @return [String]
+      def basic_login
+        ENV['API_LOGIN']
+      end
+
+      # Default password for basic auth from ENV
+      # @return [String]
+      def basic_password
+        ENV['API_PASSWORD']
+      end
+
+      # Default options for Faraday::Connection
+      # @return [Hash]
+      def connection_options
+        {
+          :headers => {
+            :user_agent => user_agent
+          }
+        }
+      end
+
+      # Default options for Sawyer::Agent
+      # @return [Hash]
+      def sawyer_options
+        {
+          :links_parser => Sawyer::LinkParsers::Simple.new
+        }
+      end
+
+      # Default pagination page size from ENV
+      # @return [Fixnum] Page size
+      def per_page
+        page_size = ENV['API_PER_PAGE']
+
+        page_size.to_i if page_size
+      end
+
+      # Default User-Agent header string from ENV or {USER_AGENT}
+      # @return [String]
+      def user_agent
+        ENV['API_USER_AGENT'] || USER_AGENT
+      end
+
+    end
+  end
+end

data/lib/api/default_options.rb

@@ -0,0 +1,14 @@
+module Api
+
+  # Module to include in Default modules of your API toolkit
+  module DefaultOptions
+
+    # Configuration options
+    # @return [Hash]
+    def options
+      Hash[Api::Configurable.keys.select { |key| respond_to?(key) }
+               .map { |key| [key, send(key)] }]
+    end
+
+  end
+end

data/lib/api/errors.rb

@@ -0,0 +1,60 @@
+module Api
+
+  # All errors from this gem will inherit from this one.
+  class Error < StandardError
+    # Returns the appropriate Api::Error subclass based
+    # on status and response message
+    #
+    # @param [Hash] response HTTP response
+    # @return [Api::Error]
+    def self.from_response(response)
+      status = if response.respond_to?(:[])
+                 response[:status].to_i
+               else
+                 response.status
+               end
+
+      if klass =  case status
+                  when 400      then Api::BadRequest
+                  when 401      then Api::Unauthorized
+                  when 403      then Api::Unauthorized
+                  when 404      then Api::NotFound
+                  when 405      then Api::MethodNotAllowed
+                  when 406      then Api::NotAcceptable
+                  when 409      then Api::Conflict
+                  when 415      then Api::UnsupportedMediaType
+                  when 422      then Api::UnprocessableEntity
+                  when 400..499 then Api::ClientError
+                  when 500      then Api::InternalServerError
+                  when 501      then Api::NotImplemented
+                  when 502      then Api::BadGateway
+                  when 503      then Api::ServiceUnavailable
+                  when 500..599 then Api::ServerError
+                  end
+        klass.new(response)
+      end
+    end
+
+    def initialize(response=nil)
+      @response = response
+      super
+    end
+  end
+
+  class ClientError < Error; end
+  class BadRequest < ClientError; end
+  class Unauthorized < ClientError; end
+  class Unauthorized < ClientError; end
+  class NotFound < ClientError; end
+  class MethodNotAllowed < ClientError; end
+  class NotAcceptable < ClientError; end
+  class Conflict < ClientError; end
+  class UnsupportedMediaType < ClientError; end
+  class UnprocessableEntity < ClientError; end
+  class InternalServerError < ClientError; end
+  class NotImplemented < ClientError; end
+  class BadGateway < ClientError; end
+  class ServiceUnavailable < ClientError; end
+  class ServerError < ClientError; end
+
+end

data/lib/api/response/raise_error.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+require 'api/errors'
+
+module Api
+  # Faraday response middleware
+  module Response
+
+    # This class raises an Api-flavored exception based
+    # HTTP status codes returned by the API
+    class RaiseError < Faraday::Response::Middleware
+
+      class << self
+        def try(response)
+          @middleware ||= RaiseError.new
+          @middleware.send(:on_complete, response)
+        end
+      end
+
+      private
+
+      def on_complete(response)
+        if error = Api::Error.from_response(response)
+          raise error
+        end
+      end
+    end
+  end
+end

data/lib/api/version.rb

@@ -0,0 +1,3 @@
+module Api
+  VERSION = '0.0.4'
+end

data/spec/client_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+describe Api::Client do
+  before do
+    VCR.turn_off!
+    allow(Sawyer::LinkParsers::Simple).to receive(:new).and_return(Sawyer::LinkParsers::Simple)
+    @client = Api::Client.new
+  end
+
+  it "sets defaults" do
+    Api::Configurable.keys.each do |key|
+      expect(@client.instance_variable_get(:"@#{key}")).to eq(Api::Default.send(key))
+    end
+  end
+
+  describe ".configure" do
+    Api::Configurable.keys.each do |key|
+      it "sets the #{key.to_s.gsub('_', ' ')}" do
+        @client.configure do |config|
+          config.send("#{key}=", key)
+        end
+        expect(@client.instance_variable_get(:"@#{key}")).to eq(key)
+      end
+    end
+  end
+
+  describe ".inspect" do
+    before do
+      @client = Api::Client.new(access_token: "token123", basic_password: "mysecret")
+    end
+
+    it "masks access token" do
+      expect(@client.inspect).to_not match("token123")
+    end
+
+    it "masks basic auth password" do
+      expect(@client.inspect).to_not match("mysecret")
+    end
+  end
+
+  describe "A client implementation" do
+    before do
+      module MyApi
+        class Client < Api::Client
+        end
+
+        module Default
+          class << self
+            include Api::DefaultOptions
+
+            def api_endpoint
+              "http://example.org"
+            end
+            def method_missing(_method)
+              ""
+            end
+          end
+        end
+      end
+
+      @client = MyApi::Client.new
+    end
+
+    describe ".root" do
+      it "gets the root of the api" do
+        stub_get('/').to_return(:status => 200)
+        expect { @client.root }.to_not raise_error
+        expect(@client.last_response.data).to eq('')
+      end
+    end
+
+    context "with no authentication" do
+      it "does requests with no authorization header" do
+        stub_head('/hello').to_return(:status => 200)
+        expect { @client.head('/hello') }.to_not raise_error
+        expect(@client.last_response.headers).to eq({})
+      end
+    end
+
+    context "with token authentication" do
+      before do
+        @client.configure do |c|
+          c.access_token = "token123"
+        end
+      end
+
+      it "does requests with a token authorization header" do
+        stub_post('/hello').with(:headers => { 'Authorization' => 'token token123' }).to_return(:status => 200)
+        expect { @client.post('/hello') }.to_not raise_error
+        expect(@client.last_response.data).to eq('')
+      end
+    end
+
+     context "with basic authentication" do
+      before do
+        @client.configure do |c|
+          c.basic_login = "login"
+          c.basic_password = "password"
+        end
+      end
+
+      it "does requests with basic auth method" do
+        stub_put('/hello', basic_login: "login", basic_password: "password").to_return(:status => 200)
+        expect { @client.put('/hello') }.to_not raise_error
+        expect(@client.last_response.data).to eq('')
+      end
+    end
+
+    context "error handling" do
+      it "raises on 404" do
+        stub_delete('/booya').to_return(:status => 404)
+        expect { @client.delete('/booya') }.to raise_error Api::NotFound
+      end
+
+      it "raises on 401" do
+        stub_patch('/forbidden').to_return(:status => 401)
+        expect { @client.patch('/forbidden') }.to raise_error Api::Unauthorized
+      end
+
+      it "raises on 500" do
+        stub_get('/boom').to_return(:status => 500)
+        expect { @client.get('/boom') }.to raise_error Api::InternalServerError
+      end
+
+      it "raises for all supported codes" do
+        %w(400 403 405 406 409 415 422 499 501 502 503 504).each do |code|
+          stub_get('/error').to_return(:status => code.to_i)
+          expect { @client.get('/error') }.to raise_error
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+require 'json'
+require 'api'
+require 'rspec'
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!(:allow => 'coveralls.io')
+
+require 'vcr'
+VCR.configure do |c|
+  c.hook_into :webmock
+end
+
+def api_url(url, opts = {})
+  return url if url =~ /^http/
+
+  basic_auth = opts[:basic_login] ? "#{opts[:basic_login]}:#{opts[:basic_password]}@" : ""
+  url = File.join("http://#{basic_auth}example.org", url)
+  uri = Addressable::URI.parse(url)
+
+  uri.to_s
+end
+
+def token_client
+  Api::Client.new(:access_token => test_token)
+end
+
+def test_token
+  ENV.fetch 'API_TEST_TOKEN', 'x' * 20
+end
+
+def stub_delete(url, opts = {})
+  stub_request(:delete, api_url(url, opts))
+end
+
+def stub_get(url, opts = {})
+  stub_request(:get, api_url(url, opts))
+end
+
+def stub_head(url, opts = {})
+  stub_request(:head, api_url(url, opts))
+end
+
+def stub_patch(url, opts = {})
+  stub_request(:patch, api_url(url, opts))
+end
+
+def stub_post(url, opts = {})
+  stub_request(:post, api_url(url, opts))
+end
+
+def stub_put(url, opts = {})
+  stub_request(:put, api_url(url, opts))
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+
+def json_response(file)
+  {
+    :body => fixture(file),
+    :headers => {
+      :content_type => 'application/json; charset=utf-8'
+    }
+  }
+end

metadata

@@ -0,0 +1,264 @@
+--- !ruby/object:Gem::Specification
+name: apii
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Paul Bonaud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sawyer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gokdok
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides a generic API client to interact with any HTTP hypermedia
+  APIs.
+email:
+- paul+gh@bonaud.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- api.gemspec
+- lib/api.rb
+- lib/api/authentication.rb
+- lib/api/client.rb
+- lib/api/configurable.rb
+- lib/api/connection.rb
+- lib/api/default.rb
+- lib/api/default_options.rb
+- lib/api/errors.rb
+- lib/api/response/raise_error.rb
+- lib/api/version.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/paulrbr/api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: api
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Easily build your API client.
+test_files: []