json_error 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 710945ff34e88690adf8b1287c718d8a1452fd22
-  data.tar.gz: b99fed58240fc196859f26225809d5095d22a119
+  metadata.gz: a4322948d35b22110cc1c146b0da8bd3d0f16f94
+  data.tar.gz: 55b445035a7813c5e4d73a12e1c270696aac45b9
 SHA512:
-  metadata.gz: 05856bbb8024a62a2733bc783ecc06cbd312cffcada7e4e0caf4935845d2b80b8a4c1d6c9150100fde8673a88aeccc15a52c3e3b2ce2ccbcf81a11d0882f7e47
-  data.tar.gz: 791ffbea2fa34ac4aaa4a4241eeb8ab14d25000c6c6d8e50201b1e05a3f8ca124bd6dd3423e285294ffe993d87f7aae4f512b6e882911390ef0a0ed36c49ca95
+  metadata.gz: e8dcdc4ca99ac2245247d35cbecfd2dc1e5e2ced09fd8fcfa303a2a699bd33868dc03fff3cd99daaef8bb734eb24fe19e2dc8c78e092046d54a3a3251241b4d7
+  data.tar.gz: fc4668dd5daca19f4a389d0b455617b3ae7958bf5461f5d7c2a5f01e207df5c04a951495a1e3adaf0117b250bfb5638af8ffd289d1d300c30f1025ecdd7c46c2

data/.rubocop.yml

@@ -1,2 +1,8 @@
+Metrics/LineLength:
+  Max: 90
+
 Style/Documentation:
   Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise

data/README.md

@@ -1,5 +1,6 @@
 # JSONError
 
+[![Gem Version](https://badge.fury.io/rb/json_error.svg)](https://badge.fury.io/rb/json_error)
 [![Code Climate](https://codeclimate.com/github/buszu/json_error/badges/gpa.svg)](https://codeclimate.com/github/buszu/json_error)
 
 ## Installation
@@ -7,46 +8,95 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'json_error', github: 'buszu/json_error'
+gem 'json_error'
 ```
 
 And then execute:
 
     $ bundle
 
+## 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_).
+
+### Why would I use it?
+To design, manage and maintain API's errors JSON responses with ease.
+
+### How to do it?
+Using locale file (e.g. json_errors.en.yml).
+
+```yml
+# json_errors.en.yml example
+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"
+```
+
 ## Usage
 
-### Defining JSONErrors
+### Understading JSONError
+
+Let's take a look at example error class definition.
+
+```ruby
+class Error < JSONError.base
+  key :error
+  translated_properties :message, :href
+  custom_properties :details, :some_dependency
+  visible_properties :key, :status, :message, :href, :details
+end
+```
+
+*Key* is the error identifier. It's not obligatory to specify its value here - you can also and pass it to the Error initializer when instantiating error object:
+```ruby
+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.
+
+*Translated properties* are error attributes which values will be loaded from locale. Translated properties can be inherited.
+
+*Custom properties* are attributes that won't be loaded from locale but passed to JSON output as they stand. It can be for exammple hash of ActiveRecord object validation error messages. Custom properties can be inherited.
+
+*Visible properties* is optional whitelist for output JSON properties. By default all default, translated and custom properties are included in output. You can use visible_properties method to include only demanded subset. Visible properties are not inherited.
+
+### Defining JSONError
+
+Let's introduce two example error classes now. They will be used in further examples.
 
 ```ruby
 module Errors
   class ResourceNotFound < JSONError.base
-    def initialize(options = {})
-      # Add required :key option
-      options.merge!(key: :resource_not_found)
-      super(options)
-    end
+    key :resource_not_found
+    translated_properties :message, :href, :description
   end
 
   class OtherError < JSONError.base
-    # Slice response JSON properties
-    def self.properties
-      super - %i(href description)
-    end
-
-    options.merge!(key: :other_error)
-    super(options)
+    key :other_error
+    translated_properties :message
   end
 end
 ```
 
 ### Defining JSONError Properties
 
-Add entries below to your locale.
+Just add entries to locale.
 
 ```yml
+# config/locales/json_errors.en.yml
 en:
-  errors:
+  json_errors:
     resource_not_found:
       status: 404
       message: 'Resource %{name} (%{id}) was not found.'
@@ -82,7 +132,6 @@ end
 
 ```ruby
 # Remember to load dependencies
-
 class Application < Sinatra::Base
   before { content_type :json }
 
@@ -124,7 +173,7 @@ You can specify different contexts for the same error key.
 # In locale
 
 en:
-  errors:
+  json_errors:
     resource_not_found:
       status: 404
       message: 'Resource %{name} (%{id}) was not found.'
@@ -157,7 +206,7 @@ Errors::ResourceNotFound.new(context: 'batmans', id: 2)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/json_error.
+Questions, propositions, bug reports and pull requests are welcome.
 
 
 ## License

data/bin/console

@@ -4,4 +4,6 @@ require 'bundler/setup'
 require 'json_error'
 
 require 'irb'
+
+I18n.load_path = Dir['./spec/fixtures/locales/*.yml']
 IRB.start

data/lib/json_error/base.rb

@@ -1,43 +1,96 @@
 module JSONError
   class Base < StandardError
+    DEFAULT_STATUS = 500
     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
+    class << self
+      def inherited(base)
+        base.instance_variable_set(:@translated_properties, translated_properties)
+        base.instance_variable_set(:@custom_properties, custom_properties)
+      end
 
-    def self.properties
-      %i(status key message description href)
-    end
+      def base?
+        self == JSONError.base
+      end
 
-    def message
-      translate(:message)
-    end
+      def disallowed_property_setting!(property)
+        raise(Errors::DisallowedPropertySetting, property: property, class: self)
+      end
+
+      def key(key = nil)
+        return @key if key.nil?
+        disallowed_property_setting!(:key) if base?
+
+        @key ||= key
+      end
+
+      def properties
+        [*default_properties, *translated_properties, *custom_properties]
+      end
+
+      def default_properties
+        %i(status key)
+      end
+
+      def translated_properties(*translated_properties)
+        return @translated_properties if translated_properties.empty?
+        disallowed_property_setting!(:translated_properties) if base?
+
+        translated_properties.each do |property|
+          define_method(property) { translate(property) }
+        end
+        @translated_properties = [*@translated_properties, *translated_properties].uniq
+      end
+
+      def custom_properties(*custom_properties)
+        return @custom_properties if custom_properties.empty?
+        disallowed_property_setting!(:custom_properties) if base?
 
-    def description
-      translate(:description)
+        attr_accessor(*custom_properties)
+        @custom_properties = [*@custom_properties, *custom_properties].uniq
+      end
+
+      def visible_properties(*visible_properties)
+        return(@visible_properties || properties) if visible_properties.empty?
+        disallowed_property_setting!(:visible_properties) if base?
+
+        @visible_properties = visible_properties.uniq
+      end
     end
 
-    def href
-      translate(:href)
+    def initialize(attrs = {})
+      @key = self.class.key || attrs.fetch(:key)
+      @context = attrs[:context]
+      assign_custom_properties(attrs)
+      assign_options(attrs)
+      super(message)
     end
 
     def status
-      translate(:status, default: 500)
+      translate(:status, default: DEFAULT_STATUS)
     end
 
     def to_json(*args)
-      properties.to_json(*args)
+      visible_properties_hash.to_json(*args)
     end
 
     private
 
+    def assign_custom_properties(attrs = {})
+      attrs = attrs.dup.delete_if { |k, _v| !custom_properties.include?(k) }
+      custom_properties.each do |property|
+        instance_variable_set("@#{property}", attrs[property])
+      end
+    end
+
+    def assign_options(attrs = {})
+      reserved_names = %i(key context) + custom_properties
+      @options = attrs.dup.delete_if { |k, _v| reserved_names.include?(k) }
+      options.merge!(default: NULL_TOKEN)
+    end
+
     def translate(node, translation_options = {})
       translation_options = options.merge(translation_options)
       translation = I18n.t("#{translation_path}.#{node}", translation_options)
@@ -45,15 +98,19 @@ module JSONError
     end
 
     def translation_path
-      context.nil? ? "errors.#{key}" : "errors.#{context}.#{key}"
+      context.nil? ? "json_errors.#{key}" : "json_errors.#{context}.#{key}"
+    end
+
+    def visible_properties_hash
+      Hash[visible_properties.map { |property| [property, send(property)] }]
+    end
+
+    def visible_properties
+      self.class.visible_properties
     end
 
-    def properties
-      { status: status,
-        key: key,
-        message: message,
-        description: description,
-        href: href }.delete_if { |k, _v| !self.class.properties.include?(k) }
+    def custom_properties
+      self.class.custom_properties || []
     end
   end
 end

data/lib/json_error/errors/disallowed_property_setting.rb

@@ -0,0 +1,11 @@
+module JSONError
+  module Errors
+    class DisallowedPropertySetting < StandardError
+      def initialize(options = {})
+        property = options.fetch(:property)
+        klass = options.fetch(:class)
+        super("Setting #{property} property is disallowed for #{klass}.")
+      end
+    end
+  end
+end

data/lib/json_error/version.rb

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

data/lib/json_error.rb

@@ -1,6 +1,7 @@
 require 'i18n'
 require 'json'
 require 'json_error/version'
+require 'json_error/errors/disallowed_property_setting'
 require 'json_error/base'
 
 module JSONError

data/spec/fixtures/json_error_base_children.rb

@@ -0,0 +1,18 @@
+class ResourceNotFound < JSONError.base
+  key :resource_not_found
+  translated_properties :message, :description, :href
+  custom_properties :details
+end
+
+class MissingTranslations < JSONError.base
+  key :missing_translations
+  translated_properties :message, :description, :href
+  custom_properties :details
+  visible_properties(*default_properties, :message, :details)
+end
+
+class ChildError < MissingTranslations
+  key :child_error
+  translated_properties :additional_translated
+  custom_properties :additional_custom
+end

data/spec/fixtures/locales/en.yml

@@ -1,7 +1,13 @@
 en:
-  errors:
+  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

@@ -0,0 +1,274 @@
+require 'spec_helper'
+
+describe ResourceNotFound do
+  context 'as JSONError.base child-class' 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(JSONError.base) }
+    end
+
+    describe '.base?' do
+      subject { described_class.base? }
+      it { is_expected.to be_falsey }
+    end
+
+    describe '.key' do
+      context 'when no key was passed' do
+        subject { described_class.key }
+        it { is_expected.to eq(:resource_not_found) }
+      end
+    end
+
+    describe '.properties' do
+      subject { described_class.properties }
+      let(:properties) do
+        described_class.default_properties + %i(message description href details)
+      end
+      it { is_expected.to eq(properties) }
+    end
+
+    describe '.default_properties' do
+      subject { described_class.default_properties }
+      it { is_expected.to eq(%i(status key)) }
+    end
+
+    describe '.translated_properties' do
+      subject { described_class.translated_properties }
+      context 'when no args were passed' do
+        it { is_expected.to eq(%i(message description href)) }
+      end
+    end
+
+    describe '.custom_properties' do
+      subject { described_class.custom_properties }
+
+      context 'when no args were passed' do
+        it { is_expected.to eq(%i(details)) }
+      end
+    end
+
+    describe '.visible_properties' do
+      subject { described_class.visible_properties }
+      context 'when no args were passed' do
+        it { is_expected.to eq(described_class.properties) }
+      end
+    end
+
+    describe '.new' do
+      context 'called without :key option' do
+        subject { described_class.new }
+        it { is_expected.to be_a(described_class) }
+        describe '#key' do
+          it { expect(subject.key).to eq(:resource_not_found) }
+        end
+      end
+
+      context 'called with :key option' do
+        subject { described_class.new(key: :other_key) }
+        it { is_expected.to be_a(described_class) }
+        describe '#key' do
+          it { expect(subject.key).to eq(:resource_not_found) }
+        end
+      end
+    end
+
+    describe '#status' do
+      context 'for default context' do
+        subject { described_class.new.status }
+        it { is_expected.to eq(404) }
+      end
+
+      context 'for context "other"' do
+        subject { described_class.new(context: 'other').status }
+        it { is_expected.to eq(400) }
+      end
+    end
+
+    describe '#key' do
+      subject { described_class.new.key }
+      it { is_expected.to eq(:resource_not_found) }
+    end
+
+    describe '#message' do
+      context 'for default context' do
+        subject { described_class.new.message }
+        it { is_expected.to eq('Resource %{name} (%{id}) was not found.') }
+      end
+
+      context 'for context "other"' do
+        subject { described_class.new(context: 'other').message }
+        it { is_expected.to eq('Resource not found.') }
+      end
+    end
+
+    describe '#description' do
+      context 'for default context' do
+        subject { described_class.new.description }
+        it { is_expected.to eq('Blah blah blah.') }
+      end
+
+      context 'for context "other"' do
+        subject { described_class.new(context: 'other').description }
+        it { is_expected.to eq('Bleh bleh bleh.') }
+      end
+    end
+
+    describe '#href' do
+      context 'for default context' do
+        subject { described_class.new.href }
+        it do
+          is_expected.to eq('https://developers.api.pl/doc/errors/resource_not_found')
+        end
+      end
+
+      context 'for context "other"' do
+        subject { described_class.new(context: 'other').href }
+        it do
+          is_expected.to eq('https://developers.api.pl/doc/errors/resource_not_found?context=other')
+        end
+      end
+    end
+
+    describe '#to_json' do
+      let(:parse) { -> (s) { JSON.parse(s) } }
+      let(:error) { described_class.new }
+      subject { error.to_json }
+
+      describe '#keys' do
+        let(:keys) { %w(status key message description href details) }
+        it { expect(parse.call(subject).keys).to eq(keys) }
+      end
+
+      context 'when defined in locale' do
+        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.to_s) }
+        end
+        describe 'description property' do
+          it { expect(parse.call(subject)['description']).to eq(error.description.to_s) }
+        end
+        describe 'href property' do
+          it { expect(parse.call(subject)['href']).to eq(error.href.to_s) }
+        end
+      end
+    end
+  end
+end
+
+describe MissingTranslations do
+  context 'as JSONError.base child-class' do
+    describe '.visible_properties' do
+      subject { described_class.visible_properties }
+      context 'when no args were passed' do
+        it { is_expected.to eq(%i(status key message details)) }
+      end
+    end
+
+    describe '#status' do
+      subject { described_class.new.status }
+      it { is_expected.to eq(500) }
+    end
+
+    describe '#key' do
+      subject { described_class.new.key }
+      it { is_expected.to eq(:missing_translations) }
+    end
+
+    describe '#message' do
+      subject { described_class.new.message }
+      it { is_expected.to be_nil }
+    end
+
+    describe '#description' do
+      subject { described_class.new.description }
+      it { is_expected.to be_nil }
+    end
+
+    describe '#href' do
+      subject { described_class.new.href }
+      it { is_expected.to be_nil }
+    end
+
+    describe '#to_json' do
+      let(:parse) { -> (s) { JSON.parse(s) } }
+      let(:details) { { 'detail' => 'value' } }
+      let(:error) { described_class.new(details: details) }
+      subject { error.to_json }
+
+      describe '#keys' do
+        let(:keys) { %w(status key message details) }
+        it { expect(parse.call(subject).keys).to eq(keys) }
+      end
+
+      context 'when defined in locale' do
+        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 be_nil }
+        end
+        describe 'details property' do
+          it { expect(parse.call(subject)['details']).to eq(error.details) }
+        end
+      end
+    end
+  end
+end
+
+describe ChildError do
+  let(:parent_class) { MissingTranslations }
+  context 'as MissingTranslations child-class' do
+    describe '.visible_properties' do
+      subject { described_class.visible_properties.sort }
+      context 'when no args were passed' do
+        it do
+          is_expected.to eq(
+            [*parent_class.properties, :additional_translated, :additional_custom].sort
+          )
+        end
+      end
+    end
+
+    describe '.translated_properties' do
+      subject { described_class.translated_properties.sort }
+      context 'when no args were passed' do
+        it do
+          is_expected.to eq(
+            [*parent_class.translated_properties, :additional_translated].sort
+          )
+        end
+      end
+    end
+
+    describe '.custom_properties' do
+      subject { described_class.custom_properties.sort }
+      context 'when no args were passed' do
+        it do
+          is_expected.to eq(
+            [*parent_class.custom_properties, :additional_custom].sort
+          )
+        end
+      end
+    end
+
+    describe '#key' do
+      subject { described_class.new.key }
+      it { is_expected.to eq(:child_error) }
+    end
+  end
+end

data/spec/json_error/base_spec.rb

@@ -1,6 +1,11 @@
 require 'spec_helper'
 
 describe JSONError::Base do
+  describe 'DEFAULT_STATUS' do
+    subject { described_class::DEFAULT_STATUS }
+    it { is_expected.to eq(500) }
+  end
+
   describe 'NULL_TOKEN' do
     subject { described_class::NULL_TOKEN }
     it { is_expected.to eq('~') }
@@ -11,88 +16,111 @@ describe JSONError::Base do
     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) }
+  describe '.base?' do
+    subject { described_class.base? }
+    it { is_expected.to be_truthy }
+  end
+
+  describe '.key' do
+    context 'when no key was passed' do
+      subject { described_class.key }
+      it { is_expected.to be_nil }
     end
 
-    context 'called with :key option' do
-      subject { described_class.new(key: :resource_not_found) }
-      it { is_expected.to be_a(described_class) }
+    context 'when key were passed' do
+      let(:error) { JSONError::Errors::DisallowedPropertySetting }
+      subject { -> { described_class.key(:error) } }
+      it { is_expected.to raise_error(error) }
     end
   end
 
-  describe '#status' do
-    subject { error.status }
+  describe '.properties' do
+    subject { described_class.properties }
+    it { is_expected.to eq(described_class.default_properties) }
+  end
 
-    context 'when not defined in locale' do
-      let(:error) { described_class.new(key: :other_error) }
-      it { is_expected.to eq(500) }
-    end
+  describe '.default_properties' do
+    subject { described_class.default_properties }
+    it { is_expected.to eq(%i(status key)) }
+  end
 
-    context 'when defined in locale' do
-      let(:error) { described_class.new(key: :resource_not_found) }
-      it { is_expected.to eq(404) }
+  describe '.translated_properties' do
+    subject { described_class.translated_properties(*args) }
+
+    context 'when no args were passed' do
+      let(:args) { [] }
+      it { is_expected.to be_nil }
     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) }
+    context 'when args were passed' do
+      let(:args) { %i(message) }
+      let(:error) { JSONError::Errors::DisallowedPropertySetting }
+      it { expect { subject }.to raise_error(error) }
+    end
   end
 
-  describe '#message' do
-    subject { error.message }
+  describe '.custom_properties' do
+    subject { described_class.custom_properties(*args) }
 
-    context 'when not defined in locale' do
-      let(:error) { described_class.new(key: :other_error) }
+    context 'when no args were passed' do
+      let(:args) { [] }
       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.") }
+    context 'when args were passed' do
+      let(:args) { %i(message) }
+      let(:error) { JSONError::Errors::DisallowedPropertySetting }
+      it { expect { subject }.to raise_error(error) }
     end
   end
 
-  describe '#description' do
-    subject { error.description }
+  describe '.visible_properties' do
+    subject { described_class.visible_properties(*args) }
 
-    context 'when not defined in locale' do
-      let(:error) { described_class.new(key: :other_error) }
-      it { is_expected.to be_nil }
+    context 'when no args were passed' do
+      let(:args) { [] }
+      it { is_expected.to eq(described_class.properties) }
     end
 
-    context 'when defined in locale' do
-      let(:error) { described_class.new(key: :resource_not_found) }
-      it { is_expected.to eq('Blah blah blah.') }
+    context 'when args were passed' do
+      let(:args) { %i(message) }
+      let(:error) { JSONError::Errors::DisallowedPropertySetting }
+      it { expect { subject }.to raise_error(error) }
     end
   end
 
-  describe '#href' do
-    subject { error.href }
+  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 be_nil }
+      it { is_expected.to eq(500) }
     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
+      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 '#to_json' do
     let(:parse) { -> (s) { JSON.parse(s) } }
     subject { error.to_json }
@@ -106,15 +134,6 @@ describe JSONError::Base do
       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
@@ -126,17 +145,6 @@ describe JSONError::Base do
       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/errors/disallowed_property_setting.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe JSONError::Base do
+  describe '.superclass' do
+    subject { described_class.superclass }
+    it { is_expected.to be(StandardError) }
+  end
+
+  describe '.new' do
+    let(:no_option_error) { KeyError }
+    subject { -> (options) { described_class.new(options) } }
+
+    it 'requires :property option' do
+      expect { subject.call({}) }.to raise_error(no_option_error)
+    end
+
+    it 'requires :class option' do
+      expect { subject.call(property: :p) }.to raise_error(no_option_error)
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_error
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Krzysztof Buszewicz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-11 00:00:00.000000000 Z
+date: 2015-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -100,9 +100,13 @@ files:
 - json_error.gemspec
 - lib/json_error.rb
 - lib/json_error/base.rb
+- lib/json_error/errors/disallowed_property_setting.rb
 - lib/json_error/version.rb
+- spec/fixtures/json_error_base_children.rb
 - spec/fixtures/locales/en.yml
+- spec/json_error/base_children_spec.rb
 - spec/json_error/base_spec.rb
+- spec/json_error/errors/disallowed_property_setting.rb
 - spec/json_error_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/buszu/json_error
@@ -130,8 +134,11 @@ signing_key:
 specification_version: 4
 summary: JSON errors base for APIs.
 test_files:
+- spec/fixtures/json_error_base_children.rb
 - spec/fixtures/locales/en.yml
+- spec/json_error/base_children_spec.rb
 - spec/json_error/base_spec.rb
+- spec/json_error/errors/disallowed_property_setting.rb
 - spec/json_error_spec.rb
 - spec/spec_helper.rb
 has_rdoc: