RubyGems - roar - Versions diffs - 0.0.1.alpha1 → 0.8.0 - Mend

roar 0.0.1.alpha1 → 0.8.0

Files changed (77) hide show

data/.gitignore +1 -0
data/Gemfile +8 -0
data/README.textile +297 -0
data/Rakefile +16 -0
data/lib/roar/client/entity_proxy.rb +58 -0
data/lib/roar/client/proxy.rb +14 -0
data/lib/roar/client/transport.rb +29 -0
data/lib/roar/model.rb +36 -0
data/lib/roar/model/representable.rb +31 -0
data/lib/roar/rails.rb +21 -0
data/lib/roar/rails/controller_methods.rb +71 -0
data/lib/roar/rails/representer_methods.rb +52 -0
data/lib/roar/rails/test_case.rb +43 -0
data/lib/roar/representer.rb +72 -0
data/lib/roar/representer/feature/http_verbs.rb +63 -0
data/lib/roar/representer/feature/hypermedia.rb +43 -0
data/lib/roar/representer/feature/model_representing.rb +88 -0
data/lib/roar/representer/json.rb +32 -0
data/lib/roar/representer/xml.rb +43 -0
data/lib/roar/version.rb +1 -1
data/roar.gemspec +10 -1
data/test/Gemfile +6 -0
data/test/dummy/Rakefile +7 -0
data/test/dummy/app/controllers/albums_controller.rb +27 -0
data/test/dummy/app/controllers/application_controller.rb +4 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/models/album.rb +6 -0
data/test/dummy/app/models/song.rb +2 -0
data/test/dummy/app/representers/representer/xml/album.rb +19 -0
data/test/dummy/app/representers/representer/xml/song.rb +9 -0
data/test/dummy/app/views/layouts/application.html.erb +14 -0
data/test/dummy/app/views/musician/featured.html.erb +1 -0
data/test/dummy/app/views/musician/featured_with_block.html.erb +4 -0
data/test/dummy/app/views/musician/hamlet.html.haml +1 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/config/application.rb +20 -0
data/test/dummy/config/boot.rb +10 -0
data/test/dummy/config/database.yml +22 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +16 -0
data/test/dummy/config/environments/production.rb +46 -0
data/test/dummy/config/environments/test.rb +32 -0
data/test/dummy/config/locales/en.yml +5 -0
data/test/dummy/config/routes.rb +7 -0
data/test/dummy/db/development.sqlite3 +0 -0
data/test/dummy/db/migrate/20110514114753_create_albums.rb +14 -0
data/test/dummy/db/migrate/20110514121228_create_songs.rb +14 -0
data/test/dummy/db/schema.rb +29 -0
data/test/dummy/db/test.sqlite3 +0 -0
data/test/dummy/module - (2011-05-14 15:26:19) +5 -0
data/test/dummy/public/404.html +26 -0
data/test/dummy/public/422.html +26 -0
data/test/dummy/public/500.html +26 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/dummy/script/rails +6 -0
data/test/dummy/tmp/app/cells/blog/post/latest.html.erb +7 -0
data/test/dummy/tmp/app/cells/blog/post_cell.rb +7 -0
data/test/fake_server.rb +80 -0
data/test/http_verbs_test.rb +46 -0
data/test/hypermedia_test.rb +35 -0
data/test/integration_test.rb +122 -0
data/test/json_representer_test.rb +101 -0
data/test/model_representing_test.rb +121 -0
data/test/model_test.rb +50 -0
data/test/order_representers.rb +34 -0
data/test/proxy_test.rb +89 -0
data/test/rails/controller_methods_test.rb +147 -0
data/test/rails/rails_representer_methods_test.rb +32 -0
data/test/representable_test.rb +49 -0
data/test/representer_test.rb +25 -0
data/test/ruby_representation_test.rb +144 -0
data/test/test_helper.rb +45 -0
data/test/test_helper_test.rb +59 -0
data/test/transport_test.rb +34 -0
data/test/xml_hypermedia_test.rb +47 -0
data/test/xml_representer_test.rb +238 -0
metadata +181 -13

@@ -0,0 +1,29 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+ActiveRecord::Schema.define(:version => 20110514121228) do
+  create_table "albums", :force => true do |t|
+    t.string   "title"
+    t.string   "year"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+  create_table "songs", :force => true do |t|
+    t.string   "title"
+    t.integer  "album_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+end

data/test/dummy/db/test.sqlite3 ADDED

File without changes

data/test/dummy/module - (2011-05-14 15:26:19) ADDED

@@ -0,0 +1,5 @@
+module Representer
+  module CSV
+    class AlbumRepresenter; end
+  end
+end

data/test/dummy/public/404.html ADDED

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/422.html ADDED

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/500.html ADDED

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+    <p>We've been notified about this issue and we'll take a look at it shortly.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/favicon.ico ADDED

File without changes

data/test/dummy/script/rails ADDED

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/test/dummy/tmp/app/cells/blog/post/latest.html.erb ADDED

@@ -0,0 +1,7 @@
+<h1>
+  Blog::Post#latest
+</h1>
+<p>
+  Find me in app/cells/blog/post/latest.html.erb
+</p>

data/test/dummy/tmp/app/cells/blog/post_cell.rb ADDED

@@ -0,0 +1,7 @@
+class Blog::PostCell < Cell::Rails
+  def latest
+    render
+  end
+end

data/test/fake_server.rb ADDED

@@ -0,0 +1,80 @@
+require "bundler/setup"
+require 'sinatra/base'
+require 'sinatra/reloader'
+class FakeServer < Sinatra::Base
+  get "/method" do
+    "<method>get</method>"
+  end
+  post "/method" do
+    "<method>post</method>"
+  end
+  put "/method" do
+    "<method>put</method>"
+  end
+  delete "/method" do
+    "<method>delete</method>"
+  end
+  #patch "/method" do
+  #  "<method>patch</method>"
+  #end
+  post "/band" do
+    if request.content_type =~ /xml/
+      %{<band><label>n/a</label><name>Strung Out</name>
+        <link href="http://search" rel="search" />
+        <link href="http://band/strungout" rel="self" />
+      </band>}
+    else
+      '{"band": {"label": "n/a", "name": "Strung Out", "links": [{"href":"http://search", "rel": "search"}, {"href":"http://band/strungout", "rel": "self"}]}}'
+    end
+  end
+  put "/band/strungout" do
+    %{<band><label>Fat Wreck</label><name>Strung Out</name></band>}
+  end
+  require Dir.pwd + '/order_representers'
+  JSON::Order.class_eval do
+    def items_url
+      "http://localhost:9999/orders/1/items"
+    end
+    def order_url(order)
+      "http://localhost:9999/orders/#{order}"
+    end
+    def represented
+      1
+    end
+  end
+  post "/orders" do
+    incoming = JSON::Order.deserialize(request.body.string)
+    # create new record
+    # render new record
+    JSON::Order.from_attributes(incoming.to_attributes).serialize
+  end
+  post "/orders/1/items" do
+    incoming = JSON::Item.deserialize(request.body.string)
+    JSON::Item.from_attributes(incoming.to_attributes).serialize
+  end
+  get "/orders/1" do
+    JSON::Order.new(:client_id => 1, :items => [JSON::Item.new(:article_id => "666-S", :amount => 1)]).serialize
+  end
+end
+FakeServer.run! :host => 'localhost', :port => 9999

data/test/http_verbs_test.rb ADDED

@@ -0,0 +1,46 @@
+require 'test_helper'
+require 'roar/representer/feature/http_verbs'
+class HttpVerbsTest < MiniTest::Spec
+  class BandRepresenter < Roar::Representer::XML
+    self.representation_name = :band
+    property :name
+    property :label
+    include Roar::Representer::Feature::HttpVerbs
+  end
+  describe "HttpVerbs" do
+    before do
+      @r = BandRepresenter.new
+    end
+    # TODO: assert that Restfulie#post receives the correct document.
+    it "#post deserializes the incoming representation and returns it" do
+      @r.name = "Strung Out"
+      rep = @r.post("http://localhost:9999/band", "application/xml")
+      assert_equal "Strung Out", rep.name
+      assert_equal "n/a", rep.label
+    end
+    it "#post! deserializes the incoming representation and replaces attributes" do
+      @r.name = "Strung Out"
+      assert_equal nil, @r.label
+      @r.post!("http://localhost:9999/band", "application/xml")
+      assert_equal "Strung Out", @r.name
+      assert_equal "n/a", @r.label
+    end
+    it "#put deserializes the incoming representation and returns it" do
+      @r.name   = "Strung Out"
+      @r.label  = "Fat Wreck"
+      rep = @r.put("http://localhost:9999/band/strungout", "application/xml")
+      assert_equal "Strung Out", rep.name
+      assert_equal "Fat Wreck", rep.label
+    end
+  end
+end

data/test/hypermedia_test.rb ADDED

@@ -0,0 +1,35 @@
+require 'test_helper'
+require 'roar/representer/feature/hypermedia'
+class HypermediaTest
+  describe "Hypermedia" do
+    class Bookmarks
+      include Roar::Representer::Feature::Hypermedia
+    end
+    before do
+      Hyperlink = Roar::Representer::XML::Hyperlink # TODO: move to abstract module.
+      @b = Bookmarks.new
+      @b.links = [Hyperlink.from_attributes({"rel" => "self", "href" => "http://self"}), Hyperlink.from_attributes({"rel" => "next", "href" => "http://next"})]
+    end
+    describe "#links" do
+      it "returns links" do
+        assert_kind_of Roar::Representer::Feature::Hypermedia::LinkCollection, @b.links
+        assert_equal 2, @b.links.size
+      end
+      it "works with empty links set" do
+        assert_equal nil, Bookmarks.new.links # default empty array doesn't make sense.
+      end
+    end
+    it "responds to links #[]" do
+      assert_equal "http://self", @b.links["self"]
+      assert_equal "http://self", @b.links[:self]
+      assert_equal "http://next", @b.links[:next]
+      assert_equal nil, @b.links[:prev]
+    end
+  end
+end

data/test/integration_test.rb ADDED

@@ -0,0 +1,122 @@
+require 'test_helper'
+require 'roar/representer/xml'
+require 'roar/representer/json'
+require 'roar/representer/feature/http_verbs'
+require 'roar/representer/feature/hypermedia'
+class RepresenterIntegrationTest < MiniTest::Spec
+  module XML
+    class BandRepresenter < Roar::Representer::XML
+      self.representation_name = :band
+      property :name
+      property :label
+      include Roar::Representer::Feature::HttpVerbs
+      link :search do
+        search_url
+      end
+      link :self do
+        order_url(represented)
+      end
+    end
+  end
+  # TODO: inherit properly.
+  module JSON
+    class BandRepresenter < Roar::Representer::JSON
+      self.representation_name = :band
+      property :name
+      property :label
+      include Roar::Representer::Feature::HttpVerbs
+      include Roar::Representer::Feature::Hypermedia
+      link :search do
+        search_url
+      end
+      link :self do
+        order_url(represented)
+      end
+    end
+  end
+  require 'order_representers'
+  describe "Representer as client" do
+    describe "JSON" do
+      it "allows a POST workflow" do
+        # create representation with initial values:
+        @r = JSON::BandRepresenter.new(:name => "Bigwig")
+        assert_equal "Bigwig", @r.name
+        @r = @r.post("http://localhost:9999/band", "application/band+json")
+        assert_equal "n/a", @r.label
+        # check HATEOAS:
+        #@r.extend Roar::Representer::Feature::Hypermedia
+        assert_equal "http://search",         @r.links[:search]
+        assert_equal "http://band/strungout", @r.links[:self]
+      end
+      # TODO: implement me.
+      it "allows an ordering workflow" do
+        # create representation with initial values:
+        @o = ::JSON::Order.new(:client_id => 1)
+        assert_equal 1, @o.client_id
+        @o.post!("http://localhost:9999/orders", "application/order+json")
+        # check HATEOAS:
+        #@r.extend Roar::Representer::Feature::Hypermedia
+        assert_equal "http://localhost:9999/orders/1/items",     @o.links[:items]
+        assert_equal "http://localhost:9999/orders/1",           @o.links[:self]
+        # manually POST item:
+        @i = ::JSON::Item.new(:article_id => "666-S", :amount => 1)
+        @i.post!(@o.links[:items], "application/item+json")
+        @o.get!(@o.links[:self], "application/order+json")
+        # check if item is included in order:
+        assert_equal 1, @o.items.size
+        assert_equal @i.to_attributes, @o.items.first.to_attributes
+        ###@@o.delete!(@o.links[:self])
+        # use the DSL to add items:
+        #@o.links[:items].post(:article_id => "666-S", :amount => 1)
+        #@o.items.post(:article_id => "666-S", :amount => 1)
+      end
+    end
+    describe "XML" do
+      it "allows a POST workflow" do
+        # create representation with initial values:
+        @r = XML::BandRepresenter.new(:name => "Bigwig")
+        assert_equal "Bigwig", @r.name
+        @r = @r.post("http://localhost:9999/band", "application/band+xml")
+        assert_equal "n/a", @r.label
+        # check HATEOAS:
+        #@r.extend Roar::Representer::Feature::Hypermedia
+        assert_equal "http://search",         @r.links[:search]
+        assert_equal "http://band/strungout", @r.links[:self]
+      end
+    end
+  end
+end

data/test/json_representer_test.rb ADDED

@@ -0,0 +1,101 @@
+require 'test_helper'
+require "test_xml/mini_test"
+require "roar/representer/json"
+class JsonRepresenterFunctionalTest < MiniTest::Spec
+  class OrderRepresenter < Roar::Representer::JSON
+    self.representation_name= :order
+    representable_property :id
+  end
+  describe "JsonRepresenter" do
+    before do
+      @r = OrderRepresenter.new
+    end
+    describe "#to_json" do
+      it "#serialize returns the serialized model" do
+        @r.id = 1
+        assert_equal '{"order":{"id":1}}', @r.serialize
+      end
+      it ".from_xml returns the deserialized model" do
+        @m = OrderRepresenter.deserialize('{"order": {"id":1}}')
+        assert_equal 1, @m.id
+      end
+      it ".from_xml still works with nil" do
+        assert OrderRepresenter.deserialize(nil)
+      end
+    end
+  end
+end
+class JsonHyperlinkRepresenterTest
+  describe "API" do
+    before do
+      @l = Roar::Representer::JSON::Hyperlink.from_json({:link => {:rel => :self, :href => "http://roar.apotomo.de"}}.to_json)
+    end
+    it "responds to #representation_name" do
+      assert_equal :link, @l.class.representation_name
+    end
+    it "responds to #rel" do
+      assert_equal "self", @l.rel
+    end
+    it "responds to #href" do
+      assert_equal "http://roar.apotomo.de", @l.href
+    end
+  end
+end
+class JsonHypermediaTest
+  describe "Hypermedia API" do
+    before do
+      @c = Class.new(Roar::Representer::JSON) do
+        include Roar::Representer::Feature::Hypermedia
+        self.representation_name= :order
+        representable_property :id
+        link :self do "http://self" end
+        link :next do "http://next/#{id}" end
+      end
+      @r = @c.new
+    end
+    it "responds to #links" do
+      assert_equal nil, @r.links
+    end
+    it "computes links in #from_attributes" do
+      @r = @c.from_attributes({"id" => 1})
+      assert_equal 2, @r.links.size
+      assert_equal({"rel"=>:self, "href"=>"http://self"}, @r.links.first.to_attributes)
+      assert_equal({"rel"=>:next, "href"=>"http://next/1"}, @r.links.last.to_attributes)
+    end
+    it "extracts links from JSON" do
+      @r = @c.deserialize({:order => {:links => [{:rel => "self", :href => "http://self"}]}}.to_json)
+      assert_equal 1, @r.links.size
+      assert_equal({"rel"=>"self", "href"=>"http://self"}, @r.links.first.to_attributes)
+    end
+    it "renders link: correctly in JSON" do
+      assert_equal "{\"order\":{\"id\":1,\"links\":[{\"rel\":\"self\",\"href\":\"http://self\"},{\"rel\":\"next\",\"href\":\"http://next/1\"}]}}", @c.from_attributes({"id" => 1}).serialize
+    end
+  end
+end