rack-scaffold 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 360768fd0ef66689a6eb6c3fda2fe1d66088c5ec
-  data.tar.gz: 61ec5dbd6a8b956694c6d0752ec4944961ca0598
+  metadata.gz: 7ef91f24e25308a80570de00566258b1f6dd8ba3
+  data.tar.gz: 044364fe5fca8ce8bfe21d4ca62f34201b5f2d3b
 SHA512:
-  metadata.gz: 342900ad0c9c8e43f0911b0ae9d556fe357047136e2d0c0a7618e4004909efcc5d291823d65cae6469f72c399a96f3bbbbbb815497f43524735a33141404b344
-  data.tar.gz: 87f6a502de098edfc7abc9cff2b28de7153b77629783bf296fa2bbdf8474a00337ec7250de0fb184addd2619a66b320f21da2eca83e94e309c83d5d665eb4401
+  metadata.gz: 57c614e8c131c3f8b0aef53b3a2f5b6d4d9ea991ae251e0c4d11623f68a85398920fa5a6e5c139c08dec42bf85dc328a85887305dceb61a9208da601c737e961
+  data.tar.gz: d2c028e14bd9dd1dc82cc1cdd5be3c216cbbcebef372c9f5c6c1fde50ba2b299bfb08e6ae97fe0db033b6a28722a9e5c311d8a4cb275f9012aafbf8cca6b54ee

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    rack-scaffold (0.0.3)
+    rack-scaffold (0.1.0)
       activesupport (>= 3.0)
       rack (~> 1.4)
       rack-contrib (~> 1.1)
-      sinatra (~> 1.3)
+      sinatra (~> 1.4)
+      sinatra-contrib (~> 1.4)
       sinatra-param (~> 0.1)
 
 GEM
@@ -18,6 +19,8 @@ GEM
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
     atomic (1.1.10)
+    backports (3.3.3)
+    eventmachine (1.0.3)
     i18n (0.6.4)
     minitest (4.7.5)
     multi_json (1.7.7)
@@ -26,14 +29,23 @@ GEM
       rack (>= 0.9.1)
     rack-protection (1.5.0)
       rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
     rake (10.0.4)
     sinatra (1.4.3)
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
+    sinatra-contrib (1.4.0)
+      backports (>= 2.0)
+      eventmachine
+      rack-protection
+      rack-test
+      sinatra (~> 1.4.2)
+      tilt (~> 1.3)
     sinatra-param (0.1.3)
       sinatra (~> 1.3)
-    thread_safe (0.1.0)
+    thread_safe (0.1.2)
       atomic
     tilt (1.4.1)
     tzinfo (0.3.37)

data/README.md

@@ -1,7 +1,7 @@
 # Rack::Scaffold
 **Automatically generate RESTful CRUD services**
 
-> This project generalizes the webservice auto-generation functionality of [Rack::CoreData](https://github.com/mattt/rack-core-data) with a plugin architecture that can adapt to any data model format. It is currently being actively developed for inclusion in the next release of [Helios](https://github.com/helios-framework/helios)
+> This project generalizes the webservice auto-generation functionality of [Rack::CoreData](https://github.com/mattt/rack-core-data) with a plugin architecture that can adapt to any data model format. It is currently used in the latest release of [Helios](https://github.com/helios-framework/helios)
 
 ### Supported Data Models
 
@@ -13,10 +13,11 @@
 
 ### Gemfile
 
-```Ruby
+```ruby
 source :rubygems
 
 gem 'rack-scaffold', require: 'rack/scaffold'
+
 gem 'sequel'
 gem 'core_data'
 
@@ -36,6 +37,16 @@ DB = Sequel.connect(ENV['DATABASE_URL'])
 run Rack::Scaffold model: './Example.xcdatamodeld', only: [:create, :read]
 ```
 
+## Available Actions
+
+By default, `Rack::Scaffold` will enable all of the actions described below. Actions can be whitelisted or blacklisted by passing either the `only` or `except` options, respectively.
+
+- `create` (`POST /resources`): Creates a new resource with the fields in a `www-form-urlencoded` or `application/json` encoded HTTP request body.
+- `read` (`GET /resources` & `GET /resources/123`): Reads a collection of resources or an individual resource at the specified URI. Supports pagination by passing either `page` & `per_page` or `limit` & `offset` parameters.
+- `update` (`PUT` OR `PATCH /resources/123`): Updates the specified resource with the fields in a `www-form-urlencoded` or `application/json` encoded HTTP request body.
+- `delete` (`DELETE /resources/123`): Deletes the specified resource.
+- `susbscribe` (`SUBSCRIBE` or `GET /resources` with `Accept: text/event-stream`): Subscribes to create, update, and delete actions performed, streaming corresponding JSON Patch diffs. You can read more about the Rocket technique for streaming REST resources at http://rocket.github.io.
+
 ## Examples
 
 An example web API using a Core Data model can be found the `/example` directory.

data/lib/rack/scaffold.rb

@@ -2,12 +2,15 @@ require 'rack'
 require 'rack/contrib'
 require 'sinatra/base'
 require 'sinatra/param'
+require 'sinatra/multi_route'
 
 require 'rack/scaffold/adapters'
 
+require 'pathname'
+
 module Rack
   class Scaffold
-    ACTIONS = [:create, :read, :update, :destroy]
+    ACTIONS = [:subscribe, :create, :read, :update, :destroy]
 
     def initialize(options = {})
       raise ArgumentError, "Missing option: :model or :models" unless options[:model] or options[:models]
@@ -18,6 +21,7 @@ module Rack
 
       @app = Class.new(Sinatra::Base) do
         use Rack::PostBodyContentTypeParser
+        register Sinatra::MultiRoute
         helpers Sinatra::Param
 
         before do
@@ -34,6 +38,28 @@ module Rack
           timestamp = most_recently_updated.send(update_timestamp_field) if most_recently_updated
           timestamp
         end
+
+        def notify!(record)
+          return unless @@connections
+          
+          pathname = Pathname.new(request.path)
+
+          lines = []
+          lines << "event: patch"
+
+          op = case status
+               when 201 then :add
+               when 204 then :remove
+               else
+                 :update
+               end
+
+          data = [{op: op, path: record.url, value: record}].to_json
+
+          @@connections[pathname.dirname].each do |out|
+            out << "event: patch\ndata: #{data}\n\n"
+          end
+        end
       end
 
       @actions = (options[:only] || ACTIONS) - (options[:except] || [])
@@ -43,10 +69,29 @@ module Rack
 
       resources = Array(@adapter.resources(options[:model], options))
       resources.each do |resource|
+        @app.instance_eval do
+          @@connections = Hash.new([])
+
+          route :get, :subscribe, "/#{resource.plural}/?" do
+            pass unless request.accept? 'text/event-stream'
+
+            content_type 'text/event-stream'
+
+            stream :keep_open do |out|
+              @@connections[request.path] << out
+
+              out.callback do
+                @@connections[request.path].delete(out)
+              end
+            end
+          end
+        end if @actions.include?(:subscribe)
+
         @app.instance_eval do
           post "/#{resource.plural}/?" do
             if record = resource.create!(params)
               status 201
+              notify!(record)
               {"#{resource.singular}" => record}.to_json
             else
               status 406
@@ -88,13 +133,24 @@ module Rack
             {"#{resource.singular}" => record}.to_json
           end
 
+          resource.one_to_many_associations.each do |association|
+            get "/#{resource.plural}/:id/#{association}/?" do
+              record = resource[params[:id]] or halt 404
+              associations = record.send(association)
+
+              {
+                "#{association}" => associations
+              }.to_json
+            end
+          end          
         end if @actions.include?(:read)
 
         @app.instance_eval do
-          put "/#{resource.plural}/:id/?" do
+          route :put, :patch, "/#{resource.plural}/:id/?" do
             record = resource[params[:id]] or halt 404
             if record.update!(params)
               status 200
+              notify!(record)
               {"#{resource.singular}" => record}.to_json
             else
               status 406
@@ -107,23 +163,14 @@ module Rack
           delete "/#{resource.plural}/:id/?" do
             record = resource[params[:id]] or halt 404
             if record.destroy
-              status 200
+              status 204
+              notify!(record)
             else
               status 406
               {errors: record.errors}.to_json
             end
           end
         end if @actions.include?(:destroy)
-
-        # @app.instance_eval do
-        #   entity.relationships.each do |relationship|
-        #     next unless relationship.to_many?
-
-        #     get "/#{resource.plural}/:id/#{relationship.name}/?" do
-        #       {relationship.name => resource[params[:id]].send(relationship.name)}.to_json
-        #     end
-        #   end
-        # end
       end
     end
 

data/lib/rack/scaffold/adapters.rb

@@ -53,6 +53,10 @@ module Rack
           raise NotImplementedError
         end
 
+        def one_to_many_associations
+          raise NotImplementedError
+        end
+
         def find(options = {})
           raise NotImplementedError
         end
@@ -76,6 +80,10 @@ module Rack
         def update_timestamp_field
           raise NotImplementedError
         end
+
+        def method_missing(method, *args, &block)
+          @klass.send(method)
+        end
       end
     end
   end

data/lib/rack/scaffold/adapters/active_record.rb

@@ -37,6 +37,10 @@ module Rack::Scaffold::Adapters
       self.find(id)
     end
 
+    def one_to_many_associations
+      @klass.reflect_on_all_associations(:has_many).collect(&:name)
+    end
+
     def update_timestamp_field
       self.attribute_names.include?("updated_at") ? "updated_at" : "updated_on"
     end

data/lib/rack/scaffold/adapters/core_data.rb

@@ -12,7 +12,14 @@ module Rack::Scaffold::Adapters
 
       def resources(xcdatamodel, options = {})
         model = ::CoreData::DataModel.new(xcdatamodel)
-        model.entities.collect{|entity| new(entity, options)}
+        resources = model.entities.collect{|entity| resource = new(entity, options)}
+        model.entities.each do |entity|
+          resources.each do |resource|
+            resource.establish_associations!(entity)
+          end
+        end
+
+        return resources
       end
     end
 
@@ -37,23 +44,12 @@ module Rack::Scaffold::Adapters
           else
             plugin :timestamps
           end
-#          plugin :timestamps, create: :createdAt, update: :updatedAt
         end
 
         def url
           "/#{self.class.table_name}/#{self[primary_key]}"
         end
 
-        # entity.relationships.each do |relationship|
-        #   options = {:class => Rack::Scaffold::Models.const_get(relationship.destination.capitalize)}
-
-        #   if relationship.to_many?
-        #     one_to_many relationship.name.to_sym, options
-        #   else
-        #     many_to_one relationship.name.to_sym, options
-        #   end
-        # end
-
         set_schema do
           primary_key :id
 
@@ -120,8 +116,22 @@ module Rack::Scaffold::Adapters
         end
       end
 
-
       super(CoreData.const_set(entity.name, klass))
     end
+
+    def establish_associations!(entity)
+      klass.class_eval do
+        entity.relationships.each do |relationship|
+          options = {:class => CoreData.const_get(relationship.destination.capitalize)}
+
+          options = {}
+          if relationship.to_many?
+            one_to_many relationship.name.to_sym, options
+          else
+            many_to_one relationship.name.to_sym, options
+          end
+        end
+      end
+    end
   end
 end

data/lib/rack/scaffold/adapters/sequel.rb

@@ -18,7 +18,6 @@ module Rack::Scaffold::Adapters
       def resources(model, options = {})
         model
       end
-
     end
 
     def singular
@@ -33,9 +32,12 @@ module Rack::Scaffold::Adapters
       @klass.limit(limit, offset)
     end
 
+    def one_to_many_associations
+      @klass.all_association_reflections.select{|association| association[:type] == :one_to_many}.collect{|association| association[:name]}
+    end
+
     def timestamps?
       defined?(::Sequel::Plugins::Timestamps) and @klass.plugins.include?(::Sequel::Plugins::Timestamps)
     end
-
   end
 end

data/rack-scaffold.gemspec

@@ -7,14 +7,15 @@ Gem::Specification.new do |s|
   s.email       = "m@mattt.me"
   s.homepage    = "http://mattt.me"
   s.license     = "MIT"
-  s.version     = "0.0.3"
+  s.version     = "0.1.0"
   s.platform    = Gem::Platform::RUBY
   s.summary     = "Rack::Scaffold"
   s.description = "Automatically generate RESTful CRUD services"
 
   s.add_dependency "rack", "~> 1.4"
   s.add_dependency "rack-contrib", "~> 1.1"
-  s.add_dependency "sinatra", "~> 1.3"
+  s.add_dependency "sinatra", "~> 1.4"
+  s.add_dependency "sinatra-contrib", "~> 1.4"
   s.add_dependency "sinatra-param", "~> 0.1"
   s.add_dependency "activesupport", ">= 3.0"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-scaffold
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Mattt Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -44,14 +44,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: sinatra-param
   requirement: !ruby/object:Gem::Requirement