footrest 0.1

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/footrest.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'footrest/version'
+
+Gem::Specification.new do |gem|
+  gem.authors =       ["Nathan Mills"]
+  gem.email =         ["nathanm@instructure.com"]
+  gem.description =   %q{Ruby interface for restful APIs}
+  gem.summary =       %q{REST APIs}
+
+  gem.files = %w[Rakefile footrest.gemspec]
+  gem.files += Dir.glob("lib/**/*.rb")
+  gem.files += Dir.glob("spec/**/*")
+  gem.test_files    = Dir.glob("spec/**/*")
+  gem.name          = "footrest"
+  gem.require_paths = ["lib"]
+  gem.version       = Footrest::VERSION
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "bundler", ">= 1.0.0"
+  gem.add_development_dependency "rspec", "~> 2.6"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "debugger"
+  gem.add_development_dependency "pry"
+
+  gem.add_dependency "faraday", "~> 0.8.8"
+  gem.add_dependency "faraday_middleware", "~> 0.9.0"
+  gem.add_dependency "activesupport", ">= 3.0.0"
+end

data/lib/faraday/response/raise_footrest_http_error.rb

@@ -0,0 +1,22 @@
+require 'faraday'
+
+module Faraday
+  class Response::RaiseFootrestHttpError < Response::Middleware
+    ERROR_MAP = {
+      400 => Footrest::HttpError::BadRequest,
+      401 => Footrest::HttpError::Unauthorized,
+      403 => Footrest::HttpError::Forbidden,
+      404 => Footrest::HttpError::NotFound,
+      405 => Footrest::HttpError::MethodNotAllowed,
+      500 => Footrest::HttpError::InternalServerError,
+      501 => Footrest::HttpError::NotImplemented,
+      502 => Footrest::HttpError::BadGateway,
+      503 => Footrest::HttpError::ServiceUnavailable
+    }
+
+    def on_complete(response)
+      key = response[:status].to_i
+      raise ERROR_MAP[key].new(response) if ERROR_MAP.has_key? key
+    end
+  end
+end

data/lib/footrest.rb

@@ -0,0 +1,6 @@
+require 'footrest/http_error'
+require 'footrest/configuration'
+require 'footrest/client'
+
+module Footrest
+end

data/lib/footrest/client.rb

@@ -0,0 +1,16 @@
+require 'footrest/connection'
+require 'footrest/request'
+
+module Footrest
+  class Client
+    attr_reader :options
+
+    include Footrest::Connection
+    include Footrest::Request
+
+    def initialize(options={}, &block)
+      @options = Footrest.config.merge(options)
+      @faraday_option_block = block
+    end
+  end
+end

data/lib/footrest/configuration.rb

@@ -0,0 +1,13 @@
+require 'faraday'
+require 'active_support/configurable'
+
+module Footrest
+  include ActiveSupport::Configurable
+  config_accessor :token
+  config_accessor :domain
+  config_accessor :path_prefix
+
+  def configure
+    yield self
+  end
+end

data/lib/footrest/connection.rb

@@ -0,0 +1,26 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday/response/raise_footrest_http_error'
+
+module Footrest
+  module Connection
+
+    def connection
+      @options ||= {}
+      @connection ||= Faraday.new(url: @options[:domain]) do |faraday|
+        faraday.request                     :multipart
+        faraday.request                     :url_encoded
+        faraday.response                    :logger if @options[:logging]
+        faraday.adapter                     Faraday.default_adapter
+        faraday.use                         FaradayMiddleware::FollowRedirects
+        faraday.use                         FaradayMiddleware::ParseJson, :content_type => /\bjson$/
+        faraday.use                         Faraday::Response::RaiseFootrestHttpError
+        faraday.headers[:accept]          = "application/json"
+        faraday.headers[:authorization]   = "Bearer #{@options[:token]}"
+        faraday.headers[:user_agent]      = "Footrest"
+        @faraday_option_block.call(faraday) if @faraday_option_block
+      end
+    end
+
+  end
+end

data/lib/footrest/http_error.rb

@@ -0,0 +1,26 @@
+module Footrest
+  module HttpError
+    class ErrorBase < StandardError
+
+      attr_reader :status, :body, :method, :response
+
+      def initialize(response=nil)
+        @response = response
+        @status = @response[:status]
+        @body = @response[:body]
+        @method = @response[:method]
+
+        super("HTTP ERROR: #{@status}")
+      end
+    end
+
+    %w(
+      BadRequest Unauthorized Forbidden
+      NotFound MethodNotAllowed InternalServerError
+      NotImplemented BadGateway ServiceUnavailable
+    ).each do |error|
+      const_set error.to_sym, Class.new(ErrorBase)
+    end
+
+  end
+end

data/lib/footrest/request.rb

@@ -0,0 +1,39 @@
+module Footrest
+  module Request
+
+    def delete(path, options={})
+      request_with_params_in_url(:delete, path, options)
+    end
+
+    def get(path, options={})
+      request_with_params_in_url(:get, path, options)
+    end
+
+    def post(path, options={})
+      request_with_params_in_body(:post, path, options)
+    end
+
+    def put(path, options={})
+      request_with_params_in_body(:put, path, options)
+    end
+
+    def request_with_params_in_url(method, path, options)
+      request(method, options) do |r|
+        r.url(File.join(path_prefix, path), options)
+      end
+    end
+
+    def request_with_params_in_body(method, path, options)
+      request(method, options) do |r|
+        r.path = File.join(path_prefix, path)
+        r.body = options unless options.empty?
+      end
+    end
+
+    # Generic request
+    def request(method, options, &block)
+      connection.send(method, &block).body
+    end
+
+  end
+end

data/lib/footrest/version.rb

@@ -0,0 +1,3 @@
+module Footrest
+  VERSION = '0.1' unless defined?(Footrest::VERSION)
+end

data/spec/footrest/client_spec.rb

@@ -0,0 +1,16 @@
+require 'helper'
+
+describe Footrest::Client do
+
+  it "sets the domain" do
+    client = Footrest::Client.new(domain:"http://domain.com")
+    expect(client.options[:domain]).to eq("http://domain.com")
+
+  end
+
+  it "sets the authtoken" do
+    client = Footrest::Client.new(token:"test_token")
+    expect(client.options[:token]).to eq("test_token")
+  end
+
+end

data/spec/footrest/http_error_spec.rb

@@ -0,0 +1,99 @@
+require 'helper'
+
+describe Footrest::HttpError do
+  before do
+    @client = Footrest::Client.new(domain: "http://domain.com", token: "test_token")
+  end
+
+  it "raises a bad request error" do
+    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 400)
+
+    begin
+      @client.get "/api/v1/not_found"
+    rescue Footrest::HttpError::BadRequest => e
+      expect(e.status).to eq(400)
+    end
+  end
+
+  it "raises a unauthorized error" do
+    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 401)
+
+    begin
+      @client.get "/api/v1/not_found"
+    rescue Footrest::HttpError::Unauthorized => e
+      expect(e.status).to eq(401)
+    end
+  end
+
+  it "raises a forbidden error" do
+    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 403)
+
+    begin
+      @client.get "/api/v1/not_found"
+    rescue Footrest::HttpError::Forbidden => e
+      expect(e.status).to eq(403)
+    end
+  end
+
+
+  it "raises a not found error" do
+    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 404)
+
+    begin
+      @client.get "/api/v1/not_found"
+    rescue Footrest::HttpError::NotFound => e
+      expect(e.status).to eq(404)
+    end
+  end
+
+  it "raises a method not found allowed" do
+    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 405)
+
+    begin
+      @client.get "/api/v1/not_found"
+    rescue Footrest::HttpError::MethodNotAllowed => e
+      expect(e.status).to eq(405)
+    end
+  end
+
+  it "raises a internal server error" do
+    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 500)
+
+    begin
+      @client.get "/api/v1/not_found"
+    rescue Footrest::HttpError::InternalServerError => e
+      expect(e.status).to eq(500)
+    end
+  end
+
+  it "raises a not implemented error" do
+    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 501)
+
+    begin
+      @client.get "/api/v1/not_found"
+    rescue Footrest::HttpError::NotImplemented => e
+      expect(e.status).to eq(501)
+    end
+  end
+
+  it "raises a bad gateway error" do
+    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 502)
+
+    begin
+      @client.get "/api/v1/not_found"
+    rescue Footrest::HttpError::BadGateway => e
+      expect(e.status).to eq(502)
+    end
+  end
+
+  it "raises a Server Unavailible error" do
+    stub_request(:get, "http://domain.com/api/v1/not_found").to_return(:status => 503)
+
+    begin
+      @client.get "/api/v1/not_found"
+    rescue Footrest::HttpError::ServiceUnavailable => e
+      expect(e.status).to eq(503)
+    end
+  end
+
+end

data/spec/footrest/request_spec.rb

@@ -0,0 +1,38 @@
+require 'helper'
+require 'ostruct'
+
+class RequestHarness
+  include Footrest::Connection
+  include Footrest::Request
+end
+
+describe Footrest::Request do
+
+  let(:request) { RequestHarness.new }
+
+  it "gets" do
+    stub_request(:get, "http://domain.test/page?p=1").
+      to_return(:status => 200, :body => "", :headers => {})
+    request.get('http://domain.test/page', :p => 1)
+  end
+
+  it "deletes" do
+    stub_request(:get, "http://domain.test/page?auth=xyz").
+      to_return(:status => 200, :body => "", :headers => {})
+    request.get('http://domain.test/page', :auth => 'xyz')
+  end
+
+  it "posts" do
+    stub_request(:post, "http://domain.test/new_page").
+      with(:body => {"password"=>"xyz", "username"=>"abc"}).
+      to_return(:status => 200, :body => "", :headers => {})
+    request.post('http://domain.test/new_page', :username => 'abc', :password => 'xyz')
+  end
+
+  it "puts" do
+    stub_request(:put, "http://domain.test/update_page").
+      with(:body => {"password"=>"zzz", "username"=>"aaa"}).
+      to_return(:status => 200, :body => "", :headers => {})
+    request.put('http://domain.test/update_page', :username => 'aaa', :password => 'zzz')
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,43 @@
+
+require 'footrest'
+require 'rspec'
+require 'webmock/rspec'
+require 'json'
+
+WebMock.disable_net_connect!
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+def fixture(file)
+  File.new(File.join(File.expand_path("../fixtures", __FILE__), file))
+end
+
+def stub_get(client, url)
+  stub_request(:get, "#{client.domain}#{url}")
+end
+
+def stub_post(client, url)
+  stub_request(:post, "#{client.domain}#{url}")
+end
+
+def stub_put(client, url)
+  stub_request(:put, "#{client.domain}#{url}")
+end
+
+def stub_delete(client, url)
+  stub_request(:delete, "#{client.domain}#{url}")
+end
+
+def json_response(file)
+  {
+    :body => fixture(file),
+    :headers => {
+      :content_type => 'application/json; charset=utf-8'
+    }
+  }
+end
+

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: footrest
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Nathan Mills
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Ruby interface for restful APIs
+email:
+- nathanm@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- footrest.gemspec
+- lib/faraday/response/raise_footrest_http_error.rb
+- lib/footrest/client.rb
+- lib/footrest/configuration.rb
+- lib/footrest/connection.rb
+- lib/footrest/http_error.rb
+- lib/footrest/request.rb
+- lib/footrest/version.rb
+- lib/footrest.rb
+- spec/footrest/client_spec.rb
+- spec/footrest/http_error_spec.rb
+- spec/footrest/request_spec.rb
+- spec/helper.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: REST APIs
+test_files:
+- spec/footrest/client_spec.rb
+- spec/footrest/http_error_spec.rb
+- spec/footrest/request_spec.rb
+- spec/helper.rb
+has_rdoc: