json_answer_contract 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcc944b34640abd1802b80971889a9b6bac7b248
+  data.tar.gz: 4a05052f478e7c8fe51b3854b34e29559508f301
+SHA512:
+  metadata.gz: 8ab47b09c33e4cd2fce4cb3fd0c5906bd969d7ec13099072ea72d77ec961b7937732f5732da1b90b2f6b98788eff11614b5c34792004d94ea5f3587740e195eb
+  data.tar.gz: 3da25300e92931a67a7019e702a2f2b59bd7fdee865ff5b46ad57e1121b96a94bdbe73c0c24f9a519ddde92f81ce269fc397a277033653906cba60e4bd2eaa05

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

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 sergeg1990@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in json_answer_contract.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sergey Gernyak
+
+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,80 @@
+# JsonAnswerContract
+
+This gem provides some useful controller helper methods that tries to
+unify JSON responses. For this the following structure is used:
+
+```json
+{
+  success: true/false,
+  data: {
+    # The data that you want to return must be there
+  }
+}
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_answer_contract'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_answer_contract
+
+## Usage
+
+After installations you may use this gem without some additional
+onfigurations.
+
+For you gem provides 3 methods:
+
+- `#success_json_response(data_hash, http_status)`
+- `#faillure_json_response(data_hash, http_status)`
+- `#build_json_response(success_flag, data_hash, http_status)`
+
+First two methods are special cases of the last one.
+
+For example, you want to return json response in `UsersController#show`
+action:
+
+```ruby
+class UsersController < ApplicationController
+  def show
+    user = User.find params[:id]
+    success_json_response user: user.as_json
+  end
+end
+```
+
+Or, maybe you want to return appropriate JSON response for create
+response in case when validations are failed:
+
+```ruby
+class UsersController < ApplicationController
+  def create
+    user = User.new params[:user]
+    if user.save
+      # success case
+    else
+      failure_json_response({errors: user.errors.full_messages}, 422)
+    end
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alterego-labs/json_answer_contract. 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json_answer_contract"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json_answer_contract.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_answer_contract/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_answer_contract"
+  spec.version       = JsonAnswerContract::VERSION
+  spec.authors       = ["Sergey Gernyak"]
+  spec.email         = ["sergeg1990@gmail.com"]
+
+  spec.summary       = %q{Small library with controller's helper methods for providing json response in single format.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/alterego-labs/json_answer_contract"
+  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_dependency 'rails',            '>= 4.0'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/json_answer_contract.rb

@@ -0,0 +1,14 @@
+require "json_answer_contract/version"
+require 'active_support/dependencies/autoload'
+
+require 'json_answer_contract/railtie'
+
+module JsonAnswerContract
+  extend ActiveSupport::Autoload
+
+  module Controller
+    extend ActiveSupport::Autoload
+
+    autoload :Helper
+  end
+end

data/lib/json_answer_contract/controller/helper.rb

@@ -0,0 +1,17 @@
+module JsonAnswerContract
+  module Controller
+    module Helper
+      def success_json_response(data = {}, status = 200)
+        build_json_response true, data, status
+      end
+
+      def failure_json_response(data = {}, status = 500)
+        build_json_response false, data, status
+      end
+
+      def build_json_response(is_success, data, status)
+        render json: { success: is_success, data: data }, status: status
+      end
+    end
+  end
+end

data/lib/json_answer_contract/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module JsonAnswerContract
+  class Railtie < ::Rails::Railtie
+    initializer "json_answer_contract.configure_controller" do |app|
+      ActiveSupport.on_load :action_controller do
+        include JsonAnswerContract::Controller::Helper
+      end
+    end
+  end
+end

data/lib/json_answer_contract/version.rb

@@ -0,0 +1,3 @@
+module JsonAnswerContract
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: json_answer_contract
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Gernyak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Small library with controller's helper methods for providing json response
+  in single format.
+email:
+- sergeg1990@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_answer_contract.gemspec
+- lib/json_answer_contract.rb
+- lib/json_answer_contract/controller/helper.rb
+- lib/json_answer_contract/railtie.rb
+- lib/json_answer_contract/version.rb
+homepage: https://github.com/alterego-labs/json_answer_contract
+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.8
+signing_key: 
+specification_version: 4
+summary: Small library with controller's helper methods for providing json response
+  in single format.
+test_files: []