json_error_serializer 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a40011fe62a351236367051a4cde984f071cebf
+  data.tar.gz: 5d0e1edcccdbda32db52dcc6f340221d0961d361
+SHA512:
+  metadata.gz: d02e399738682a2a30386dc44828525e2014da145918d52eaa1505e6cf5e8bb58680b44d0f2b9e56a59f014c05750b546082762f1f79cb39e8040c4291a268c3
+  data.tar.gz: c8df4dced8fc6883d6657b7e0047f8d852d442587ae9caf79f7756399f13d74003650aa23442431892c533002e63413bad0a2c7e87fd0ccd18d730310cfccf6a

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at vadimstroganov@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'json_builder'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Vadim Stroganov
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Vadim Stroganov
+
+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,38 @@
+# JsonErrorSerializer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/JsonErrorSerializer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'JsonErrorSerializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install JsonErrorSerializer
+
+## Usage
+
+Description
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/JsonErrorSerializer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/json_error_serializer.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_error_serializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'json_error_serializer'
+  spec.version       = JsonErrorSerializer::VERSION
+  spec.authors       = ['Vadim Stroganov']
+  spec.email         = ['vadimstroganov@gmail.com']
+
+  spec.summary       = 'Convenient return errors to the API as JSON'
+  spec.homepage      = 'https://github.com/Strollager/error_json_serializer.git'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/json_error_serializer/extenders/controller.rb

@@ -0,0 +1,37 @@
+module JsonErrorSerializer
+  module Extenders
+
+    module Controller
+
+      def respond_200(message = nil)
+        render json: JsonErrorSerializer::Extenders::Serialize._200(message), status: :ok
+      end
+
+      def respond_400(message = nil)
+        render json: JsonErrorSerializer::Extenders::Serialize._400(message), status: :bad_request
+      end
+
+      def respond_401(message = nil)
+        render json: JsonErrorSerializer::Extenders::Serialize._401(message), status: :unauthorized
+      end
+
+      def respond_404(message = nil)
+        render json: JsonErrorSerializer::Extenders::Serialize._404(message), status: :not_found
+      end
+
+      def respond_409(message = nil)
+        render json: JsonErrorSerializer::Extenders::Serialize._409(message), status: :conflict
+      end
+
+      def respond_422(message = nil)
+        render json: JsonErrorSerializer::Extenders::Serialize._422(message), status: :unprocessable_entity
+      end
+
+      def respond_423(message = nil)
+        render json: JsonErrorSerializer::Extenders::Serialize._423(message), status: :locked
+      end
+
+    end
+
+  end
+end

data/lib/json_error_serializer/extenders/serialize.rb

@@ -0,0 +1,87 @@
+module JsonErrorSerializer
+  module Extenders
+
+    module Serialize
+
+      def self.serialize(errors)
+        return if errors.nil?
+
+        json = {}
+        new_hash = errors.to_hash(true).map do |key, message|
+          {
+              id: key,
+              title: message.join(". ") + "."
+          }
+        end.flatten
+
+        json[:errors] = new_hash
+        json
+      end
+
+      def self._200(message = nil)
+        message = message.nil? ? 'OK' : message
+        data = JSONBuilder::Compiler.generate do
+          status '200'
+          message message
+        end
+        data
+      end
+
+      def self._400(message = nil)
+        message = message.nil? ? 'Bad request' : message
+        data = JSONBuilder::Compiler.generate do
+          status '400'
+          message message
+        end
+        data
+      end
+
+      def self._401(message = nil)
+        message = message.nil? ? 'Access denied' : message
+        data = JSONBuilder::Compiler.generate do
+          status '401'
+          message message
+        end
+        data
+      end
+
+      def self._404(message = nil)
+        message = message.nil? ? 'Not found' : message
+        data = JSONBuilder::Compiler.generate do
+          status '404'
+          message message
+        end
+        data
+      end
+
+      def self._409(message = nil)
+        message = message.nil? ? 'Conflict' : message
+        data = JSONBuilder::Compiler.generate do
+          status '409'
+          message message
+        end
+        data
+      end
+
+      def self._422(message = nil)
+        message = message.nil? ? 'Unprocessable Entity' : message
+        data = JSONBuilder::Compiler.generate do
+          status '422'
+          message message
+        end
+        data
+      end
+
+      def self._423(message = nil)
+        message = message.nil? ? 'Locked' : message
+        data = JSONBuilder::Compiler.generate do
+          status '423'
+          message message
+        end
+        data
+      end
+
+    end
+
+  end
+end

data/lib/json_error_serializer/version.rb

@@ -0,0 +1,3 @@
+module JsonErrorSerializer
+  VERSION = "0.3.0"
+end

data/lib/json_error_serializer.rb

@@ -0,0 +1,10 @@
+require 'json_error_serializer/version'
+
+module JsonErrorSerializer
+  require 'json_error_serializer/extenders/serialize'
+end
+
+require 'json_error_serializer/extenders/controller'
+ActiveSupport.on_load(:action_controller) do
+  include JsonErrorSerializer::Extenders::Controller
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: json_error_serializer
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Vadim Stroganov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: 
+email:
+- vadimstroganov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- json_error_serializer.gemspec
+- lib/json_error_serializer.rb
+- lib/json_error_serializer/extenders/controller.rb
+- lib/json_error_serializer/extenders/serialize.rb
+- lib/json_error_serializer/version.rb
+homepage: https://github.com/Strollager/error_json_serializer.git
+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.6
+signing_key: 
+specification_version: 4
+summary: Convenient return errors to the API as JSON
+test_files: []