webmachine 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9309a2f44549ae1c912684fcdc7f60d31404bbf3
-  data.tar.gz: 9531f40a275a2bf5e2bda7ed4816ff2463e4c234
+SHA256:
+  metadata.gz: edddc1a3a4d7be22971484644cbf1bece06b2ba0f95ab5c8a3ed08cf485982b2
+  data.tar.gz: 4a1e642ad3fb3a1a57e8eee886393802f7b85f8ecb81bf9f06812577fe253840
 SHA512:
-  metadata.gz: 5f5e9419fadcf121f8e0e80ec41417bd5dd9f096933aaf06793dd18d9d6ac6f5e2d028f56e0bc105ff5a87f9b2aa7ebc72e1d61424cc8c88d76e7cb92b9655a0
-  data.tar.gz: d79442bba70911a7b704a26135a2fcadc4dbc1f0a0e12197d1ddbfb055498c54e164e972b03479d7428839ceef15bf32faa070b7ace58fc4b76704bdc5ec7bf8
+  metadata.gz: 89062ab939aadad0f1a41d3c3b85d030acf0e4668b5d06b0c65ad4a4425284bdaf60ece3af7e76f2b9eacc02cf2052f657cfb491372fef62463dad4324933617
+  data.tar.gz: 0a6078e13d68abaa7692675f5057e3b69d06dd5311d6e662a176490f427b6d1a1053bd3e5e0ed82fa9536eab421f05285e54939a2c900ca364347a361c21b21a

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 ### HEAD
 
+### 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/Gemfile

@@ -12,11 +12,13 @@ group :test do
   gem "rspec-its", "~> 1.2"
   gem "rack", "~> 2.0"
   gem "rack-test", "~> 0.7"
+  gem "websocket_parser", "~>1.0"
 end
 
 group :webservers do
   gem 'reel', '~> 0.5.0'
   gem 'http', '~> 0.6.0'
+  gem 'celluloid', '0.17.4' # Refactors in 0.18.0 break the tests
   gem 'httpkit', :platform => [:mri, :rbx]
 end
 

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://travis-ci.org/webmachine/webmachine-ruby.svg)](https://travis-ci.org/webmachine/webmachine-ruby)
 
 webmachine-ruby is a port of
 [Webmachine](https://github.com/basho/webmachine), which is written in

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/lib/webmachine/adapters/rack.rb

@@ -106,15 +106,25 @@ module Webmachine
 
       private
       def build_webmachine_request(rack_req, headers)
-        Webmachine::Request.new(rack_req.request_method,
+        RackRequest.new(rack_req.request_method,
                                 rack_req.url,
                                 headers,
                                 RequestBody.new(rack_req),
                                 routing_tokens(rack_req),
-                                base_uri(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
 

data/lib/webmachine/constants.rb

@@ -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/decision/conneg.rb

@@ -14,7 +14,7 @@ module Webmachine
       # appropriate media type.
       # @api private
       def choose_media_type(provided, header)
-        types = Array(header).map{|h| h.split(SPLIT_SEMI) }.flatten
+        types = Array(header).map{|h| h.split(SPLIT_COMMA) }.flatten
         requested = MediaTypeList.build(types)
         provided = provided.map do |p| # normalize_provided
           MediaType.parse(p)
@@ -57,7 +57,7 @@ module Webmachine
       # @api private
       def choose_language(provided, header)
         if provided && !provided.empty?
-          requested = PriorityList.build(header.split(SPLIT_SEMI))
+          requested = PriorityList.build(header.split(SPLIT_COMMA))
           star_priority = requested.priority_of(STAR)
           any_ok = star_priority && star_priority > 0.0
           accepted = requested.find do |priority, range|
@@ -99,7 +99,7 @@ module Webmachine
       # @api private
       def do_choose(choices, header, default)
         choices = choices.dup.map {|s| s.downcase }
-        accepted = PriorityList.build(header.split(SPLIT_SEMI))
+        accepted = PriorityList.build(header.split(SPLIT_COMMA))
         default_priority = accepted.priority_of(default)
         star_priority = accepted.priority_of(STAR)
         default_ok = (default_priority.nil? && star_priority != 0.0) || default_priority

data/lib/webmachine/decision/flow.rb

@@ -245,7 +245,7 @@ module Webmachine
 
       # ETag in If-Match
       def g11
-        request_etags = request.if_match.split(SPLIT_SEMI).map {|etag| ETag.new(etag) }
+        request_etags = request.if_match.split(SPLIT_COMMA).map {|etag| ETag.new(etag) }
         request_etags.include?(ETag.new(resource.generate_etag)) ? :h10 : 412
       end
 
@@ -327,7 +327,7 @@ module Webmachine
 
       # Etag in if-none-match?
       def k13
-        request_etags = request.if_none_match.split(SPLIT_SEMI).map {|etag| ETag.new(etag) }
+        request_etags = request.if_none_match.split(SPLIT_COMMA).map {|etag| ETag.new(etag) }
         resource_etag = resource.generate_etag
         if resource_etag && request_etags.include?(ETag.new(resource_etag))
            :j18

data/lib/webmachine/dispatcher/route.rb

@@ -120,7 +120,7 @@ module Webmachine
           when tokens.empty?
             return false
           when Regexp === spec.first
-            matches = spec.first.match URI.decode(tokens.first)
+            matches = spec.first.match Route.rfc3986_percent_decode(tokens.first)
             if matches
               if spec.first.named_captures.empty?
                 bindings[:captures] = (bindings[:captures] || []) + matches.captures
@@ -134,7 +134,7 @@ module Webmachine
               return false
             end
           when Symbol === spec.first
-            bindings[spec.first] = URI.decode(tokens.first)
+            bindings[spec.first] = Route.rfc3986_percent_decode(tokens.first)
           when spec.first == tokens.first
           else
             return false
@@ -145,6 +145,20 @@ module Webmachine
         end
       end
 
+      # Decode a string using the scheme described in RFC 3986 2.1. Percent-Encoding (https://www.ietf.org/rfc/rfc3986.txt)
+      def self.rfc3986_percent_decode(value)
+        s = StringScanner.new(value)
+        result = ''
+        until s.eos?
+          encoded_val = s.scan(/%([0-9a-fA-F]){2}/)
+          result << if encoded_val.nil?
+            s.getch
+          else
+            [encoded_val[1..-1]].pack('H*')
+          end
+        end
+        result
+      end
     end # class Route
   end # module Dispatcher
 end # module Webmachine

data/lib/webmachine/spec/test_resource.rb

@@ -19,7 +19,8 @@ module Test
         ["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.request_uri", :to_request_uri],
+        ["test/response.rack_env", :to_rack_env]
       ]
     end
 
@@ -75,5 +76,9 @@ module Test
     def to_request_uri
       request.uri.to_s
     end
+
+    def to_rack_env
+      request.env.to_json
+    end
   end
 end

data/lib/webmachine/version.rb

@@ -1,6 +1,6 @@
 module Webmachine
   # Library version
-  VERSION = "1.5.0".freeze
+  VERSION = "1.6.0".freeze
 
   # String for use in "Server" HTTP response header, which includes
   # the {VERSION}.

data/spec/webmachine/adapters/rack_spec.rb

@@ -53,5 +53,10 @@ describe Webmachine::Adapters::Rack do
       rack_response = get "test", nil, {"HTTP_ACCEPT" => "test/response.request_uri"}
       expect(rack_response.body).to eq "http://example.org/test"
     end
+
+    it "provides the rack env on the request" do
+      rack_response = get "test", nil, {"HTTP_ACCEPT" => "test/response.rack_env"}
+      expect(JSON.parse(rack_response.body).keys).to include "rack.input"
+    end
   end
 end

data/spec/webmachine/decision/fsm_spec.rb

@@ -106,7 +106,7 @@ describe Webmachine::Decision::FSM do
     end
 
     it 'does not call resource.finish_request again' do
-      expect(resource).to_not receive(:finish_request).once { raise }
+      expect(resource).to receive(:finish_request).once
       run_with_exception
     end
   end

data/spec/webmachine/dispatcher/rfc3986_percent_decode_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Webmachine::Dispatcher::Route do
+  describe '#rfc3986_percent_decode' do
+    def call_subject(value)
+      Webmachine::Dispatcher::Route.rfc3986_percent_decode(value)
+    end
+
+    it 'does not change un-encoded strings' do
+      expect(call_subject('this is a normal string, I think')).to eq 'this is a normal string, I think'
+      expect(call_subject('')).to eq ''
+    end
+
+    it 'decodes percent encoded sequences' do
+      expect(call_subject('/tenants/esckimo+test%20%65')).to eq '/tenants/esckimo+test e'
+    end
+
+    it 'leaves incorrectly encoded sequences as is' do
+      expect(call_subject('/tenants/esckimo+test%2%65')).to eq '/tenants/esckimo+test%2e'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webmachine
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Sean Cribbs
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-07 00:00:00.000000000 Z
+date: 2021-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -70,7 +70,6 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
-- bethtemp
 - documentation/adapters.md
 - documentation/authentication-and-authorization.md
 - documentation/configurator.md
@@ -148,7 +147,6 @@ files:
 - lib/webmachine/translation.rb
 - lib/webmachine/version.rb
 - memory_test.rb
-- pkg/webmachine-1.5.0.gem
 - spec/spec_helper.rb
 - spec/webmachine/adapter_spec.rb
 - spec/webmachine/adapters/httpkit_spec.rb
@@ -165,6 +163,7 @@ files:
 - spec/webmachine/decision/flow_spec.rb
 - spec/webmachine/decision/fsm_spec.rb
 - spec/webmachine/decision/helpers_spec.rb
+- spec/webmachine/dispatcher/rfc3986_percent_decode_spec.rb
 - spec/webmachine/dispatcher/route_spec.rb
 - spec/webmachine/dispatcher_spec.rb
 - spec/webmachine/errors_spec.rb
@@ -185,7 +184,7 @@ homepage: http://github.com/seancribbs/webmachine-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -200,41 +199,41 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: webmachine is a toolkit for building HTTP applications,
 test_files:
 - spec/spec_helper.rb
+- spec/webmachine/trace/fsm_spec.rb
+- spec/webmachine/trace/resource_proxy_spec.rb
+- spec/webmachine/trace/trace_store_spec.rb
+- spec/webmachine/configuration_spec.rb
+- spec/webmachine/dispatcher/route_spec.rb
+- spec/webmachine/dispatcher/rfc3986_percent_decode_spec.rb
+- spec/webmachine/rescueable_exception_spec.rb
+- spec/webmachine/etags_spec.rb
+- spec/webmachine/chunked_body_spec.rb
 - spec/webmachine/adapter_spec.rb
-- spec/webmachine/adapters/httpkit_spec.rb
-- spec/webmachine/adapters/rack_mapped_spec.rb
-- spec/webmachine/adapters/rack_spec.rb
+- spec/webmachine/headers_spec.rb
 - spec/webmachine/adapters/reel_spec.rb
+- spec/webmachine/adapters/rack_spec.rb
+- spec/webmachine/adapters/httpkit_spec.rb
 - spec/webmachine/adapters/webrick_spec.rb
-- spec/webmachine/application_spec.rb
-- spec/webmachine/chunked_body_spec.rb
-- spec/webmachine/configuration_spec.rb
-- spec/webmachine/cookie_spec.rb
-- spec/webmachine/decision/conneg_spec.rb
+- spec/webmachine/adapters/rack_mapped_spec.rb
+- spec/webmachine/request_spec.rb
+- spec/webmachine/response_spec.rb
+- spec/webmachine/decision/fsm_spec.rb
 - spec/webmachine/decision/falsey_spec.rb
 - spec/webmachine/decision/flow_spec.rb
-- spec/webmachine/decision/fsm_spec.rb
 - spec/webmachine/decision/helpers_spec.rb
-- spec/webmachine/dispatcher/route_spec.rb
-- spec/webmachine/dispatcher_spec.rb
-- spec/webmachine/errors_spec.rb
-- spec/webmachine/etags_spec.rb
-- spec/webmachine/events_spec.rb
-- spec/webmachine/headers_spec.rb
+- spec/webmachine/decision/conneg_spec.rb
+- spec/webmachine/cookie_spec.rb
 - spec/webmachine/media_type_spec.rb
-- spec/webmachine/request_spec.rb
-- spec/webmachine/rescueable_exception_spec.rb
+- spec/webmachine/errors_spec.rb
 - spec/webmachine/resource/authentication_spec.rb
-- spec/webmachine/response_spec.rb
-- spec/webmachine/trace/fsm_spec.rb
-- spec/webmachine/trace/resource_proxy_spec.rb
-- spec/webmachine/trace/trace_store_spec.rb
 - spec/webmachine/trace_spec.rb
+- spec/webmachine/application_spec.rb
+- spec/webmachine/events_spec.rb
+- spec/webmachine/dispatcher_spec.rb
 - ".gitignore"

data/bethtemp

@@ -1,3 +0,0 @@
-  * use Integer instead of Fixnum (removes deprecation warnings in Ruby 2.4)
-  * Fixing multiple cookie setting code
-  * Added support for named captures