roar 0.12.3 → 0.12.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36037871272f0ad904505c747eeabb1a09c96c58
-  data.tar.gz: 964389ed57a09eb10a95f02a292865c909bda5d1
+  metadata.gz: 0d3ecc28432b3f2a039e743ea1503d71379cae06
+  data.tar.gz: dc4f0e29a6c0e62599809b02f700fa97b8971c3b
 SHA512:
-  metadata.gz: 33c07296b014315ac382722598061026f629d95ce212e6c6f98f49068a9eb5c0939eef39fc26d54b7a267f9e5e4c266f0fc7a4391787ad7958b1451ed4614a1f
-  data.tar.gz: 7391c7bc51baee1d3bf8c3c6eb3b37762b4182c36cdb8474e3f0a027e5184156e1153d37890c68a7b2bc5c3ca92d943cf7ffc20151279fe74efae38baf627914
+  metadata.gz: 096cf974e914065adc6bb7d098db53b9e4190a73402a3ae06be99a50e0ec7457186112ed5b78368d4c6a8d479c04f5832d86ac745a6907b1ab27fa0716909a81
+  data.tar.gz: e7e465c95e3430976763afd86e5fd2445f128a369eb11337ee456926b7631be92923af84155291359aad102570be14ec73dc2886a101caa0629f8cc09d552a8c

data/CHANGES.markdown

@@ -1,3 +1,11 @@
+# 0.12.5
+
+
+# 0.12.4
+
+* The `HAL` module supports [CURIE links](https://github.com/mikekelly/hal_specification/blob/f937dbc9f9e1fa25be824834794407fdcb8f116f/hal_specification.md#curies) now using the `::curie` method.
+* Allow old and new API in HttpVerbs#get and friends.
+
 # 0.12.3
 
 * Allow basic authentication with `basic_auth: [:admin, :password]`.

data/README.markdown

@@ -180,6 +180,7 @@ puts album.songs[1] #=> #<Song title="Roadblock">
 
 The nesting of two representers can map composed object as you find them in many many APIs.
 
+In case you're after virtual nesting, where a nested block in your document still maps to the same outer object, [check out the `::nested` method](https://github.com/apotonick/representable#document-nesting).
 
 ## Inline Representer
 
@@ -355,6 +356,8 @@ module SongRepresenter
 end
 ```
 
+Documentation for HAL can be found in the [API docs](http://rdoc.info/github/apotonick/roar/Roar/Representer/JSON/HAL).
+
 ### Hypermedia
 
 Including the `Roar::Representer::JSON::HAL` module adds some more DSL methods to your module. It still allows using `::link` but treats them slightly different.

data/lib/roar/representer/feature/http_verbs.rb

@@ -31,33 +31,36 @@ module Roar
 
         # Serializes the object, POSTs it to +url+ with +format+, deserializes the returned document
         # and updates properties accordingly.
-        def post(url, format, options={}, &block)
-          response = http.post_uri(options.merge(:uri => url, :body => serialize, :as => format), &block)
+        def post(*args, &block)
+          options  = handle_deprecated_args(serialize, *args)
+          response = http.post_uri(options, &block)
           handle_response(response)
         end
 
         # GETs +url+ with +format+, deserializes the returned document and updates properties accordingly.
-        def get(url, format, options={}, &block)
-          response = http.get_uri(options.merge(:uri => url, :as => format), &block)
+        def get(*args, &block)
+          response = http.get_uri(*args, &block)
           handle_response(response)
         end
 
         # Serializes the object, PUTs it to +url+ with +format+, deserializes the returned document
         # and updates properties accordingly.
-        def put(url, format, options={}, &block)
-          response = http.put_uri(options.merge(:uri => url, :body => serialize, :as => format), &block)
+        def put(*args, &block)
+          options  = handle_deprecated_args(serialize, *args)
+          response = http.put_uri(options, &block)
           handle_response(response)
           self
         end
 
-        def patch(url, format, options={}, &block)
-          response = http.patch_uri(options.merge(:uri => url, :body => serialize, :as => format), &block)
+        def patch(*args, &block)
+          options  = handle_deprecated_args(serialize, *args)
+          response = http.patch_uri(options, &block)
           handle_response(response)
           self
         end
 
-        def delete(url, format, options={}, &block)
-          http.delete_uri(options.merge(:uri => url, :as => format), &block)
+        def delete(*args, &block)
+          http.delete_uri(*args, &block)
           self
         end
 
@@ -70,6 +73,22 @@ module Roar
         def http
           transport_engine.new
         end
+
+        def handle_deprecated_args(body, *args) # TODO: remove in 1.0.
+          options = args.first
+
+          if args.size > 1
+            warn %{DEPRECATION WARNING: #get, #post, #put, #delete and #patch no longer accept positional arguments. Please call them as follows:
+     get(uri: "http://localhost/songs", as: "application/json")
+    post(uri: "http://localhost/songs", as: "application/json")
+Thank you and have a beautiful day.}
+            options = {:uri => args[0], :as => args[1]} if args.size == 2
+            options = {:uri => args[0], :as => args[2]}
+          end
+
+          options[:body] = body
+          options
+        end
       end
     end
   end

data/lib/roar/representer/json/hal.rb

@@ -9,6 +9,10 @@ module Roar::Representer
     # Embedded resources can be specified when calling #property or +collection using the
     # :embedded => true option.
     #
+    # Link arrays can be defined using +::links+.
+    #
+    # CURIEs are specified with the - surprise - +::curie+ class method.
+    #
     # Example:
     #
     #   module OrderRepresenter
@@ -20,6 +24,18 @@ module Roar::Representer
     #     link :self do
     #       "http://orders/#{id}"
     #     end
+    #
+    #     links :self do
+    #       [{:lang => "en", :href => "http://en.hit"},
+    #        {:lang => "de", :href => "http://de.hit"}]
+    #     end
+    #
+    #     curies do
+    #       [{:name => :doc,
+    #         :href => "//docs/{rel}",
+    #         :templated => true}
+    #       ]
+    #     end
     #   end
     #
     # Renders to
@@ -184,6 +200,18 @@ module Roar::Representer
             options[:array] = true  # FIXME: we need to save this information somewhere.
             link(options, &block)
           end
+
+          # Add a CURIEs link section as defined in
+          #
+          # curies do
+          #   [{:name => :doc,
+          #     :href => "//docs/{rel}",
+          #     :templated => true}
+          #   ]
+          # end
+          def curies(&block)
+            links(:curies, &block)
+          end
         end
       end
     end

data/lib/roar/version.rb

@@ -1,3 +1,3 @@
 module Roar
-  VERSION = "0.12.3"
+  VERSION = "0.12.4"
 end

data/test/hal_json_test.rb

@@ -140,4 +140,21 @@ class LinkCollectionTest < MiniTest::Spec
       subject.is_array?("prev").must_equal false
     end
   end
+end
+
+
+class HalCurieTest < MiniTest::Spec
+  representer!([Roar::Representer::JSON::HAL]) do
+    link "doc:self" do
+      "/"
+    end
+
+    curies do
+      [{:name => :doc,
+        :href => "//docs/{rel}",
+        :templated => true}]
+    end
+  end
+
+  it { Object.new.extend(rpr).to_hash.must_equal({"_links"=>{"doc:self"=>{:href=>"/"}, "curies"=>[{:name=>:doc, :href=>"//docs/{rel}", :templated=>true}]}}) }
 end

data/test/http_verbs_test.rb

@@ -38,6 +38,14 @@ class HttpVerbsTest < MiniTest::Spec
     end
 
 
+    describe "deprecations" do
+      it "old #get API still works" do
+        @band.get("http://localhost:4567/bands/slayer", "application/json")
+        assert_equal ["Slayer", "Canadian Maple"], [@band.name, @band.label]
+      end
+    end
+
+
     describe "HttpVerbs.get" do
       it "returns instance from incoming representation" do
         band = @band.get("http://localhost:4567/bands/slayer", "application/json")
@@ -66,9 +74,8 @@ class HttpVerbsTest < MiniTest::Spec
 
     describe "#get" do
       it "updates instance with incoming representation" do
-        @band.get("http://localhost:4567/bands/slayer", "application/json")
-        assert_equal "Slayer", @band.name
-        assert_equal "Canadian Maple", @band.label
+        @band.get(:uri => "http://localhost:4567/bands/slayer", :as => "application/json")
+        assert_equal ["Slayer", "Canadian Maple"], [@band.name, @band.label]
       end
     end
 
@@ -77,7 +84,7 @@ class HttpVerbsTest < MiniTest::Spec
         @band.name = "Strung Out"
         assert_equal nil, @band.label
 
-        @band.post("http://localhost:4567/bands", "application/xml")
+        @band.post(:uri => "http://localhost:4567/bands", :as => "application/xml")
         assert_equal "STRUNG OUT", @band.name
         assert_equal nil, @band.label
       end
@@ -87,7 +94,7 @@ class HttpVerbsTest < MiniTest::Spec
       it "updates instance with incoming representation" do
         @band.name   = "Strung Out"
         @band.label  = "Fat Wreck"
-        @band.put("http://localhost:4567/bands/strungout", "application/xml")
+        @band.put(:uri => "http://localhost:4567/bands/strungout", :as => "application/xml")
         assert_equal "STRUNG OUT", @band.name
         assert_equal "FAT WRECK", @band.label
       end
@@ -96,17 +103,18 @@ class HttpVerbsTest < MiniTest::Spec
     describe "#patch" do
       it 'does something' do
         @band.label  = 'Fat Mike'
-        @band.patch("http://localhost:4567/bands/strungout", "application/xml")
+        @band.patch(:uri => "http://localhost:4567/bands/strungout", :as => "application/xml")
         assert_equal 'FAT MIKE', @band.label
       end
     end
 
     describe "#delete" do
       it 'does something' do
-        @band.delete("http://localhost:4567/bands/metallica", "application/xml")
+        @band.delete(:uri => "http://localhost:4567/bands/metallica", :as => "application/xml")
       end
     end
 
+
     describe "HTTPS and Authentication" do
       let (:song) { OpenStruct.new(:name => "bodyjar").extend(Roar::Representer::Feature::HttpVerbs, BandRepresenter) }
 
@@ -117,7 +125,7 @@ class HttpVerbsTest < MiniTest::Spec
       describe "HTTPS: passing manually" do
         verbs do |verb|
           it "allows #{verb}" do
-            song.send(verb, "https://localhost:8443/bands/bodyjar", "application/json")
+            song.send(verb, :uri => "https://localhost:8443/bands/bodyjar", :as => "application/json")
 
             if verb == "delete"
               song.name.must_equal "bodyjar"
@@ -130,7 +138,7 @@ class HttpVerbsTest < MiniTest::Spec
 
       describe "HTTPS+Basic Auth: passing manually" do
         it "allows GET" do
-          song.get("https://localhost:8443/protected", "application/json", :basic_auth => [:admin, :password])
+          song.get(:uri => "https://localhost:8443/protected", :as => "application/json", :basic_auth => [:admin, :password])
 
           song.name.must_equal "Bodyjar"
         end
@@ -139,7 +147,7 @@ class HttpVerbsTest < MiniTest::Spec
 
     describe "request customization" do
       it "yields the request object" do
-        band.get("http://localhost:4567/cookies", "application/json") do |req|
+        band.get(:uri => "http://localhost:4567/cookies", :as => "application/json") do |req|
           req.add_field("Cookie", "Yumyum")
         end.name.must_equal "Bodyjar"
       end

data/test/test_helper.rb

@@ -43,8 +43,8 @@ MiniTest::Spec.class_eval do
     end
   end
 
-  def self.representer!(*args)
-    representer_for(*args)
+  def self.representer!(*args, &block)
+    representer_for(*args, &block)
   end
 
   def self.verbs(&block)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roar
 version: !ruby/object:Gem::Version
-  version: 0.12.3
+  version: 0.12.4
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-28 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable