webmachine 1.5.0 → 2.0.0.beta

data/lib/webmachine/media_type.rb

@@ -23,11 +23,11 @@ module Webmachine
         obj
       when MEDIA_TYPE_REGEX
         type, raw_params = $1, $2
-        params = Hash[raw_params.scan(PARAMS_REGEX).map { |m| [m[0], m[2].to_s] }]
+        params = raw_params.scan(PARAMS_REGEX).map { |m| [m[0], m[2].to_s] }.to_h
         new(type, params)
       else
         unless Array === obj && String === obj[0] && Hash === obj[1]
-          raise ArgumentError, t('invalid_media_type', :type => obj.inspect)
+          raise ArgumentError, t('invalid_media_type', type: obj.inspect)
         end
         type = parse(obj[0])
         type.params.merge!(obj[1])
@@ -43,7 +43,7 @@ module Webmachine
 
     # @param [String] type the main media type, e.g. application/json
     # @param [Hash] params the media type parameters
-    def initialize(type, params={})
+    def initialize(type, params = {})
       @type, @params = type, params
     end
 
@@ -88,13 +88,13 @@ module Webmachine
     # @param [Hash] params the requested params
     # @return [true,false] whether it is an acceptable match
     def params_match?(other)
-      other.all? {|k,v| params[k] == v }
+      other.all? { |k, v| params[k] == v }
     end
 
     # Reconstitutes the type into a String
     # @return [String] the type as a String
     def to_s
-      [type, *params.map {|k,v| "#{k}=#{v}" }].join(";")
+      [type, *params.map { |k, v| "#{k}=#{v}" }].join(';')
     end
 
     # @return [String] The major type, e.g. "application", "text", "image"

data/lib/webmachine/quoted_string.rb

@@ -19,10 +19,10 @@ module Webmachine
 
     # Ensures that quotes exist around a quoted-string
     def quote(str)
-      if str =~ QS_ANCHORED
+      if QS_ANCHORED.match?(str)
         str
       else
-        %Q{"#{escape_quotes str}"}
+        %("#{escape_quotes str}")
       end
     end
 
@@ -33,7 +33,7 @@ module Webmachine
 
     # Unescapes quotes within a quoted string
     def unescape_quotes(str)
-      str.gsub(%r{\\}, '')
+      str.delete('\\')
     end
   end
 end

data/lib/webmachine/request.rb

@@ -21,7 +21,7 @@ module Webmachine
     # @param [Headers] headers the HTTP request headers
     # @param [String,#to_s,#each,nil] body the entity included in the
     #   request, if present
-    def initialize(method, uri, headers, body, routing_tokens=nil, base_uri=nil)
+    def initialize(method, uri, headers, body, routing_tokens = nil, base_uri = nil)
       @method, @headers, @body = method, headers, body
       @uri = build_uri(uri, headers)
       @routing_tokens = routing_tokens || @uri.path.match(ROUTING_PATH_MATCH)[1].split(SLASH)
@@ -37,12 +37,12 @@ module Webmachine
     # lowercased-underscored version of the header name, e.g.
     # `if_unmodified_since`.
     def method_missing(m, *args, &block)
-      if m =~ HTTP_HEADERS_MATCH
+      if HTTP_HEADERS_MATCH.match?(m)
         # Access headers more easily as underscored methods.
         header_name = m.to_s.tr(UNDERSCORE, DASH)
         if (header_value = @headers[header_name])
           # Make future lookups faster.
-          self.class.class_eval <<-RUBY, __FILE__, __LINE__
+          self.class.class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{m}
             @headers["#{header_name}"]
           end
@@ -66,8 +66,8 @@ module Webmachine
     def query
       unless @query
         @query = {}
-        (uri.query || '').split(/&/).each do |kv|
-          key, value = kv.split(/=/)
+        (uri.query || '').split('&').each do |kv|
+          key, value = kv.split('=')
           if key && value
             key, value = CGI.unescape(key), CGI.unescape(value)
             @query[key] = value
@@ -82,9 +82,7 @@ module Webmachine
     # @return [Hash]
     #   {} if no Cookies header set
     def cookies
-      unless @cookies
-        @cookies = Webmachine::Cookie.parse(headers['Cookie'])
-      end
+      @cookies ||= Webmachine::Cookie.parse(headers['Cookie'])
       @cookies
     end
 
@@ -93,7 +91,7 @@ module Webmachine
     # @return [Boolean]
     #   true if this request was made via HTTPS
     def https?
-      uri.scheme == "https"
+      uri.scheme == 'https'
     end
 
     # Is this a GET request?
@@ -191,6 +189,5 @@ module Webmachine
 
       parse_host(uri, headers.fetch(HOST))
     end
-
   end # class Request
 end # module Webmachine

data/lib/webmachine/rescueable_exception.rb

@@ -2,7 +2,7 @@ module Webmachine::RescuableException
   require_relative 'errors'
   require 'set'
 
-  UNRESCUABLE_DEFAULTS =  [
+  UNRESCUABLE_DEFAULTS = [
     Webmachine::MalformedRequest,
     NoMemoryError, SystemExit, SignalException
   ].freeze
@@ -45,7 +45,7 @@ module Webmachine::RescuableException
   # @param (see #remove)
   #
   def self.add(*exceptions)
-    exceptions.each{|e| UNRESCUABLE.delete(e)}
+    exceptions.each { |e| UNRESCUABLE.delete(e) }
   end
 
   #
@@ -57,6 +57,6 @@ module Webmachine::RescuableException
   #   A subclass of Exception.
   #
   def self.remove(*exceptions)
-    exceptions.each{|e| UNRESCUABLE.add(e)}
+    exceptions.each { |e| UNRESCUABLE.add(e) }
   end
 end

data/lib/webmachine/resource/authentication.rb

@@ -23,14 +23,13 @@ module Webmachine
       # @yieldparam [String] user the passed username
       # @yieldparam [String] password the passed password
       # @yieldreturn [true,false] whether the username/password is correct
-      def basic_auth(header, realm="Webmachine")
-        if header =~ BASIC_HEADER && (yield *$1.unpack('m*').first.split(/:/,2))
+      def basic_auth(header, realm = 'Webmachine')
+        if header =~ BASIC_HEADER && yield(*$1.unpack1('m*').split(/:/, 2))
           true
         else
-          %Q[Basic realm="#{realm}"]
+          %(Basic realm="#{realm}")
         end
       end
-
     end # module Authentication
   end # class Resource
 end # module Webmachine

data/lib/webmachine/resource/callbacks.rb

@@ -265,7 +265,7 @@ module Webmachine
       # @api callback
       # @see Encodings
       def encodings_provided
-        {IDENTITY => :encode_identity }
+        {IDENTITY => :encode_identity}
       end
 
       # If this method is implemented, it should return a list of
@@ -360,7 +360,8 @@ module Webmachine
       # constructed and sent. The return value is ignored, so any effect
       # of this method must be by modifying the response.
       # @api callback
-      def finish_request; end
+      def finish_request
+      end
 
       #
       # This method is called when an error is raised within a subclass of
@@ -389,7 +390,6 @@ module Webmachine
       def validate_content_checksum
         nil
       end
-
     end # module Callbacks
   end # class Resource
 end # module Webmachine

data/lib/webmachine/resource/encodings.rb

@@ -15,23 +15,17 @@ module Webmachine
       # The 'deflate' encoding, which uses libz's DEFLATE compression.
       def encode_deflate(data)
         # The deflate options were borrowed from Rack and Mongrel1.
-        Zlib::Deflate.deflate(data, *[Zlib::DEFAULT_COMPRESSION,
-                                      # drop the zlib header which causes both Safari and IE to choke
-                                      -Zlib::MAX_WBITS,
-                                      Zlib::DEF_MEM_LEVEL,
-                                      Zlib::DEFAULT_STRATEGY
-                                     ])
+        Zlib::Deflate.deflate(data, Zlib::DEFAULT_COMPRESSION, -Zlib::MAX_WBITS, Zlib::DEF_MEM_LEVEL, Zlib::DEFAULT_STRATEGY)
       end
 
       # The 'gzip' encoding, which uses GNU Zip (via libz).
       # @note Because of the header/checksum requirements, gzip cannot
       #     be used on streamed responses.
       def encode_gzip(data)
-        "".tap do |out|
-          Zlib::GzipWriter.wrap(StringIO.new(out)){|gz| gz << data }
+        ''.tap do |out|
+          Zlib::GzipWriter.wrap(StringIO.new(out)) { |gz| gz << data }
         end
       end
-
     end # module Encodings
   end # class Resource
 end # module Webmachine

data/lib/webmachine/resource.rb

@@ -59,11 +59,11 @@ module Webmachine
     end
 
     private
+
     # When no specific charsets are provided, this acts as an identity
     # on the response body. Probably deserves some refactoring.
     def charset_nop(x)
       x
     end
-
   end # class Resource
 end # module Webmachine

data/lib/webmachine/response.rb

@@ -35,7 +35,7 @@ module Webmachine
     # of the target resource, or manually set the Location header
     # using {#headers}.
     # @param [String, URI] location the target of the redirection
-    def do_redirect(location=nil)
+    def do_redirect(location = nil)
       headers['Location'] = location.to_s if location
       self.redirect = true
     end
@@ -54,8 +54,8 @@ module Webmachine
       end
     end
 
-    alias :is_redirect? :redirect
-    alias :redirect_to :do_redirect
+    alias_method :is_redirect?, :redirect
+    alias_method :redirect_to, :do_redirect
 
     # A {Hash} that can flatten array values into single values with a separator
     class HeaderHash < ::Hash
@@ -63,17 +63,15 @@ module Webmachine
       # @param [String] The separator used to join Array values
       # @return [HeaderHash] A new {HeaderHash} with Array values flattened
       def flattened(separator = ',')
-        Hash[self.collect { |k,v|
+        collect { |k, v|
           case v
           when Array
-            [k,v.join(separator)]
+            [k, v.join(separator)]
           else
-            [k,v]
+            [k, v]
           end
-        }]
-
+        }.to_h
       end
     end
-
   end # class Response
 end # module Webmachine

data/lib/webmachine/spec/adapter_lint.rb

@@ -1,7 +1,7 @@
-require "webmachine/spec/test_resource"
-require "net/http"
+require 'webmachine/spec/test_resource'
+require 'net/http'
 
-ADDRESS = "127.0.0.1"
+ADDRESS = '127.0.0.1'
 
 shared_examples_for :adapter_lint do
   attr_reader :client
@@ -12,7 +12,7 @@ shared_examples_for :adapter_lint do
     temp_server = TCPServer.new(ADDRESS, 0)
     port = temp_server.addr[1]
     temp_server.close # only frees Ruby resource, socket is in TIME_WAIT at OS level
-                      # so we can't have our adapter use it too quickly
+    # so we can't have our adapter use it too quickly
 
     sleep(0.1)        # 'Wait' for temp_server to *really* close, not just TIME_WAIT
     port
@@ -20,10 +20,10 @@ shared_examples_for :adapter_lint do
 
   def create_test_application(port)
     Webmachine::Application.new.tap do |application|
-      application.dispatcher.add_route ["test"], Test::Resource
+      application.dispatcher.add_route ['test'], Test::Resource
 
       application.configure do |c|
-        c.ip   = ADDRESS
+        c.ip = ADDRESS
         c.port = port
       end
     end
@@ -37,12 +37,10 @@ shared_examples_for :adapter_lint do
 
   def wait_until_server_responds_to(client)
     Timeout.timeout(5, TestApplicationNotResponsive) do
-      begin
-        client.start
-      rescue Errno::ECONNREFUSED
-        sleep(0.01)
-        retry
-      end
+      client.start
+    rescue Errno::ECONNREFUSED
+      sleep(0.01)
+      retry
     end
   end
 
@@ -62,9 +60,9 @@ shared_examples_for :adapter_lint do
     @server_thread.kill
   end
 
-  it "provides the request URI" do
-    request = Net::HTTP::Get.new("/test")
-    request["Accept"] = "test/response.request_uri"
+  it 'provides the request URI' do
+    request = Net::HTTP::Get.new('/test')
+    request['Accept'] = 'test/response.request_uri'
     response = client.request(request)
     expect(response.body).to eq("http://#{ADDRESS}:#{@port}/test")
   end
@@ -80,92 +78,92 @@ shared_examples_for :adapter_lint do
   #   end
   # end
 
-  it "provides a string-like request body" do
-    request = Net::HTTP::Put.new("/test")
-    request.body = "Hello, World!"
-    request["Content-Type"] = "test/request.stringbody"
+  it 'provides a string-like request body' do
+    request = Net::HTTP::Put.new('/test')
+    request.body = 'Hello, World!'
+    request['Content-Type'] = 'test/request.stringbody'
     response = client.request(request)
-    expect(response["Content-Length"]).to eq("21")
-    expect(response.body).to eq("String: Hello, World!")
+    expect(response['Content-Length']).to eq('21')
+    expect(response.body).to eq('String: Hello, World!')
   end
 
-  it "provides an enumerable request body" do
-    request = Net::HTTP::Put.new("/test")
-    request.body = "Hello, World!"
-    request["Content-Type"] = "test/request.enumbody"
+  it 'provides an enumerable request body' do
+    request = Net::HTTP::Put.new('/test')
+    request.body = 'Hello, World!'
+    request['Content-Type'] = 'test/request.enumbody'
     response = client.request(request)
-    expect(response["Content-Length"]).to eq("19")
-    expect(response.body).to eq("Enum: Hello, World!")
+    expect(response['Content-Length']).to eq('19')
+    expect(response.body).to eq('Enum: Hello, World!')
   end
 
-  it "handles missing pages" do
-    request = Net::HTTP::Get.new("/missing")
+  it 'handles missing pages' do
+    request = Net::HTTP::Get.new('/missing')
     response = client.request(request)
-    expect(response.code).to eq("404")
-    expect(response["Content-Type"]).to eq("text/html")
+    expect(response.code).to eq('404')
+    expect(response['Content-Type']).to eq('text/html')
   end
 
-  it "handles empty response bodies" do
-    request = Net::HTTP::Post.new("/test")
-    request.body = ""
+  it 'handles empty response bodies' do
+    request = Net::HTTP::Post.new('/test')
+    request.body = ''
     response = client.request(request)
-    expect(response.code).to eq("204")
-    expect(["0", nil]).to include(response["Content-Length"])
+    expect(response.code).to eq('204')
+    expect(['0', nil]).to include(response['Content-Length'])
     expect(response.body).to be_nil
   end
 
-  it "handles string response bodies" do
-    request = Net::HTTP::Get.new("/test")
-    request["Accept"] = "test/response.stringbody"
+  it 'handles string response bodies' do
+    request = Net::HTTP::Get.new('/test')
+    request['Accept'] = 'test/response.stringbody'
     response = client.request(request)
-    expect(response["Content-Length"]).to eq("20")
-    expect(response.body).to eq("String response body")
+    expect(response['Content-Length']).to eq('20')
+    expect(response.body).to eq('String response body')
   end
 
-  it "handles enumerable response bodies" do
-    request = Net::HTTP::Get.new("/test")
-    request["Accept"] = "test/response.enumbody"
+  it 'handles enumerable response bodies' do
+    request = Net::HTTP::Get.new('/test')
+    request['Accept'] = 'test/response.enumbody'
     response = client.request(request)
-    expect(response["Transfer-Encoding"]).to eq("chunked")
-    expect(response.body).to eq("Enumerable response body")
+    expect(response['Transfer-Encoding']).to eq('chunked')
+    expect(response.body).to eq('Enumerable response body')
   end
 
-  it "handles proc response bodies" do
-    request = Net::HTTP::Get.new("/test")
-    request["Accept"] = "test/response.procbody"
+  it 'handles proc response bodies' do
+    request = Net::HTTP::Get.new('/test')
+    request['Accept'] = 'test/response.procbody'
     response = client.request(request)
-    expect(response["Transfer-Encoding"]).to eq("chunked")
-    expect(response.body).to eq("Proc response body")
+    expect(response['Transfer-Encoding']).to eq('chunked')
+    expect(response.body).to eq('Proc response body')
   end
 
-  it "handles fiber response bodies" do
-    request = Net::HTTP::Get.new("/test")
-    request["Accept"] = "test/response.fiberbody"
+  it 'handles fiber response bodies' do
+    request = Net::HTTP::Get.new('/test')
+    request['Accept'] = 'test/response.fiberbody'
     response = client.request(request)
-    expect(response["Transfer-Encoding"]).to eq("chunked")
-    expect(response.body).to eq("Fiber response body")
+    expect(response['Transfer-Encoding']).to eq('chunked')
+    expect(response.body).to eq('Fiber response body')
   end
 
-  it "handles io response bodies" do
-    request = Net::HTTP::Get.new("/test")
-    request["Accept"] = "test/response.iobody"
+  it 'handles io response bodies' do
+    request = Net::HTTP::Get.new('/test')
+    request['Accept'] = 'test/response.iobody'
     response = client.request(request)
-    expect(response["Content-Length"]).to eq("17")
+    expect(response['Content-Length']).to eq('17')
     expect(response.body).to eq("IO response body\n")
   end
 
-  it "handles request cookies" do
-    request = Net::HTTP::Get.new("/test")
-    request["Accept"] = "test/response.cookies"
-    request["Cookie"] = "echo=echocookie"
+  it 'handles request cookies' do
+    request = Net::HTTP::Get.new('/test')
+    request['Accept'] = 'test/response.cookies'
+    request['Cookie'] = 'echo=echocookie'
     response = client.request(request)
-    expect(response.body).to eq("echocookie")
+    expect(response.body).to eq('echocookie')
   end
 
-  it "handles response cookies" do
-    request = Net::HTTP::Get.new("/test")
-    request["Accept"] = "test/response.cookies"
+  it 'handles response cookies' do
+    request = Net::HTTP::Get.new('/test')
+    request['Accept'] = 'test/response.cookies'
     response = client.request(request)
-    expect(response["Set-Cookie"]).to eq("cookie=monster, rodeo=clown")
+    expect(response['Set-Cookie']).to eq('cookie=monster, rodeo=clown')
   end
 end

data/lib/webmachine/spec/test_resource.rb

@@ -1,34 +1,35 @@
 module Test
   class Resource < Webmachine::Resource
     def allowed_methods
-      ["GET", "PUT", "POST"]
+      ['GET', 'PUT', 'POST']
     end
 
     def content_types_accepted
       [
-        ["test/request.stringbody", :from_string],
-        ["test/request.enumbody", :from_enum]
+        ['test/request.stringbody', :from_string],
+        ['test/request.enumbody', :from_enum]
       ]
     end
 
     def content_types_provided
       [
-        ["test/response.stringbody", :to_string],
-        ["test/response.enumbody", :to_enum],
-        ["test/response.procbody", :to_proc],
-        ["test/response.fiberbody", :to_fiber],
-        ["test/response.iobody", :to_io_body],
-        ["test/response.cookies", :to_cookies],
-        ["test/response.request_uri", :to_request_uri]
+        ['test/response.stringbody', :to_string],
+        ['test/response.enumbody', :to_enum],
+        ['test/response.procbody', :to_proc],
+        ['test/response.fiberbody', :to_fiber],
+        ['test/response.iobody', :to_io_body],
+        ['test/response.cookies', :to_cookies],
+        ['test/response.request_uri', :to_request_uri],
+        ['test/response.rack_env', :to_rack_env]
       ]
     end
 
     def from_string
-      response.body = "String: #{request.body.to_s}"
+      response.body = "String: #{request.body}"
     end
 
     def from_enum
-      response.body = "Enum: "
+      response.body = 'Enum: '
       request.body.each do |part|
         response.body += part
       end
@@ -40,22 +41,22 @@ module Test
     end
 
     def to_string
-      "String response body"
+      'String response body'
     end
 
     def to_enum
-      ["Enumerable ", "response " "body"]
+      ['Enumerable ', 'response ', 'body']
     end
 
     def to_proc
-      Proc.new { "Proc response body" }
+      proc { 'Proc response body' }
     end
 
     def to_fiber
       Fiber.new do
-        Fiber.yield "Fiber "
-        Fiber.yield "response "
-        "body"
+        Fiber.yield 'Fiber '
+        Fiber.yield 'response '
+        'body'
       end
     end
 
@@ -64,16 +65,20 @@ module Test
     end
 
     def to_cookies
-      response.set_cookie("cookie", "monster")
-      response.set_cookie("rodeo", "clown")
+      response.set_cookie('cookie', 'monster')
+      response.set_cookie('rodeo', 'clown')
       # FIXME: Mongrel/WEBrick fail if this method returns nil
       # Might be a net/http issue. Is this a bug?
       # @see Flow#o18, Helpers#encode_body_if_set
-      request.cookies["echo"] || ""
+      request.cookies['echo'] || ''
     end
 
     def to_request_uri
       request.uri.to_s
     end
+
+    def to_rack_env
+      request.env.to_json
+    end
   end
 end

data/lib/webmachine/streaming/encoder.rb

@@ -12,12 +12,13 @@ module Webmachine
       end
 
       protected
+
       # @return [true, false] whether the stream will be modified by
       # the encoder and/or charsetter. Only returns true if using the
       # built-in "encode_identity" and "charset_nop" methods.
       def is_unencoded?
-        encoder.to_s == "encode_identity" &&
-          charsetter.to_s == "charset_nop"
+        encoder.to_s == 'encode_identity' &&
+          charsetter.to_s == 'charset_nop'
       end
     end # class Encoder
   end # module Streaming

data/lib/webmachine/streaming/io_encoder.rb

@@ -13,7 +13,7 @@ module Webmachine
       # @yield [chunk]
       # @yieldparam [String] chunk a chunk of the response, encoded
       def each
-        while chunk = body.read(CHUNK_SIZE) and chunk != ""
+        while (chunk = body.read(CHUNK_SIZE)) && (chunk != '')
           yield resource.send(encoder, resource.send(charsetter, chunk))
         end
       end
@@ -26,7 +26,7 @@ module Webmachine
         if can_copy_stream?
           IO.copy_stream(body, outstream)
         else
-          each {|chunk| outstream << chunk }
+          each { |chunk| outstream << chunk }
         end
       end
 
@@ -60,9 +60,10 @@ module Webmachine
         size == 0
       end
 
-      alias bytesize size
+      alias_method :bytesize, :size
 
       private
+
       def can_copy_stream?
         IO.respond_to?(:copy_stream) && is_unencoded? && !is_string_io?
       end