src/ring/adapter/httpcore.clj src/ring/adapter/jetty.clj src/ring/example/hello_world.clj src/ring/example/linted.clj src/ring/example/public/clojure.png src/ring/example/wrapping.clj src/ring/handler/dump.clj src/ring/middleware/file.clj src/ring/middleware/file_info.clj src/ring/middleware/lint.clj src/ring/middleware/reload.clj src/ring/middleware/stacktrace.clj src/ring/middleware/static.clj test/ring/handler/dump_test.clj test/ring/middleware/file_info_test.clj test/ring/middleware/file_test.clj test/ring/middleware/lint_test.clj test/ring/middleware/reload_test.clj test/ring/middleware/stacktrace_test.clj test/ring/middleware/static_test.clj @@ -1 +1 @@ -bundle \ No newline at end of file +bundle .gitignore @@ -1,51 +1,68 @@ h1. Ring -Ring is a Clojure web applications library inspired by Python's WSGI and Ruby's Rack. By abstracting the details of HTTP into a simple, unified API, Ring allows web applications to be constructed of modular components that can be shared among a variety of applications, web servers, and web frameworks. +Ring is a Clojure web applications library inspired by Python's WSGI and Ruby's +Rack. By abstracting the details of HTTP into a simple, unified API, Ring allows +web applications to be constructed of modular components that can be shared among +a variety of applications, web servers, and web frameworks. -The @SPEC@ file at the root of this distribution for provides a complete description of the Ring interface. +The @SPEC@ file at the root of this distribution for provides a complete +description of the Ring interface. -h2. Quick Setup +h2. Quick Start -First clone the Ring source: +First clone the Ring source and download Ring's dependencies: git clone git://github.com/mmcgrana/ring.git - cd ring - -Then download the needed dependencies: - + cd ring ant deps -The @deps@ ant target downloads all Ring dependencies and unpacks them to @deps/@. To see a live "Hello World" Ring app, run: +To see a live "Hello World" Ring app, run: java -Djava.ext.dirs=deps clojure.main src/ring/examples/hello_world.clj -then visit @http://localhost:8080/@ in your browser; the Ring app will respond to your request with a simple HTML page indicating the time of day. +Now visit @http://localhost:8080/@ in your browser; the Ring app will respond +to your request with a simple HTML page indicating the time of day. To see a more sophisticated Ring app, run: - java -Djava.ext.dirs=deps clojure.main src/ring/examples/wrapping.clj - - * If you request @http://localhost:8080/@ in your browser the @ring.dump@ handler will respond with an HTML page representing the request map that it received (see the @SPEC@ for details on the request map). - * If you request @http://localhost:8080/clojure.png@, the @ring.file@ middleware will detect that there is a @clojure.png@ file in the app's @public@ directory and return that image as a response. - * If you request @http://localhost:8080/error@, the app will produce an error that will be caught by the @ring.show-exceptions@ middleware, which will in turn return a readable backtrace as the HTML response. + java -Djava.ext.dirs=deps clojure.main src/ring/example/wrapping.clj + + * If you request @http://localhost:8080/@ in your browser the @ring.dump@ + handler will respond with an HTML page representing the request map that it + received (see the @SPEC@ for details on the request map). + * If you request @http://localhost:8080/clojure.png@, the @ring.file@ + middleware will detect that there is a @clojure.png@ file in the app's + @public@ directory and return that image as a response. + * If you request @http://localhost:8080/error@, the app will produce an error + that will be caught by the @ring.show-exceptions@ middleware, which will in + turn return a readable stacktrace as the HTML response. -h2. All Available Libs - - * @ring.jetty@: Adapter for the Jetty webserver. - * @ring.httpcore@: Adapter for the Apache HttpCore webserver. - * @ring.file@: Middleware that serves static files out of a public directory. - * @ring.file-info@: Middleware that augments response headers with info about File responses. - * @ring.static@: Middleware that serves static files with specified prefixes out of a public directory. - * @ring.dump@: Handler that dumps request maps as HTML responses for debugging. - * @ring.show-exceptions@: Middleware that catches exceptions and displays readable backtraces for debugging. - * @ring.reload@: Middleware to automatically reload selected libs before each requests, minimizing server restarts. - * @ring.builder@: Helpers for composing Ring apps from multiple handlers and middleware. - * @ring.lint@: Linter for the Ring interface, ensures compliance with the Ring spec. - * @ring.examples.*@: Various example Ring apps. +h2. Included Libs + + * @ring.adapter.jetty@: Adapter for the Jetty webserver. + * @ring.adapter.httpcore@: Adapter for the Apache HttpCore webserver. + * @ring.middleware.file@: Middleware that serves static files out of a public + directory. + * @ring.middleware.file-info@: Middleware that augments response headers with + info about File responses. + * @ring.middleware.static@: Middleware that serves static files with specified + prefixes out of a public directory. + * @ring.middleware.show-exceptions@: Middleware that catches exceptions and + displays readable stacktraces for debugging. + * @ring.middleware.reload@: Middleware to automatically reload selected libs + before each requests, minimizing server restarts. + * @ring.handler.dump@: Handler that dumps request maps as HTML responses for + debugging. + * @ring.util.builder@: Helpers for composing Ring apps from multiple handlers + and middleware. + * @ring.util.lint@: Linter for the Ring interface, ensures compliance with the + Ring spec. + * @ring.example.*@: Various example Ring apps. h2. Development -Ring is being actively developed; you can track its progress and contribute at the project's "GitHub"::http://github.com/mmcgrana/ring page. +Ring is being actively developed; you can track its progress and contribute at +the project's "GitHub"::http://github.com/mmcgrana/ring page. To run all the Ring unit tests: @@ -57,7 +74,7 @@ You can learn more about Ring's dependencies at the following sites: * @jetty-6.1.14.jar@, @jetty-util-6.1.14.jar@, @servlet-api-2.5-6.1.14.jar@: "mortbay.org/jetty":http://www.mortbay.org/jetty * @httpcore-4.0.jar@, @httpcore-nio-4.0.jar@: "hc.apache.org":http://hc.apache.org/httpcomponents-core/index.html * @commons-io-1.4.jar@: "commons.apache.org/io":http://commons.apache.org/io/ - * @clj-html.jar@, @clj-html-helpers.jar@, @clj-backtrace.jar@, @clj-unit@ (testing): "github.com/mmcgrana":http://github.com/mmcgrana + * @clj-html.jar@, @clj-html-helpers.jar@, @clj-stacktrace.jar@, @clj-unit@: "github.com/mmcgrana":http://github.com/mmcgrana h2. Thanks @@ -65,13 +82,5 @@ This project borrows heavily from Ruby's Rack and Python's WSGI, and I thank the --- -<pre><code> - +--->HTTP Request--->[Adapter]--->Req1---->[Middleware]--->Req2----+ - | | - [Client] [Handler] - | | - +----HTTP Response<--[Adapter]<---Resp2<---[Middleware]<---Resp1<--+ -</code></pre> - Copyright (c) 2009 Mark McGranaghan and released under an MIT license. Clojure logo by Tom Hickey. \ No newline at end of file README.textile @@ -22,9 +22,9 @@ Handlers are run via Ring adapters, which are in turn responsible for implementing the HTTP protocol and abstracting the handlers that they run from the details of the protocol. -Adapters are implemented as functions of two arguments: an options map and a -handler. The options map provides any needed configuration to the adapter, such -as the port on which to run. +Adapters are implemented as functions of two arguments: a handler and an options +map. The options map provides any needed configuration to the adapter, such as +the port on which to run. Once initialized, adapters receive HTTP requests, parse them to construct an request map, and then invoke their handler with this request map as an SPEC @@ -1,10 +1,9 @@ (use 'clj-unit.core) (require-and-run-tests - 'ring.builder-test - 'ring.dump-test - 'ring.lint-test - 'ring.file-test - 'ring.file-info-test - 'ring.static-test - 'ring.reload-test - 'ring.backtrace-test) + 'ring.handler.dump-test + 'ring.middleware.lint-test + 'ring.middleware.file-test + 'ring.middleware.file-info-test + 'ring.middleware.static-test + 'ring.middleware.reload-test + 'ring.middleware.stacktrace-test) test/run.clj src/ring/backtrace.clj src/ring/builder.clj src/ring/dump.clj src/ring/examples/hello_world.clj src/ring/examples/linted.clj src/ring/examples/public/clojure.png src/ring/examples/wrapping.clj src/ring/file.clj src/ring/file_info.clj src/ring/httpcore.clj src/ring/jetty.clj src/ring/lint.clj src/ring/reload.clj src/ring/static.clj src/ring/utils.clj test/ring/backtrace_test.clj test/ring/builder_test.clj test/ring/dump_test.clj test/ring/file_info_test.clj test/ring/file_test.clj test/ring/lint_test.clj test/ring/reload_test.clj test/ring/static_test.clj 24fe773f62026b95e275468f6875812f87989508 Mark McGranaghan mmcgrana@gmail.com http://github.com/mmcgrana/ring/commit/cbeebac281a156f111ee02a6b2908de45387c81b cbeebac281a156f111ee02a6b2908de45387c81b 2009-07-11T14:01:02-07:00 2009-07-11T14:01:02-07:00 Initial refactor towards 0.1. 1a9650ee26d2febd259abd1af516266a52e6d299 Mark McGranaghan mmcgrana@gmail.com