reck 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e42763c73766c0f37b6d11774d0ae7d4c090e933142a293ab4fa8020fbc115c3
+  data.tar.gz: 0b34320493ef0739d2bbe5c6c21ae2bd28b02c823de789172f302f5bd930f884
+SHA512:
+  metadata.gz: 605e3033cafec280edff30012a1214ed09df89c012488f7a762ce63014410a668a7f20742899898681b538ae84a84d52207965fcdc12996720d187fe1078f5d1
+  data.tar.gz: 70bcdc64891926d594082827225d43bf29c3490cb095478b5b1656784a73d4f0da64382073ac3ad43c13800fcd165eff707b6d71c0d253de80204ba7befeedd2

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Honeybadger Industries LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,170 @@
+# Reck
+
+An exception-based web framework for Ruby.
+
+# Why another framework?
+
+If you've ever programmed in Ruby on Rails, you know that it prefers convention
+over configuration. We believe this approach works well as a design paradigm but
+falls down over time (just ask anyone who has maintained a Rails application
+since version 1). In order to remain competitive with newer high-level (and
+often concurrent) programming languages like Node and Elixir, Ruby needs a
+strong component-based framework which let's you use the *right* tool for the
+job.
+
+Reck is very light-weight compared to other web frameworks such as Rails
+or even Sinatra. We handle the routing and controller layer using a very simple
+exception-based DSL and then get out of the way so that any existing model or
+view components may be used.
+
+## Installation
+
+```sh
+$ gem install reck
+```
+
+## Usage
+
+To respond to the defined route with rendered content, simply raise an
+exception. The message of the exception will be evaluated as ERB before being
+added to the response. If the exception is raised without a message, a
+no-content response will be sent. This exception-based DSL is dead-simple and
+great for controlling the flow of your application.
+
+Routing code to a controller is as simple as:
+
+```ruby
+Reck.route '/' do |request|
+  raise Reck::Ok, 'Hello World'
+end
+```
+
+Want to add authentication? No problem. (Actually, with a single-page app, this *really is* all you need!)
+
+```ruby
+Reck.route '/admin' do |request|
+  raise Reck::Forbidden unless request.params['username'] == 'admin'
+  raise Reck::Forbidden unless request.params['password'] == 'secret'
+  raise Reck::Ok, 'Super secret admin page'
+end
+```
+
+Since the message of each exception is actually a template, use ERB tags to
+interpolate Ruby values in your views:
+
+```ruby
+Reck.route '/version' do |request|
+  raise Reck::Ok, 'Reck version: <%= Reck::VERSION %>'
+end
+```
+
+Since Reck depends on Rack, you also have access to helper methods
+derived from the keys in Rack's env hash:
+
+```ruby
+Reck.route '/method' do |request|
+  raise Reck::Ok, 'Requested via: <%= request_method %>'
+end
+```
+
+To run the application server:
+
+```sh
+$ ruby -r reck application.rb
+```
+
+## Supported Responses
+
+Each response inherits from the exception `Reck::Response`.
+
+| Exception Class       | Status code |
+| --------------------- | ----------- |
+| Reck::Ok              | 200         |
+| Reck::Created         | 201         |
+| Reck::Forbidden       | 403         |
+| Reck::NotFound        | 404         |
+
+## Handling exceptions
+
+While responses should always be raised, you may wish to handle other types of
+unexpected exceptions, or "exceptional exceptions", if you will. In these cases,
+we recommend using Honeybadger. Honeybadger provides middleware (and a bunch of
+other cool features) to catch exceptions in Ruby applications -- whether you're
+using Reck, Rails, Sinatra, Rack, or rolling your own Ruby web-framework.
+
+There are two ways you can get Honeybadger to monitor Reck:
+
+1. Reporting errors inside a controller
+
+  ```ruby
+  require 'reck'
+  require 'honeybadger'
+
+  Honeybadger.configure do |config|
+    config.api_key = 'your_api_key'
+  end
+
+  Reck.route '/oops' do |request|
+    begin
+      fail 'oops!'
+    rescue Reck::Response
+      raise # Raise the response to the router
+    rescue => e
+      # Exceptional Reck exception: report it with Honeybadger!
+      Honeybadger.notify(e)
+    end
+  end
+  ```
+
+  ```sh
+  ruby application.rb
+  ```
+
+2. Automatically catching all errors which aren't responses
+
+  ```ruby
+  require 'reck/application'
+  require 'honeybadger'
+
+  Honeybadger.configure do |config|
+    config.api_key = 'your_api_key'
+    config.exceptions.ignore << Reck::Response
+  end
+
+  Reck.route '/oops' do |request|
+    fail 'oops!'
+  end
+
+  use Honeybadger::Rack::ErrorNotifier
+
+  run Reck::Application
+  ```
+
+  ```sh
+  rackup application.ru
+  ```
+
+Don't forget to replace `'your_api_key'` with the API key from your [project
+settings page](https://www.honeybadger.io/) on Honeybadger.
+
+## TODO
+
+- [ ] Handle all HTTP 1.1 status codes
+- [ ] Access to response headers
+- [ ] Custom response formats
+
+## Contributing
+
+1. Fork it.
+2. Create a topic branch `git checkout -b my_branch`
+3. Commit your changes `git commit -am "Boom"`
+3. Push to your branch `git push origin my_branch`
+4. Send a [pull request](https://github.com/honeybadger-io/reck/pulls)
+
+## License
+
+Reck is Copyright 2015 © Honeybadger Industries LLC. It is free software, and
+may be redistributed under the terms specified in the LICENSE file.
+
+Brought to you by :zap: **Honeybadger.io**: our kick-ass exception tracking is no joke. :trollface:
+[Start exterminating errors in your Ruby apps today](https://www.honeybadger.io/)!

data/lib/reck/application.rb

@@ -0,0 +1,70 @@
+require 'rack'
+require 'forwardable'
+require 'erb'
+
+require 'reck/version'
+
+module Reck
+  class Response < RuntimeError
+    NOT_BLANK = Regexp.new('\S').freeze
+
+    def head?
+      message == self.class.name || message !~ NOT_BLANK
+    end
+
+    def render
+      erb = ERB.new(message)
+      erb.result
+    end
+  end
+
+  class Ok < Response; end
+  class Created < Response; end
+  class Forbidden < Response; end
+  class NotFound < Response; end
+
+  STATUS = {
+    Ok => 200,
+    Created => 201,
+    Forbidden => 403,
+    NotFound => 404
+  }.freeze
+
+  class Application
+    def self.call(env)
+      req = Rack::Request.new(env)
+      if route = routes.find {|r| r.path.chomp('/') == req.path_info.chomp('/') }
+        route.call(req)
+        fail 'invalid response'
+      else
+        [404, {}, ['Not Found']]
+      end
+    rescue Reck::Response => e
+      [STATUS[e.class], {}, [e.head? ? nil : e.render].compact]
+    rescue => e
+      env['rack.exception'] = e
+      [500, {}, ['Internal Server Error']]
+    end
+
+    def self.routes
+      @@routes ||= []
+    end
+  end
+
+  class Route
+    extend Forwardable
+    attr_reader :path
+    def_delegator :@block, :call
+
+    def initialize(path, block)
+      @path  = path
+      @block = block
+    end
+  end
+
+  def route(path, &block)
+    Application.routes.unshift(Route.new(path, block))
+  end
+
+  extend self
+end

data/lib/reck/version.rb

@@ -0,0 +1,3 @@
+module Reck
+  VERSION = '0.0.1'.freeze
+end

data/lib/reck.rb

@@ -0,0 +1,7 @@
+require 'reck/application'
+
+module Reck
+  at_exit do
+    Rack::Handler::WEBrick.run Reck::Application
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: reck
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Honeybadger Industries LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- support@honeybadger.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/reck.rb
+- lib/reck/application.rb
+- lib/reck/version.rb
+homepage: https://github.com/honeybadger-io/reck
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: An exception-based web framework for Ruby.
+test_files: []