restpack-resource 0.0.8 → 0.0.9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    restpack-resource (0.0.8)
+    restpack-resource (0.0.9)
       activesupport (~> 3.2.11)
       dm-pager (~> 1.1.0)
 

data/lib/restpack-resource/resource/filterable.rb

@@ -13,6 +13,7 @@ module RestPack
         self.resource_filterable_by += columns
       end
       def resource_validate_filters!(filters)
+        return unless filters
         filters.keys.each do |filter|
           raise InvalidFilter.new unless self.resource_filterable_by.include?(filter)
         end

data/lib/restpack-resource/resource/includable.rb

@@ -14,7 +14,7 @@ module RestPack
       end
       def resource_validate_includes!(includes)
         includes.each do |include|
-          unless self.resource_includable_associations.include?(include)
+          unless self.resource_includable_associations.include?(include.to_sym)
             raise InvalidInclude, "#{self.name}.#{include} is not an includable relation"
           end
         end

data/lib/restpack-resource/resource/pageable.rb

@@ -119,7 +119,7 @@ module RestPack
       def resource_validate_options!(options)
         self.resource_validate_includes! options[:includes]
         self.resource_validate_filters! options[:filters]
-        self.resource_validate_sort_by! options[:sort_by]
+        self.resource_validate_sort_by! options[:sort_by] 
       end
     end
   end

data/lib/restpack-resource/resource/single.rb

@@ -1,5 +1,6 @@
 module RestPack
   module Resource
+    #NOTE: GJ: this need a great big refactor
     module Single      
       def single_resource(params = {}, overrides = {})
         options = build_single_options(params, overrides)
@@ -11,7 +12,49 @@ module RestPack
       def get_single_resource(options)
         model = self.get(options[:id])
         
-        model_as_resource(model)
+        raise "404" unless model #TODO: GJ: decide on error handling / status
+        resource = model_as_resource(model)
+        
+        options[:includes].each do |association|
+          add_single_side_loads(resource, model, association)
+        end
+        
+        resource
+      end
+      
+      def add_single_side_loads(resource, model, association)
+        target_model_name = association.to_s.singularize.capitalize  
+         
+        relationships = self.relationships.select {|r| r.target_model.to_s == target_model_name }
+        raise InvalidInclude if relationships.empty?
+
+        side_loaded_entities = []
+
+        relationships.each do |relationship|
+          if relationship.is_a? DataMapper::Associations::ManyToOne::Relationship
+            relation = model.send(relationship.name.to_sym)
+            
+            side_loaded_entities << (relation ? model_as_resource(relation) : nil)
+          elsif relationship.is_a? DataMapper::Associations::OneToMany::Relationship
+            parent_key_name = relationship.parent_key.first.name
+            child_key_name = relationship.child_key.first.name        
+            foreign_key = model.send(parent_key_name)
+                
+            #TODO: GJ: configurable side-load page size
+            children = relationship.child_model.all(child_key_name.to_sym => foreign_key).page({ per_page: 100 })
+            side_loaded_entities += children.map { |c| model_as_resource(c) }
+            
+            count_key = "#{relationship.child_model_name.downcase}_count".to_sym
+            resource[count_key] = children.pager.total
+          else
+            raise InvalidInclude, "#{self.name}.#{relationship.name} can't be included when paging #{self.name.pluralize.downcase}"
+          end
+        end
+        
+        side_loaded_entities.uniq!
+        side_loaded_entities.compact!
+        
+        resource[association] = side_loaded_entities
       end
       
       def build_single_options(params, overrides)        
@@ -23,13 +66,12 @@ module RestPack
         options.reverse_merge!( #defaults
           :includes => []
         )
-        
+
         raise InvalidArguments, "id must be specified" unless params[:id]
         
-        resource_validate_includes! options[:includes]
-
+        resource_normalise_options!(options)
+        resource_validate_options!(options)
         #TODO: GJ: other validations
-        
         options
       end
     end

data/lib/restpack-resource/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Resource
-    VERSION = "0.0.8"
+    VERSION = "0.0.9"
   end
 end

data/spec/resource/single_spec.rb

@@ -12,11 +12,37 @@ describe RestPack::Resource do
       end.to raise_error(RestPack::Resource::InvalidArguments, "id must be specified")
     end
     
+    pending "handles unfound ids"
+    
     it "return correct model #as_resource" do
       result = Song.single_resource({ :id => @song.id })
       result[:id].should == @song.id
       result[:url].should == "/api/v1/songs/#{@song.id}"
     end
+    
+    it "sideloads ManyToOne" do
+      result = Song.single_resource(:id => @song.id, :includes => 'artists')
+      result[:id].should == @song.id
+      
+      result[:artists].should_not == nil
+      result[:artists].count.should == 1
+      result[:artists][0][:url].should == "/api/v1/artists/#{@song.artist.id}"
+    end
+    
+    describe "OneToMany" do
+      before(:each) do
+        @artist = create(:artist)
+        3.times { create(:song, :artist => @artist) }
+      end
+      
+      it "sideloads OneToMany relations" do
+        result = Artist.single_resource(:id => @artist.id, :includes => 'songs')
+        result[:id].should == @artist.id
+      
+        result[:songs].should_not == nil
+        result[:songs].count.should == 3
+      end
+    end
 
   end
 end

data/spec/spec_helper.rb

@@ -33,6 +33,14 @@ class Artist
   
   resource_can_include :songs
   resource_can_sort_by :id, :name
+  
+  def as_resource
+    {
+      id: id,
+      name: name,
+      url: "/api/v1/artists/#{id}"
+    }
+  end
 end
 
 class Song

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restpack-resource
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -104,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 840564972735635958
+      hash: 1427584335195097292
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 840564972735635958
+      hash: 1427584335195097292
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25