api_problem 0.0.1 → 0.0.2

data/README.md

@@ -5,11 +5,15 @@
 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
+=======
+With this gem you can return api errors that follow the http api problem draft 
+- http://tools.ietf.org/html/draft-nottingham-http-problem-06
 
 Here is a explanation behind the draft:
 - http://www.mnot.net/blog/2013/05/15/http_problem
 
+## VERSION 0.0.2 almost ready this is what you will be able to do....
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,47 +28,42 @@ 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'
+This gem installs a generator for your project
+    
+    rail g api_problem bad_token_error
+    
+You can specify the problem detail object members
+
+    rail g api_problem bad_token_error type:"http://example.com/probs/out-of-credit" status:403 title:"You do not have enough credit." detail:"Your current balance is 30, but that costs 50."
+    
+You can also namespace it with the ns key
+
+    rail g api_problem bad_token_error ns:api
+    
+About the type, if you DON'T want a type you need to specify with false
+
+    rail g api_problem bad_token_error type:false
+
+About the type, if you dont set a type, it will default to the error name
+    
+    # This will create a bad_token_error type for you.
+    rail g api_problem bad_token_error
+    
+Files that get created for you
+
+    create app/views/api_problems/bad_token_error.jbuilder
+    create app/views/errors/bad_token_error.html.erb
+    create app/controllers/errors_controller.rb
+    route  match '/bad_token_error' => 'errors#bad_token_error', :via => :get, :as => :bad_token_error
+    
+## TODO
+- The XML views
+- Tests for the genrator
 
 ## Contributing
 

data/api_problem.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency "jbuilder"
 end

data/lib/api_problem/version.rb

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

data/lib/generators/api_problem/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate api_problem Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/api_problem/api_problem_generator.rb

@@ -0,0 +1,69 @@
+class ApiProblemGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  argument :one, :type => :hash, :required => false, :default => {}
+
+  def build_http_error
+    template "api_problem_layout.jbuilder.erb", "app/views#{ns_path}api_problems/#{name}.jbuilder"
+    template "api_problem_layout.xml.erb", "app/views#{ns_path}api_problems/#{name}.xml.erb"
+  end
+
+  def build_error_html
+    template "errors_view.html.erb", "app/views#{ns_path}errors/#{name}.html.erb"
+    template "errors_controller.erb", "app/controllers#{ns_path}errors_controller.rb"
+  end
+
+  def build_route
+    route "match '#{ns_path}#{name}' => '#{ns_class_name}errors##{name}', :via => :get, :as => :#{problem}"
+    inject_into_class "app/controllers/#{ns_path}errors_controller.rb", "#{ns_class_name}ErrorsController".classify, "def #{name}\nend\n"
+  end
+
+  private
+    # User must specify that they don't a type by setting type:false
+    def type
+      if one["type"].nil?
+        problem_url
+      elsif one["type"] && one["type"] != "false"
+        "'#{one["type"]}'"
+      elsif one["type"] && one["type"] == "false"
+        nil
+      end
+    end
+
+    def title
+      one["title"]
+    end
+
+    def status
+      one["status"] ? Integer(one["status"]) : nil
+    end
+
+    def detail
+      one["detail"]
+    end
+
+    def instance
+      one["instance"]
+    end
+    
+    # Namespace
+    def ns
+      one["ns"]
+    end
+
+    def ns_path
+      ns ? "/#{ns}/" : "/"
+    end
+
+    def ns_class_name
+      ns ? "#{ns.classify}::" : ""
+    end
+
+    def problem
+      ns ? "#{ns}_#{name}" : "#{name}"
+    end
+    
+    def problem_url
+      "#{problem}_url"
+    end
+
+end

data/lib/generators/api_problem/templates/api_problem_layout.jbuilder.erb

@@ -0,0 +1,5 @@
+<% if type %>json.set! :type, <%= type %><% end %>
+<% if title %>json.set! :title, "<%= title %>"<% end %>
+<% if status %>json.set! :status, <%= status %><% end %>
+<% if detail %>json.set! :detail, "<%= detail %>"<% end %>
+<% if instance %>json.set! :instance, "<%= instance %>"<% end %>

data/lib/generators/api_problem/templates/api_problem_layout.xml.erb

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<problem xmlns="urn:ietf:rfc:XXXX">
+  <% if type %>
+    <type><%%= type %></type>
+  <% end %>
+  <% if status  %>
+    <statu><%= status %></status>
+  <% end %>
+  <% if title  %>
+    <title><%= title %></title>
+  <% end %>
+  <% if detail  %>
+    <detail><%= detail %></detail>
+  <% end %>
+  <% if instance  %>
+    <instance><%= instance %></instance>
+  <% end %>
+</problem>

data/lib/generators/api_problem/templates/errors_controller.erb

@@ -0,0 +1,2 @@
+class <%= ns_class_name %>ErrorsController < ApplicationController
+end

data/lib/generators/api_problem/templates/errors_view.html.erb

@@ -0,0 +1,2 @@
+<h1><%= name.classify %></h1>
+When dereferenced, it SHOULD provide human-readable documentation for the problem type 

data/test/api_problem_generator.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+require 'api_problem'
+
+class CellGeneratorTest < Rails::Generators::TestCase
+  p "asflkasflksadjflaksdjfl;k"
+  destination File.join(Rails.root, "tmp")
+  setup :prepare_destination
+  tests ::Cells::Generators::CellGenerator
+
+  test "create the standard assets" do
+    run_generator %w(Blog post latest)
+
+    assert_file "app/cells/blog_cell.rb", /class BlogCell < Cell::Rails/
+    assert_file "app/cells/blog_cell.rb", /def post/
+    assert_file "app/cells/blog_cell.rb", /def latest/
+    assert_file "app/cells/blog/post.html.erb", %r(app/cells/blog/post.html.erb)
+    assert_file "app/cells/blog/latest.html.erb", %r(app/cells/blog/latest.html.erb)
+    assert_file "test/cells/blog_cell_test.rb"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_problem
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-16 00:00:00.000000000 Z
+date: 2014-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
@@ -59,7 +75,14 @@ files:
 - lib/api_problem.rb
 - lib/api_problem/railtie.rb
 - lib/api_problem/version.rb
+- lib/generators/api_problem/USAGE
+- lib/generators/api_problem/api_problem_generator.rb
+- lib/generators/api_problem/templates/api_problem_layout.jbuilder.erb
+- lib/generators/api_problem/templates/api_problem_layout.xml.erb
+- lib/generators/api_problem/templates/errors_controller.erb
+- lib/generators/api_problem/templates/errors_view.html.erb
 - test/api_problem_draft_spec_test.rb
+- test/api_problem_generator.rb
 - test/api_problem_test.rb
 - test/test_helper.rb
 homepage: https://github.com/guillec/api_problem
@@ -89,6 +112,7 @@ specification_version: 3
 summary: An implementation of draft-nottingham-http-problem.
 test_files:
 - test/api_problem_draft_spec_test.rb
+- test/api_problem_generator.rb
 - test/api_problem_test.rb
 - test/test_helper.rb
 has_rdoc: