clean_errors 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f60044739670af8f1146e9d2fec015cafc639dba76a1dd5ea46bbc5b356b676
-  data.tar.gz: 54466c860ccaaede9ff70e61609f238e8596dd5a81a0a586c64ebc202a024a23
+  metadata.gz: c5e9f3cb62e40e238bccfbcb9e0adc1aebb0eeb58cd6b9d6c6c442208a6be0ed
+  data.tar.gz: ac3ea0aac7d03c12fa54641b8963e05ce97e26a646eea052383b00c3316dc5aa
 SHA512:
-  metadata.gz: 97cdd89abd0ebaa2094d48d15af59dded38cd7ca1605439ca59ab5f0e85c9a4d497c6ec9b9bc83bc64325e1ad82ebf95b157e0ab879722fca92ff45599c88814
-  data.tar.gz: 158361b020b22cec2f46446f143c3f0c12553c1cb4fe80ae1ed5e184fcbfe2fad6cb334fbcb09e67526308f0a4fbad7d639a20131366b4eed6b9481ef8708f9b
+  metadata.gz: cde57ba45af21562d5c52d80056f7d494b8729a596c3a72d5643e48b2d9a9c0cd1f5a29f73f6ea3a8d4eece69aa1d1f6e75bc299fd9deec25eed8c0f83625e98
+  data.tar.gz: 6e6c45f19240f18a0eee3833324d886044bfdfd0a17793aaf6d2e848301b64263e7cdd15535672cda387da512806cb49162c2917ac064a7e9bace6871424bd74

data/CHANGES.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## [1.0.1]
+- Clean up gemspec
+
+## [1.0.0]
+- Initial release of the gem

data/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+Contributing
+============
+
+If you would like to contribute code to this project you can do so through GitHub by
+forking the repository and sending a pull request.
+
+When submitting code, please make every effort to follow existing conventions
+and style in order to keep the code as readable as possible. Please also make
+sure your code compiles by running `mvn clean verify`. Checkstyle failures
+during compilation indicate errors in your style and can be viewed in the
+`checkstyle-result.xml` file.
+
+Before your code can be accepted into the project you must also sign the
+[Individual Contributor License Agreement (CLA)][1].
+
+
+ [1]: https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1

data/Gemfile

@@ -0,0 +1,7 @@
+ruby '2.5.1'
+
+group :development, :test do
+  gem 'rspec'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 Square, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# Clean Errors Gem
+
+This is a small utility gem that allows for typed errors with I18n
+lookup built in. It provides an easy to use framework for making
+well structured, meaningful errors without adding a ton of boilerplate
+to your ruby code.
+
+## Requirements
+
+Requires Ruby 2.5 or greater.
+Requires I18n (included in Rails by default).
+
+## Installation
+
+Add clean_errors to your Gemfile
+
+```
+gem 'clean_errors'
+```
+
+## Usage
+
+```ruby
+class PlainRubyClass
+  def do_something
+    obj = Object.find_by(id: 1)
+
+    return CleanErrors::ValidationError('ResourceNotFound') unless obj
+
+    obj
+  end
+end
+```
+
+This will create a validation error that will look up the message in I18n
+config files and type it appropriately. You can also render this object as
+JSON and it'll work.
+
+### I18n
+
+This will look up keys by "errors.#{type}" where the type is the value you
+pass in. It will then apply named substitions on the string and set it
+to the message.
+
+### JSON Representation
+
+When you return a CleanError as JSON, it will render like this:
+
+```json
+{
+  "type": "ResourceNotFound",
+  "message": "Resource User[14] was not found."
+}
+```
+
+### Named Substitutions
+
+We use Ruby's built in string substition to make I18n more flexible. For example,
+we could have the I18n string set to
+
+```yaml
+errors:
+  ResourceNotFound: "Resource %{resource} was not found"
+```
+
+And then have the caller pass in the named arguments
+
+```ruby
+CleanErrors::ValidationError('ResourceNotFound', resource: 'Object[1]')
+```
+
+### License
+
+    Copyright 2018 Square, Inc.
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

data/clean_errors.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clean_errors/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'clean_errors'
+  spec.version       = CleanErrors::VERSION
+  spec.authors       = ['Square']
+  spec.email         = ['support@trycaviar.com']
+  spec.summary       = 'Simple errors with strong definitions'
+  spec.description   = 'Simple errors with strong definitions. Used for making API Errors.'
+  spec.homepage      = 'https://www.trycaviar.com'
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'i18n', '~> 1.0'
+  spec.add_dependency 'activesupport', '>= 4.2'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 12.3'
+end

data/lib/clean_errors.rb

@@ -0,0 +1,25 @@
+require 'i18n'
+require 'active_support/json'
+require 'clean_errors/validation_error'
+
+I18n.config.available_locales = :en
+
+module CleanErrors
+  class << self
+    def ValidationError(type, i18n_data={})
+      CleanErrors::ValidationError.new(
+        type: type,
+        message: I18n.t("#{translation_path}.#{type}") % i18n_data
+      )
+    end
+    alias_method :Error, :ValidationError
+
+    def translation_path
+      @path || "errors"
+    end
+
+    def translation_path= value
+      @path = value
+    end
+  end
+end

data/lib/clean_errors/validation_error.rb

@@ -0,0 +1,3 @@
+module CleanErrors
+  ValidationError = Struct.new(:type, :message, keyword_init: true)
+end

data/lib/clean_errors/version.rb

@@ -0,0 +1,3 @@
+module CleanErrors
+  VERSION = '1.0.1'
+end

data/spec/json_spec.rb

@@ -0,0 +1,38 @@
+require 'clean_errors'
+
+RSpec.describe CleanErrors::ValidationError do
+  subject { CleanErrors::ValidationError('ResourceNotFound') }
+
+  it 'should render json' do
+    expected_value = {
+      type: 'ResourceNotFound',
+      message: 'translation missing: en.errors.ResourceNotFound'
+    }
+    expect(subject.to_json).to eq(expected_value.to_json)
+  end
+
+  context 'for Error' do
+    subject { CleanErrors::Error('GenericError') }
+
+    it 'should render json' do
+      expected_value = {
+        type: 'GenericError',
+        message: 'translation missing: en.errors.GenericError'
+      }
+      expect(subject.to_json).to eq(expected_value.to_json)
+    end
+  end
+
+  context 'for different path' do
+    before { CleanErrors.translation_path = 'mypath' }
+    after { CleanErrors.translation_path = nil }
+
+    it 'should render json' do
+      expected_value = {
+        type: 'ResourceNotFound',
+        message: 'translation missing: en.mypath.ResourceNotFound'
+      }
+      expect(subject.to_json).to eq(expected_value.to_json)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clean_errors
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Square
@@ -14,30 +14,30 @@ dependencies:
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -56,23 +56,33 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Simple errors with strong definitions
+        version: '12.3'
+description: Simple errors with strong definitions. Used for making API Errors.
 email:
 - support@trycaviar.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- CHANGES.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- clean_errors.gemspec
+- lib/clean_errors.rb
+- lib/clean_errors/validation_error.rb
+- lib/clean_errors/version.rb
+- spec/json_spec.rb
 homepage: https://www.trycaviar.com
 licenses:
 - Apache-2.0
@@ -97,4 +107,5 @@ rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Simple errors with strong definitions
-test_files: []
+test_files:
+- spec/json_spec.rb