roar-rails 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dbecd0bbc7e521087763fd2ff0313d7d3cda940
-  data.tar.gz: 3b14e95c24d51ee0003f97c4c079dafc62a40699
+  metadata.gz: a55ffa3152e3f698afddef93555e37f5b61d232c
+  data.tar.gz: b3a48ed2ee0c550d255e1a5b031609c53f050a8e
 SHA512:
-  metadata.gz: 0bcfc77fe5ff9d9e0fdb48d962bad6ffd2f44fcbd7446d31b4fbf3f1c14bbadad93ead2356103024f2923d0d1104f0317c93398d5ede28b5e5beaa499d4b30d8
-  data.tar.gz: 87b69c8d04bfbf819c32b0bbe2dca74ac929d374f315837a87d449a76656eaf2b0ba090ef93b605bfeaa0579c34f91070c768f3f886be9e1902059dffebeb73c
+  metadata.gz: a6701490dd9bfbe6730bf702ac41d536e3158982ab469b7a8f217d6469051220b85cfe6019636a261196a5d91bedd579df740482dd6dbb909fedc342a221593c
+  data.tar.gz: 08128efd725c3cae0bf5c5a7bf78ed84e1f71c9c3f48b7569a8676dfe7470bbd21f26894f3f3c2bbfd9ad82ff33bfb450d70bf785bca53a83058a2ea8dc0bff1

data/.travis.yml

@@ -6,3 +6,4 @@ gemfile:
   - gemfiles/Gemfile.rails3-0
   - gemfiles/Gemfile.rails3-2
   - gemfiles/Gemfile.rails4-0
+  - gemfiles/Gemfile.rails4-2

data/CHANGES.markdown

@@ -1,3 +1,9 @@
+## 1.0.1
+
+* Added a dependency on `responders` gem for Rails 4.2 support
+* `#render` from `ControllerAdditions::Render` now accepts a status code
+* Added support for JSON-API.
+
 ## 1.0.0
 
 * Requires Roar >= 1.0.0.

data/README.markdown

@@ -270,21 +270,30 @@ end
 
 Put your representers in `app/representers` and they will be autoloaded by Rails. Also, frequently used modules as media representers and features don't need to be required manually.
 
-## Rails 4.1 + HAL
+## Rails 4.1+ and HAL/JSON-API
 
 **Note**: this is a temporary work-around, we're trying to fix that in Rails/roar-rails itself [May 2014].
 
-Rails 4.1 expects you to manually register a global HAL renderer, or `respond_with` will throw the exception `ActionController::MissingRenderer (No renderer defined for format: hal)`.
+Rails 4.1 and up expects you to manually register a global HAL or JSON-API renderer, or `respond_with` will throw an `ActionController::MissingRenderer` exception.
 
 One fix is to add this to `config/initializers/mime_types.rb` right below `Mime::Type.register 'application/hal+json', :hal`:
 
 ```ruby
 ActionController::Renderers.add :hal do |obj, options|
   self.content_type ||= Mime[:hal]
-  obj.to_hal
+  obj
 end
 ```
 
+Similarly, for JSON-API, below `Mime::Type.register 'application/vnd.api+json', :json_api` add:
+
+
+```ruby
+ActionController::Renderers.add :json_api do |obj, options|
+  self.content_type ||= Mime[:json_api]
+  obj
+end
+```
 ## Contributors
 
 * [Railslove](http://www.railslove.de) and especially Michael Bumann [bumi] have heavily supported development of roar-rails ("resource :singers").

data/gemfiles/Gemfile.rails4-2

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in roar-rails.gemspec
+gemspec :path => '../'
+
+gem 'railties', '~> 4.2.0'
+gem 'actionpack', '~> 4.2.0'
+
+gem 'activemodel', '~> 4.2.0'
+gem 'activerecord', '~> 4.2.0'
+
+gem 'minitest', '~> 5.5.0'

data/lib/generators/rails/USAGE

@@ -10,7 +10,7 @@ Examples:
   This will create a representer as follows:
 
   module BandRepresenter
-    include Roar::Representer::JSON
+    include Roar::JSON
 
     property :id
     property :name
@@ -18,12 +18,12 @@ Examples:
 
   You can pass :class and :extend property options:
 
-    rails g singer id instrument:equipament:instrument_representer
+    rails g singer id instrument:equipment:instrument_representer
 
   This will add property options:
 
     module SingerRepresenter
-      include Roar::Representer::JSON
+      include Roar::JSON
 
       property :id
       property :instrument, :class => Equipment, :extend => InstrumentRepresenter
@@ -34,7 +34,7 @@ Examples:
     rails g representer Band id name --format=xml
 
   module BandRepresenter
-    include Roar::Representer::XML
+    include Roar::XML
 
     property :id
     property :name

data/lib/generators/rails/templates/representer.rb

@@ -1,5 +1,5 @@
 module <%= class_name %>Representer
-  include Roar::Representer::<%= format %>
+  include Roar::<%= format %>
   <% property_options.each do |property| %>
   <%= property -%>
   <% end %>

data/lib/roar-rails.rb

@@ -9,6 +9,7 @@ module Roar
 
   module JSON
     autoload("HAL", "roar/rails/hal")
+    autoload("JSONAPI", "roar/rails/json_api")
   end
 
   autoload("Hypermedia", "roar/hypermedia")
@@ -28,7 +29,10 @@ module Roar
       require 'roar/rails/rails3_1_strategy'
     elsif rails_version.~ 3.2
       require 'roar/rails/rails3_2_strategy'
+    elsif rails_version.~ 4.2
+      require 'roar/rails/rails4_2_strategy'
     else
+      # fallback to 4.0 strategy
       require 'roar/rails/rails4_0_strategy'
     end
 

data/lib/roar/rails/controller_additions.rb

@@ -1,3 +1,4 @@
+require 'responders'
 require 'uber/inheritable_attr'
 require 'roar/rails/responder'
 require 'roar/rails/formats'
@@ -79,7 +80,8 @@ module Roar::Rails
     module Render
       def render(options)
         format = options.keys.first
-        super format => prepare_model_for(format, options.values.first, options)
+        status = options[:status] || :ok
+        super format => prepare_model_for(format, options.values.first, options), :status => status
       end
     end
   end

data/lib/roar/rails/json_api.rb

@@ -0,0 +1,7 @@
+require 'roar/json/json_api'
+
+Roar::JSON::JSONAPI.class_eval do
+  def to_json_api(*args);   to_json(*args);   end
+  def from_json_api(*args); from_json(*args); end
+end
+

data/lib/roar/rails/rails4_2_strategy.rb

@@ -0,0 +1,13 @@
+require 'action_controller/responder'
+
+module Roar::Rails
+  class Responder < ActionController::Responder
+    module VersionStrategy
+    end
+  end
+
+  module TestCase
+    module VersionStrategy
+    end
+  end
+end

data/lib/roar/rails/responder.rb

@@ -33,7 +33,7 @@ module Roar
       def create_response(model)
         render_method = "to_#{format}"
         media_format  = Mime[format]
-        Response.new(model.send(render_method, options), media_format)
+        Response.new(model.send(render_method, options), media_format).body
       end
 
       def handle_lonely_collection!(collection)

data/lib/roar/rails/version.rb

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

data/roar-rails.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "actionpack"
   s.add_runtime_dependency "railties",      ">= 3.0.0"
   s.add_runtime_dependency "uber",          ">= 0.0.5"
+  s.add_runtime_dependency "responders"
 
   s.add_development_dependency "minitest"
   s.add_development_dependency "activemodel"

data/test/consume_test.rb

@@ -38,6 +38,22 @@ class ConsumeHalWithNoHalRespondTest < ActionController::TestCase
   end
 end
 
+class ConsumeJsonApiWithNoJsonApiRespondTest < ActionController::TestCase
+  include Roar::Rails::TestCase
+
+  tests UnnamespaceSingersController
+
+  # Content-type is set properly, it's a registered mime but responder doesn't do #from_json_api.
+  # FIXME: why does that still find a representer?
+  test "#consume parses hal document and updates the model" do
+    @request.env['CONTENT_TYPE'] = 'application/vnd.api+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
 
@@ -109,6 +125,36 @@ class ConsumeHalTest < ActionController::TestCase
   end
 end
 
+class ConsumeJsonApiTest < ActionController::TestCase
+  include Roar::Rails::TestCase
+
+  module MusicianRepresenter
+    include Roar::JSON::JSONAPI
+    type :singer
+    property :name
+  end
+
+
+  class SingersController < ActionController::Base
+    include Roar::Rails::ControllerAdditions
+    represents :json_api, :entity => MusicianRepresenter
+
+    def consume_json_api
+      singer = consume!(Singer.new)
+      render :text => singer.inspect
+    end
+  end
+
+  tests SingersController
+
+  test "#consume parses JSON-API document and updates the model" do
+    @request.env['CONTENT_TYPE'] = 'application/vnd.api+json'
+    post :consume_json_api, "{\"singer\": {\"name\": \"Bumi\"}}"
+
+    assert_equal %{#<struct Singer name="Bumi">}, @response.body
+  end
+end
+
 class ConsumeWithOptionsOverridingConfigurationTest < ActionController::TestCase
   include Roar::Rails::TestCase
 

data/test/dummy/config/environments/test.rb

@@ -31,4 +31,10 @@ Dummy::Application.configure do
   # config.active_record.schema_format = :sql
 
   config.representer.default_url_options = {:host => "roar.apotomo.de"}
+
+  if Roar::Rails.rails_version.~ 4.2
+    config.eager_load = false
+    config.active_support.test_order = :random
+  end
+
 end

data/test/json_api_renderer_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class HalRendererTest < ActionController::TestCase
+  include Roar::Rails::TestCase
+
+  class SingersController < ActionController::Base
+    module JsonApiSingerRepresenter
+      include Roar::JSON::JSONAPI
+
+      type :singer
+      property :name
+    end
+
+    include Roar::Rails::ControllerAdditions
+    represents :json_api, :entity => JsonApiSingerRepresenter
+
+    def show
+      singer = Musician.new("Bumi")
+      respond_with singer
+    end
+  end
+
+  tests SingersController
+
+  test "should render correctly in response to a application/vnd.api+json" do
+    get :show, :id => "bumi", :format => :json_api
+    assert_body '{"singer":{"name":"Bumi"}}'
+  end
+
+  test "should have a content_type of application/vnd.api+json" do
+    get :show, :id => "bumi", :format => :json_api
+    assert_equal response.content_type, 'application/vnd.api+json'
+  end
+end
+

data/test/render_test.rb

@@ -17,7 +17,7 @@ class RenderTest < ActionController::TestCase
 
     def show
       singer = Musician.new("Bumi")
-      render :json => singer
+      render :json => singer, status: 201
     end
   end
 
@@ -26,5 +26,6 @@ class RenderTest < ActionController::TestCase
   test "should use Representer for #render" do
     get :show, :id => "bumi", :format => :json
     assert_body '{"title":"Bumi"}'
+    assert_equal 201, response.status
   end
-end
+end

data/test/test_helper.rb

@@ -11,8 +11,17 @@ Singer = Struct.new(:name)
 # Rails.backtrace_cleaner.remove_silencers!
 
 Mime::Type.register 'application/hal+json', :hal
+Mime::Type.register 'application/vnd.api+json', :json_api
 
-ActionController.add_renderer :hal do |js, options|
+
+
+# see also https://github.com/jingweno/msgpack_rails/issues/3
+::ActionController::Renderers.add :hal do |js, options|
   self.content_type ||= Mime::HAL
   js.is_a?(String) ? js : js.to_json
 end
+
+::ActionController::Renderers.add :json_api do |js, options|
+  self.content_type ||= Mime::JSONAPI
+  js.is_a?(String) ? js : js.to_json
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roar-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-23 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roar
@@ -86,6 +86,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -175,6 +189,7 @@ files:
 - gemfiles/Gemfile.rails3-2
 - gemfiles/Gemfile.rails4-0
 - gemfiles/Gemfile.rails4-1
+- gemfiles/Gemfile.rails4-2
 - lib/generators/rails/USAGE
 - lib/generators/rails/representer_generator.rb
 - lib/generators/rails/templates/representer.rb
@@ -182,11 +197,12 @@ files:
 - lib/roar/rails/controller_additions.rb
 - lib/roar/rails/formats.rb
 - lib/roar/rails/hal.rb
+- lib/roar/rails/json_api.rb
 - lib/roar/rails/rails3_0_strategy.rb
 - lib/roar/rails/rails3_1_strategy.rb
 - lib/roar/rails/rails3_2_strategy.rb
 - lib/roar/rails/rails4_0_strategy.rb
-- lib/roar/rails/rails4_1_strategy.rb
+- lib/roar/rails/rails4_2_strategy.rb
 - lib/roar/rails/railtie.rb
 - lib/roar/rails/responder.rb
 - lib/roar/rails/test_case.rb
@@ -213,6 +229,7 @@ files:
 - test/dummy/config/routes.rb
 - test/dummy/db/test.sqlite3
 - test/formats_test.rb
+- test/json_api_renderer_test.rb
 - test/json_hal_renderer_test.rb
 - test/render_test.rb
 - test/representer_generator_test.rb
@@ -264,6 +281,7 @@ test_files:
 - test/dummy/config/routes.rb
 - test/dummy/db/test.sqlite3
 - test/formats_test.rb
+- test/json_api_renderer_test.rb
 - test/json_hal_renderer_test.rb
 - test/render_test.rb
 - test/representer_generator_test.rb

data/lib/roar/rails/rails4_1_strategy.rb

@@ -1,21 +0,0 @@
-module Roar::Rails
-  class Responder < ActionController::Responder
-    module VersionStrategy
-      extend ActiveSupport::Concern
-      included do
-        # FIXME: this totally SUCKS, why am i supposed to add a global "renderer" (whatever that is) to handle hal requests. this should be a generic behaviour in Rails core.
-        # TODO: replace renderer/responder layer in Rails with a simpler implementation.
-        # ActionController.add_renderer :hal do |js, options|
-        #   self.content_type ||= Mime::HAL
-        #   js.to_json
-        # end
-      end
-    end
-  end
-
-  module TestCase
-    module VersionStrategy
-    end
-  end
-end
-