webmachine 1.2.2 → 1.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: edddc1a3a4d7be22971484644cbf1bece06b2ba0f95ab5c8a3ed08cf485982b2
+  data.tar.gz: 4a1e642ad3fb3a1a57e8eee886393802f7b85f8ecb81bf9f06812577fe253840
+SHA512:
+  metadata.gz: 89062ab939aadad0f1a41d3c3b85d030acf0e4668b5d06b0c65ad4a4425284bdaf60ece3af7e76f2b9eacc02cf2052f657cfb491372fef62463dad4324933617
+  data.tar.gz: 0a6078e13d68abaa7692675f5057e3b69d06dd5311d6e662a176490f427b6d1a1053bd3e5e0ed82fa9536eab421f05285e54939a2c900ca364347a361c21b21a

data/.gitignore

@@ -26,3 +26,6 @@ Gemfile.lock
 **/bin
 *.rbc
 .rvmrc
+.SyncID
+.SyncIgnore
+vendor

data/CHANGELOG.md

@@ -1,3 +1,60 @@
+### 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
+* Improved logic for determining which errors are 'rescuable' by Webmachine,
+  and which are 'unhandlable'.
+
+### 1.4.0 March 20, 2015
+
+* Added RackMapped adapter which allows Webmachine apps to be mounted
+  at a non-root path using Rack::Map.
+  Thanks to [Julian Doherty](https://github.com/madlep) for writing this.
+
+### 1.3.1 January 15, 2015
+
+* Fixed URI construction, including handling IPv6 addresses, when the
+  adapter did not supply a complete hostname.
+* Removed dependency of Rack Adapter on REQUEST_INFO rack environment
+  variable which was not always present.
+* Use IPAddr instead of Addrinfo as rbx does not support Addrinfo.
+
+### 1.3.0 January 3, 2015
+
+1.3.0 is a feature and bugfix release that removes two adapters,
+reduces memory usage, fixes bugs, and includes a bunch of new
+documentation. Thank you to our new contributor @rpag!
+
+* Greatly reduced per-request garbage by freezing commonly used
+  Strings and Regexps into constants.
+* Tutorial/example documentation was extracted from the README and
+  extended in the `documentation` directory.
+* HTTPkit adapter was added.
+* Hatetepe and Mongrel adapters were removed and adapters no longer
+  install interrupt handlers.
+* The "splat" matcher in path specifications is now a Symbol `:*`
+  rather than a String `"*"`. Using the String version will result in
+  a deprecation warning.
+* Requests with If-None-Match where the resource does not supply an
+  ETag will no longer respond with 412 or 500, but follow the success
+  path.
+* Path fragments are now decoded.
+* Simplified the interaction between the decision FSM and tracing.
+* Updated specs to use RSpec 3.
+* Improved handling of IO.copy_stream on Rack servers.
+* Updated the Reel adapter.
+* Exposed Application instance to the Adapter.
+* Decode the value of the header 'Content-MD5' as base64-encoded string.
+
 ### 1.2.2 January 8, 2014
 
 1.2.2 is a bugfix/patch release that expands functionality with some edge

data/Gemfile

@@ -1,24 +1,34 @@
 require 'rbconfig'
-
 source 'https://rubygems.org'
-
 gemspec
 
-gem 'bundler'
+group :development do
+  gem "yard", "~> 0.9"
+  gem "rake", "~> 12.0"
+end
+
+group :test do
+  gem "rspec", "~> 3.0", ">= 3.6.0"
+  gem "rspec-its", "~> 1.2"
+  gem "rack", "~> 2.0"
+  gem "rack-test", "~> 0.7"
+  gem "websocket_parser", "~>1.0"
+end
 
 group :webservers do
-  gem 'mongrel',  '~> 1.2.beta', :platform => [:mri, :rbx]
-  gem 'reel', '~> 0.4.0.pre5'
-  gem 'hatetepe', '~> 0.5.2'
+  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
 
 group :guard do
-  gem 'guard-rspec'
+  gem 'guard-rspec', '~> 4.7'
   case RbConfig::CONFIG['host_os']
   when /darwin/
-    gem 'rb-fsevent'
+    gem 'rb-fsevent', '~> 0.10'
     # gem 'growl_notify'
-    gem 'growl'
+    gem 'growl', '~> 1.0'
   when /linux/
     gem 'rb-inotify'
     gem 'libnotify'
@@ -27,15 +37,10 @@ end
 
 group :docs do
   platform :mri_19, :mri_20 do
-    gem 'redcarpet'
+    gem 'redcarpet', '~> 3.4'
   end
 end
 
 platforms :jruby do
   gem 'jruby-openssl'
 end
-
-platform :rbx do
-  gem 'rubysl'
-  gem 'racc'
-end

data/README.md

@@ -1,12 +1,15 @@
-# webmachine for Ruby [![travis](https://travis-ci.org/seancribbs/webmachine-ruby.png?branch=master)](http://travis-ci.org/seancribbs/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
 Erlang.  The goal of both projects is to expose interesting parts of
 the HTTP protocol to your application in a declarative way.  This
-means that you are less concerned with handling requests directly and
-more with describing the behavior of the resources that make up your
-application. Webmachine is not a web framework _per se_, but more of a
+means that you are less concerned with the procedures involved in handling
+requests directly and more with describing facts about the resources
+that make up your application.
+Webmachine is not a web framework _per se_, but more of a
 toolkit for building HTTP-friendly applications. For example, it does
 not provide a templating engine or a persistence layer; those choices
 are up to you.
@@ -15,46 +18,34 @@ are up to you.
 
 * Handles the hard parts of content negotiation, conditional
   requests, and response codes for you.
-* Most callbacks can interrupt the decision flow by returning an
-  integer response code. You generally only want to do this when new
-  information comes to light, requiring a modification of the response.
-* Supports WEBrick and Mongrel (1.2pre+), and a Rack shim. Other host
+* 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.
 * Streaming/chunked response bodies are permitted as Enumerables,
   Procs, or Fibers!
 * Unlike the Erlang original, it does real Language negotiation.
-* Includes the visual debugger so you can look through the decision
+* Includes a visual debugger so you can look through the decision
   graph to determine how your resources are behaving.
 
 ## Documentation & Finding Help
 
+* [How it works](/documentation/how-it-works.md) - understand how Webmachine works and the basics of creating a resource.
+* [Example resources][example-resources] showing how to implement each HTTP method.
+* [Routes][routes]
+* [Authentication and authorization][authentication-and-authorization]
+* [Validation][validation]
+* [Error handling][error-handling]
+* [Visual debugger][visual-debugger]
+* [Configurator][configurator]
+* [Webserver adapters][adapters]
+* [Versioning APIs][versioning-apis]
 * [API documentation](http://rubydoc.info/gems/webmachine/frames/file/README.md)
 * [Mailing list](mailto:webmachine.rb@librelist.com)
 * IRC channel #webmachine on freenode
 
-## A Note about Rack
-
-In order to be compatible with popular deployment stacks,
-Webmachine has a [Rack](https://github.com/rack/rack) adapter (thanks to Jamis Buck).
-**n.b.:** We recommend that NO middleware is used. The
-behaviors that are encapsulated in Webmachine assume that no modifications
-are done to requests or response outside of Webmachine.
-
-## A Note about MRI 1.9
-
-The [Reel](https://github.com/celluloid/reel) and [Hatetepe](https://github.com/lgierth/hatetepe)
-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.
-
-
 ## Getting Started
 
-[GiddyUp](https://github.com/basho/giddyup) is an actively
-developed webmachine-ruby app that is in production. You
-can look there for an example of how to write and structure a
-webmachine-ruby app (although it is hacky in places).
-
 Below we go through some examples of how to do basic things
 with webmachine-ruby.
 
@@ -71,8 +62,11 @@ There are many other HTTP features exposed to a resource through
 of the decision tree Webmachine implements, and the decision tree
 is what makes Webmachine unique and powerful.
 
+### A simple static  HTML resource
+
 ```ruby
 require 'webmachine'
+
 class MyResource < Webmachine::Resource
   def to_html
     "<html><body>Hello, world!</body></html>"
@@ -83,6 +77,39 @@ end
 MyResource.run
 ```
 
+### A simple dynamic JSON Resource
+
+```ruby
+require 'webmachine'
+require 'widget'
+
+class MyResource < Webmachine::Resource
+
+  # GET and HEAD are allowed by default, but are shown here for clarity.
+  def allowed_methods
+    ['GET','HEAD']
+  end
+
+  def content_types_provided
+    [['application/json', :to_json]]
+  end
+
+  # Return a Truthy or Falsey value
+  def resource_exists?
+    widget
+  end
+
+  def widget
+    @widget ||= Widget.find(request.path_info[:id])
+  end
+
+  def to_json
+    widget.to_json
+  end
+end
+
+```
+
 ### Router
 
 The router is used to map a resource to a given path. To map the class `MyResource` to
@@ -97,92 +124,54 @@ end
 Webmachine.application.run
 ```
 
-### Application/Configurator
-
-There's a configurator that allows you to set what IP address and port
-a web server should bind to as well as what web server should serve a
-webmachine resource.
-
-A call to `Webmachine::Application#configure` returns a `Webmachine::Application` instance,
-so you could chain other method calls if you like. If you don't want to create your own separate
-application object `Webmachine.application` will return a global one.
+When the resource needs to be mapped with variables that will be passed into the resource, use symbols to identify which path components are variables.
 
 ```ruby
-require 'webmachine'
-require 'my_resource'
 
-Webmachine.application.configure do |config|
-  config.ip = '127.0.0.1'
-  config.port = 3000
-  config.adapter = :Mongrel
+Webmachine.application.routes do
+  add ['myresource', :id], MyResource
 end
 
-# Start a web server to serve requests via localhost
-Webmachine.application.run
 ```
 
-Webmachine includes adapters for [Webrick][webrick], [Mongrel][mongrel],
-[Reel][reel], and [Hatetepe][hatetepe]. 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]).
-
-[webrick]: http://rubydoc.info/stdlib/webrick
-[mongrel]: https://github.com/evan/mongrel
-[reel]: https://github.com/celluloid/reel
-[hatetepe]: https://github.com/lgierth/hatetepe
-[rack]: https://github.com/rack/rack
-[shotgun]: https://github.com/rtomayko/shotgun
-[shotgun_example]: https://gist.github.com/4389220
-
-### Visual debugger
-
-It can be hard to understand all of the decisions that Webmachine
-makes when servicing a request to your resource, which is why we have
-the "visual debugger". In development, you can turn on tracing of the
-decision graph for a resource by implementing the `#trace?` callback
-so that it returns true:
+To add more components to the URL mapping, simply add them to the array.
 
 ```ruby
-class MyTracedResource < Webmachine::Resource
-  def trace?
-    true
-  end
 
-  # The rest of your callbacks...
+Webmachine.application.routes do
+  add ['myparentresource', :parent_id, 'myresource', :id], MyResource
 end
+
 ```
 
-Then enable the visual debugger resource by adding a route to your
-configuration:
+Read more about routing [here][routes].
 
-```ruby
-Webmachine.application.routes do
-  # This can be any path as long as it ends with '*'
-  add ['trace', '*'], Webmachine::Trace::TraceResource
-  # The rest of your routes...
-end
-```
+### Application/Configurator
+
+There is a configurator that allows you to set what IP address and port
+a web server should bind to as well as what web server should serve a
+webmachine resource. Learn how to configure your application [here][configurator].
 
-Now when you visit your traced resource, a trace of the request
-process will be recorded in memory. Open your browser to `/trace` to
-list the recorded traces and inspect the result. The response from your
-traced resource will also include the `X-Webmachine-Trace-Id` that you
-can use to lookup the trace. It might look something like this:
 
-![preview calls at decision](http://seancribbs-skitch.s3.amazonaws.com/Webmachine_Trace_2156885920-20120625-100153.png)
+### Adapters
 
-Refer to
-[examples/debugger.rb](/examples/debugger.rb)
-for an example of how to enable the debugger.
+Webmachine provides adapters for many popular webservers. Learn more [here][adapters].
+
+### Visual debugger
+
+It can be hard to understand all of the decisions that Webmachine
+makes when servicing a request to your resource, which is why we have
+the "visual debugger". Learn how to configure it [here][visual-debugger].
 
 ## Related libraries
 
-* [irwebmachine](https://github.com/robgleeson/irwebmachine) - IRB/Pry debugging of Webmachine applications
+* [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
 
 ## LICENSE
 
@@ -190,3 +179,12 @@ webmachine-ruby is licensed under the
 [Apache v2.0 license](http://www.apache.org/licenses/LICENSE-2.0). See
 LICENSE for details.
 
+[example-resources]: /documentation/examples.md
+[versioning-apis]: /documentation/versioning-apis.md
+[routes]: /documentation/routes.md
+[error-handling]: /documentation/error-handling.md
+[authentication-and-authorization]: /documentation/authentication-and-authorization.md
+[adapters]: /documentation/adapters.md
+[visual-debugger]: /documentation/visual-debugger.md
+[configurator]: /documentation/configurator.md
+[validation]: /documentation/validation.md

data/RELEASING.md

@@ -0,0 +1,21 @@
+1. Open `CHANGELOG.md` and summarize the changes made since the last release (hopefully better than the individual commit messages). The history can be grabbed with a simple git command (assuming the last version was 1.3.0:
+
+        $ git log --pretty=format:'  * %s' v1.3.0..HEAD
+
+2. Edit the version in `lib/webmachine/version.rb` according to semantic versioning rules.
+3. Commit both files.
+
+        $ git add CHANGELOG.md lib/webmachine/version.rb
+        $ git commit -m "chore(release): version $(ruby -r ./lib/webmachine/version.rb -e "puts Webmachine::VERSION")" && git push
+
+4. Release the gem.
+
+        $ bundle exec rake release
+
+5. If this is a new major or minor release, push a new stable branch, otherwise merge the commit into the stable branch (or master, depending on where you made the commit).
+
+        $ git push origin HEAD:1.3-stable
+        # or
+        $ git checkout 1.3-stable; git merge master; git push origin; git checkout master
+
+6. YOU'RE DONE!

data/Rakefile

@@ -1,5 +1,4 @@
-require 'rubygems'
-require 'rubygems/package_task'
+require "bundler/gem_tasks"
 
 begin
   require 'yard'
@@ -11,26 +10,12 @@ begin
 rescue LoadError
 end
 
-def gemspec
-  $webmachine_gemspec ||= Gem::Specification.load("webmachine.gemspec")
+desc "Validate the gemspec file."
+task :validate_gemspec do
+  Gem::Specification.load("webmachine.gemspec").validate
 end
 
-Gem::PackageTask.new(gemspec) do |pkg|
-  pkg.need_zip = false
-  pkg.need_tar = false
-end
-
-task :gem => :gemspec
-
-desc %{Validate the gemspec file.}
-task :gemspec do
-  gemspec.validate
-end
-
-desc %{Release the gem to RubyGems.org}
-task :release => :gem do
-  system "gem push pkg/#{gemspec.name}-#{gemspec.version}.gem"
-end
+task :build => :validate_gemspec
 
 desc "Cleans up white space in source files"
 task :clean_whitespace do
@@ -51,7 +36,6 @@ task :clean_whitespace do
   end
 end
 
-require 'rspec/core'
 require 'rspec/core/rake_task'
 
 desc "Run specs"