roar-rails 0.1.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fbf7c943c30c7284ff2cf46861318701910e138
-  data.tar.gz: e6e6cb5e5816418c71c75d023bbfc61dc4551def
+  metadata.gz: 1dbecd0bbc7e521087763fd2ff0313d7d3cda940
+  data.tar.gz: 3b14e95c24d51ee0003f97c4c079dafc62a40699
 SHA512:
-  metadata.gz: 45631ddc9bfc4f96279e7b1f7538cf33473cf5f6cc5f5cb1abafb4b5b7a149a65e5ec67f95c25c63510821898c9a47d6c7b86aec31270399dbd821bb343339c0
-  data.tar.gz: 5d20060c50ce90161bbd93ee41c81cb71e5544ad04c32e428dbf556e69b1d32153f63d7f5c1e5631d7db9bf6f60216d9286ea511cd6a955f35e6ceef4b57dca8
+  metadata.gz: 0bcfc77fe5ff9d9e0fdb48d962bad6ffd2f44fcbd7446d31b4fbf3f1c14bbadad93ead2356103024f2923d0d1104f0317c93398d5ede28b5e5beaa499d4b30d8
+  data.tar.gz: 87b69c8d04bfbf819c32b0bbe2dca74ac929d374f315837a87d449a76656eaf2b0ba090ef93b605bfeaa0579c34f91070c768f3f886be9e1902059dffebeb73c

data/CHANGES.markdown

@@ -1,3 +1,8 @@
+## 1.0.0
+
+* Requires Roar >= 1.0.0.
+* In `#consume!` roar-rails now finds the correct representer for the `Content-type:` header. In former version the representer name was infered using the `Accept:` header, which was totally wrong. Thanks to @pgaertig for fixing that.
+
 ## 0.1.6
 
 * Added `ControllerAdditions::Render` to support `#render` in controller actions with representers.

data/Gemfile

@@ -4,7 +4,7 @@ source "http://rubygems.org"
 gemspec
 
 group :test do
-  #gem 'roar', path: "../roar" #">= 0.11.17"
+  # gem 'roar', path: "../roar" #">= 0.11.17"
   #gem 'representable', path: "../representable"
   gem 'rake', '10.1.0'
 end

data/README.markdown

@@ -32,7 +32,7 @@ This will create the file `app/representers/band_representer.rb` with the follow
 
 ```ruby
   module BandRepresenter
-    include Roar::Representer::JSON
+    include Roar::JSON
 
     property :id
     property :name
@@ -129,6 +129,7 @@ end
 ## Parsing incoming documents
 
 In `#create` and `#update` actions it is often necessary to parse the incoming representation and map it to a model instance. Use the `#consume!` method for this.
+The client must provide a `Content-Type` request header with proper MIME type to let `#consume!` know which representer to use.
 
 ```ruby
 class SingersController < ApplicationController
@@ -143,17 +144,20 @@ class SingersController < ApplicationController
 end
 ```
 
-The `consume!` call will roughly do the following.
+For instance, if content type is set to `application/xml` the `consume!` call will roughly do the following.
 
 ```ruby
 singer.
   extend(SingerRepresenter)
-  from_json(request.body)
+  from_xml(request.body)
 ```
 
-So, `#consume!` helps you figuring out the representer module and reading the incoming document.
+So, `#consume!` helps you figuring out the representer module and reading the incoming document. Just like Rails, depending on the registered MIME type for `Content-type` it picks the deserialize method (e.g. `from_json` vs. `from_xml`)
 
-Note that it respects settings from `#represents`. It uses the same mechanics known from `#respond_with` to choose a representer.
+It is important to provide a known content type in the request. If it is missing or not supported by the responder
+`#consume!` will raise an exception `Roar::Rails::ControllerAdditions::UnsupportedMediaType`. Unless you rescue the exception the action will stop and respond with HTTP status `406 Unsupported Media Type`.
+
+Note that `#consume!` respects settings from `#represents`. It uses the same mechanics known from `#respond_with` to choose a representer.
 
 ```ruby
 consume!(singer, :represent_with => MusicianRepresenter)
@@ -165,7 +169,7 @@ If you prefer roar's decorator approach over extend, just go for it. roar-rails
 
 ```ruby
 class SingerRepresenter < Roar::Decorator
-  include Roar::Representer::JSON
+  include Roar::JSON
 
   property :name
 
@@ -211,8 +215,8 @@ Any URL helpers from the Rails app are automatically available in representers.
 
 ```ruby
 module FruitRepresenter
-  include Roar::Representer::JSON
-  include Roar::Representer::Feature::Hypermedia
+  include Roar::JSON
+  include Roar::Hypermedia
 
   link :self do
     fruit_url self

data/gemfiles/Gemfile.rails3-0

@@ -5,3 +5,5 @@ gemspec :path => '../'
 
 gem 'railties', '~> 3.0.11'
 gem 'activerecord', '~> 3.0.11'
+gem 'minitest', '4.7.5'
+

data/gemfiles/Gemfile.rails3-2

@@ -6,3 +6,4 @@ gemspec :path => '../'
 
 gem 'railties', '~> 3.2.13'
 gem 'activerecord', '~> 3.2.13'
+gem 'minitest', '4.7.5'

data/lib/roar-rails.rb

@@ -3,17 +3,15 @@ require "roar/representer"
 require "roar/decorator"
 require "roar/rails/railtie"
 
-module Roar::Representer
-  autoload("XML", "roar/representer/xml")
-  autoload("JSON", "roar/representer/json")
+module Roar
+  autoload("XML", "roar/xml")
+  autoload("JSON", "roar/json")
 
   module JSON
     autoload("HAL", "roar/rails/hal")
   end
 
-  module Feature
-    autoload("Hypermedia", "roar/representer/feature/hypermedia")
-  end
+  autoload("Hypermedia", "roar/hypermedia")
 end
 
 

data/lib/roar/rails/controller_additions.rb

@@ -17,17 +17,22 @@ module Roar::Rails
 
     module ClassMethods
       def represents(format, options)
-        represents_options.add(format,options)
+        represents_options.add(format, options)
         respond_to format
       end
     end
 
 
+    # TODO: move into separate class so we don't pollute controller.
     def consume!(model, options={})
-      format      = formats.first  # FIXME: i expected request.content_mime_type to do the job. copied from responder.rb. this will return the wrong format when the controller responds to :json and :xml and the Content-type is :xml (?)
+      content_type = request.content_type
+
+      format = Mime::Type.lookup(content_type).try(:symbol) or raise UnsupportedMediaType.new("Cannot consume unregistered media type '#{content_type.inspect}'")
+
+      parsing_method = compute_parsing_method(format)
       representer = prepare_model_for(format, model, options)
 
-      representer.send(compute_parsing_method(format), incoming_string, options) # e.g. from_json("...")
+      representer.send(parsing_method, incoming_string, options) # e.g. from_json("...")
       model
     end
 
@@ -52,15 +57,23 @@ module Roar::Rails
       body.read
     end
 
-    def render_to_body(options)
-      if res = options[formats.first] and res.is_a?(Roar::Rails::Responder::Response)
-        response.content_type = res.content_type
-        return res.body
-      end
+    # These methods deal with interfacing between the Roar Response object and
+    # ActionController, they simply pass the body of the Roar response up or do nothing
+    def _render_option_json(resource, options)
+      super(_resource_or_body(resource), options)
+    end
 
-      super
+    def _render_option_xml(resource, options)
+      super(_resource_or_body(resource), options)
     end
 
+    def _render_option_hal(resource, options)
+      super(_resource_or_body(resource), options)
+    end
+
+    def _resource_or_body(resource)
+      resource.is_a?(Roar::Rails::Responder::Response) ? resource.body : resource
+    end
 
     # Include if you intend to use roar-rails with <tt>render json: model</tt>.
     module Render
@@ -70,4 +83,7 @@ module Roar::Rails
       end
     end
   end
-end
+
+  class UnsupportedMediaType < StandardError #:nodoc:
+  end
+end

data/lib/roar/rails/hal.rb

@@ -1,6 +1,6 @@
-require 'roar/representer/json/hal'
+require 'roar/json/hal'
 
-Roar::Representer::JSON::HAL.class_eval do
+Roar::JSON::HAL.class_eval do
   def to_hal(*args);   to_json(*args);   end
   def from_hal(*args); from_json(*args); end
-end
+end

data/lib/roar/rails/railtie.rb

@@ -6,6 +6,11 @@ module Roar
     class Railtie < ::Rails::Railtie
       config.representer = ActiveSupport::OrderedOptions.new
 
+      rescue_responses = config.action_dispatch.rescue_responses || ActionDispatch::ShowExceptions.rescue_responses #newer or fallback to 3.0
+      rescue_responses.merge!(
+          'Roar::Rails::ControllerAdditions::UnsupportedMediaType' => :unsupported_media_type
+      )
+
       initializer "roar.set_configs" do |app|
         ::Roar::Representer.module_eval do
           include app.routes.url_helpers

data/lib/roar/rails/responder.rb

@@ -69,4 +69,4 @@ module Roar
       end
     end
   end
-end
+end

data/lib/roar/rails/validations_representer.rb

@@ -6,14 +6,14 @@ module ValidatorsRepresenter
   class ValidatorClient
     attr_accessor :kind, :options
   end
-  
+
   # Represents a single Validator instance.
   module ValidatorRepresenter
-    include Roar::Representer::JSON
+    include Roar::JSON
     property :kind
     hash :options
   end
-  
+
   # Represents an array of validators for an attribute.
   module AttributeValidators
     include Representable::JSON::Collection

data/lib/roar/rails/version.rb

@@ -1,5 +1,5 @@
 module Roar
   module Rails
-    VERSION = "0.1.6"
+    VERSION = "1.0.0"
   end
 end

data/roar-rails.gemspec

@@ -18,13 +18,13 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "roar",          ">= 0.11.13"
+  s.add_runtime_dependency "roar",          ">= 1.0.0", "<= 1.1.0"
   s.add_runtime_dependency "test_xml",      ">= 0.1.6"  # TODO: remove dependency as most people don't use XML.
   s.add_runtime_dependency "actionpack"
   s.add_runtime_dependency "railties",      ">= 3.0.0"
-  s.add_runtime_dependency "uber"
+  s.add_runtime_dependency "uber",          ">= 0.0.5"
 
-  s.add_development_dependency "minitest",	"~> 4.0"
+  s.add_development_dependency "minitest"
   s.add_development_dependency "activemodel"
   s.add_development_dependency "activerecord"
   s.add_development_dependency "sqlite3"

data/test/consume_test.rb

@@ -16,16 +16,33 @@ class ConsumeTest < ActionController::TestCase
   tests UnnamespaceSingersController
 
   test "#consume parses incoming document and updates the model" do
-    post :consume_json, "{\"name\": \"Bumi\"}", :format => 'json'
+    @request.env['CONTENT_TYPE'] = 'application/json'
+    post :consume_json, "{\"name\": \"Bumi\"}"
     assert_equal %{#<struct Singer name="Bumi">}, @response.body
   end
 end
 
+class ConsumeHalWithNoHalRespondTest < ActionController::TestCase
+  include Roar::Rails::TestCase
+
+  tests UnnamespaceSingersController
+
+  # Content-type is set properly, it's a registered mime but responder doesn't do #from_hal.
+  # FIXME: why does that still find a representer?
+  test "#consume parses hal document and updates the model" do
+    @request.env['CONTENT_TYPE'] = 'application/hal+json'
+    # assert_raises Roar::Rails::UnsupportedMediaType do
+    assert_raises NoMethodError do # currently, we don't know if a format is supported in general, or not.
+      post :consume_json, "{\"name\": \"Bumi\"}"
+    end
+  end
+end
+
 class ConsumeWithConfigurationTest < ActionController::TestCase
   include Roar::Rails::TestCase
 
   module MusicianRepresenter
-    include Roar::Representer::JSON
+    include Roar::JSON
     property :name, :as => :called
   end
 
@@ -44,9 +61,52 @@ class ConsumeWithConfigurationTest < ActionController::TestCase
   tests SingersController
 
   test "#consume uses ConsumeWithConfigurationTest::MusicianRepresenter to parse incoming document" do
+    @request.env['CONTENT_TYPE'] = 'application/json'
     post :consume_json, %{{"called":"Bumi"}}, :format => :json
     assert_equal %{#<struct Singer name="Bumi">}, @response.body
   end
+
+  test "#do not consume missing content type" do
+    assert_raises Roar::Rails::UnsupportedMediaType do
+      post :consume_json, "{\"name\": \"Bumi\"}"
+    end
+  end
+
+
+  test "#do not consume parses unknown content type" do
+    @request.env['CONTENT_TYPE'] = 'application/custom+json'
+    assert_raises Roar::Rails::UnsupportedMediaType do
+      post :consume_json, "{\"name\": \"Bumi\"}"
+    end
+  end
+end
+
+class ConsumeHalTest < ActionController::TestCase
+  include Roar::Rails::TestCase
+
+  module MusicianRepresenter
+    include Roar::JSON::HAL
+    property :name
+  end
+
+
+  class SingersController < ActionController::Base
+    include Roar::Rails::ControllerAdditions
+    represents :hal, :entity => MusicianRepresenter
+
+    def consume_hal
+      singer = consume!(Singer.new)
+      render :text => singer.inspect
+    end
+  end
+
+  tests SingersController
+
+  test "#consume parses HAL document and updates the model" do
+    @request.env['CONTENT_TYPE'] = 'application/hal+json'
+    post :consume_hal, "{\"name\": \"Bumi\"}"
+    assert_equal %{#<struct Singer name="Bumi">}, @response.body
+  end
 end
 
 class ConsumeWithOptionsOverridingConfigurationTest < ActionController::TestCase
@@ -66,6 +126,7 @@ class ConsumeWithOptionsOverridingConfigurationTest < ActionController::TestCase
   tests SingersController
 
   test "#consume uses #represents config to parse incoming document" do
+    @request.env['CONTENT_TYPE'] = 'application/json'
     post :consume_json, %{{"called":"Bumi"}}, :format => :json
     assert_equal %{#<struct Singer name="Bumi">}, @response.body
   end
@@ -73,6 +134,7 @@ end
 
 class RequestBodyStringTest < ConsumeTest
   test "#read rewinds before reading" do
+    @request.env['CONTENT_TYPE'] = 'application/json'
     @request.instance_eval do
       def body
         incoming = super

data/test/dummy/app/representers/band_representer.rb

@@ -1,6 +1,6 @@
 class BandRepresenter < Roar::Decorator
-  include Roar::Representer::JSON
-  include Roar::Representer::Feature::Hypermedia
+  include Roar::JSON
+  include Roar::Hypermedia
 
   property :name
 

data/test/dummy/app/representers/singer_alias_representer.rb

@@ -1,5 +1,5 @@
 module SingerAliasRepresenter
-  include Roar::Representer::JSON
+  include Roar::JSON
 
   property :name, :as => :alias
 

data/test/dummy/app/representers/singer_representer.rb

@@ -1,6 +1,6 @@
 module SingerRepresenter
-  include Roar::Representer::JSON
-  include Roar::Representer::Feature::Hypermedia
+  include Roar::JSON
+  include Roar::Hypermedia
 
   property :name
 

data/test/json_hal_renderer_test.rb

@@ -1,19 +1,11 @@
 require 'test_helper'
 
-Mime::Type.register 'application/json+hal', :hal
-if Roar::Rails.rails_version >= 4.1
-  ActionController.add_renderer :hal do |js, options|
-    self.content_type ||= Mime::HAL
-    js.to_json
-  end
-end
-
 class HalRendererTest < ActionController::TestCase
   include Roar::Rails::TestCase
 
   class SingersController < ActionController::Base
     module HalSingerRepresenter
-      include Roar::Representer::JSON::HAL
+      include Roar::JSON::HAL
 
       property :name
       link(:self) { "http://#{name}" }
@@ -30,13 +22,13 @@ class HalRendererTest < ActionController::TestCase
 
   tests SingersController
 
-  test "should render correctly in response to a application/json+hal request" do
+  test "should render correctly in response to a application/hal+json request" do
     get :show, :id => "bumi", :format => :hal
     assert_body '{"name":"Bumi","_links":{"self":{"href":"http://Bumi"}}}'
   end
 
-  test "should have a content_type of application/json+hal" do
+  test "should have a content_type of application/hal+json" do
     get :show, :id => "bumi", :format => :hal
-    assert_equal response.content_type, 'application/json+hal'
+    assert_equal response.content_type, 'application/hal+json'
   end
-end
+end

data/test/render_test.rb

@@ -5,7 +5,7 @@ class RenderTest < ActionController::TestCase
 
   class SingersController < ActionController::Base
     module SingerRepresenter
-      include Roar::Representer::JSON
+      include Roar::JSON
 
       property :name, :as => :title
     end