restpack-resource 0.0.5 → 0.0.6

data/Gemfile.lock

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

data/README.md

@@ -1,25 +1,161 @@
 # restpack-resource [![Build Status](https://api.travis-ci.org/RestPack/restpack-resource.png?branch=master)](https://travis-ci.org/RestPack/restpack-resource) [![Code Climate](https://codeclimate.com/github/RESTpack/restpack-resource.png)](https://codeclimate.com/github/RESTpack/restpack-resource) [![Dependency Status](https://gemnasium.com/RestPack/restpack-resource.png)](https://gemnasium.com/RestPack/restpack-resource)
 
-RESTful resource paging, side-loading, filtering and sorting:
+RESTful resource paging, side-loading, filtering and sorting. 
+
+Define your models:
 
 ```ruby
-class Group
+class Channel
   include DataMapper::Resource
   include RestPack::Resource
-
   property :id, Serial
-  property :name, String, :length => 128
-  property :created_by, Integer, :required => true
-  property :channel_id, Integer, :required => true
+  property :name, String, :length => 512
   timestamps :at
-
-  validates_presence_of :name, :channel_id
   
-  has n, :invitations
-  has n, :memberships
+  validates_presence_of :name
+  
+  has n, :applications
+  has n, :domains
+  has n, :configurations
   
-  resource_can_include :memberships, :invitations
-  resource_can_filter_by :channel_id, :created_by
-  resource_can_sort_by :id
+  resource_can_include :applications, :domains, :configurations
+  resource_can_filter_by :id
+  resource_can_sort_by :id, :created_at, :modified_at
+  
+  def as_resource
+    {
+      :id => id,
+      :name => name,
+      :url => "/api/v1/channels/#{id}.json"
+    }
+  end
+end
+```
+
+Then you can do this in your API (Grape in this example):
+
+```ruby
+module ChannelAPI
+  class V1 < Grape::API
+    version 'v1', :using => :path, :format => :json
+
+    resource :channels do
+      get do        
+        Channel.paged_resource(params)
+      end
+    end
+  end
 end
 ```
+
+Which gives you endpoints such as:
+
+`/api/v1/channels.json?includes=applications,domains,configurations`
+
+```javascript
+{
+    "page": 1,
+    "page_count": 1,
+    "count": 2,
+    "previous_page": null,
+    "next_page": null,
+    "channels": [
+        {
+            "id": 1,
+            "name": "Developer Jobs Websites",
+            "url": "/api/v1/channels/1.json"
+        },
+        {
+            "id": 2,
+            "name": "Coffee Roulette",
+            "url": "/api/v1/channels/2.json"
+        }
+    ],
+    "application_count": 3,
+    "applications": [
+        {
+            "id": 3,
+            "name": "Coffee Roulette Application",
+            "channel_id": 2,
+            "url": "/api/v1/applications/3.json"
+        },
+        {
+            "id": 2,
+            "name": "Python Jobs",
+            "channel_id": 1,
+            "url": "/api/v1/applications/2.json"
+        },
+        {
+            "id": 1,
+            "name": "Ruby Jobs",
+            "channel_id": 1,
+            "url": "/api/v1/applications/1.json"
+        }
+    ],
+    "domain_count": 5,
+    "domains": [
+        {
+            "id": 5,
+            "identifier": "www.coffeeroulette.ie",
+            "channel_id": 2,
+            "application_id": 3,
+            "url": "/api/v1/domain/5.json"
+        },
+        {
+            "id": 4,
+            "identifier": "account.pythonjobs.ie",
+            "channel_id": 1,
+            "application_id": 2,
+            "url": "/api/v1/domain/4.json"
+        },
+        {
+            "id": 3,
+            "identifier": "www.pythonjobs.ie",
+            "channel_id": 1,
+            "application_id": 2,
+            "url": "/api/v1/domain/3.json"
+        },
+        {
+            "id": 2,
+            "identifier": "account.rubyjobs.ie",
+            "channel_id": 1,
+            "application_id": 1,
+            "url": "/api/v1/domain/2.json"
+        },
+        {
+            "id": 1,
+            "identifier": "www.rubyjobs.ie",
+            "channel_id": 1,
+            "application_id": 1,
+            "url": "/api/v1/domain/1.json"
+        }
+    ],
+    "configuration_count": 2,
+    "configurations": [
+        {
+            "id": 11,
+            "name": "channel_key",
+            "value": {
+                "aaa": "111",
+                "bbb": "222"
+            },
+            "channel_id": 2,
+            "application_id": null,
+            "domain_id": null,
+            "url": "/api/v1/configuration/11.json"
+        },
+        {
+            "id": 10,
+            "name": "Key",
+            "value": {
+                "description": "Channel Config"
+            },
+            "channel_id": 2,
+            "application_id": null,
+            "domain_id": null,
+            "url": "/api/v1/configuration/10.json"
+        }
+    ]
+}
+```
+

data/Rakefile

@@ -11,4 +11,14 @@ begin
     t.rspec_opts = ['-cfs']
   end
 rescue LoadError
+end
+
+namespace :gem do 
+  task :build do
+    sh "gem build restpack-resource.gemspec"
+  end
+  
+  task :push do
+    sh "gem push restpack-resource-#{RestPack::Resource::VERSION}.gem"
+  end
 end

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

@@ -21,7 +21,7 @@ module RestPack
           :next_page => page.pager.next_page
         }
 
-        paged_resource[self.resource_collection_name] = page.map { |item| item.to_resource() }
+        paged_resource[self.resource_collection_name] = page.map { |item| model_as_resource(item) }
 
         unless page.empty?
           options[:includes].each do |association|
@@ -50,7 +50,7 @@ module RestPack
           if relationship.is_a? DataMapper::Associations::ManyToOne::Relationship
             side_loaded_entities += page.map do |entity| #TODO: GJ: PERF: we can bypass datamapper associations and get by a list of ids instead
               relation = entity.send(relationship.name.to_sym)
-              relation ? relation.to_resource : nil
+              relation ? model_as_resource(relation) : nil
             end
           elsif relationship.is_a? DataMapper::Associations::OneToMany::Relationship
             parent_key_name = relationship.parent_key.first.name
@@ -59,7 +59,7 @@ module RestPack
                 
             #TODO: GJ: configurable side-load page size
             children = relationship.child_model.all(child_key_name.to_sym => foreign_keys).page({ per_page: 100 })
-            side_loaded_entities += children.map { |c| c.to_resource }
+            side_loaded_entities += children.map { |c| model_as_resource(c) }
             
             count_key = "#{relationship.child_model_name.downcase}_count".to_sym
             paged_resource[count_key] = children.pager.total
@@ -106,6 +106,10 @@ module RestPack
         extracted.delete_if { |k, v| v.nil? }
       end
       
+      def model_as_resource(model)
+        model.as_resource() 
+      end
+      
       private
       
       def resource_normalise_options!(options)

data/lib/restpack-resource/resource.rb

@@ -15,7 +15,7 @@ module RestPack
       super
     end
     
-    def to_resource(options = {})
+    def as_resource(options = {})
       self
     end
 

data/lib/restpack-resource/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Resource
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/spec/resource/pageable_spec.rb

@@ -39,7 +39,7 @@ describe RestPack::Resource do
         end
       
         context "when side-loading" do
-          it "should return related entities with their #to_resource representation" do
+          it "should return related entities with their #as_resource representation" do
             result = Song.paged_resource(:includes => 'users')
             result[:users][0][:custom].should == 'This is custom data'
           end

data/spec/spec_helper.rb

@@ -74,7 +74,7 @@ class User
   property :name, String
   #timestamps :at
   
-  def to_resource
+  def as_resource
     {
       id: id,
       name: name,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restpack-resource
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -100,12 +100,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 808146894371819691
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 808146894371819691
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25