json_error 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8d02b5a8dc09b18176bde4e04b523d218f255cf
-  data.tar.gz: 7bf5c086a9d80d91ceff09d6d430dbafabbe6768
+  metadata.gz: 28a81b856dd02155dd289ec81a832f45b29b4f97
+  data.tar.gz: f06bd7600097f2b491bfc5b54185fe84bc047551
 SHA512:
-  metadata.gz: 462ecb79ea50676654177e3aef1474faf926393696cce610929ffe9ca27c3f202c700a5304733115598da6895249b75d19345640ed72540e28a7051073c6ac6c
-  data.tar.gz: 14cabc02842c091ec6cb8af643ec2677293a14cd42dc55d8fa3d067b2d87427b18765f873b60ca747cafd0552c1a4d601fd09b9388f1ea1fdc2ffe68548f6f1a
+  metadata.gz: 994b65539357730f815ec54b1d21eace76d8b2d1dd6e3982cfc869c81b73e757bbe80ea4a1f5f946a0a78facbc12397caf1930baaf7bf23655a8af576cb117c6
+  data.tar.gz: ec9faff67503c5ad0883729d53c6b8d61e3f3ed3d5e7dc41a949eaa9041e8069f2f297396fd8e5c84946fdf3f45668f71494a1d85d308bb363689b3f621c56a8

data/README.md

@@ -18,7 +18,7 @@ And then execute:
 ## Introduction
 
 ### What is JSONError gem?
-It provides parent class with simple DSL to define API errors. It is based on concept, that error is something that went wrong (_what? = key_), in some circumstances (_when? = context_).
+It provides parent class with simple DSL to define API errors. It is based on concept that error is something that went wrong (_what? = key_) under certain circumstances (_when? = context_).
 
 ### Why would I use it?
 To design, manage and maintain API's errors JSON responses with ease.
@@ -31,13 +31,11 @@ Using locale file (e.g. json_errors.en.yml).
 en:
   json_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"
 ```
@@ -51,6 +49,8 @@ Let's take a look at example error class definition.
 ```ruby
 class Error < JSONError.base
   key :error
+  status 500
+
   translated_properties :message, :href
   custom_properties :details, :some_dependency
   visible_properties :key, :status, :message, :href, :details
@@ -63,6 +63,9 @@ Error.new(key: :error)
 ```
 however, json errors must have a key. Key is not inherited.
 
+*Status* is the error http status. If not specified will default to 500. It may be expressed
+by integer or string.
+
 *Default properties* are properties included to JSON output by default (:key, status: 500).
 - You can alias key property like in example below:
 ```ruby
@@ -87,11 +90,14 @@ Let's introduce two example error classes now. They will be used in further exam
 module Errors
   class ResourceNotFound < JSONError.base
     key :resource_not_found
+    status 404
     translated_properties :message, :href, :description
   end
 
   class OtherError < JSONError.base
     key :other_error
+    status 500
+
     translated_properties :message
   end
 end
@@ -106,7 +112,6 @@ Just add entries to locale.
 en:
   json_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'
@@ -183,13 +188,11 @@ You can specify different contexts for the same error key.
 en:
   json_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"
 ```

data/json_error.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'bundler', '~> 1.10'
   s.add_development_dependency 'rake', '~> 10.0'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'codeclimate-test-reporter'
+  s.add_development_dependency 'simplecov'
 end

data/lib/json_error/base.rb

@@ -30,6 +30,13 @@ module JSONError
         @key ||= key
       end
 
+      def status(status = nil)
+        return @status if status.nil?
+        disallowed_property_setting!(:status) if base?
+
+        @status = status
+      end
+
       def properties
         [*default_properties, *translated_properties, *custom_properties]
       end
@@ -73,7 +80,7 @@ module JSONError
     end
 
     def status
-      translate(:status, default: DEFAULT_STATUS)
+      self.class.status || 500
     end
 
     def to_json(*args)

data/lib/json_error/version.rb

@@ -1,3 +1,3 @@
 module JSONError
-  VERSION = '1.0.1'
+  VERSION = '2.0.0'
 end

data/spec/fixtures/json_error_base_children.rb

@@ -1,11 +1,15 @@
 class ResourceNotFound < JSONError.base
   key :resource_not_found
+  status 404
+
   translated_properties :message, :description, :href
   custom_properties :details
 end
 
 class MissingTranslations < JSONError.base
   key :missing_translations
+  status 404
+
   translated_properties :message, :description, :href
   custom_properties :details
   visible_properties(*default_properties, :message, :details)
@@ -19,8 +23,10 @@ end
 
 class WithKeyAlias < JSONError.base
   key :with_key_alias, as: :error_code
+  status 400
 end
 
 class WithKeyAliasChild < WithKeyAlias
   key :with_key_alias_child
+  status '429'
 end

data/spec/fixtures/locales/en.yml

@@ -1,13 +1,11 @@
 en:
   json_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'
     other:
       resource_not_found:
-        status: 400
         message: 'Resource not found.'
         description: 'Bleh bleh bleh.'
         href: 'https://developers.api.pl/doc/errors/resource_not_found?context=other'

data/spec/json_error/base_children_spec.rb

@@ -85,7 +85,7 @@ describe ResourceNotFound do
 
       context 'for context "other"' do
         subject { described_class.new(context: 'other').status }
-        it { is_expected.to eq(400) }
+        it { is_expected.to eq(404) }
       end
     end
 
@@ -177,7 +177,7 @@ describe MissingTranslations do
 
     describe '#status' do
       subject { described_class.new.status }
-      it { is_expected.to eq(500) }
+      it { is_expected.to eq(404) }
     end
 
     describe '#key' do
@@ -292,7 +292,7 @@ describe WithKeyAlias do
     end
 
     describe 'status property' do
-      it { expect(parse.call(subject)['status']).to eq(500) }
+      it { expect(parse.call(subject)['status']).to eq(400) }
     end
 
     describe 'error_code property' do
@@ -320,7 +320,7 @@ describe WithKeyAliasChild do
     end
 
     describe 'status property' do
-      it { expect(parse.call(subject)['status']).to eq(500) }
+      it { expect(parse.call(subject)['status']).to eq('429') }
     end
 
     describe 'error_code property' do

data/spec/json_error/base_spec.rb

@@ -102,17 +102,10 @@ describe JSONError::Base do
   end
 
   describe '#status' do
+    let(:error) { described_class.new(key: :other_error) }
     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
+    it { is_expected.to eq(500) }
   end
 
   describe '#key' do

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
+require 'simplecov'
+SimpleCov.start
 
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_error
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Krzysztof Buszewicz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-17 00:00:00.000000000 Z
+date: 2018-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: JSON errors base for APIs.
@@ -155,4 +155,3 @@ test_files:
 - spec/json_error/errors/disallowed_property_setting.rb
 - spec/json_error_spec.rb
 - spec/spec_helper.rb
-has_rdoc: