weary 1.0.1 → 1.1.0

data/lib/weary/request.rb

@@ -2,6 +2,7 @@ require 'addressable/uri'
 require 'future'
 require 'rack'
 
+require 'weary/requestable'
 require 'weary/env'
 require 'weary/adapter'
 
@@ -15,12 +16,13 @@ module Weary
   # Rack application. Because the Request performs so much manipulation on
   # the Rack env, you can attach middleware to it to act on its mutated env.
   class Request
+    include Weary::Requestable
+
     attr_reader :uri
 
     def initialize(url, method='GET')
       self.uri = url
       self.method = method
-      @middlewares = []
       yield self if block_given?
     end
 
@@ -38,7 +40,7 @@ module Weary
     # Returns an Array of three items; a Rack tuple.
     def call(environment)
       app = adapter.new
-      middlewares = @middlewares
+      middlewares = @middlewares || []
       stack = Rack::Builder.new do
         middlewares.each do |middleware|
           klass, *args = middleware
@@ -64,20 +66,11 @@ module Weary
       @method = verb.to_s.upcase
     end
 
-    def headers(hash=nil)
-      @headers = hash unless hash.nil?
-      @headers ||= {}
-    end
-
-    def user_agent(agent)
-      headers.update 'User-Agent' => agent
-    end
-
     def params(parameters=nil)
       if !parameters.nil?
         if ["POST", "PUT"].include? method
           @body = query_params_from_hash(parameters)
-          body StringIO.new(@body)
+          body stringio_encode(@body)
           use Weary::Middleware::ContentType
         else
           uri.query_values = parameters
@@ -89,18 +82,13 @@ module Weary
 
     def json(parameters)
       json = MultiJson.encode(parameters)
-      body StringIO.new(json)
+      body stringio_encode(json)
       json
     end
 
     def body(io=nil)
       @attachment = io unless io.nil?
-      @attachment ||= StringIO.new('')
-    end
-
-    def adapter(connection=nil)
-      @connection = connection unless connection.nil?
-      @connection ||= Weary::Adapter::NetHttp
+      @attachment ||= stringio_encode("")
     end
 
     def basic_auth(*credentials)
@@ -133,10 +121,6 @@ module Weary
       end
     end
 
-    def use(middleware, *args, &block)
-      @middlewares << [middleware, args.compact, block]
-    end
-
     private
 
     def query_params_from_hash(hash)
@@ -153,5 +137,12 @@ module Weary
         'rack.run_once'     => false }
     end
 
+    def stringio_encode(content)
+      io = StringIO.new(content)
+      io.binmode
+      io.set_encoding "ASCII-8BIT" if io.respond_to? :set_encoding
+      io
+    end
+
   end
 end

data/lib/weary/requestable.rb

@@ -0,0 +1,69 @@
+module Weary
+  module Requestable
+
+    # An accessor to set a Weary::Adapter to use to forward the connection.
+    # When a request is made, it will be passed along to this adapter to
+    # get the eventual Response. Defaults to Weary::Adapter::NetHttp.
+    #
+    # connection - An optional Weary::Adapter.
+    #
+    # Returns the Weary::Adapter.
+    def adapter(connection=nil)
+      @connection = connection unless connection.nil?
+      @connection ||= Weary::Adapter::NetHttp
+    end
+
+    # An accessor to set HTTP request headers.
+    #
+    # hash - An optional Hash of key/value pairs that are sent as HTTP
+    #        request headers when a resource's request is performed.
+    #
+    # Returns a Hash of the headers.
+    def headers(hash=nil)
+      @headers = hash unless hash.nil?
+      @headers ||= {}
+    end
+
+    # Send a Rack middleware to be used by the Request.
+    #
+    # middleware - An object that implements the rack middleware interface.
+    # args       - Zero or more optional arguments to send to the middleware.
+    # block      - An optional block to send to the middleware.
+    #
+    # Returns an Array of middlewares.
+    def use(middleware, *args, &block)
+      @middlewares ||= []
+      @middlewares << [middleware, args.compact, block]
+    end
+
+    # Convenience method to set a User Agent Header
+    #
+    # agent - A user agent String. See Weary::USER_AGENTS for some help
+    #
+    # Returns the updated headers Hash.
+    def user_agent(agent)
+      headers.update 'User-Agent' => agent
+    end
+
+    # Should the Request use one or more Rack::Middleware?
+    def has_middleware?
+      !@middlewares.nil? && !@middlewares.empty?
+    end
+
+    # Pass Requestable values on to another Requestable object
+    # (including Middleware).
+    #
+    # requestable - Another Requestable object.
+    #
+    # Returns the Requestable object.
+    def pass_values_onto_requestable(requestable)
+      requestable.headers self.headers
+      requestable.adapter self.adapter
+      if has_middleware?
+        @middlewares.each {|middleware| requestable.use *middleware }
+      end
+      requestable
+    end
+
+  end
+end

data/lib/weary/resource.rb

@@ -7,6 +7,8 @@ module Weary
   # retrieve the resource and some constraints on the parameters necessary
   # to complete the request.
   class Resource
+    include Weary::Requestable
+
     UnmetRequirementsError = Class.new(StandardError)
 
     attr_reader :method
@@ -49,24 +51,6 @@ module Weary
       @defaults ||= {}
     end
 
-    # An accessor to set HTTP request headers.
-    def headers(hash=nil)
-      @headers = hash unless hash.nil?
-      @headers ||= {}
-    end
-
-    # Set up a Rack::Middleware to be used by the Request (which is
-    # Rack-friendly).
-    def use(middleware, *args, &block)
-      @middlewares ||= []
-      @middlewares << [middleware, args.compact, block]
-    end
-
-    # Convenience method to set a User Agent Header
-    def user_agent(agent)
-      headers.update 'User-Agent' => agent
-    end
-
     # Tell the Resource to anticipate Basic Authentication. Optionally,
     # tell the Resource what parameters to use as credentials.
     #
@@ -96,7 +80,7 @@ module Weary
 
     # The keys expected as parameters to the Request.
     def expected_params
-      defaults.keys.map(&:to_s) | optional.map(&:to_s) | required.map(&:to_s)
+      (defaults.keys | optional | required).map(&:to_s).uniq
     end
 
     # Does the Resource expect this parameter to be used to make the Request?
@@ -122,29 +106,48 @@ module Weary
     # Raises a Weary::Resource::UnmetRequirementsError if the requirements
     #   are not met.
     def request(params={})
-      params.delete_if {|k,v| v.nil? || v.to_s.empty? }
-      params.update(defaults)
+      normalize_parameters params
       raise UnmetRequirementsError, "Required parameters: #{requirements}" \
         unless meets_requirements? params
-      credentials = pull_credentials params if authenticates?
-      mapping = url.keys.map {|k| [k, params.delete(k) || params.delete(k.to_sym)] }
-      request = Weary::Request.new url.expand(Hash[mapping]), @method do |r|
-        r.headers headers
-        if !@middlewares.nil? && !@middlewares.empty?
-          @middlewares.each {|middleware| r.use *middleware }
-        end
+      credentials = pull_credentials params
+      pairs = pull_url_pairs params
+      request = construct_request expand_url(pairs), params, credentials
+      yield request if block_given?
+      request
+    end
+    alias build request
+
+    private
+
+    # Private: Build the Request object with the given Resource parameters.
+    def construct_request(uri, params, credentials=[])
+      Weary::Request.new uri, @method do |r|
+        pass_values_onto_requestable(r)
         if !expected_params.empty?
           r.params params.reject {|k,v| !expects? k }
         end
         r.send @authenticates, *credentials if authenticates?
       end
-      yield request if block_given?
-      request
     end
-    alias build request
 
+    # Private: For a set of parameters passed in to build a Request, delete
+    # those with no values, and merge them with the defaults.
+    def normalize_parameters(params)
+      params.delete_if {|k,v| v.nil? || v.to_s.empty? }
+      params.update(defaults)
+      params
+    end
 
-    private
+    # Private: Expand the url template with the passed pairs to get the
+    # final url.
+    def expand_url(pairs)
+      url.expand Hash[pairs]
+    end
+
+    # Private: Separate the parameters needed to construct a url.
+    def pull_url_pairs(params)
+      url.keys.map {|k| [k, params.delete(k) || params.delete(k.to_sym)] }
+    end
 
     # Private: Separate the credentials for authentication from the other
     # request parameters.

data/lib/weary/response.rb

@@ -52,8 +52,12 @@ module Weary
 
     def parse
       raise "The response does not contain a body" if body.nil? || body.empty?
-      raise "Unable to parse Content-Type: #{content_type}" unless content_type =~ /json($|;.*)/
-      MultiJson.decode body
+      if block_given?
+        yield body, content_type
+      else
+        raise "Unable to parse Content-Type: #{content_type}" unless content_type =~ /json($|;.*)/
+        MultiJson.decode body
+      end
     end
   end
 end

data/lib/weary/route.rb

@@ -39,7 +39,12 @@ module Weary
 
     def select_by_url(url, set=@resources)
       set.select do |resource|
-        !resource.url.extract(url).nil?
+        mapping = resource.url.extract(url)
+        if mapping.respond_to?(:empty?) && !mapping.empty?
+          !mapping.values_at(*resource.url.variables).compact.empty?
+        else
+          !mapping.nil?
+        end
       end
     end
 

data/lib/weary/version.rb

@@ -1,3 +1,3 @@
 module Weary
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'weary'
 require 'webmock/rspec'
+require 'multi_json'
 
 Dir['./spec/support/**/*.rb'].each {|f| require f }
 
-WebMock.disable_net_connect!
+WebMock.disable_net_connect!

data/spec/support/shared_examples_for_a_rack_app.rb

@@ -18,6 +18,18 @@ shared_examples_for "a Rack application" do
     subject.call(env).length.should be 3
   end
 
+  it "passes Rack::Lint" do
+    rack_defaults = {
+      'rack.version'      => Rack::VERSION,
+      'rack.errors'       => $stderr,
+      'rack.multithread'  => true,
+      'rack.multiprocess' => false,
+      'rack.run_once'     => false
+    }
+    lint = Rack::Lint.new subject
+    expect { lint.call(rack_defaults.update(env)) }.to_not raise_error Rack::Lint::LintError
+  end
+
   describe "the status" do
     let(:status) { subject.call(env).first }
 

data/spec/support/shared_examples_for_a_requestable.rb

@@ -0,0 +1,77 @@
+shared_examples_for "a Requestable" do
+
+  describe "#adapter" do
+    it "sets a new adapter to set the connection" do
+      klass = Class.new { include Weary::Adapter }
+      subject.adapter(klass)
+      subject.adapter.should be klass
+    end
+
+    it "defaults to the Net::HTTP adapter" do
+      subject.adapter.should be Weary::Adapter::NetHttp
+    end
+  end
+
+  describe "#headers" do
+    it "prepares headers for the request" do
+      subject.headers 'User-Agent' => 'RSpec'
+      subject.headers.should eql 'User-Agent' => 'RSpec'
+    end
+  end
+
+  describe "#use" do
+    it "adds a middleware to the stack" do
+      subject.use Rack::Runtime, "RSpec"
+      stack = subject.instance_variable_get :@middlewares
+      stack.first.should include(Rack::Runtime, ["RSpec"])
+    end
+  end
+
+  describe "#user_agent" do
+    it "updates the #headers hash with a User-Agent" do
+      subject.user_agent 'RSpec'
+      subject.headers.should eql 'User-Agent' => 'RSpec'
+    end
+  end
+
+  describe "#has_middleware?" do
+    it "is true if the Request is set up to use a Middleware" do
+      require 'rack/lobster'
+      subject.use Rack::Lobster
+      subject.should have_middleware
+    end
+
+    it "is false if no Middleware is attached to this Resource" do
+      subject.should_not have_middleware
+    end
+  end
+
+  describe "#pass_values_onto_requestable" do
+    it "passes middleware onto another Requestable object" do
+      require 'rack/lobster'
+      klass = Class.new { include Weary::Requestable }
+      requestable = klass.new
+      subject.use Rack::Lobster
+      subject.pass_values_onto_requestable(requestable)
+      requestable.should have_middleware
+    end
+
+    it "passes adapter onto another Requestable" do
+      klass = Class.new { include Weary::Requestable }
+      adapterClass = Class.new { include Weary::Adapter }
+      requestable = klass.new
+      subject.adapter(adapterClass)
+      subject.pass_values_onto_requestable(requestable)
+      requestable.adapter.should eql adapterClass
+    end
+
+    it "passes headers onto another Requestable" do
+      klass = Class.new { include Weary::Requestable }
+      requestable = klass.new
+      subject.user_agent "RSpec"
+      subject.pass_values_onto_requestable(requestable)
+      requestable.headers.should eql "User-Agent" => "RSpec"
+    end
+  end
+
+end

data/spec/support/shared_examples_for_an_adapter.rb

@@ -0,0 +1,16 @@
+shared_examples_for "an Adapter" do
+  it { should respond_to :call }
+  it { should respond_to :connect }
+
+  describe "#call" do
+    it_behaves_like "a Rack application"
+  end
+
+  describe "#connect" do
+    it "returns a Rack::Response" do
+      subject.connect(Rack::Request.new(env)).should be_a Rack::Response
+    end
+  end
+
+
+end

data/spec/weary/adapter_spec.rb

@@ -3,24 +3,17 @@ require 'spec_helper'
 describe Weary::Adapter do
   subject { Class.new { include Weary::Adapter }.new }
   let(:env) {
-    {
-      "REQUEST_METHOD"=>"GET",
-      "SCRIPT_NAME"=>"",
-      "PATH_INFO"=>"/api/v2/json/repos/show/mwunsch/weary",
-      "QUERY_STRING"=>nil,
-      "SERVER_NAME"=>"github.com",
-      "SERVER_PORT"=>80,
-      "REQUEST_URI"=>"/api/v2/json/repos/show/mwunsch/weary"
-    }
+    req = Weary::Request.new("http://github.com/api/v2/json/repos/show/mwunsch/weary")
+    req.headers 'User-Agent' => Weary::USER_AGENTS['Lynx 2.8.4rel.1 on Linux']
+    req.env
   }
 
-  describe "#call" do
-    it_behaves_like "a Rack application"
-  end
+  it_behaves_like "an Adapter"
 
-  describe "connect" do
-    it "returns a Rack::Response" do
-      subject.connect(Rack::Request.new(env)).should be_a Rack::Response
+  describe "#normalize_request_headers" do
+    it "removes the HTTP_ prefix from request headers" do
+      headers = subject.normalize_request_headers(env)
+      headers.should have_key "User-Agent"
     end
   end
 end