api_problem 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rvmrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in api-problem.gemspec
+gem 'minitest'
+gem 'coveralls', require: false
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Guille Carlos
+
+MIT License
+
+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,75 @@
+# ApiProblem for Rails
+[![CodeClimate](https://codeclimate.com/github/guillec/http_problem.png)](https://codeclimate.com/github/guillec/api_problem)
+[![Build Status](https://travis-ci.org/guillec/api-problem.png)](https://travis-ci.org/guillec/api_problem)
+[![Coverage
+Status](https://coveralls.io/repos/guillec/api-problem/badge.png)](https://coveralls.io/r/guillec/api_problem)
+
+With this gem you can return api errors that follow the api-problem draft specs 
+- http://tools.ietf.org/html/draft-nottingham-http-problem-04
+
+Here is a explanation behind the draft:
+- http://www.mnot.net/blog/2013/05/15/http_problem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'api_problem'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_problem
+
+## Basics on Gem
+
+This gem installs the following method: 
+
+    api_problem( problem_type, title, { optional stuff } )
+
+The method params:
+
+    problem_type = required
+    title = required
+    args = optional values
+
+## Usage in Rails
+ApiProblem provides a Railtie that registers the proper MIME types with Rails:
+- application/api-problem+json
+- application/api-problem+xml
+
+
+To use create your api problems controller:
+
+    rails g controller api_problems first_error_name second_error_name
+
+The urls to these views is what you will pass to the api_problem method as the problem_type.
+
+Here is an example of how to return a api_error:    
+
+    format.api_problem_json do 
+      render json: api_problem first_errors_name_url, "You are out of credits",  { } 
+    end
+
+This will respond to the client with something like:
+
+    {
+      "problemType": "http://example.com/problem_details/first_error_name",
+      "title": "You are out of credits",
+      ...
+    }
+
+Sample curl call
+
+    curl -i "http://localhost:3000/emails" -H 'ACCEPT: application/api-problem+json'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/api_problem.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_problem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api_problem"
+  spec.version       = ApiProblem::VERSION
+  spec.authors       = ["Guille Carlos"]
+  spec.email         = ["guille@bitpop.in"]
+  spec.description   = %q{An implementation of draft-nottingham-http-problem.}
+  spec.summary       = %q{An implementation of draft-nottingham-http-problem.}
+  spec.homepage      = "https://github.com/guillec/api_problem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/api_problem/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails'
+
+module ApiProblem
+  class Railtie < ::Rails::Railtie
+    config.to_prepare do
+      ApplicationController.send(:include, ApiProblem)
+    end
+    initializer 'api-problem-json' do
+      Mime::Type.register 'application/api-problem+json', :api_problem_json
+    end
+    initializer 'api-problem-xml' do
+      Mime::Type.register 'application/api-problem+xml', :api_problem_xml
+    end
+  end
+end

data/lib/api_problem/version.rb

@@ -0,0 +1,3 @@
+module ApiProblem
+  VERSION = "0.0.1"
+end

data/lib/api_problem.rb

@@ -0,0 +1,50 @@
+require "api_problem/version"
+require "api_problem/railtie" if defined? Rails
+
+module ApiProblem
+  MissingTitle       = Class.new(StandardError)
+  MissingProblemType = Class.new(StandardError)
+
+  def self.build(problem_type, title, options={})
+    response ={}
+    raise ApiProblem::MissingProblemType if problem_type.nil?
+    raise ApiProblem::MissingTitle if title.nil?
+    new_options = build_options(options)
+    unless new_options.empty?
+      { problemType: problem_type, title: title }.merge(new_options)
+    else
+      { problemType: problem_type, title: title }
+    end
+  end
+
+  def api_problem(problem_type, title, options={})
+    ApiProblem.build problem_type, title, options
+  end
+
+  private
+  def self.build_options(options)
+    new_options ={}
+    options.each do |key, value|
+      key = convert_key(key)
+      value = convert_value(key, value)
+      new_options[key] = value
+    end
+    new_options
+  end
+
+  def self.convert_key(key)
+    if key == :http_status || key == "http_status"
+      key = "httpStatus"
+    elsif key == :problem_instance || key == "problem_instance"
+      key = "problemInstance"
+    end
+    key.to_s
+  end
+
+  def self.convert_value(key, value)
+    if key == "httpStatus"
+      value = value.to_i
+    end
+    value
+  end
+end

data/test/api_problem_draft_spec_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+require 'api_problem'
+
+describe "API Problem Draft Specs" do
+
+  it "should return a http problem hash" do
+    response = { problemType: "http://example.com/probs/out-of-credit", title: "Your do not have enough credit."}
+    http_problem = ApiProblem.build("http://example.com/probs/out-of-credit", "Your do not have enough credit.")
+    assert_equal response, http_problem
+  end
+
+end
+
+describe "Section 3.1: Required Members" do
+
+  describe "A problem details object MUST have the following" do
+
+    it "should have a problemType" do
+      assert_raises ApiProblem::MissingProblemType do
+        http_problem = ApiProblem.build(nil, "You do not have enough credit.")
+      end
+    end
+
+    it "should have a title" do
+      assert_raises ApiProblem::MissingTitle do
+        http_problem = ApiProblem.build("http://example.com/probs/out-of-credit", nil)
+      end
+    end
+  end
+
+end
+
+describe "Section 3.2: Optional Members" do
+
+  describe "A problem details object MAY have the following members" do
+
+    it "may have a httpStatus" do
+      http_problem = ApiProblem.build("http://example.com", "You do not have enough credit.", http_status: 200 )
+      assert_equal 200, http_problem["httpStatus"]
+    end
+
+    it "may have a problemInstance" do
+      http_problem = ApiProblem.build("http://example.com", "You do not have enough credit.", problem_instance: "http://example.net/account/12345/msgs/abc" )
+      assert_equal "http://example.net/account/12345/msgs/abc", http_problem["problemInstance"]
+    end
+
+  end
+
+  describe "httpStatus" do
+
+    it "should be a number" do
+      http_problem = ApiProblem.build("http://example.com", "You do not have enough credit.", http_status: "200" )
+      assert_equal 200, http_problem["httpStatus"]
+    end
+
+  end
+
+end
+
+describe "3.3:  Extension Members" do
+
+  describe "Problem type definitions MAY extend the problem details object with additional members." do
+
+    it "will accepst options values" do
+      http_problem = ApiProblem.build("http://example.com", "You do not have enough credit.", hammer: "Time", array: [1, 2, 3] )
+      assert_equal "Time", http_problem["hammer"]
+      assert_equal [1,2,3], http_problem["array"]
+    end
+
+  end
+
+end
+

data/test/api_problem_test.rb

@@ -0,0 +1,14 @@
+require "test_helper.rb"
+require "api_problem"
+
+describe "ApiProblem module" do
+  it "should return a hash" do
+
+    fake_class = class Class
+      include ApiProblem
+    end
+
+    http_problem = { problemType: "http://example.com", title: "This is a test" }
+    assert_equal http_problem, fake_class.new.api_problem("http://example.com", "This is a test")
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter do |source_file|
+    source_file.filename =~ /test/
+  end
+end
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'minitest/autorun'

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: api_problem
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Guille Carlos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An implementation of draft-nottingham-http-problem.
+email:
+- guille@bitpop.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_problem.gemspec
+- lib/api_problem.rb
+- lib/api_problem/railtie.rb
+- lib/api_problem/version.rb
+- test/api_problem_draft_spec_test.rb
+- test/api_problem_test.rb
+- test/test_helper.rb
+homepage: https://github.com/guillec/api_problem
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: An implementation of draft-nottingham-http-problem.
+test_files:
+- test/api_problem_draft_spec_test.rb
+- test/api_problem_test.rb
+- test/test_helper.rb
+has_rdoc: