roar 0.12.9 → 1.0.0.beta1

data/lib/roar/transport/net_http.rb

@@ -0,0 +1,57 @@
+require 'roar/transport/net_http/request'
+
+module Roar
+  # Implements the (HTTP) transport interface with Net::HTTP.
+  module Transport
+    # Low-level interface for HTTP. The #get_uri and friends accept an options and an optional block, invoke
+    # the HTTP request and return the request object.
+    #
+    # The following options are available:
+    class NetHTTP
+
+      def get_uri(*options, &block)
+        call(Net::HTTP::Get, *options, &block)
+      end
+
+      def post_uri(*options, &block)
+        call(Net::HTTP::Post, *options, &block)
+      end
+
+      def put_uri(*options, &block)
+        call(Net::HTTP::Put, *options, &block)
+      end
+
+      def delete_uri(*options, &block)
+        call(Net::HTTP::Delete, *options, &block)
+      end
+
+      def patch_uri(*options, &block)
+        call(Net::HTTP::Patch, *options, &block)
+      end
+
+    private
+      def call(what, *args, &block)
+        options = handle_deprecated_args(args)
+        # TODO: generically handle return codes.
+        Request.new(options).call(what, &block)
+      end
+
+      def handle_deprecated_args(args) # TODO: remove in 1.0.
+        if args.size > 1
+          warn %{DEPRECATION WARNING: #get_uri, #post_uri, #put_uri, #delete_uri and #patch_uri no longer accept positional arguments. Please call them as follows:
+   get_uri(uri: "http://localhost/songs", as: "application/json")
+  post_uri(uri: "http://localhost/songs", as: "application/json", body: "{'id': 1}")
+Thank you and have a lovely day.}
+          return {:uri => args[0], :as => args[1]} if args.size == 2
+          return {:uri => args[0], :as => args[2], :body => args[1]}
+        end
+
+        args.first
+      end
+
+    end
+
+    class UnauthorizedError < RuntimeError # TODO: raise this from Faraday, too.
+    end
+  end
+end

data/lib/roar/transport/net_http/request.rb

@@ -0,0 +1,72 @@
+require "net/http"
+require "openssl"
+
+module Roar
+  module Transport
+    class NetHTTP
+      class Request # TODO: implement me.
+        def initialize(options)
+          @uri     = parse_uri(options[:uri]) # TODO: add :uri.
+          @as      = options[:as]
+          @body    = options[:body]
+          @options = options
+
+          @http = Net::HTTP.new(uri.host, uri.port)
+          unless options[:pem_file].nil?
+            pem = File.read(options[:pem_file])
+            @http.use_ssl = true
+            @http.cert = OpenSSL::X509::Certificate.new(pem)
+            @http.key = OpenSSL::PKey::RSA.new(pem)
+            @http.verify_mode = options[:ssl_verify_mode].nil? ? OpenSSL::SSL::VERIFY_PEER : options[:ssl_verify_mode]
+          end
+        end
+
+        def call(what)
+          @req = what.new(uri.request_uri)
+
+          # if options[:ssl]
+          #   uri.port = Net::HTTP.https_default_port()
+          # end
+          https!
+          basic_auth!
+
+          req.content_type = as
+          req["accept"]    = as # TODO: test me. # DISCUSS: if Accept is not set, rails treats this request as as "text/html".
+          req.body         = body if body
+
+          yield req if block_given?
+
+          http.request(req).tap do |res|
+            raise UnauthorizedError if res.is_a?(Net::HTTPUnauthorized) # FIXME: make this better. # DISCUSS: abstract all that crap here?
+          end
+        end
+
+        def get
+          call(Net::HTTP::Get)
+        end
+
+        private
+        attr_reader :uri, :as, :body, :options, :req, :http
+
+        def parse_uri(url)
+          uri = URI(url)
+          raise "Incorrect URL `#{url}`. Maybe you forgot http://?" if uri.instance_of?(URI::Generic)
+          uri
+        end
+
+        def https!
+          return unless uri.scheme == 'https'
+
+          @http.use_ssl     = true
+          @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+
+        def basic_auth!
+          return unless options[:basic_auth]
+
+          @req.basic_auth(*options[:basic_auth])
+        end
+      end
+    end
+  end
+end

data/lib/roar/version.rb

@@ -1,3 +1,3 @@
 module Roar
-  VERSION = "0.12.9"
+  VERSION = "1.0.0.beta1"
 end

data/lib/roar/xml.rb

@@ -0,0 +1,54 @@
+require 'roar/representer'
+require 'roar/hypermedia'
+require 'representable/xml'
+
+module Roar
+  # Includes #from_xml and #to_xml into your represented object.
+  # In addition to that, some more options are available when declaring properties.
+  module XML
+    def self.included(base)
+      base.class_eval do
+        include Representer # Roar::Representer, this is needed for Rails URL helpers
+        include Representable::XML
+
+        extend ClassMethods
+        include InstanceMethods # otherwise Representable overrides our #to_xml.
+      end
+    end
+
+    module InstanceMethods
+      # Generic entry-point for rendering.
+      def serialize(*args)
+        to_xml(*args)
+      end
+
+      def deserialize(*args)
+        from_xml(*args)
+      end
+    end
+
+
+    module ClassMethods
+      include Representable::XML::ClassMethods
+
+      def links_definition_options
+        # FIXME: this doesn't belong into the generic XML representer.
+        {
+          :as => :link,
+          :collection   => true,
+          :class        => Hypermedia::Hyperlink,
+          :extend       => XML::HyperlinkRepresenter,
+          :exec_context => :decorator,
+          } # TODO: merge with JSON.
+      end
+    end
+
+
+    require 'representable/xml/hash'
+    module HyperlinkRepresenter
+      include Representable::XML::AttributeHash
+
+      self.representation_wrap = :link
+    end
+  end
+end

data/roar.gemspec

@@ -13,17 +13,18 @@ Gem::Specification.new do |s|
   s.license = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files    = `git ls-files -- {test}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "representable", ">= 1.6.0", "< 2.0.0"
+  s.add_runtime_dependency "representable", ">= 2.0.0", "<= 3.0.0"
 
   s.add_development_dependency "rake", ">= 0.10.1"
   s.add_development_dependency "test_xml", ">= 0.1.6"
-  s.add_development_dependency "minitest",	"= 5.0.0"
+  s.add_development_dependency "minitest",	">= 5.4.2"
   s.add_development_dependency "sinatra"
-  s.add_development_dependency "virtus"
+  s.add_development_dependency "sinatra-contrib"
+  s.add_development_dependency "virtus", ">= 1.0.0"
   s.add_development_dependency "faraday"
   s.add_development_dependency "json"
 end

data/test/client_test.rb

@@ -1,5 +1,5 @@
 require 'test_helper'
-require 'roar/representer/feature/client'
+require 'roar/client'
 
 class ClientTest < MiniTest::Spec
   representer_for([Roar::Representer]) do
@@ -7,7 +7,7 @@ class ClientTest < MiniTest::Spec
     property :band
   end
 
-  let(:song) { Object.new.extend(rpr).extend(Roar::Representer::Feature::Client) }
+  let(:song) { Object.new.extend(rpr).extend(Roar::Client) }
 
   it "adds accessors" do
     song.name = "Social Suicide"
@@ -17,7 +17,7 @@ class ClientTest < MiniTest::Spec
   end
 
   describe "links" do
-    representer_for([Roar::Representer::JSON, Roar::Representer::Feature::Hypermedia]) do
+    representer_for([Roar::JSON, Roar::Hypermedia]) do
       property :name
       link(:self) { never_call_me! }
     end

data/test/coercion_feature_test.rb

@@ -1,15 +1,18 @@
 require 'test_helper'
-require 'roar/representer/feature/coercion'
+require 'roar/coercion'
 
 class CoercionFeatureTest < MiniTest::Spec
   describe "Coercion" do
     class ImmigrantSong
-      include Roar::Representer::JSON
-      include Roar::Representer::Feature::Coercion
+      include Roar::JSON
+      include Roar::Coercion
 
       property :composed_at, :type => DateTime, :default => "May 12th, 2012"
 
       attr_accessor :composed_at
+      def composed_at=(v) # in ruby 2.2, #label= is not there, all at sudden. what *is* that?
+        @composed_at = v
+      end
     end
 
     it "coerces into the provided type" do

data/test/collection_json_test.rb

@@ -1,10 +1,10 @@
 require 'test_helper'
-require 'roar/representer/json/collection_json'
+require 'roar/json/collection_json'
 
 class CollectionJsonTest < MiniTest::Spec
   let(:song) { OpenStruct.new(:title => "scarifice", :length => 43) }
 
-  representer_for([Roar::Representer::JSON::CollectionJSON]) do
+  representer_for([Roar::JSON::CollectionJSON]) do
     version "1.0"
     href { "//songs/" }
 
@@ -34,11 +34,9 @@ class CollectionJsonTest < MiniTest::Spec
 
   describe "#to_json" do
     it "renders document" do
-      collection_key = Representable::VERSION =~ /^1.8/ ? "collection" : :collection
-
       [song].extend(rpr).to_hash.must_equal(
       {
-        collection_key=>{
+        "collection"=>{
           "version"=>"1.0",
           "href"=>"//songs/",
 
@@ -50,8 +48,8 @@ class CollectionJsonTest < MiniTest::Spec
           },
 
           "queries"=>[
-            {:rel=>:search, :href=>"//search",
-              :data=>[
+            {"rel"=>"search", "href"=>"//search",
+              "data"=>[
                 {:name=>"q", :value=>""}
               ]
             }
@@ -60,8 +58,8 @@ class CollectionJsonTest < MiniTest::Spec
           "items"=>[
             {
               "links"=>[
-                {:rel=>:download, :href=>"//songs/scarifice.mp3"},
-                {:rel=>:stats, :href=>"//songs/scarifice/stats"}
+                {"rel"=>"download", "href"=>"//songs/scarifice.mp3"},
+                {"rel"=>"stats",    "href"=>"//songs/scarifice/stats"}
               ],
               "href"=>"//songs/scarifice",
               :data=>[
@@ -72,7 +70,7 @@ class CollectionJsonTest < MiniTest::Spec
           ],
 
           "links"=>[
-            {:rel=>:feed, :href=>"//songs/feed"}
+            {"rel"=>"feed", "href"=>"//songs/feed"}
           ]
         }
       })# %{{"collection":{"version":"1.0","href":"//songs/","items":[{"href":"//songs/scarifice","links":[{"rel":"download","href":"//songs/scarifice.mp3"},{"rel":"stats","href":"//songs/scarifice/stats"}],"data":[{"name":"title","value":"scarifice"},{"name":"length","value":43}]}],"template":{"data":[{"name":"title","value":null},{"name":"length","value":null}]},"queries":[{"rel":"search","href":"//search","data":[{"name":"q","value":""}]}],"links":[{"rel":"feed","href":"//songs/feed"}]}}}

data/test/decorator_test.rb

@@ -3,7 +3,7 @@ require 'roar/decorator'
 
 class DecoratorTest < MiniTest::Spec
   class SongRepresentation < Roar::Decorator
-    include Roar::Representer::JSON
+    include Roar::JSON
 
     property :name
   end
@@ -32,7 +32,7 @@ class DecoratorTest < MiniTest::Spec
       let (:decorator) { decorator_class.new(model) }
 
       it "rendering links works" do
-        decorator.to_hash.must_equal({"links"=>[{:rel=>:self, :href=>"http://self"}]})
+        decorator.to_hash.must_equal({"links"=>[{"rel"=>"self", "href"=>"http://self"}]})
       end
 
       it "sets links on decorator" do
@@ -45,22 +45,34 @@ class DecoratorTest < MiniTest::Spec
         model_with_links.links.must_equal nil
       end
 
-      describe "Decorator::HypermediaClient" do
-        let (:decorator) { rpr_mod = rpr
-          Class.new(Roar::Decorator) do
-            include rpr_mod
-            include Roar::Decorator::HypermediaConsumer
-          end }
+      class ConsumingDecorator < Roar::Decorator
+        include Roar::JSON
+        include Roar::Hypermedia
+        link(:self) { "http://self" }
+
+        include HypermediaConsumer
+      end
+
+      # TODO: test include ModuleWithLinks
 
+      describe "Decorator::HypermediaClient" do
         it "propagates links to represented" do
-          decorator.new(model_with_links).from_hash("links"=>[{:rel=>:self, :href=>"http://next"}])
-          model_with_links.links[:self].must_equal(link(:rel=>:self, :href=>"http://next"))
+          decorator = ConsumingDecorator.new(model_with_links)
+
+
+          decorator.from_hash("links"=>[{:rel=>:self, :href=>"http://percolator"}])
+
+          # links are always set on decorator instance.
+          decorator       .links[:self].must_equal(link(:rel=>:self, :href=>"http://percolator"))
+
+          # and propagated to represented with HypermediaConsumer.
+          model_with_links.links[:self].must_equal(link(:rel=>:self, :href=>"http://percolator"))
         end
       end
     end
 
     describe "XML" do
-      representer_for([Roar::Representer::XML, Roar::Representer::Feature::Hypermedia]) do
+      representer_for([Roar::XML, Roar::Hypermedia]) do
         link(:self) { "http://self" } # TODO: test with HAL, too.
         #self.representation_wrap = :song   # FIXME: why isn't this working?
       end
@@ -84,7 +96,7 @@ class DecoratorTest < MiniTest::Spec
 
 
     describe "JSON::HAL" do
-      representer_for([Roar::Representer::JSON::HAL]) do
+      representer_for([Roar::JSON::HAL]) do
         link(:self) { "http://self" }
       end
       let (:decorator_class) { rpr_mod = rpr
@@ -95,12 +107,12 @@ class DecoratorTest < MiniTest::Spec
       let (:decorator) { decorator_class.new(model) }
 
       it "rendering links works" do
-        decorator.to_hash.must_equal({"_links"=>{"self"=>{:href=>"http://self"}}})
+        decorator.to_hash.must_equal({"_links"=>{"self"=>{"href"=>"http://self"}}})
       end
 
       it "sets links on decorator" do
-        decorator.from_hash({"_links"=>{"self"=>{:href=>"http://next"}}})
-        decorator.links.must_equal("self"=>link(:rel=>"self", :href=>"http://next"))
+        decorator.from_hash({"_links"=>{"self"=>{"href"=>"http://next"}}})
+        decorator.links.must_equal("self"=>link("rel"=>"self", "href"=>"http://next"))
       end
 
       describe "Decorator::HypermediaClient" do

data/test/faraday_http_transport_test.rb

@@ -1,5 +1,5 @@
 require 'test_helper'
-require 'roar/representer/transport/faraday'
+require 'roar/transport/faraday'
 
 class FaradayHttpTransportTest < MiniTest::Spec
   describe 'FaradayHttpTransport' do
@@ -7,55 +7,53 @@ class FaradayHttpTransportTest < MiniTest::Spec
     let(:body) { "booty" }
     let(:as) { "application/xml" }
     before do
-      @transport = Roar::Representer::Transport::Faraday.new
+      @transport = Roar::Transport::Faraday.new
     end
 
     it "#get_uri returns response" do
-      @transport.get_uri(url, as).must_match_faraday_response :get, url, as
+      @transport.get_uri(uri: url, as: as).must_match_faraday_response :get, url, as
     end
 
     it "#post_uri returns response" do
-      @transport.post_uri(url, body, as).must_match_faraday_response :post, url, as, body
+      @transport.post_uri(uri: url, body: body, as: as).must_match_faraday_response :post, url, as, body
     end
 
     it "#put_uri returns response" do
-      @transport.put_uri(url, body, as).must_match_faraday_response :put, url, as, body
+      @transport.put_uri(uri: url, body: body, as: as).must_match_faraday_response :put, url, as, body
     end
 
     it "#delete_uri returns response" do
-      @transport.delete_uri(url, as).must_match_faraday_response :delete, url, as
+      @transport.delete_uri(uri: url, as: as).must_match_faraday_response :delete, url, as
     end
 
     it "#patch_uri returns response" do
-      @transport.patch_uri(url, body, as).must_match_faraday_response :patch, url, as, body
+      @transport.patch_uri(uri: url, body: body, as: as).must_match_faraday_response :patch, url, as, body
     end
 
     describe 'non-existent resource' do
-      before do
-        @not_found_url = 'http://localhost:4567/missing-resource'
-      end
+      let(:not_found_url) { 'http://localhost:4567/missing-resource' }
 
       it '#get_uri raises a ResourceNotFound error' do
         assert_raises(Faraday::Error::ResourceNotFound) do
-          @transport.get_uri(@not_found_url, as).body
+          @transport.get_uri(uri: not_found_url, as: as).body
         end
       end
 
       it '#post_uri raises a ResourceNotFound error' do
         assert_raises(Faraday::Error::ResourceNotFound) do
-          @transport.post_uri(@not_found_url, body, as).body
+          @transport.post_uri(uri: not_found_url, body: body, as: as).body
         end
       end
 
       it '#post_uri raises a ResourceNotFound error' do
         assert_raises(Faraday::Error::ResourceNotFound) do
-          @transport.post_uri(@not_found_url, body, as).body
+          @transport.post_uri(uri: not_found_url, body: body, as: as).body
         end
       end
 
       it '#delete_uri raises a ResourceNotFound error' do
         assert_raises(Faraday::Error::ResourceNotFound) do
-          @transport.delete_uri(@not_found_url, as).body
+          @transport.delete_uri(uri: not_found_url, body: body, as: as).body
         end
       end
     end
@@ -63,7 +61,7 @@ class FaradayHttpTransportTest < MiniTest::Spec
     describe 'server errors (500 Internal Server Error)' do
       it '#get_uri raises a ClientError' do
         assert_raises(Faraday::Error::ClientError) do
-          @transport.get_uri('http://localhost:4567/deliberate-error', as).body
+          @transport.get_uri(uri: 'http://localhost:4567/deliberate-error', as: as).body
         end
       end
     end