errawr-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd2b23965005ffb5d9e4571a2be49f22ec27f646
+  data.tar.gz: 852a944a1062feeb9192ed35cac1d7e6a216414f
+SHA512:
+  metadata.gz: 6f2f2f341f97eb8c6c081a1daee730861e6d6b52bd02d57f3d98f32e73f52d9595cad7c8352c126a570f8796e41ad20aaecddeed2283a142fcde2498a54f2798
+  data.tar.gz: 68bc6b55bda42802df8b346f28212c3532ca119bd7a3e9a43772ac7f34e4003fc67b82aa1c509b66f950397bd68155251cc919dbeab6f200e33ea96e31d610a5

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rbenv*
+.rvmrc
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx
+env:
+  - "RAILS_VERSION=3.2.0"
+  - "RAILS_VERSION=4.0.0"
+  - "RAILS_VERSION=master"
+matrix:
+  allow_failures:
+    - env: "RAILS_VERSION=master"

data/Gemfile

@@ -0,0 +1,33 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in errawr-rails.gemspec
+gemspec
+
+rails_version = case ENV['RAILS_VERSION'] || 'default'
+when 'master'
+  { git: 'https://github.com/rails/rails.git' }
+when 'default'
+  '~> 4.0'
+else
+  "~> #{ENV['RAILS_VERSION']}"
+end
+
+gem 'rails', rails_version
+
+platforms :ruby do
+  gem 'sqlite3'
+end
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+end
+
+platforms :rbx do
+  gem 'racc'
+  gem 'rubinius-coverage', github: 'rubinius/rubinius-coverage'
+  gem 'rubysl'
+end
+
+group :development do
+  gem 'coveralls', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Anthony Smith
+
+MIT License
+
+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,133 @@
+# Errawr::Rails
+
+Raise and render errors in Rails using Errawr
+
+[![Build Status](https://travis-ci.org/anthonator/errawr-rails.png?branch=master)](https://travis-ci.org/anthonator/errawr-rails) [![Dependency Status](https://gemnasium.com/anthonator/errawr-rails.png)](https://gemnasium.com/anthonator/errawr-rails) [![Coverage Status](https://coveralls.io/repos/anthonator/errawr-rails/badge.png?branch=master)](https://coveralls.io/r/anthonator/errawr-rails?branch=master) [![Code Climate](https://codeclimate.com/github/anthonator/errawr-rails.png)](https://codeclimate.com/github/anthonator/errawr-rails)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'errawr-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install errawr-rails
+
+## Usage
+
+### Getting Started
+
+To start raising errors in Rails just include ```Errawr::Rails``` in a controller. This will provide access to the ```#error!``` method in your controller.
+
+```ruby
+class SomeController < ApplicationController
+  include Errawr::Rails
+
+  def index
+    if params[:dont_work] == true
+      error!(:bad_request)
+    end
+  end
+end
+```
+
+### Rendering Error Responses
+
+If you'd like to catch and render errors in a particular format include ```Errawr::Rails``` using the ```#with_renderer``` method.
+
+```ruby
+class SomeController < ApplicationController
+  include Errawr::Rails.with_renderer(Rails::Errawr::Renderers::JSON)
+
+  def index
+    if params[:dont_work] == true
+      error!(:bad_request)
+    end
+  end
+end
+```
+
+The above example will render the error as JSON using the following format:
+
+```json
+{
+  "error": "bad_request",
+  "description": "Bad Request"
+}
+```
+
+Depending on what renderer is used additional metadata may be added to the response output:
+
+```ruby
+class SomeController < ApplicationController
+  include Errawr::Rails.with_renderer(Rails::Errawr::Renderers::JSON)
+
+  def index
+    if params[:dont_work] == true
+      error!(:bad_request, metadata: { extra_info: 'I like candy' })
+    end
+  end
+end
+```
+
+```json
+{
+  "error": "bad_request",
+  "description": "Bad Request",
+  "extra_info": "I like candy"
+}
+```
+
+Currently the only renderer that ships with Errawr::Rails is ```Rails::Errawr::Renderers::JSON```.
+
+
+### Custom Renderers
+
+To create a custom renderer simple create a class with that specifies a ```call``` method that accepts a single parameter. The method can return anything that the Rails ```render``` method will accept.
+
+```ruby
+class MyCustomRenderer
+  def call(error)
+  {
+    json: {
+      hello: 'world'
+    }
+  }
+  end
+end
+```
+
+```ruby
+class SomeController < ApplicationController
+  include Errawr::Rails.with_renderer(MyCustomRenderer)
+
+  def index
+    if params[:dont_work] == true
+      error!(:bad_request)
+    end
+  end
+end
+```
+
+```json
+{
+  "hello": "world"
+}
+```
+
+### HTTP Status Codes
+
+Errawr::Rails uses the [Errawr::HTTP](https://github.com/anthonator/errawr-http) gem to add support for [4xx](https://github.com/anthonator/errawr-http#supported-4xx-status-codes) and [5xx](https://github.com/anthonator/errawr-http#supported-5xx-status-codes) HTTP status code errors.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: :spec

data/errawr-rails.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'errawr/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'errawr-rails'
+  spec.version       = Errawr::Rails::VERSION
+  spec.authors       = ['Anthony Smith']
+  spec.email         = ['anthony@sticksnleaves.com']
+  spec.description   = %q{Raise and render errors in Rails using Errawr}
+  spec.summary       = %q{Errawr support for Rails}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport', '>= 3.2'
+  spec.add_runtime_dependency 'errawr',        '>= 1.1.3'
+  spec.add_runtime_dependency 'errawr-http',   '>= 1.0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec-rails'
+end

data/lib/errawr/rails.rb

@@ -0,0 +1,24 @@
+require 'active_support/rescuable'
+require 'errawr'
+require 'errawr/http'
+
+require 'errawr/rails/renderable'
+require 'errawr/rails/renderers/json'
+require 'errawr/rails/version'
+
+module Errawr
+  module Rails
+    def self.included(base)
+      base.send(:include, Errawr::ClassMethods)
+    end
+    
+    def self.with_renderer(renderer)
+      mod = Module.new
+      mod.define_singleton_method :included do |object|
+        object.send(:include, Errawr::Rails)
+        object.send(:include, Errawr::Rails::Renderable.render_with(renderer))
+      end
+      mod
+    end
+  end
+end

data/lib/errawr/rails/renderable.rb

@@ -0,0 +1,23 @@
+module Errawr
+  module Rails
+    module Renderable
+      def self.render_with(handler)
+        mod = Module.new
+        mod.define_singleton_method :included do |object|
+          object.class_eval do
+            object.const_set(:ERRAWR_HANDLER, handler)
+            rescue_from Errawr::Error, with: :render_errawr
+            
+            private
+            def render_errawr(error)
+              handler =  self.class.const_get(:ERRAWR_HANDLER)
+              self.status = error.context[:http_status] || 500
+              render handler.new.call(error)
+            end
+          end
+        end
+        mod
+      end
+    end
+  end
+end

data/lib/errawr/rails/renderers/json.rb

@@ -0,0 +1,16 @@
+module Errawr
+  module Rails
+    module Renderers
+      class JSON
+        def call(error)
+          {
+            json: {
+              error: error.context[:name] || error.key,
+              description: error.message
+            }.merge(error.metadata)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/errawr/rails/version.rb

@@ -0,0 +1,5 @@
+module Errawr
+  module Rails
+    VERSION = "1.0.0"
+  end
+end

data/spec/dummy/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */