rescuable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8dad4e210462d824a2f6ce7107a62a1fe8c33d21
+  data.tar.gz: e286e25d5fa6a2c913346fd661549ac0a0a7be14
+SHA512:
+  metadata.gz: 9c7f62c62080e2b94321582d65bf2b505eb4acf06a16911fa6c425d3bb4bdd15a29eaeff6dfeb891da8c9cb47ed288ca925f1acd37125a91134bd6979c28bb2c
+  data.tar.gz: 5bc65dfd0d746afc9b37db710aa13aefa7cb5f45c6ae6e9acfbe030c1e9042644896ae434db2d0c347891a41fc6a7e12adc50f9bf5c46682c239d05c6b324c3f

data/.editorconfig

@@ -0,0 +1,13 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+doc
+log
+*.lock

data/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing
+
+## Issues
+
+If you want to request a feature or report a bug, please use the following template.
+
+```markdown
+## Description
+
+[Add feature/bug description here]
+
+## How to reproduce
+
+[Add steps on how to reproduce this issue]
+
+## What do you expect
+
+[Describe what do you expect to happen]
+
+## What happened instead
+
+[Describe the actual results]
+
+## Gem version:
+
+Rescuable version: [Add gem version here]
+```
+
+## Writing code
+
+Once you've made your great commits (include tests, please):
+
+1. [Fork](http://help.github.com/forking/) the [original repository](http://github.com/dhyegofernando/rescuable)
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. [Create an Issue](http://github.com/dhyegofernando/rescuable/issues) with a link to your branch
+5. That's it!
+
+Please respect the code style using [editorconfig](http://editorconfig.org/) in your text editor.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in rescuable.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dhyego Fernando
+
+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,13 @@
+# Rescuable
+Render an error in JSON format with support for I18n. Awesome for define a pattern to follow in Web APIs.
+
+## Installation
+
+```bash
+```
+
+## Usage
+
+## Maintainer
+
+## Contributors

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['./test/**/*_test.rb']
+end
+
+task :default => :test

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  rescuable:
+    errors:
+      messages:
+        default: Something went wrong

data/lib/rescuable.rb

@@ -0,0 +1,14 @@
+require 'active_support/concern'
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/lazy_load_hooks'
+require 'active_support/dependencies/autoload'
+
+module Rescuable
+  extend ActiveSupport::Autoload
+
+  autoload :Error
+  autoload :RecordError
+  autoload :Version
+end
+
+require 'rescuable/engine'

data/lib/rescuable/engine.rb

@@ -0,0 +1,17 @@
+require 'rescuable/rails/renderer_controller'
+
+module Rescuable
+  class Engine < ::Rails::Engine
+    initializer 'rescuable.locales' do |app|
+      if app.config.i18n.fallbacks.blank?
+        app.config.i18n.fallbacks = [:en]
+      end
+    end
+
+    initializer 'rescuable.helpers' do
+      ActiveSupport.on_load(:action_controller) do
+        include Rescuable::Rails::RendererController
+      end
+    end
+  end
+end

data/lib/rescuable/error.rb

@@ -0,0 +1,40 @@
+module Rescuable
+  class Error
+    include ActiveModel::Serializers::JSON
+
+    DEFAULT_ERROR_MESSAGE = 'Something went wrong'.freeze
+
+    cattr_accessor :statuses
+    @@statuses = Hash.new(:internal_server_error)
+    @@statuses.merge!(
+      invalid_record: :unprocessable_entity
+    )
+
+    attr_accessor :id, :message, :status
+
+    def initialize(id, options = {})
+      @id = id
+      @message = options[:message]
+      @status = options[:status]
+    end
+
+    def status
+      @status || @@statuses[@id]
+    end
+
+    def message
+      @message || I18n.t(@id, :default => [:default, DEFAULT_ERROR_MESSAGE], :scope => 'rescuable.errors.messages')
+    end
+
+    def attributes
+      {
+        id: id,
+        message: message
+      }.with_indifferent_access
+    end
+
+    def to_error
+      self
+    end
+  end
+end

data/lib/rescuable/rails/renderer_controller.rb

@@ -0,0 +1,29 @@
+module Rescuable
+  module Rails
+    module RendererController
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def rescuable_error(error, status)
+          Error.statuses.merge!(error.to_sym => status)
+        end
+      end
+
+      protected
+
+      def error_renderer(error)
+        render json: error.to_json, status: error.status
+      end
+
+      def render_error(error, **args)
+        error = Error.new(error, **args) unless error.respond_to?(:to_error)
+        error = error.to_error
+        error_renderer error
+      end
+
+      def render_record_error(record)
+        render_error RecordError.new(record)
+      end
+    end
+  end
+end

data/lib/rescuable/record_error.rb

@@ -0,0 +1,13 @@
+module Rescuable
+  class RecordError
+    attr_accessor :record
+
+    def initialize(record)
+      @record = record
+    end
+
+    def to_error
+      Error.new(:invalid_record, message: record.errors.full_messages.first)
+    end
+  end
+end

data/lib/rescuable/version.rb

@@ -0,0 +1,8 @@
+module Rescuable
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/rescuable.gemspec

@@ -0,0 +1,28 @@
+require './lib/rescuable/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'rescuable'
+  spec.version     = Rescuable::Version::STRING
+  spec.authors     = ['Dhyego Fernando']
+  spec.email       = ['dhyegofernando@gmail.com']
+
+  spec.summary     = 'Render an error in JSON format with support for I18n.'
+  spec.description = spec.summary
+  spec.homepage    = 'http://github.com/dhyegofernando/rescuable'
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'i18n', '~> 0.6'
+  spec.add_dependency 'activesupport', '~> 4.0'
+  spec.add_dependency 'railties', '~> 4.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-utils'
+  spec.add_development_dependency 'pry-meta'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: rescuable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dhyego Fernando
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: minitest
+  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: minitest-utils
+  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: pry-meta
+  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: Render an error in JSON format with support for I18n.
+email:
+- dhyegofernando@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- config/locales/en.yml
+- lib/rescuable.rb
+- lib/rescuable/engine.rb
+- lib/rescuable/error.rb
+- lib/rescuable/rails/renderer_controller.rb
+- lib/rescuable/record_error.rb
+- lib/rescuable/version.rb
+- rescuable.gemspec
+homepage: http://github.com/dhyegofernando/rescuable
+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.6
+signing_key: 
+specification_version: 4
+summary: Render an error in JSON format with support for I18n.
+test_files: []