json_error 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 710945ff34e88690adf8b1287c718d8a1452fd22
+  data.tar.gz: b99fed58240fc196859f26225809d5095d22a119
+SHA512:
+  metadata.gz: 05856bbb8024a62a2733bc783ecc06cbd312cffcada7e4e0caf4935845d2b80b8a4c1d6c9150100fde8673a88aeccc15a52c3e3b2ce2ccbcf81a11d0882f7e47
+  data.tar.gz: 791ffbea2fa34ac4aaa4a4241eeb8ab14d25000c6c6d8e50201b1e05a3f8ca124bd6dd3423e285294ffe993d87f7aae4f512b6e882911390ef0a0ed36c49ca95

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Krzysztof Buszewicz
+
+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,165 @@
+# JSONError
+
+[![Code Climate](https://codeclimate.com/github/buszu/json_error/badges/gpa.svg)](https://codeclimate.com/github/buszu/json_error)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_error', github: 'buszu/json_error'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Defining JSONErrors
+
+```ruby
+module Errors
+  class ResourceNotFound < JSONError.base
+    def initialize(options = {})
+      # Add required :key option
+      options.merge!(key: :resource_not_found)
+      super(options)
+    end
+  end
+
+  class OtherError < JSONError.base
+    # Slice response JSON properties
+    def self.properties
+      super - %i(href description)
+    end
+
+    options.merge!(key: :other_error)
+    super(options)
+  end
+end
+```
+
+### Defining JSONError Properties
+
+Add entries below to your locale.
+
+```yml
+en:
+  errors:
+    resource_not_found:
+      status: 404
+      message: 'Resource %{name} (%{id}) was not found.'
+      description: 'Blah blah blah.'
+      href: 'https://developers.api.pl/doc/errors/resource_not_found'
+```
+
+### Rendering JSONError
+
+#### Rails
+
+```ruby
+# app/controllers/batmans_controller.rb
+class BatmansController < ApplicationController
+  def index
+    error = Errors::ResourceNotFound.new(name: :Batman, id: 2)
+    render json: error, status: error.status
+  end
+end
+
+# or
+
+class BatmansController < ApplicationController
+  def index
+    raise Errors::ResourceNotFound, name: :Batman, id: 2
+  rescue JSONError.base => e
+    render json: e, status: e.status
+  end
+end
+```
+
+#### Sinatra
+
+```ruby
+# Remember to load dependencies
+
+class Application < Sinatra::Base
+  before { content_type :json }
+
+  get '/batmans' do
+    error = Errors::ResourceNotFound.new(name: :Batman, id: 2)
+    halt error.status, json(error)
+  end
+end
+```
+
+### Responses
+
+#### For ResourceNotFound
+
+```js
+{
+  "status": 404,
+  "key": "resource_not_found",
+  "message": "Resource Batman (2) was not found.",
+  "description": "Blah blah blah.",
+  "href": "https://developers.api.pl/doc/errors/resource_not_found"
+}
+```
+
+#### For OtherError
+```js
+{
+  "status": 500,
+  "key": "other_error",
+  "message": null
+}
+```
+
+### Using Contexts
+
+You can specify different contexts for the same error key.
+
+```yml
+# In locale
+
+en:
+  errors:
+    resource_not_found:
+      status: 404
+      message: 'Resource %{name} (%{id}) was not found.'
+      description: 'Blah blah blah.'
+      href: 'https://developers.api.pl/doc/errors/resource_not_found'
+    batmans:
+      resource_not_found:
+        status: 404
+        message: 'Resource Batman (%{id}) was not found.'
+        description: "Cuz I'm Batman"
+```
+
+```ruby
+# In constructor
+
+Errors::ResourceNotFound.new(context: 'batmans', id: 2)
+```
+
+```js
+// And then response will look like below
+
+{
+  "status": 404,
+  "key": "resource_not_found",
+  "message": "Resource Batman (2) was not found.",
+  "description": "Cuz I'm Batman",
+  "href": null
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/json_error.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'json_error'
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/json_error.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+require 'json_error/version'
+
+Gem::Specification.new do |s|
+  s.name = 'json_error'
+  s.version = JSONError::VERSION
+  s.summary = 'JSON errors base for APIs.'
+  s.homepage = 'https://github.com/buszu/json_error'
+  s.license = 'MIT'
+
+  s.authors = ['Krzysztof Buszewicz']
+  s.email = ['krzysztof.buszewicz@gmail.com']
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_dependency 'json'
+  s.add_dependency 'i18n'
+
+  s.add_development_dependency 'bundler', '~> 1.10'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec'
+end

data/lib/json_error.rb

@@ -0,0 +1,10 @@
+require 'i18n'
+require 'json'
+require 'json_error/version'
+require 'json_error/base'
+
+module JSONError
+  def self.base
+    Base
+  end
+end

data/lib/json_error/base.rb

@@ -0,0 +1,59 @@
+module JSONError
+  class Base < StandardError
+    NULL_TOKEN = '~'
+
+    attr_reader :context, :key, :options
+
+    def initialize(attrs = {})
+      @context = attrs[:context]
+      @key = attrs.fetch(:key)
+      @options = attrs.delete_if { |k, _v| %i(key context).include?(k) }
+      options.merge!(default: NULL_TOKEN)
+      super(message)
+    end
+
+    def self.properties
+      %i(status key message description href)
+    end
+
+    def message
+      translate(:message)
+    end
+
+    def description
+      translate(:description)
+    end
+
+    def href
+      translate(:href)
+    end
+
+    def status
+      translate(:status, default: 500)
+    end
+
+    def to_json(*args)
+      properties.to_json(*args)
+    end
+
+    private
+
+    def translate(node, translation_options = {})
+      translation_options = options.merge(translation_options)
+      translation = I18n.t("#{translation_path}.#{node}", translation_options)
+      translation unless translation == NULL_TOKEN
+    end
+
+    def translation_path
+      context.nil? ? "errors.#{key}" : "errors.#{context}.#{key}"
+    end
+
+    def properties
+      { status: status,
+        key: key,
+        message: message,
+        description: description,
+        href: href }.delete_if { |k, _v| !self.class.properties.include?(k) }
+    end
+  end
+end

data/lib/json_error/version.rb

@@ -0,0 +1,3 @@
+module JSONError
+  VERSION = '0.1.0'
+end

data/spec/fixtures/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  errors:
+    resource_not_found:
+      status: 404
+      message: 'Resource %{name} (%{id}) was not found.'
+      description: 'Blah blah blah.'
+      href: 'https://developers.api.pl/doc/errors/resource_not_found'

data/spec/json_error/base_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe JSONError::Base do
+  describe 'NULL_TOKEN' do
+    subject { described_class::NULL_TOKEN }
+    it { is_expected.to eq('~') }
+  end
+
+  describe '.superclass' do
+    subject { described_class.superclass }
+    it { is_expected.to be(StandardError) }
+  end
+
+  describe '.new' do
+    context 'called without :key option' do
+      subject { -> { described_class.new } }
+      it { is_expected.to raise_error(KeyError) }
+    end
+
+    context 'called with :key option' do
+      subject { described_class.new(key: :resource_not_found) }
+      it { is_expected.to be_a(described_class) }
+    end
+  end
+
+  describe '#status' do
+    subject { error.status }
+
+    context 'when not defined in locale' do
+      let(:error) { described_class.new(key: :other_error) }
+      it { is_expected.to eq(500) }
+    end
+
+    context 'when defined in locale' do
+      let(:error) { described_class.new(key: :resource_not_found) }
+      it { is_expected.to eq(404) }
+    end
+  end
+
+  describe '#key' do
+    let(:error) { described_class.new(key: :resource_not_found) }
+    subject { error.key }
+    it { is_expected.to eq(:resource_not_found) }
+  end
+
+  describe '#message' do
+    subject { error.message }
+
+    context 'when not defined in locale' do
+      let(:error) { described_class.new(key: :other_error) }
+      it { is_expected.to be_nil }
+    end
+
+    context 'when defined in locale' do
+      let(:name) { 'stick' }
+      let(:id) { 1 }
+      let(:error) do
+        described_class.new(key: :resource_not_found, name: name, id: id)
+      end
+      it { is_expected.to eq("Resource #{name} (#{id}) was not found.") }
+    end
+  end
+
+  describe '#description' do
+    subject { error.description }
+
+    context 'when not defined in locale' do
+      let(:error) { described_class.new(key: :other_error) }
+      it { is_expected.to be_nil }
+    end
+
+    context 'when defined in locale' do
+      let(:error) { described_class.new(key: :resource_not_found) }
+      it { is_expected.to eq('Blah blah blah.') }
+    end
+  end
+
+  describe '#href' do
+    subject { error.href }
+
+    context 'when not defined in locale' do
+      let(:error) { described_class.new(key: :other_error) }
+      it { is_expected.to be_nil }
+    end
+
+    context 'when defined in locale' do
+      let(:error) { described_class.new(key: :resource_not_found) }
+      it do
+        is_expected.to eq(
+          'https://developers.api.pl/doc/errors/resource_not_found'
+        )
+      end
+    end
+  end
+
+  describe '#to_json' do
+    let(:parse) { -> (s) { JSON.parse(s) } }
+    subject { error.to_json }
+
+    context 'when not defined in locale' do
+      let(:error) { described_class.new(key: :other_error) }
+      it { is_expected.to be_a(String) }
+      describe 'status property' do
+        it { expect(parse.call(subject)['status']).to eq(500) }
+      end
+      describe 'key property' do
+        it { expect(parse.call(subject)['key']).to eq(error.key.to_s) }
+      end
+      describe 'message property' do
+        it { expect(parse.call(subject)['message']).to be_nil }
+      end
+      describe 'description property' do
+        it { expect(parse.call(subject)['description']).to be_nil }
+      end
+      describe 'href property' do
+        it { expect(parse.call(subject)['href']).to be_nil }
+      end
+    end
+
+    context 'when defined in locale' do
+      let(:error) { described_class.new(key: :resource_not_found) }
+      it { is_expected.to be_a(String) }
+      describe 'status property' do
+        it { expect(parse.call(subject)['status']).to eq(error.status) }
+      end
+      describe 'key property' do
+        it { expect(parse.call(subject)['key']).to eq(error.key.to_s) }
+      end
+      describe 'message property' do
+        it { expect(parse.call(subject)['message']).to eq(error.message) }
+      end
+      describe 'description property' do
+        it do
+          expect(parse.call(subject)['description']).to eq(error.description)
+        end
+      end
+      describe 'href property' do
+        it { expect(parse.call(subject)['href']).to eq(error.href) }
+      end
+    end
+  end
+end

data/spec/json_error_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe JSONError do
+  describe 'VERSION' do
+    subject { described_class::VERSION }
+    it { is_expected.not_to be_nil }
+  end
+
+  describe '.base' do
+    subject { described_class.base }
+    it { is_expected.to be(described_class::Base) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'i18n'
+
+I18n.load_path = Dir['./spec/fixtures/locales/*.yml']
+require 'json_error'

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: json_error
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Krzysztof Buszewicz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  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'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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:
+- krzysztof.buszewicz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_error.gemspec
+- lib/json_error.rb
+- lib/json_error/base.rb
+- lib/json_error/version.rb
+- spec/fixtures/locales/en.yml
+- spec/json_error/base_spec.rb
+- spec/json_error_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/buszu/json_error
+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.5
+signing_key: 
+specification_version: 4
+summary: JSON errors base for APIs.
+test_files:
+- spec/fixtures/locales/en.yml
+- spec/json_error/base_spec.rb
+- spec/json_error_spec.rb
+- spec/spec_helper.rb
+has_rdoc: