transport 1.0.0

data/lib/transport/http/request_builder/parameter_serializer.rb

@@ -0,0 +1,61 @@
+require 'cgi'
+
+module Transport
+
+  # Common transport layer for http transfers.
+  class HTTP
+
+    # Builder for the transport layer requests.
+    class RequestBuilder
+
+      # Serializer for transport http parameters.
+      class ParameterSerializer
+
+        attr_reader :result
+
+        def initialize(parameters = nil)
+          @parameters = parameters || { }
+        end
+
+        def perform
+          quote_parameters
+          serialize_parameters
+        end
+
+        private
+
+        def quote_parameters
+          @quoted_parameters = { }
+          @parameters.each do |key, value|
+            encoded_key = CGI.escape(key.to_s)
+            @quoted_parameters[encoded_key] = self.class.escape value
+          end
+        end
+
+        def serialize_parameters
+          @result = if @parameters.nil? || @parameters.empty?
+            nil
+          else
+            @quoted_parameters.collect do |key, value|
+              self.class.pair key, value
+            end.join("&")
+          end
+        end
+
+        def self.escape(value)
+          value.is_a?(Array) ? value.map{ |element| CGI.escape element } : CGI.escape(value)
+        end
+
+        def self.pair(key, value)
+          value.is_a?(Array) ?
+            value.map{ |element| "#{key}=#{element}" }.join("&") :
+            "#{key}=#{value}"
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/transport/json.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), "common")
+require File.join(File.dirname(__FILE__), "http")
+
+module Transport
+
+  # Transport layer for json transfers.
+  class JSON
+    include Common
+
+    autoload :RequestBuilder, File.join(File.dirname(__FILE__), "json", "request_builder")
+    autoload :ResponseParser, File.join(File.dirname(__FILE__), "json", "response_parser")
+
+    # ParserError will be raised if the response parser couldn't process the http response.
+    class ParserError < StandardError; end
+
+    def perform
+      perform_http_transport
+      parse_response
+    end
+
+    private
+
+    def perform_http_transport
+      http_transport = HTTP.new @uri, @request, @options
+      http_transport.perform
+      @http_response = http_transport.response
+    end
+
+    def parse_response
+      response_parser = ResponseParser.new @http_response
+      response_parser.perform
+      @response = response_parser.result
+    end
+
+  end
+
+end

data/lib/transport/json/request_builder.rb

@@ -0,0 +1,56 @@
+require 'json'
+
+module Transport
+
+  # Transport layer for json transfers.
+  class JSON
+
+    # Builder for the json transport layer requests.
+    class RequestBuilder
+      include Common::RequestBuilder
+
+      attr_reader :request
+
+      def perform
+        set_headers
+        convert_parameters_to_json
+        convert_body_to_json
+        build_http_request
+      end
+
+      private
+
+      def set_headers
+        headers = @options[:headers] || { }
+        headers.merge! "Accept" => "application/json"
+        headers.merge! "Content-Type" => "application/json" if @options[:body]
+        @options[:headers] = headers
+      end
+
+      def convert_parameters_to_json
+        return unless @options[:encode_parameters]
+        parameters = @options[:parameters]
+        if parameters
+          parameters.each do |key, value|
+            parameters[key] = value.to_json if value.respond_to?(:to_json)
+          end
+          @options[:parameters] = parameters
+        end
+      end
+
+      def convert_body_to_json
+        body = @options[:body]
+        @options[:body] = body.to_json if body
+      end
+
+      def build_http_request
+        http_request_builder = HTTP::RequestBuilder.new @http_method, @url, @options
+        http_request_builder.perform
+        @request = http_request_builder.request
+      end
+
+    end
+
+  end
+
+end

data/lib/transport/json/response_parser.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+module Transport
+
+  # Transport layer for json transfers.
+  class JSON
+
+    # Parser for the json response.
+    class ResponseParser
+
+      attr_reader :result
+
+      def initialize(http_response)
+        @http_response = http_response
+      end
+
+      def perform
+        parse_response_body
+      end
+
+      private
+
+      def parse_response_body
+        @result = @http_response && @http_response.strip != "" ? ::JSON.parse(@http_response) : nil
+      rescue ::JSON::ParserError => error
+        raise ParserError, error.to_s
+      end
+
+    end
+
+  end
+
+end

data/lib/transport/spec.rb

@@ -0,0 +1,10 @@
+
+module Transport
+
+  module Spec
+
+    autoload :Faker, File.join(File.dirname(__FILE__), "spec", "faker")
+
+  end
+
+end

data/lib/transport/spec/faker.rb

@@ -0,0 +1,75 @@
+require 'yaml'
+require 'rspec'
+
+module Transport
+
+  module Spec
+
+    # Spec helper class to fake http and json request.
+    class Faker
+
+      TRANSPORT_CLASSES = [
+        Transport::HTTP,
+        Transport::JSON
+      ].freeze unless defined?(TRANSPORT_CLASSES)
+
+      # This error is raised if no fake request is found for the call.
+      class NoFakeRequestError < StandardError; end
+
+      def initialize(fakes)
+        @fakes = fakes
+      end
+
+      def stub_requests!
+        TRANSPORT_CLASSES.each do |transport_class|
+          stub_requests_for_transport! transport_class
+        end
+      end
+
+      private
+
+      def stub_requests_for_transport!(transport_class)
+        transport_class.stub(:request).and_return do |*arguments|
+          request *arguments
+        end
+      end
+
+      def request(http_method, url, options = { })
+        parameters, headers, expected_status_code = options.values_at :parameters, :headers, :expected_status_code
+        fake = find_fake :http_method => http_method, :url => url, :parameters => parameters, :headers => headers
+        response = fake[:response]
+        check_status_code response, expected_status_code
+        response[:body].dup
+      end
+
+      def check_status_code(response, expected_status_code)
+        response_code, response_body = response.values_at :code, :body
+        raise Transport::UnexpectedStatusCodeError.new(
+          response_code.to_i,
+          response_body
+        ) if expected_status_code && expected_status_code.to_s != response_code
+      end
+
+      def find_fake(options)
+        fake = @fakes.detect{ |fake| self.class.fake_match? fake, options }
+        raise NoFakeRequestError, "no fake request found for [#{options[:http_method]} #{options[:url]} #{options[:parameters].inspect} #{options[:headers].inspect}]" unless fake
+        fake
+      end
+
+      def self.fake_match?(fake, options)
+        fake[:http_method].to_s == options[:http_method].to_s &&
+          fake[:url].to_s == options[:url].to_s &&
+          fake[:parameters] == options[:parameters] &&
+          fake[:headers] == options[:headers]
+      end
+
+      def self.fake!(filename)
+        faker = new YAML.load_file(filename)
+        faker.stub_requests!
+      end
+
+    end
+
+  end
+
+end

data/lib/transport/unexpected_status_code_error.rb

@@ -0,0 +1,21 @@
+
+module Transport
+
+  # The UnexpectedStatusCodeError is raised if the :expected_status_code option is given to
+  # the :request method and the responded status code is different from the expected one.
+  class UnexpectedStatusCodeError < StandardError
+
+    attr_reader :status_code
+    attr_reader :message
+
+    def initialize(status_code, message = nil)
+      @status_code, @message = status_code, message
+    end
+
+    def to_s
+      "#{super} received status code #{self.status_code}" + (@message ? " [#{@message}]" : "")
+    end
+
+  end
+
+end

data/spec/acceptance/http_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+require 'logger'
+
+describe "fetching the google start page" do
+
+  it "should return some html" do
+    response = Transport::HTTP.request :get, "http://www.google.de"
+    response.should_not be_nil
+  end
+
+end
+
+describe "fetch a search query result from google" do
+
+  it "should return some html" do
+    response = Transport::HTTP.request :get, "http://www.google.de/search", :parameters => { "q" => "transport" }
+    response.should_not be_nil
+  end
+
+end

data/spec/acceptance/json_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+
+describe "fetching the delicious bookmarks" do
+
+  it "should return some json" do
+    response = Transport::JSON.request :get, "http://feeds.delicious.com/v2/json", :logger => Logger.new(STDOUT)
+    response.should be_instance_of(Array)
+  end
+
+end

data/spec/lib/transport/common/request_builder_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "spec_helper"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "..", "lib", "transport", "common", "request_builder"))
+
+describe Transport::Common::RequestBuilder do
+
+  before :each do
+    @klass = Class.new
+    @klass.send :include, described_class
+  end
+
+  describe "initialize" do
+
+    before :each do
+      @object = @klass.new :test_http_method, "http://host:1234/test", :test_options
+    end
+
+    it "should set the http_method" do
+      @object.http_method.should == :test_http_method
+    end
+
+    it "should set the url" do
+      @object.url.should == "http://host:1234/test"
+    end
+
+    it "should set the options" do
+      @object.options.should == :test_options
+    end
+
+    it "should set the uri" do
+      @object.uri.host.should == "host"
+      @object.uri.port.should == 1234
+    end
+
+  end
+
+  describe "build" do
+
+    before :each do
+      @uri = Object.new
+      @request = Object.new
+      @object = mock described_class, :perform => nil, :uri => @uri, :request => @request
+      @klass.stub(:new).and_return(@object)
+    end
+
+    it "should initialize the request builder" do
+      @klass.should_receive(:new).with(:test_argument).and_return(@object)
+      @klass.build :test_argument
+    end
+
+    it "should perform the build" do
+      @object.should_receive(:perform)
+      @klass.build
+    end
+
+    it "should return the uri and the request" do
+      @klass.build.should == [ @uri, @request ]
+    end
+
+  end
+
+end

data/spec/lib/transport/common_spec.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "lib", "transport", "common"))
+
+describe Transport::Common do
+
+  before :each do
+    @klass = Class.new
+    @klass.send :include, described_class
+  end
+
+  describe "initialize" do
+
+    before :each do
+      @object = @klass.new :test_uri, :test_request, :test_options
+    end
+
+    it "should set the uri" do
+      @object.uri.should == :test_uri
+    end
+
+    it "should set the request" do
+      @object.request.should == :test_request
+    end
+
+    it "should set the options" do
+      @object.options.should == :test_options
+    end
+
+  end
+
+  describe "request" do
+
+    before :each do
+      @uri = Object.new
+      @request = Object.new
+
+      @klass::RequestBuilder.stub(:build).and_return([ @uri, @request ])
+
+      @object = mock described_class, :perform => nil, :response => :test_response
+      @klass.stub(:new).and_return(@object)
+    end
+
+    def do_request
+      @klass.request :test_http_method, :test_url, :test_options
+    end
+
+    it "should build the request" do
+      @klass::RequestBuilder.should_receive(:build).with(:test_http_method, :test_url, :test_options).and_return([ @uri, @request ])
+      do_request
+    end
+
+    it "should initialize the transport" do
+      @klass.should_receive(:new).with(@uri, @request, :test_options).and_return(@object)
+      do_request
+    end
+
+    it "should perform the transport" do
+      @object.should_receive(:perform)
+      do_request
+    end
+
+    it "should return the response" do
+      do_request.should == :test_response
+    end
+
+  end
+
+end