friendly_responses 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ac0583900090aca248d9fdf719bdb9f7502e5a0
+  data.tar.gz: 77a0b885579cfbabf7890c062e26a33167426c94
+SHA512:
+  metadata.gz: 786b7e7a8213caf997e5aeed8434e52f4d000c61652a4c4385be3ef37aa135a87ec8d1a885d2362ff9ca8f50cfda4398a84d56ba7d238b8089f6ad1ea2a6ae70
+  data.tar.gz: dc28dfcc14171d07e8f69b329ecf99718745ec4cd4ca55e1b661c4aa02be46c751105d2c2abe70f255bea37108cd0b14a65faef3cdae109ffabd673dad43c7f3

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.1.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in friendly_responses.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jordan Bach
+
+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,93 @@
+# friendly-responses
+
+Provides friendly responses for validation and server errors to RESTful Rails JSON APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'friendly-responses'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install friendly-responses
+
+## Usage
+
+Simply include the `FriendlyResponses` module in your controller to enable friendly-responses.
+You may prefer to include this module in your application controller
+or a controller your API controllers will subclass as shown in the example below.
+
+```
+# app/controllers/api_controller.rb
+class ApiController < ApplicationController
+  include FriendlyResponses
+  # ...custom controller code
+end
+```
+
+## Validation errors
+
+The friendly-responses gem provides a convenient way to respond with validation errors
+that are actually useful to API clients. In the example controller action below, we
+call the `#respond_with_invalid_record` method with our model to create a friendly
+error response.
+
+```
+# app/controller/frienemies_controller.rb
+class FrienemiesController < ApiController
+  def create
+    @frienemy = Frienemy.new frienemy_params
+
+    if @frienemy.save
+      render action: 'show', status: :created
+    else
+      respond_with_invalid_record @frienemy
+    end
+  end
+end
+```
+
+Here is an example of a request that triggers a validation error and a friendly response.
+
+```
+$ curl -i -X POST http://localhost:3000/frienemies \
+    -H 'Accept: application/json' \
+    -H 'Content-Type: application/json' \
+    -d '{ "frienemy": { "name": "Donald Trump" } }'
+
+{
+  "errors": [
+    "Why you can't have a frienemy for no reason"
+  ],
+  "frienemy": {
+    "errors": {
+      "why": [
+        "you can't have a frienemy for no reason"
+      ]
+    }
+  }
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/kalkomey/friendly-responses.
+
+
+## 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 "friendly_responses"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/friendly_responses.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'friendly_responses/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "friendly_responses"
+  spec.version       = FriendlyResponses::VERSION
+  spec.authors       = ["Jordan Bach"]
+  spec.email         = ["jbach@kalkomey.com"]
+
+  spec.summary       = %q{Friendly error responses for RESTful Rails APIs.}
+  spec.homepage      = "https://github.com/kalkomey/friendly_responses"
+  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 "activemodel", "~> 4.0"
+  spec.add_dependency "activesupport", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/friendly_responses.rb

@@ -0,0 +1,24 @@
+require "friendly_responses/version"
+
+module FriendlyResponses
+
+  class ValidModelError < StandardError
+  end
+
+
+  # Renders a friendly JSON error response
+  def respond_with_invalid_record(model)
+    model_name = model.class.name.underscore.to_sym
+
+    if model.valid?
+      raise ValidModelError.new "can't render error response for valid model"
+    end
+
+    render status: :unprocessable_entity,
+      json: {
+        errors: model.errors.full_messages,
+        model_name => { errors: model.errors }
+      }
+  end
+
+end

data/lib/friendly_responses/version.rb

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

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: friendly_responses
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jordan Bach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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: activesupport
+  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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jbach@kalkomey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- friendly_responses.gemspec
+- lib/friendly_responses.rb
+- lib/friendly_responses/version.rb
+homepage: https://github.com/kalkomey/friendly_responses
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Friendly error responses for RESTful Rails APIs.
+test_files: []