json_error 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4322948d35b22110cc1c146b0da8bd3d0f16f94
-  data.tar.gz: 55b445035a7813c5e4d73a12e1c270696aac45b9
+  metadata.gz: d8d02b5a8dc09b18176bde4e04b523d218f255cf
+  data.tar.gz: 7bf5c086a9d80d91ceff09d6d430dbafabbe6768
 SHA512:
-  metadata.gz: e8dcdc4ca99ac2245247d35cbecfd2dc1e5e2ced09fd8fcfa303a2a699bd33868dc03fff3cd99daaef8bb734eb24fe19e2dc8c78e092046d54a3a3251241b4d7
-  data.tar.gz: fc4668dd5daca19f4a389d0b455617b3ae7958bf5461f5d7c2a5f01e207df5c04a951495a1e3adaf0117b250bfb5638af8ffd289d1d300c30f1025ecdd7c46c2
+  metadata.gz: 462ecb79ea50676654177e3aef1474faf926393696cce610929ffe9ca27c3f202c700a5304733115598da6895249b75d19345640ed72540e28a7051073c6ac6c
+  data.tar.gz: 14cabc02842c091ec6cb8af643ec2677293a14cd42dc55d8fa3d067b2d87427b18765f873b60ca747cafd0552c1a4d601fd09b9388f1ea1fdc2ffe68548f6f1a

data/README.md

@@ -63,7 +63,15 @@ Error.new(key: :error)
 ```
 however, json errors must have a key. Key is not inherited.
 
-*Default properties* are properties included to JSON output by default (:key, status: 500). You can change status in locale.
+*Default properties* are properties included to JSON output by default (:key, status: 500).
+- You can alias key property like in example below:
+```ruby
+class SomeError < JSONError.base
+  # There will be "error_code" within .to_json output instead of "key"
+  key :error, as: :error_code
+end
+```
+- You can change status in locale.
 
 *Translated properties* are error attributes which values will be loaded from locale. Translated properties can be inherited.
 

data/json_error.gemspec

@@ -23,4 +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'
 end

data/lib/json_error/base.rb

@@ -6,9 +6,12 @@ module JSONError
     attr_reader :context, :key, :options
 
     class << self
+      attr_reader :key_alias
+
       def inherited(base)
         base.instance_variable_set(:@translated_properties, translated_properties)
         base.instance_variable_set(:@custom_properties, custom_properties)
+        base.instance_variable_set(:@key_alias, key_alias)
       end
 
       def base?
@@ -19,10 +22,11 @@ module JSONError
         raise(Errors::DisallowedPropertySetting, property: property, class: self)
       end
 
-      def key(key = nil)
+      def key(key = nil, options = {})
         return @key if key.nil?
         disallowed_property_setting!(:key) if base?
 
+        @key_alias = options[:as] if options[:as].is_a?(Symbol)
         @key ||= key
       end
 
@@ -102,7 +106,9 @@ module JSONError
     end
 
     def visible_properties_hash
-      Hash[visible_properties.map { |property| [property, send(property)] }]
+      h = Hash[visible_properties.map { |property| [property, send(property)] }]
+      h[key_alias] = h.delete(:key) unless key_alias.nil?
+      h
     end
 
     def visible_properties
@@ -112,5 +118,9 @@ module JSONError
     def custom_properties
       self.class.custom_properties || []
     end
+
+    def key_alias
+      self.class.key_alias
+    end
   end
 end

data/lib/json_error/version.rb

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

data/spec/fixtures/json_error_base_children.rb

@@ -16,3 +16,11 @@ class ChildError < MissingTranslations
   translated_properties :additional_translated
   custom_properties :additional_custom
 end
+
+class WithKeyAlias < JSONError.base
+  key :with_key_alias, as: :error_code
+end
+
+class WithKeyAliasChild < WithKeyAlias
+  key :with_key_alias_child
+end

data/spec/json_error/base_children_spec.rb

@@ -272,3 +272,59 @@ describe ChildError do
     end
   end
 end
+
+describe WithKeyAlias do
+  let(:error_object) { described_class.new }
+  let(:error_key) { :with_key_alias }
+
+  describe '#key' do
+    subject { error_object.key }
+    it { is_expected.to eq(error_key) }
+  end
+
+  describe '#to_json' do
+    let(:parse) { -> (s) { JSON.parse(s) } }
+    subject { error_object.to_json }
+
+    describe '#keys' do
+      let(:keys) { %w(status error_code) }
+      it { expect(parse.call(subject).keys).to eq(keys) }
+    end
+
+    describe 'status property' do
+      it { expect(parse.call(subject)['status']).to eq(500) }
+    end
+
+    describe 'error_code property' do
+      it { expect(parse.call(subject)['error_code']).to eq(error_key.to_s) }
+    end
+  end
+end
+
+describe WithKeyAliasChild do
+  let(:error_object) { described_class.new }
+  let(:error_key) { :with_key_alias_child }
+
+  describe '#key' do
+    subject { error_object.key }
+    it { is_expected.to eq(error_key) }
+  end
+
+  describe '#to_json' do
+    let(:parse) { -> (s) { JSON.parse(s) } }
+    subject { error_object.to_json }
+
+    describe '#keys' do
+      let(:keys) { %w(status error_code) }
+      it { expect(parse.call(subject).keys).to eq(keys) }
+    end
+
+    describe 'status property' do
+      it { expect(parse.call(subject)['status']).to eq(500) }
+    end
+
+    describe 'error_code property' do
+      it { expect(parse.call(subject)['error_code']).to eq(error_key.to_s) }
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_error
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Krzysztof Buszewicz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-25 00:00:00.000000000 Z
+date: 2015-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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
@@ -129,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: JSON errors base for APIs.