webmachine 1.5.0 → 2.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9309a2f44549ae1c912684fcdc7f60d31404bbf3
-  data.tar.gz: 9531f40a275a2bf5e2bda7ed4816ff2463e4c234
+SHA256:
+  metadata.gz: 9fa67f8c8882d39968e933f1f3e40888e05f25ddb26754f04efb5f0ee6e85342
+  data.tar.gz: 979c3bef1f736792ea3b9754b6dd6837e2a02ba92b04ea0ac0b607260b09b5e0
 SHA512:
-  metadata.gz: 5f5e9419fadcf121f8e0e80ec41417bd5dd9f096933aaf06793dd18d9d6ac6f5e2d028f56e0bc105ff5a87f9b2aa7ebc72e1d61424cc8c88d76e7cb92b9655a0
-  data.tar.gz: d79442bba70911a7b704a26135a2fcadc4dbc1f0a0e12197d1ddbfb055498c54e164e972b03479d7428839ceef15bf32faa070b7ace58fc4b76704bdc5ec7bf8
+  metadata.gz: ed27aee0010e3375d49c8e3e5bc38fba49073c177cf4e271f593beedc9ca7de272869be9ebd20fdafbd834e465d3d77f52052cbfe48f08713a296723a61c1776
+  data.tar.gz: e4b38c9ecc8183fefa4b40d90d69cda5c3b9f0b22828bbe59acd03fede5d907d54816488d7ded9b8677343a49a43c4a2c963b4b8aa31d29bb32825ff0361a3c4

data/CHANGELOG.md

@@ -1,6 +1,19 @@
 ### HEAD
 
+### 2.0.0.beta Mar 30, 2023
+
+* Drop support for ruby 2.3, 2.4, and 2.5
+* Remove the HTTPkit adapter
+* Format cookie 'Expires' timestamps as per RFC 2616
+
+### 1.6.0 June 22, 2021
+
+* fix: replace missed URI.decode with new Route.rfc3986_percent_decode (#261)
+* fix: implement rfc3986 Percent-Encoding decoder
+* feat: make rack env available on the webmachine request when using a rack adapter
+
 ### 1.5.0 September 8, 2017
+
 * Removed Fixnum/Integer deprecation warnings in Ruby 2.4
 * Fixed multiple cookie setting code
 * Added support for named captures

data/README.md

@@ -1,4 +1,6 @@
-# webmachine for Ruby [![Build Status](https://travis-ci.org/webmachine/webmachine-ruby.svg)](https://travis-ci.org/webmachine/webmachine-ruby)
+# webmachine for Ruby
+ [![Gem Version](https://badge.fury.io/rb/webmachine.svg)](https://badge.fury.io/rb/webmachine)
+ [![Build Status](https://github.com/webmachine/webmachine-ruby/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/webmachine/webmachine-ruby/actions/workflows/test.yml)
 
 webmachine-ruby is a port of
 [Webmachine](https://github.com/basho/webmachine), which is written in
@@ -18,8 +20,7 @@ are up to you.
   requests, and response codes for you.
 * Provides a base resource with points of extension to let you
   describe what is relevant about your particular resource.
-* Supports WEBrick, Reel, HTTPkit, and a Rack shim. Other host
-  servers are being investigated.
+* Supports WEBrick and a Rack shim. Other host servers are being investigated.
 * Streaming/chunked response bodies are permitted as Enumerables,
   Procs, or Fibers!
 * Unlike the Erlang original, it does real Language negotiation.
@@ -163,10 +164,8 @@ the "visual debugger". Learn how to configure it [here][visual-debugger].
 
 ## Related libraries
 
-* [irwebmachine](https://github.com/generalassembly/irwebmachine) - IRB/Pry debugging of Webmachine applications
 * [webmachine-test](https://github.com/bernd/webmachine-test) - Helpers for testing Webmachine applications
 * [webmachine-linking](https://github.com/petejohanson/webmachine-linking) - Helpers for linking between Resources, and Web Linking
-* [webmachine-sprockets](https://github.com/lgierth/webmachine-sprockets) - Integration with Sprockets assets packaging system
 * [webmachine-actionview](https://github.com/rgarner/webmachine-actionview) - Integration of some Rails-style view conventions into Webmachine
 * [jruby-http-kit](https://github.com/nLight/jruby-http-kit) - Includes an adapter for the Clojure-based Ring library/server
 * [newrelic-webmachine](https://github.com/mdub/newrelic-webmachine) - NewRelic instrumentation

data/documentation/adapters.md

@@ -1,7 +1,7 @@
 ### Adapters
 
-Webmachine includes adapters for [WEBrick][webrick], [Reel][reel], and
-[HTTPkit][httpkit]. Additionally, the [Rack][rack] adapter lets it
+Webmachine includes an adapter for [WEBrick][webrick].
+Additionally, the [Rack][rack] adapter lets it
 run on any webserver that provides a Rack interface. It also lets it run on
 [Shotgun][shotgun] ([example][shotgun_example]).
 
@@ -24,16 +24,7 @@ For an example of using Webmachine with Rack middleware, see the [Pact Broker][m
 
 See the [Rack Adapter API docs][rack-adapter-api-docs] for more information.
 
-#### A Note about MRI 1.9
-
-The [Reel][reel] and [HTTPkit][httpkit]
-adapters might crash with a `SystemStackError` on MRI 1.9 due to its
-limited fiber stack size. If your application is affected by this, the
-only known solution is to switch to JRuby, Rubinius or MRI 2.0.
-
 [webrick]: http://rubydoc.info/stdlib/webrick
-[reel]: https://github.com/celluloid/reel
-[httpkit]: https://github.com/lgierth/httpkit
 [rack]: https://github.com/rack/rack
 [shotgun]: https://github.com/rtomayko/shotgun
 [shotgun_example]: https://gist.github.com/4389220

data/documentation/examples.md

@@ -92,12 +92,15 @@ end
 ```
 
 # POST to perform a task
-* Override `allowed_methods` and `process_post`.  Put all the code to be executed in `process_post`.
-* `process_post` must return true, or the HTTP response code
-* Response headers like Content-Type will need to be set manually.
+* Override `allowed_methods`, `process_post`, and `content_types_provided` (if the response has a content type).
+* Rather than providing a method handler in the `content_type_provided` mappings, put all the code to be executed in `process_post`.
+* `process_post` must return true, or the HTTP response code.
 
 ```ruby
 class DispatchOrderResource < Webmachine::Resource
+  def content_types_provided
+    [["application/json"]]
+  end
 
   def allowed_methods
     ["POST"]
@@ -108,9 +111,8 @@ class DispatchOrderResource < Webmachine::Resource
   end
 
   def process_post
-    @order.dispatch
-    response.headers['Content-Type'] = 'text/plain'
-    response.body = "Successfully dispatched order #{id}"
+    @order.dispatch(params['some_param'])
+    response.body = { message: "Successfully dispatched order #{id}" }.to_json
     true
   end
 
@@ -119,6 +121,10 @@ class DispatchOrderResource < Webmachine::Resource
   def id
     request.path_info[:id]
   end
+
+  def params
+    JSON.parse(request.body.to_s)
+  end
 end
 
 ```

data/examples/debugger.rb

@@ -2,21 +2,23 @@ require 'webmachine'
 require 'webmachine/trace'
 
 class MyTracedResource < Webmachine::Resource
-  def trace?; true; end
+  def trace?
+    true
+  end
 
   def resource_exists?
     case request.query['e']
     when 'true'
       true
     when 'fail'
-      raise "BOOM"
+      raise 'BOOM'
     else
       false
     end
   end
 
   def to_html
-    "<html>You found me.</html>"
+    '<html>You found me.</html>'
   end
 end
 

data/examples/logging.rb

@@ -18,7 +18,7 @@ class LogListener
     resource = event.payload[:resource]
     code = event.payload[:code]
 
-    puts "[%s] method=%s uri=%s code=%d resource=%s time=%.4f" % [
+    puts '[%s] method=%s uri=%s code=%d resource=%s time=%.4f' % [
       Time.now.iso8601, request.method, request.uri.to_s, code, resource,
       event.duration
     ]
@@ -34,7 +34,7 @@ App = Webmachine::Application.new do |app|
 
   app.configure do |config|
     config.adapter = :WEBrick
-    config.adapter_options = {:AccessLog => [], :Logger => Logger.new('/dev/null')}
+    config.adapter_options = {AccessLog: [], Logger: Logger.new('/dev/null')}
   end
 end
 

data/examples/webrick.rb

@@ -6,11 +6,11 @@ class HelloResource < Webmachine::Resource
   end
 
   def encodings_provided
-    { "gzip" => :encode_gzip, "identity" => :encode_identity }
+    {'gzip' => :encode_gzip, 'identity' => :encode_identity}
   end
 
   def to_html
-    "<html><head><title>Hello from Webmachine</title></head><body>Hello, world!</body></html>"
+    '<html><head><title>Hello from Webmachine</title></head><body>Hello, world!</body></html>'
   end
 end
 

data/lib/webmachine/adapter.rb

@@ -1,10 +1,8 @@
 module Webmachine
-
   # The abstract class for definining a Webmachine adapter.
   #
   # @abstract Subclass and override {#run} to implement a custom adapter.
   class Adapter
-
     # @return [Webmachine::Application] returns the application
     attr_reader :application
 
@@ -25,6 +23,5 @@ module Webmachine
     def run
       raise NotImplementedError
     end
-
   end
 end

data/lib/webmachine/adapters/lazy_request_body.rb

@@ -24,7 +24,7 @@
       # @yield [chunk]
       # @yieldparam [String] chunk a chunk of the request body
       def each
-        @request.body {|chunk| yield chunk }
+        @request.body { |chunk| yield chunk }
       end
     end # class RequestBody
   end # module Adapters

data/lib/webmachine/adapters/rack.rb

@@ -47,9 +47,9 @@ module Webmachine
       # Start the Rack adapter
       def run
         options = DEFAULT_OPTIONS.merge({
-          :app => self,
-          :Port => application.configuration.port,
-          :Host => application.configuration.ip
+          app: self,
+          Port: application.configuration.port,
+          Host: application.configuration.ip
         }).merge(application.configuration.adapter_options)
 
         @server = ::Rack::Server.new(options)
@@ -69,33 +69,34 @@ module Webmachine
 
         response.headers[SERVER] = VERSION_STRING
 
-        rack_status  = response.code
+        rack_status = response.code
         rack_headers = response.headers.flattened(NEWLINE)
         rack_body = case response.body
-                    when String # Strings are enumerable in ruby 1.8
-                      [response.body]
-                    else
-                      if (io_body = IO.try_convert(response.body))
-                        io_body
-                      elsif response.body.respond_to?(:call)
-                        Webmachine::ChunkedBody.new(Array(response.body.call))
-                      elsif response.body.respond_to?(:each)
-                        # This might be an IOEncoder with a Content-Length, which shouldn't be chunked.
-                        if response.headers[TRANSFER_ENCODING] == "chunked"
-                          Webmachine::ChunkedBody.new(response.body)
-                        else
-                          response.body
-                        end
-                      else
-                        [response.body.to_s]
-                      end
-                    end
+        when String # Strings are enumerable in ruby 1.8
+          [response.body]
+        else
+          if (io_body = IO.try_convert(response.body))
+            io_body
+          elsif response.body.respond_to?(:call)
+            Webmachine::ChunkedBody.new(Array(response.body.call))
+          elsif response.body.respond_to?(:each)
+            # This might be an IOEncoder with a Content-Length, which shouldn't be chunked.
+            if response.headers[TRANSFER_ENCODING] == 'chunked'
+              Webmachine::ChunkedBody.new(response.body)
+            else
+              response.body
+            end
+          else
+            [response.body.to_s]
+          end
+        end
 
         rack_res = RackResponse.new(rack_body, rack_status, rack_headers)
         rack_res.finish
       end
 
       protected
+
       def routing_tokens(rack_req)
         nil # no-op for default, un-mapped rack adapter
       end
@@ -105,28 +106,38 @@ module Webmachine
       end
 
       private
+
       def build_webmachine_request(rack_req, headers)
-        Webmachine::Request.new(rack_req.request_method,
-                                rack_req.url,
-                                headers,
-                                RequestBody.new(rack_req),
-                                routing_tokens(rack_req),
-                                base_uri(rack_req)
-                               )
+        RackRequest.new(rack_req.request_method,
+          rack_req.url,
+          headers,
+          RequestBody.new(rack_req),
+          routing_tokens(rack_req),
+          base_uri(rack_req),
+          rack_req.env)
+      end
+
+      class RackRequest < Webmachine::Request
+        attr_reader :env
+
+        def initialize(method, uri, headers, body, routing_tokens, base_uri, env)
+          super(method, uri, headers, body, routing_tokens, base_uri)
+          @env = env
+        end
       end
 
       class RackResponse
         ONE_FIVE = '1.5'.freeze
 
         def initialize(body, status, headers)
-          @body    = body
-          @status  = status
+          @body = body
+          @status = status
           @headers = headers
         end
 
         def finish
           @headers[CONTENT_TYPE] ||= TEXT_HTML if rack_release_enforcing_content_type
-          @headers.delete(CONTENT_TYPE)        if response_without_body
+          @headers.delete(CONTENT_TYPE) if response_without_body
           [@status, @headers, @body]
         end
 
@@ -178,10 +189,13 @@ module Webmachine
         # @yieldparam [String] chunk a chunk of the request body
         def each
           if @value
-            @value.each {|chunk| yield chunk }
+            @value.each { |chunk| yield chunk }
           else
             @value = []
-            @request.body.each {|chunk| @value << chunk; yield chunk }
+            @request.body.each { |chunk|
+              @value << chunk
+              yield chunk
+            }
           end
         end
       end # class RequestBody

data/lib/webmachine/adapters/rack_mapped.rb

@@ -21,12 +21,11 @@ module Webmachine
     #     end
     #   end
     class RackMapped < Rack
-
       protected
 
       def routing_tokens(rack_req)
         routing_match = rack_req.path_info.match(Webmachine::Request::ROUTING_PATH_MATCH)
-        routing_path = routing_match ? routing_match[1] : ""
+        routing_path = routing_match ? routing_match[1] : ''
         routing_path.split(SLASH)
       end
 

data/lib/webmachine/adapters/webrick.rb

@@ -17,9 +17,9 @@ module Webmachine
       # Starts the WEBrick adapter
       def run
         options = DEFAULT_OPTIONS.merge({
-          :Port => application.configuration.port,
-          :BindAddress => application.configuration.ip,
-          :application => application
+          Port: application.configuration.port,
+          BindAddress: application.configuration.ip,
+          application: application
         }).merge(application.configuration.adapter_options)
         @server = Server.new(options)
         @server.start
@@ -27,7 +27,6 @@ module Webmachine
 
       # WEBRick::HTTPServer that is run by the WEBrick adapter.
       class Server < ::WEBrick::HTTPServer
-
         def initialize(options)
           @application = options[:application]
           super(options)
@@ -36,29 +35,29 @@ module Webmachine
         # Handles a request
         def service(wreq, wres)
           header = Webmachine::Headers.new
-          wreq.each {|k,v| header[k] = v }
+          wreq.each { |k, v| header[k] = v }
           request = Webmachine::Request.new(wreq.request_method,
-                                            wreq.request_uri,
-                                            header,
-                                            LazyRequestBody.new(wreq))
+            wreq.request_uri,
+            header,
+            LazyRequestBody.new(wreq))
 
           response = Webmachine::Response.new
           @application.dispatcher.dispatch(request, response)
           wres.status = response.code.to_i
 
-          headers = response.headers.flattened.reject { |k,v| k == 'Set-Cookie' }
-          headers.each { |k,v| wres[k] = v }
+          headers = response.headers.flattened.reject { |k, v| k == 'Set-Cookie' }
+          headers.each { |k, v| wres[k] = v }
 
           cookies = [response.headers['Set-Cookie'] || []].flatten
           cookies.each { |c| wres.cookies << c }
 
-          wres[SERVER] = [Webmachine::SERVER_STRING, wres.config[:ServerSoftware]].join(" ")
+          wres[SERVER] = [Webmachine::SERVER_STRING, wres.config[:ServerSoftware]].join(' ')
           case response.body
           when String
             wres.body << response.body
           when Enumerable
             wres.chunked = response.headers[TRANSFER_ENCODING] == 'chunked'
-            response.body.each {|part| wres.body << part }
+            response.body.each { |part| wres.body << part }
           else
             if response.body.respond_to?(:call)
               wres.chunked = true

data/lib/webmachine/adapters.rb

@@ -5,7 +5,5 @@ module Webmachine
   # Contains classes and modules that connect Webmachine to Ruby
   # application servers.
   module Adapters
-    autoload :Reel,     'webmachine/adapters/reel'
-    autoload :HTTPkit,  'webmachine/adapters/httpkit'
   end
 end

data/lib/webmachine/application.rb

@@ -43,7 +43,7 @@ module Webmachine
     #   the Application instance being initialized
     def initialize(configuration = Configuration.default, dispatcher = Dispatcher.new)
       @configuration = configuration
-      @dispatcher    = dispatcher
+      @dispatcher = dispatcher
 
       yield self if block_given?
     end
@@ -73,7 +73,7 @@ module Webmachine
     #
     # @see Webmachine::Dispatcher#add_route
     def routes(&block)
-      if block_given?
+      if block
         dispatcher.instance_eval(&block)
         self
       else

data/lib/webmachine/chunked_body.rb

@@ -29,7 +29,7 @@ module Webmachine
     # parameter.
     # Returns an {Enumerator} if no block is given.
     def each
-      return self.to_enum unless block_given?
+      return to_enum unless block_given?
 
       @body.each do |chunk|
         size = chunk.bytesize

data/lib/webmachine/configuration.rb

@@ -12,7 +12,7 @@ module Webmachine
 
   # @return [Configuration] the default configuration
   def Configuration.default
-    new("0.0.0.0", 8080, :WEBrick, {})
+    new('0.0.0.0', 8080, :WEBrick, {})
   end
 
   # Yields the current configuration to the passed block.

data/lib/webmachine/constants.rb

@@ -28,20 +28,20 @@
 
   MATCHES_ALL = '*/*'.freeze
 
-  GET_METHOD     = "GET"
-  HEAD_METHOD    = "HEAD"
-  POST_METHOD    = "POST"
-  PUT_METHOD     = "PUT"
-  DELETE_METHOD  = "DELETE"
-  OPTIONS_METHOD = "OPTIONS"
-  TRACE_METHOD   = "TRACE"
-  CONNECT_METHOD = "CONNECT"
+  GET_METHOD = 'GET'
+  HEAD_METHOD = 'HEAD'
+  POST_METHOD = 'POST'
+  PUT_METHOD = 'PUT'
+  DELETE_METHOD = 'DELETE'
+  OPTIONS_METHOD = 'OPTIONS'
+  TRACE_METHOD = 'TRACE'
+  CONNECT_METHOD = 'CONNECT'
 
   STANDARD_HTTP_METHODS = [
-                           GET_METHOD, HEAD_METHOD, POST_METHOD,
-                           PUT_METHOD, DELETE_METHOD, TRACE_METHOD,
-                           CONNECT_METHOD, OPTIONS_METHOD
-                          ].map!(&:freeze)
+    GET_METHOD, HEAD_METHOD, POST_METHOD,
+    PUT_METHOD, DELETE_METHOD, TRACE_METHOD,
+    CONNECT_METHOD, OPTIONS_METHOD
+  ].map!(&:freeze)
   STANDARD_HTTP_METHODS.freeze
 
   # A colon
@@ -59,8 +59,8 @@
   # Charset string
   CHARSET = 'Charset'.freeze
 
-  # Semicolon split match
-  SPLIT_SEMI = /\s*,\s*/.freeze
+  # Comma split match
+  SPLIT_COMMA = /\s*,\s*/.freeze
 
   # Star Character
   STAR = '*'.freeze

data/lib/webmachine/cookie.rb

@@ -11,7 +11,7 @@ module Webmachine
     def self.parse(cstr, include_dups = false)
       cookies = {}
       (cstr || '').split(/\s*[;,]\s*/n).each { |c|
-        k,v = c.split(/\s*=\s*/, 2).map { |s| unescape(s) }
+        k, v = c.split(/\s*=\s*/, 2).map { |s| unescape(s) }
 
         case cookies[k]
         when nil
@@ -31,7 +31,7 @@ module Webmachine
     # Allowed keys for the attributes parameter of
     # {Webmachine::Cookie#initialize}
     ALLOWED_ATTRIBUTES = [:secure, :httponly, :path, :domain,
-                          :comment, :maxage, :expires, :version]
+      :comment, :maxage, :expires, :version]
 
     # If the cookie is HTTP only
     def http_only?
@@ -83,32 +83,34 @@ module Webmachine
       attributes = ALLOWED_ATTRIBUTES.select { |a| @attributes[a] }.map do |a|
         case a
         when :httponly
-          "HttpOnly" if @attributes[a]
+          'HttpOnly' if @attributes[a]
         when :secure
-          "Secure" if @attributes[a]
+          'Secure' if @attributes[a]
         when :maxage
-          "Max-Age=" + @attributes[a].to_s
+          'Max-Age=' + @attributes[a].to_s
         when :expires
-          "Expires=" + rfc2822(@attributes[a])
+          'Expires=' + rfc2822(@attributes[a])
         when :comment
-          "Comment=" + escape(@attributes[a].to_s)
+          'Comment=' + escape(@attributes[a].to_s)
         else
-          a.to_s.sub(/^\w/) { $&.capitalize } + "="  + @attributes[a].to_s
+          a.to_s.sub(/^\w/) { $&.capitalize } + '=' + @attributes[a].to_s
         end
       end
 
-      ([escape(name) + "=" + escape(value)] + attributes).join("; ")
+      ([escape(name) + '=' + escape(value)] + attributes).join('; ')
     end
 
     private
 
+    # Format timestamps for the 'Expires' portion of the cookie string, as per RFC 2822 and 2616.
+    #
+    # @see https://www.rfc-editor.org/rfc/rfc2616#section-3.3.1
+    # @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Expires
     def rfc2822(time)
-      wday = Time::RFC2822_DAY_NAME[time.wday]
-      mon = Time::RFC2822_MONTH_NAME[time.mon - 1]
-      time.strftime("#{wday}, %d-#{mon}-%Y %H:%M:%S GMT")
+      time.strftime('%a, %d %b %Y %T GMT')
     end
 
-    if URI.respond_to?(:decode_www_form_component) and defined?(::Encoding)
+    if URI.respond_to?(:decode_www_form_component) && defined?(::Encoding)
       # Escape a cookie
       def escape(s)
         URI.encode_www_form_component(s)
@@ -132,7 +134,7 @@ module Webmachine
       # @private
       TBLDECWWWCOMP_ = {}
       256.times do |i|
-        h, l = i>>4, i&15
+        h, l = i >> 4, i & 15
         TBLDECWWWCOMP_['%%%X%X' % [h, l]] = i.chr
         TBLDECWWWCOMP_['%%%x%X' % [h, l]] = i.chr
         TBLDECWWWCOMP_['%%%X%x' % [h, l]] = i.chr
@@ -146,9 +148,9 @@ module Webmachine
       # This decodes + to SP.
       #
       # @private
-      def self.unescape(str, enc=nil)
-        raise ArgumentError, "invalid %-encoding (#{str})" unless /\A(?:%\h\h|[^%]+)*\z/ =~ str
-        str.gsub(/\+|%\h\h/){|c| TBLDECWWWCOMP_[c] }
+      def self.unescape(str, enc = nil)
+        raise ArgumentError, "invalid %-encoding (#{str})" unless /\A(?:%\h\h|[^%]+)*\z/.match?(str)
+        str.gsub(/\+|%\h\h/) { |c| TBLDECWWWCOMP_[c] }
       end
 
       # Encode given +str+ to URL-encoded form data.
@@ -161,7 +163,7 @@ module Webmachine
       #
       # @private
       def escape(str)
-        str.to_s.gsub(/[^*\-.0-9A-Z_a-z]/){|c| TBLENCWWWCOMP_[c] }
+        str.to_s.gsub(/[^*\-.0-9A-Z_a-z]/) { |c| TBLENCWWWCOMP_[c] }
       end
     end
   end