rod-rest 0.0.1.1 → 0.5.0

data/lib/rod/rest/collection_proxy.rb

@@ -6,7 +6,7 @@ module Rod
       include Enumerable
       attr_reader :size
 
-      # Initializes a CollectionPorxy.
+      # Initializes a CollectionProxy.
       # * +:proxy+ - the object this collection belongs to
       # * +:association_name+ - the name of proxie's plural association this collection is returned for
       # * +:size+ - the size of the collection
@@ -16,6 +16,18 @@ module Rod
         @association_name = association_name
         @size = size
         @client = client
+        @cache = []
+      end
+
+      # Detailed description of the object, i.e.
+      # Rod::Rest::CollectionProxy<Car#drivers[5]>
+      def inspect
+        "#{self.class.name}<#{@proxy.type}\##{@association_name}[#{@size}]>"
+      end
+
+      # Short description of the collection, i.e. [5-elements].
+      def to_s
+        "[#{@size}-elements]"
       end
 
       # Returns true if the collection is empty (i.e. its size == 0).
@@ -26,22 +38,32 @@ module Rod
       # Returns the index-th element of the collection.
       def [](index)
         begin
-          @client.fetch_related_object(@proxy,@association_name,index)
+          if Range === index
+            @cache[index] = @client.fetch_related_objects(@proxy,@association_name,index)
+          else
+            return @cache[index] unless @cache[index].nil?
+            @cache[index] = @client.fetch_related_object(@proxy,@association_name,index)
+          end
         rescue MissingResource
           nil
         end
       end
 
+      # Returns the first element of the collection.
+      def first
+        self.size > 0 ? self[0] : nil
+      end
+
       # Returns the last element of the collection.
       def last
-        size > 0 ? self[size - 1] : nil
+        self.size > 0 ? self[size - 1] : nil
       end
 
       # Iterates over the elements of the collection.
       def each
         if block_given?
-          @size.times do |index|
-            yield self[index]
+          self[0..@size-1].each do |object|
+            yield object
           end
         else
           enum_for(:each)

data/lib/rod/rest/constants.rb

@@ -1,5 +1,5 @@
 module Rod
   module Rest
-    VERSION = "0.0.1.1"
+    VERSION = "0.5.0"
   end
 end

data/lib/rod/rest/exception.rb

@@ -4,5 +4,6 @@ module Rod
     class APIError < RuntimeError; end
     class InvalidData < RuntimeError; end
     class UnknownResource < RuntimeError; end
+    class CacheMissed < RuntimeError; end
   end
 end

data/lib/rod/rest/metadata.rb

@@ -22,6 +22,16 @@ module Rod
         @resources
       end
 
+      # Returns the description of the metadata and the class name.
+      def inspect
+        "#{self.class}<#{@description.inspect}>"
+      end
+
+      # Returns the description of the metadata.
+      def to_s
+        @description.to_s
+      end
+
       private
       def create_resource_descriptions(hash_description)
         hash_description.map do |name,description|

data/lib/rod/rest/property_metadata.rb

@@ -15,6 +15,18 @@ module Rod
       def indexed?
         !! @index
       end
+
+      # Detailed description of the porperty, i.e.
+      # Rod::Rest::PropertyMetadata<name>
+      def inspect
+        indexed = indexed? ? ",indexed" : ""
+        "#{self.class}<#{@name}#{indexed}>"
+      end
+
+      # Short description of the poperty.
+      def to_s
+        "'#{@name}' property"
+      end
     end
   end
 end

data/lib/rod/rest/proxy.rb

@@ -38,8 +38,13 @@ module Rod
       private
       def build_class(metadata)
         Class.new do
+          class_variable_set("@@metadata",metadata)
+
           attr_reader :type,:rod_id
 
+          # Initialize the object with its +rod_it+, +type+ and the +client+
+          # used to fetch the referenced objects. Use +collection_proxy_factory+
+          # to create the referenced objects.
           def initialize(rod_id,type,client,collection_proxy_factory)
             @rod_id = rod_id
             @type = type
@@ -47,6 +52,22 @@ module Rod
             @collection_proxy_factory = collection_proxy_factory
           end
 
+          # Detailed description of the object, e.g.
+          # Proxy[Car]<rod_id:1,brand:Mercedes><owner:Person:1><drivers[3]>
+          def inspect
+            result = "Proxy[#{@type}]"
+            result << "<#{inspect_fields}>"
+            result << "<#{inspect_singular_associations}>"
+            result << "<#{inspect_plural_associations}>"
+            result
+          end
+
+          # Only reports the type of the proxy and its rod_id, e.g.
+          # Car[1]
+          def to_s
+            "#{@type}[#{@rod_id}]"
+          end
+
           metadata.fields.each do |field|
             attr_reader field.symbolic_name
           end
@@ -65,10 +86,34 @@ module Rod
           metadata.plural_associations.each do |association|
             class_eval <<-END
               def #{association.name}
-                @collection_proxy_factory.new(self,"#{association.name}",@_#{association.name}_count,@client)
+                if defined?(@#{association.name})
+                  return @#{association.name}
+                end
+                @#{association.name} = @collection_proxy_factory.new(self,"#{association.name}",@_#{association.name}_count,@client)
               end
             END
           end
+
+          private
+          def inspect_fields
+            @@metadata.fields.map do |field|
+              "#{field.name}:#{self.send(field.symbolic_name)}"
+            end.join(",")
+          end
+
+          def inspect_singular_associations
+            @@metadata.singular_associations.map do |association|
+              description = instance_variable_get("@_#{association.name}_description")
+              "#{association.name}:#{description[:type]}:#{description[:rod_id]}"
+            end.join(",")
+          end
+
+          def inspect_plural_associations
+            @@metadata.plural_associations.map do |association|
+              count = instance_variable_get("@_#{association.name}_count")
+              "#{association.name}[#{count}]"
+            end.join(",")
+          end
         end
       end
 

data/lib/rod/rest/proxy_cache.rb

@@ -0,0 +1,65 @@
+require 'rod/rest/exception'
+
+module Rod
+  module Rest
+    # Cache used to store proxy objects.
+    class ProxyCache
+      # Initializes empty cache.
+      def initialize()
+        @cache_implementation = {}
+      end
+
+      # Returns true if the described object is in the cache.
+      def has_key?(description)
+        check_description(description)
+        @cache_implementation.has_key?(description_signature(description))
+      end
+
+      # Returns the object stored in the cache. Raises CacheMissed exception if
+      # the result is nil.
+      def [](description)
+        check_description(description)
+        begin
+          @cache_implementation.fetch(description_signature(description))
+        rescue KeyError
+          raise CacheMissed.new(missing_entry_message(description))
+        end
+      end
+
+      # Store the +object+ in the cache.
+      def store(object)
+        check_object(object)
+        @cache_implementation[description_signature(rod_id: object.rod_id,type: object.type)] = object
+      end
+
+      private
+      def description_signature(description)
+        "#{description[:rod_id]},#{description[:type]}"
+      end
+
+      def check_object(object)
+        if !object.respond_to?(:rod_id) || !object.respond_to?(:type)
+          raise InvalidData.new(invalid_object_message(object))
+        end
+      end
+
+      def check_description(description)
+        if !description.respond_to?(:has_key?) || !description.has_key?(:rod_id) || !description.has_key?(:type)
+          raise InvalidData.new(invalid_description_message(description))
+        end
+      end
+
+      def missing_entry_message(description)
+        "No entry for object rod_id:#{description[:rod_id]} type:#{description[:type]}"
+      end
+
+      def invalid_object_message(object)
+        "The object cannot be stored in the cache: #{object}."
+      end
+
+      def invalid_description_message(description)
+        "The description of the object is invalid: #{description}."
+      end
+    end
+  end
+end

data/lib/rod/rest/proxy_factory.rb

@@ -7,8 +7,10 @@ module Rod
       # +client+.
       # Options:
       # * proxy_class - the class used to create the resource proxy factories.
+      # * cache - used to cache created proxy instances
       def initialize(metadata,client,options={})
         proxy_class = options[:proxy_class] || Proxy
+        @cache = options[:cache]
         @proxies = {}
         metadata.each do |resource_metadata|
           @proxies[resource_metadata.name] = proxy_class.new(resource_metadata,client)
@@ -17,6 +19,7 @@ module Rod
 
       # Build new object-proxy from the hash-like +object_description+.
       def build(object_description)
+        return from_cache(object_description) if in_cache?(object_description)
         check_type(object_description[:type])
         @proxies[object_description[:type]].new(object_description)
       end
@@ -25,6 +28,15 @@ module Rod
       def check_type(type)
         raise UnknownResource.new(type) unless @proxies.has_key?(type)
       end
+
+      def from_cache(description)
+        @cache[description]
+      end
+
+      def in_cache?(description)
+        return false if @cache.nil?
+        @cache.has_key?(description)
+      end
     end
   end
 end

data/lib/rod/rest/resource_metadata.rb

@@ -8,6 +8,7 @@ module Rod
       # * +property_factory+ - factory used to create descriptions of the
       #   properties
       def initialize(name,description,options={})
+        @description = description
         @name = name.to_s
         @property_factory = options[:property_factory] || PropertyMetadata
         @fields = create_properties(description[:fields])
@@ -17,6 +18,16 @@ module Rod
         @indexed_properties = @properties.select{|p| p.indexed? }
       end
 
+      # Description of the metadata.
+      def inspect
+        @description.inspect
+      end
+
+      # Description of the metadata.
+      def to_s
+        @description.to_s
+      end
+
       private
       def create_properties(description)
         if  description

data/test/int/end_to_end.rb

@@ -82,8 +82,9 @@ module Rod
           sleep 0.5
         end
 
-        after(:all) do
-          #Thread.join
+        example "Client#inspect reports host and port" do
+          client.inspect.should match(/4567/)
+          client.inspect.should match(/localhost/)
         end
 
         example "API serves the metadata" do
@@ -99,38 +100,44 @@ module Rod
           end
         end
 
-        example "Schumaher might be retrieved by id" do
-          schumaher_in_rod = Person.find_by_name(SCHUMAHER_NAME)
-          schumaher_via_api = client.find_person(schumaher_in_rod.rod_id)
-          verify_person_equality(schumaher_via_api,schumaher_in_rod)
-        end
+        describe "with cars and drivers loaded from Rod" do
+          let(:schumaher_in_rod)  { Person.find_by_name(SCHUMAHER_NAME) }
+          let(:kubica_in_rod)     { Person.find_by_name(KUBICA_NAME) }
+          let(:mercedes_in_rod)   { Car.find_by_brand(MERCEDES_300_NAME) }
 
-        example "Kubica might be retrieved by name" do
-          kubica_in_rod = Person.find_by_name(KUBICA_NAME)
-          kubica_via_api = client.find_people_by_name(KUBICA_NAME).first
-          verify_person_equality(kubica_via_api,kubica_in_rod)
-        end
+          example "Schumaher might be retrieved by id" do
+            schumaher_via_api = client.find_person(schumaher_in_rod.rod_id)
+            verify_person_equality(schumaher_via_api,schumaher_in_rod)
+          end
 
-        example "Mercedes might be retrieved by id" do
-          mercedes_in_rod = Car.find_by_brand(MERCEDES_300_NAME)
-          mercedes_via_api = client.find_car(mercedes_in_rod.rod_id)
-          mercedes_via_api.brand.should == mercedes_in_rod.brand
-        end
+          example "Kubica might be retrieved by name" do
+            kubica_via_api = client.find_people_by_name(KUBICA_NAME).first
+            verify_person_equality(kubica_via_api,kubica_in_rod)
+          end
 
-        example "Mercedes owner is retrieved properly" do
-          mercedes_in_rod = Car.find_by_brand(MERCEDES_300_NAME)
-          schumaher_in_rod = Person.find_by_name(SCHUMAHER_NAME)
-          mercedes_via_api = client.find_car(mercedes_in_rod.rod_id)
-          verify_person_equality(mercedes_via_api.owner,schumaher_in_rod)
-        end
+          example "Mercedes might be retrieved by id" do
+            mercedes_via_api = client.find_car(mercedes_in_rod.rod_id)
+            mercedes_via_api.brand.should == mercedes_in_rod.brand
+          end
+
+          example "Mercedes owner is retrieved properly" do
+            mercedes_via_api = client.find_car(mercedes_in_rod.rod_id)
+            verify_person_equality(mercedes_via_api.owner,schumaher_in_rod)
+          end
 
-        example "Mercedes drivers are retrieved properly" do
-          mercedes_in_rod = Car.find_by_brand(MERCEDES_300_NAME)
-          schumaher_in_rod = Person.find_by_name(SCHUMAHER_NAME)
-          kubica_in_rod = Person.find_by_name(KUBICA_NAME)
-          mercedes_via_api = client.find_car(mercedes_in_rod.rod_id)
-          verify_person_equality(mercedes_via_api.drivers[0],schumaher_in_rod)
-          verify_person_equality(mercedes_via_api.drivers[1],kubica_in_rod)
+          example "Mercedes drivers are retrieved properly" do
+            mercedes_via_api = client.find_car(mercedes_in_rod.rod_id)
+            verify_person_equality(mercedes_via_api.drivers[0],schumaher_in_rod)
+            verify_person_equality(mercedes_via_api.drivers[1],kubica_in_rod)
+          end
+
+          example "Mercedes drivers might be iterated over" do
+            mercedes_via_api = client.find_car(mercedes_in_rod.rod_id)
+            expected_drivers = [schumaher_in_rod,kubica_in_rod]
+            mercedes_via_api.drivers.zip(expected_drivers).each do |driver,expected_driver|
+              verify_person_equality(driver,expected_driver)
+            end
+          end
         end
       end
     end

data/test/spec/api.rb

@@ -82,35 +82,88 @@ module Rod
           end
         end
 
-        describe "GET /cars/1" do
+        describe "with three cars" do
           let(:mercedes_300_id)       { 1 }
-          let(:audi_a4_id)            { 2 }
           let(:mercedes_300)          { Object.new }
-          let(:mercedes_300_response) { Object.new.to_s }
+          let(:audi_a4_id)            { 2 }
+          let(:audi_a4)               { Object.new }
+          let(:fiat_panda_id)         { 3 }
+          let(:fiat_panda)            { Object.new }
+          let(:invalid_id)            { 4 }
 
           before do
             stub(resource).find_by_rod_id(mercedes_300_id) { mercedes_300 }
-            stub(resource).find_by_rod_id(audi_a4_id)  { nil }
-            stub(serializer).serialize(mercedes_300) { mercedes_300_response }
+            stub(resource).find_by_rod_id(audi_a4_id)  { audi_a4 }
+            stub(resource).find_by_rod_id(fiat_panda_id)  { fiat_panda }
+            stub(resource).find_by_rod_id(invalid_id)  { nil }
           end
 
-          it "returns serialized car" do
-            get "/#{resource_name}/#{mercedes_300_id}"
-            last_response.status.should == 200
-            last_response.body.should == mercedes_300_response
+          describe "GET /cars/1" do
+            let(:mercedes_300_response) { Object.new.to_s }
+
+            before do
+              stub(serializer).serialize(mercedes_300) { mercedes_300_response }
+            end
+
+            it "returns serialized car" do
+              get "/#{resource_name}/#{mercedes_300_id}"
+              last_response.status.should == 200
+              last_response.body.should == mercedes_300_response
+            end
+
+            it "returns 404 for non-existing car" do
+              get "/#{resource_name}/#{invalid_id}"
+              last_response.status.should == 404
+            end
           end
 
-          it "returns 404 for non-existing car" do
-            get "/#{resource_name}/#{audi_a4_id}"
-            last_response.status.should == 404
+          describe "GET /cars/1..3" do
+            let(:collection_response)   { Object.new.to_s }
+
+            before do
+              stub(serializer).serialize([mercedes_300,audi_a4,fiat_panda]) { collection_response }
+            end
+
+            it "returns collection of cars" do
+              get "/#{resource_name}/#{mercedes_300_id}..#{fiat_panda_id}"
+              last_response.status.should == 200
+              last_response.body.should == collection_response
+            end
+
+            it "only returns non-nil elements" do
+              get "/#{resource_name}/#{mercedes_300_id}..#{invalid_id}"
+              last_response.status.should == 200
+              last_response.body.should == collection_response
+            end
+          end
+
+          describe "GET /cars/1,3" do
+            let(:collection_response)   { Object.new.to_s }
+
+            before do
+              stub(serializer).serialize([mercedes_300,fiat_panda]) { collection_response }
+            end
+
+            it "returns collection of cars" do
+              get "/#{resource_name}/#{mercedes_300_id},#{fiat_panda_id}"
+              last_response.status.should == 200
+              last_response.body.should == collection_response
+            end
+
+            it "only returns non-nil elements" do
+              get "/#{resource_name}/#{mercedes_300_id},#{fiat_panda_id},#{invalid_id}"
+              last_response.status.should == 200
+              last_response.body.should == collection_response
+            end
           end
         end
 
+
         describe "GET /cars/1/drivers" do
           let(:relation_name)   { "drivers" }
           let(:mercedes_300_id) { 1 }
           let(:mercedes_300)    { stub!.drivers_count { drivers_count }.subject }
-          let(:audi_a4_id)      { 2 }
+          let(:invalid_id)      { 2 }
           let(:drivers_count)   { 4 }
           let(:drivers_response){ Object.new.to_s }
           let(:plural_associations) { [ property1 ] }
@@ -118,7 +171,7 @@ module Rod
 
           before do
             stub(resource).find_by_rod_id(mercedes_300_id) { mercedes_300 }
-            stub(resource).find_by_rod_id(audi_a4_id) { nil }
+            stub(resource).find_by_rod_id(invalid_id) { nil }
             stub(serializer).serialize({count: drivers_count}) { drivers_response }
           end
 
@@ -129,7 +182,7 @@ module Rod
           end
 
           it "returns 404 for non-existing car" do
-            get "/#{resource_name}/#{audi_a4_id}/#{relation_name}"
+            get "/#{resource_name}/#{invalid_id}/#{relation_name}"
             last_response.status.should == 404
           end
 
@@ -139,43 +192,47 @@ module Rod
           end
         end
 
-        describe "GET /cars/1/drivers/0" do
+        describe "with three drivers" do
           let(:relation_name)       { "drivers" }
           let(:plural_associations) { [ drivers_property ] }
           let(:drivers_property)    { stub!.name { relation_name }.subject }
 
           let(:mercedes_300_id)     { 1 }
-          let(:audi_a4_id)          { 2 }
-          let(:driver_index)        { 0 }
-          let(:invalid_driver_index){ 10 }
+          let(:invalid_id)          { 2 }
+          let(:schumaher_index)     { 0 }
+          let(:kubica_index)        { 1 }
+          let(:alonzo_index)        { 2 }
+          let(:invalid_driver_index){ 3 }
+          let(:mercedes_300)        { stub!.drivers { drivers }.subject }
+          let(:drivers)             { [schumaher,kubica,alonzo] }
+          let(:schumaher)           { Object.new }
+          let(:kubica)              { Object.new }
+          let(:alonzo)              { Object.new }
 
           before do
             stub(resource).find_by_rod_id(mercedes_300_id) { mercedes_300 }
-            stub(resource).find_by_rod_id(audi_a4_id)  { nil }
+            stub(resource).find_by_rod_id(invalid_id)  { nil }
           end
 
-          it "returns 404 for non-existing car" do
-            get "/#{resource_name}/#{audi_a4_id}/#{relation_name}/#{driver_index}"
-            last_response.status.should == 404
-          end
-
-          it "returns 404 for non-existing relation" do
-            get "/#{resource_name}/#{mercedes_300_id}/non_existing/#{driver_index}"
-            last_response.status.should == 404
-          end
-
-          describe "with one driver" do
-            let(:mercedes_300)        { stub!.drivers { drivers }.subject }
-            let(:drivers)             { [schumaher] }
-            let(:schumaher)           { Object.new }
+          describe "GET /cars/1/drivers/0" do
             let(:schumaher_response)  { Object.new.to_s }
 
             before do
               stub(serializer).serialize(schumaher) { schumaher_response }
             end
 
+            it "returns 404 for non-existing car" do
+              get "/#{resource_name}/#{invalid_id}/#{relation_name}/#{schumaher_index}"
+              last_response.status.should == 404
+            end
+
+            it "returns 404 for non-existing relation" do
+              get "/#{resource_name}/#{mercedes_300_id}/non_existing/#{schumaher_index}"
+              last_response.status.should == 404
+            end
+
             it "returns the serialized driver" do
-              get "/#{resource_name}/#{mercedes_300_id}/#{relation_name}/#{driver_index}"
+              get "/#{resource_name}/#{mercedes_300_id}/#{relation_name}/#{schumaher_index}"
               last_response.status.should == 200
               last_response.body.should == schumaher_response
             end
@@ -185,6 +242,46 @@ module Rod
               last_response.status.should == 404
             end
           end
+
+          describe "GET /cars/1/drivers/0..2" do
+            let(:collection_response)  { Object.new.to_s }
+
+            before do
+              stub(serializer).serialize(drivers) { collection_response }
+            end
+
+            it "returns the serialized drivers" do
+              get "/#{resource_name}/#{mercedes_300_id}/#{relation_name}/#{schumaher_index}..#{alonzo_index}"
+              last_response.status.should == 200
+              last_response.body.should == collection_response
+            end
+
+            it "only returns non-nil elements" do
+              get "/#{resource_name}/#{mercedes_300_id}/#{relation_name}/#{schumaher_index}..#{invalid_driver_index}"
+              last_response.status.should == 200
+              last_response.body.should == collection_response
+            end
+          end
+
+          describe "GET /cars/1/drivers/0,2" do
+            let(:collection_response)  { Object.new.to_s }
+
+            before do
+              stub(serializer).serialize([schumaher,alonzo]) { collection_response }
+            end
+
+            it "returns the serialized drivers" do
+              get "/#{resource_name}/#{mercedes_300_id}/#{relation_name}/#{schumaher_index},#{alonzo_index}"
+              last_response.status.should == 200
+              last_response.body.should == collection_response
+            end
+
+            it "only returns non-nil elements" do
+              get "/#{resource_name}/#{mercedes_300_id}/#{relation_name}/#{schumaher_index},#{alonzo_index},#{invalid_driver_index}"
+              last_response.status.should == 200
+              last_response.body.should == collection_response
+            end
+          end
         end
       end