footrest 0.1 → 0.1.2

data/footrest.gemspec

@@ -4,10 +4,12 @@ $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.authors =       ["Duane Johnson", "Nathan Mills"]
+  gem.email =         ["duane@instructure.com", "nathanm@instructure.com"]
   gem.description =   %q{Ruby interface for restful APIs}
   gem.summary =       %q{REST APIs}
+  gem.homepage =      'https://github.com/instructure/footrest'
+  gem.license =       'MIT'
 
   gem.files = %w[Rakefile footrest.gemspec]
   gem.files += Dir.glob("lib/**/*.rb")
@@ -27,4 +29,4 @@ Gem::Specification.new do |gem|
   gem.add_dependency "faraday", "~> 0.8.8"
   gem.add_dependency "faraday_middleware", "~> 0.9.0"
   gem.add_dependency "activesupport", ">= 3.0.0"
-end
+end

data/lib/faraday/response/raise_footrest_http_error.rb

@@ -1,4 +1,5 @@
 require 'faraday'
+require 'footrest/http_error'
 
 module Faraday
   class Response::RaiseFootrestHttpError < Response::Middleware

data/lib/footrest/client.rb

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

data/lib/footrest/configuration.rb

@@ -4,10 +4,16 @@ require 'active_support/configurable'
 module Footrest
   include ActiveSupport::Configurable
   config_accessor :token
-  config_accessor :domain
-  config_accessor :path_prefix
+  config_accessor :prefix
+  config_accessor :logging
 
   def configure
     yield self
   end
-end
+end
+
+Footrest.configure do |config|
+  config.token = nil
+  config.prefix = nil
+  config.logging = false
+end

data/lib/footrest/connection.rb

@@ -5,20 +5,21 @@ require 'faraday/response/raise_footrest_http_error'
 module Footrest
   module Connection
 
-    def connection
-      @options ||= {}
-      @connection ||= Faraday.new(url: @options[:domain]) do |faraday|
+    attr_reader :connection
+
+    def set_connection(config, &block)
+      @connection = Faraday.new(url: config[:prefix]) do |faraday|
         faraday.request                     :multipart
         faraday.request                     :url_encoded
-        faraday.response                    :logger if @options[:logging]
+        faraday.response                    :logger if config[: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[:authorization]   = "Bearer #{config[:token]}" if config[:token]
         faraday.headers[:user_agent]      = "Footrest"
-        @faraday_option_block.call(faraday) if @faraday_option_block
+        yield faraday if block_given?
       end
     end
 

data/lib/footrest/request.rb

@@ -1,6 +1,20 @@
 module Footrest
   module Request
 
+    def config
+      raise "Config should be overridden"
+    end
+
+    def join(*parts)
+      joined = parts.map{ |p| p.gsub(%r{^/|/$}, '') }.join('/')
+      joined = '/' + joined if parts.first[0] == '/'
+      joined
+    end
+
+    def fullpath(path)
+      config[:prefix] ? join(config[:prefix], path) : path
+    end
+
     def delete(path, options={})
       request_with_params_in_url(:delete, path, options)
     end
@@ -18,20 +32,20 @@ module Footrest
     end
 
     def request_with_params_in_url(method, path, options)
-      request(method, options) do |r|
-        r.url(File.join(path_prefix, path), options)
+      request(method) do |r|
+        r.url(fullpath(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)
+      request(method) do |r|
+        r.path = fullpath(path)
         r.body = options unless options.empty?
       end
     end
 
     # Generic request
-    def request(method, options, &block)
+    def request(method, &block)
       connection.send(method, &block).body
     end
 

data/lib/footrest/version.rb

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

data/spec/footrest/client_spec.rb

@@ -1,16 +1,43 @@
 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")
-
+    client = Footrest::Client.new(prefix: "http://domain.test")
+    expect(client.config.prefix).to eq("http://domain.test")
   end
 
   it "sets the authtoken" do
-    client = Footrest::Client.new(token:"test_token")
-    expect(client.options[:token]).to eq("test_token")
+    client = Footrest::Client.new(token: "test_token")
+    expect(client.config.token).to eq("test_token")
   end
 
+  context "Request" do
+    let(:client) { Footrest::Client.new }
+
+    it "gets" do
+      stub_request(:get, "http://domain.test/page?p=1").
+        to_return(:status => 200, :body => "", :headers => {})
+      client.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 => {})
+      client.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 => {})
+      client.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 => {})
+      client.put('http://domain.test/update_page', :username => 'aaa', :password => 'zzz')
+    end
+  end
 end

data/spec/footrest/http_error_spec.rb

@@ -2,7 +2,7 @@ require 'helper'
 
 describe Footrest::HttpError do
   before do
-    @client = Footrest::Client.new(domain: "http://domain.com", token: "test_token")
+    @client = Footrest::Client.new(prefix: "http://domain.com", token: "test_token")
   end
 
   it "raises a bad request error" do

data/spec/footrest/request_spec.rb

@@ -1,38 +1,25 @@
 require 'helper'
-require 'ostruct'
 
-class RequestHarness
-  include Footrest::Connection
-  include Footrest::Request
-end
+class RequestHarness; include Footrest::Request; end
 
 describe Footrest::Request do
-
   let(:request) { RequestHarness.new }
+  context "join" do
+    it "retains initial slash" do
+      expect(request.join('/test', 'path')).to eq('/test/path')
+    end
 
-  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 "combines multiple segments" do
+      expect(request.join('test', 'path', 'parts')).to eq('test/path/parts')
+    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 "respects http://" do
+      expect(request.join('http://', 'path')).to eq('http://path')
+    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')
+    it "keeps slashes within strings" do
+      expect(request.join('http://', 'domain', '/path/to/something')).
+        to eq('http://domain/path/to/something')
+    end
   end
 end

data/spec/helper.rb

@@ -17,19 +17,19 @@ def fixture(file)
 end
 
 def stub_get(client, url)
-  stub_request(:get, "#{client.domain}#{url}")
+  stub_request(:get, File.join(client.domain, url))
 end
 
 def stub_post(client, url)
-  stub_request(:post, "#{client.domain}#{url}")
+  stub_request(:post, File.join(client.domain, url))
 end
 
 def stub_put(client, url)
-  stub_request(:put, "#{client.domain}#{url}")
+  stub_request(:put, File.join(client.domain, url))
 end
 
 def stub_delete(client, url)
-  stub_request(:delete, "#{client.domain}#{url}")
+  stub_request(:delete, File.join(client.domain, url))
 end
 
 def json_response(file)

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: footrest
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
+- Duane Johnson
 - Nathan Mills
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-31 00:00:00.000000000 Z
+date: 2013-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -157,6 +158,7 @@ dependencies:
         version: 3.0.0
 description: Ruby interface for restful APIs
 email:
+- duane@instructure.com
 - nathanm@instructure.com
 executables: []
 extensions: []
@@ -176,8 +178,9 @@ files:
 - spec/footrest/http_error_spec.rb
 - spec/footrest/request_spec.rb
 - spec/helper.rb
-homepage: 
-licenses: []
+homepage: https://github.com/instructure/footrest
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: