RubyGems - terrific - Versions diffs - 0.1.0 - Mend

terrific 0.1.0

Files changed (56) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +36 -0
data/Rakefile +23 -0
data/lib/terrific.rb +5 -0
data/lib/terrific/error.rb +42 -0
data/lib/terrific/locales.rb +1 -0
data/lib/terrific/locales/en.yml +10 -0
data/lib/terrific/mappable.rb +29 -0
data/lib/terrific/version.rb +3 -0
data/spec/dummy/README.rdoc +28 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/assets/javascripts/application.js +13 -0
data/spec/dummy/app/assets/stylesheets/application.css +15 -0
data/spec/dummy/app/controllers/application_controller.rb +5 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/models/user.rb +3 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/bin/setup +29 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +32 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +41 -0
data/spec/dummy/config/environments/production.rb +79 -0
data/spec/dummy/config/environments/test.rb +42 -0
data/spec/dummy/config/initializers/assets.rb +11 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/cookies_serializer.rb +3 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +4 -0
data/spec/dummy/config/initializers/session_store.rb +3 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +27 -0
data/spec/dummy/config/routes.rb +56 -0
data/spec/dummy/config/secrets.yml +22 -0
data/spec/dummy/db/development.sqlite3 +0 -0
data/spec/dummy/db/migrate/20150216205144_create_users.rb +9 -0
data/spec/dummy/db/schema.rb +22 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/development.log +32 -0
data/spec/dummy/log/test.log +1796 -0
data/spec/dummy/public/404.html +67 -0
data/spec/dummy/public/422.html +67 -0
data/spec/dummy/public/500.html +66 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/requests/errors_spec.rb +81 -0
data/spec/spec_helper.rb +17 -0
data/spec/support/request_helper.rb +27 -0
data/spec/terrific/error_spec.rb +85 -0
metadata +185 -0

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED

File without changes

data/spec/requests/errors_spec.rb ADDED

@@ -0,0 +1,81 @@
+require "spec_helper"
+Unrecognized = Class.new(StandardError)
+Parent = Class.new(StandardError)
+Child = Class.new(Parent)
+class TestController < ApplicationController
+  map_error Child, to: :unprocessable_entity, type: :first, message: "first"
+  map_error Parent, to: :unprocessable_entity, type: :second, message: "second"
+  def unrecognized_exception
+    raise Unrecognized
+  end
+  def record_not_found
+    raise ActiveRecord::RecordNotFound
+  end
+  def record_invalid
+    User.create!
+  end
+  def overridden
+    raise Child
+  end
+end
+describe "Errors" do
+  before do
+    Rails.application.routes.draw do
+      get "/unrecognized_exception"  => "test#unrecognized_exception"
+      get "/record_not_found"  => "test#record_not_found"
+      get "/record_invalid"  => "test#record_invalid"
+      get "/overridden"  => "test#overridden"
+    end
+  end
+  after do
+    Rails.application.reload_routes!
+  end
+  context "when there is an unrecognized exception" do
+    it "responds with a server_error" do
+      j_get("/unrecognized_exception")
+      expect_status(500)
+      expect_type("server_error")
+      expect_message("Something went wrong")
+    end
+  end
+  context "when a record is not found" do
+    it "responds with a record_not_found" do
+      j_get("/record_not_found")
+      expect_status(404)
+      expect_type("record_not_found")
+      expect_message("No such record")
+    end
+  end
+  context "when an attribute is not valid" do
+    it "responds with a record_invalid" do
+      j_get("/record_invalid")
+      expect_status(422)
+      expect_type("record_invalid")
+      expect_message("Name can't be blank")
+    end
+  end
+  context "when an error is mapped twice" do
+    it "responds with the last mapping" do
+      j_get("/overridden")
+      expect_status(422)
+      expect_type("second")
+      expect_message("second")
+    end
+  end
+end

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,17 @@
+ENV["RAILS_ENV"] ||= "test"
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rspec/rails"
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+RSpec.configure do |config|
+  config.include RequestHelper, type: :request
+  config.infer_spec_type_from_file_location!
+  config.mock_with :rspec
+  config.use_transactional_fixtures = true
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = :random
+end

data/spec/support/request_helper.rb ADDED

@@ -0,0 +1,27 @@
+module RequestHelper
+  def json
+    @json ||= JSON.parse(response.body, symbolize_names: true)
+  end
+  def expect_status(status)
+    expect(response.status).to eq(status)
+  end
+  def expect_type(type)
+    expect(json[:error][:type]).to eq(type)
+  end
+  def expect_message(message)
+    expect(json[:error][:message]).to eq(message)
+  end
+  def j_get(path, params = nil, headers = {})
+    json_request(:get, path, params, headers)
+  end
+  def json_request(method, path, params = nil, headers = {})
+    send(method, path, params, headers.merge({
+      "CONTENT_TYPE" => "application/json"
+    }))
+  end
+end

data/spec/terrific/error_spec.rb ADDED

@@ -0,0 +1,85 @@
+require 'spec_helper'
+describe Terrific::Error do
+  let(:exception) { Exception.new }
+  describe "#as_json" do
+    let(:error) { Terrific::Error.new(exception) }
+    before do
+      expect(error).to receive(:message) { "message" }
+      expect(error).to receive(:type) { "type" }
+    end
+    it "returns message and type" do
+      expect(error.as_json).to eq({
+        type: "type",
+        message: "message"
+      })
+    end
+  end
+  describe "#message" do
+    context "when it is explictly provided" do
+      let(:error) { Terrific::Error.new(exception, message: "explicit message") }
+      it "is the value specified" do
+        expect(error.message).to eq("explicit message")
+      end
+    end
+    context "when it is provided as lambda" do
+      let(:lambda) { ->(e) { "lambda message" } }
+      let(:error) { Terrific::Error.new(exception, message: lambda) }
+      it "is the result of the lambda" do
+        expect(error.message).to eq("lambda message")
+      end
+    end
+    context "when it is not provided" do
+      context "but a translation is available" do
+        let(:error) { Terrific::Error.new(Exception.new("message")) }
+        it "is the translated message" do
+          expect(error.message).to eq("translated message")
+        end
+      end
+      context "and there is no translation available" do
+        let(:error) { Terrific::Error.new(StandardError.new("message")) }
+        it "is the exception message" do
+          expect(error.message).to eq("message")
+        end
+      end
+    end
+  end
+  describe "#type" do
+    context "when it is explictly provided" do
+      let(:error) { Terrific::Error.new(exception, type: "explicit") }
+      it "is the value specified" do
+        expect(error.type).to eq("explicit")
+      end
+    end
+    context "when it is provided as lambda" do
+      let(:lambda) { ->(e) { "lambda" } }
+      let(:error) { Terrific::Error.new(exception, type: lambda) }
+      it "is the result of the lambda" do
+        expect(error.type).to eq("lambda")
+      end
+    end
+    context "when it is not provided" do
+      let(:error) { Terrific::Error.new(exception) }
+      it "is uses the default" do
+        expect(error.type).to eq("exception")
+      end
+    end
+  end
+end

metadata ADDED

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: terrific
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Kriss
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- jasonkriss@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/terrific.rb
+- lib/terrific/error.rb
+- lib/terrific/locales.rb
+- lib/terrific/locales/en.yml
+- lib/terrific/mappable.rb
+- lib/terrific/version.rb
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/user.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/migrate/20150216205144_create_users.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/requests/errors_spec.rb
+- spec/spec_helper.rb
+- spec/support/request_helper.rb
+- spec/terrific/error_spec.rb
+homepage: https://github.com/jasonkriss/terrific
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.3
+signing_key:
+specification_version: 4
+summary: Exception handling for your Rails API.
+test_files:
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/user.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/config.ru
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/migrate/20150216205144_create_users.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/Rakefile
+- spec/dummy/README.rdoc
+- spec/requests/errors_spec.rb
+- spec/spec_helper.rb
+- spec/support/request_helper.rb
+- spec/terrific/error_spec.rb