bulk_api 0.0.8 → 0.0.9

data/README.markdown

@@ -9,9 +9,19 @@ to use that.
 
 Bulk Rails API plugin makes integrating Sproutcore applications with Rails applications dead simple. It handles all the communication and allows to take advantage of bulk operations, which can make your application much faster. To use that plugin you will also need BulkDataSource, which will handle Sproutcore side of communcation.
 
-## Installing:
+## Example
 
-### Rails app:
+https://github.com/drnic/todos-bulk-api-demo
+
+## Installing
+
+After following this guide you will have a setup like this:
+
+  * `$RAILS_ROOT/app/sproutcore` is the path where your sproutcore application lives
+  * `/api/bulk` is routed to serve the API
+  * `/_sproutcore` is routed to serve your sproutcore application
+
+### Rails
 
 Add this line to Gemfile and run bundle install:
 
@@ -25,20 +35,37 @@ To set up Bulk API in your Rails app:
 rails generate bulk:install
 ```
 
-Now you need to configure it in your application. First thing to do is to use it with your store:
+### Sproutcore
+
+Now you need to configure your application. Install `BulkDataSource`:
+
+```
+cd <sproutcore_root>
+mkdir frameworks # In case it does not exist yet
+git clone https://github.com/drogus/bulk_data_source.git frameworks/bulk_data_source
+```
+
+Change your `Buildfile` to include it:
+
+```ruby
+config :all, :required => [:sproutcore, "sproutcore/core_foundation", "bulk_data_source"]
+```
+
+Configure your store:
 
 ```javascript
 YourApp = SC.Application.create({
-  store: SC.Store.create().from('SC.BulkDataSource')
+  store: SC.Store.create().from('BulkApi.BulkDataSource')
 });
 ```
 
-The last thing that you need to do is to set resource names for your models. BulkDataSource assumes that you have resourceName attribute set on your record. If you don't have such attributes, you can add it like that:
+The last thing that you need to do is to set resource names for your models. `BulkDataSource` assumes that you have resourceName attribute set on your model. If you don't have such attributes, you can add it like that:
 
 ```javascript
 Todos.Todo = SC.Record.extend({
-  resourceName: 'todo'
-})
+  // your code here
+});
+Todos.Todo.resourceName = 'todo';
 ```
 
 ## Usage
@@ -268,7 +295,7 @@ While overriding records you can use super to handle the actions with default be
 Bulk::Collection is a container for records and is used to construct response from. It has a few handy methods to easily modify collection, for more please refer to documantation.
 
 ```ruby
-collection = Bulk::Colection.new
+collection = Bulk::Collection.new
 collection.set(1, record) # add record with identifier '1', identifier is then used while constructing response
                           # most of the time it's id or _local_id (the latter one is mainly for create)
 
@@ -297,11 +324,11 @@ The point of using bulk API is to cut the requests number. Because of its nature
 POST /bulk/api
 {
   'todos': [
-    {'title': "First todo", 'done': false, '_storeKey': '3'},
-    {'title': "Second todo", 'done': true, '_storeKey': '10'}
+    {'title': "First todo", 'done': false, '_local_id': '3'},
+    {'title': "Second todo", 'done': true, '_local_id': '10'}
   ],
   'projects': [
-    {'name': "Sproutcore todolist", '_storeKey': '12'}
+    {'name': "Sproutcore todolist", '_local_id': '12'}
   ]
 }
 ```
@@ -311,10 +338,10 @@ As you can see we POST some new items to our application. Rails application will
 ```
 {
   'todos': [
-    {'id': 1, 'title': "First todo", 'done': false, '_storeKey': '3'}
+    {'id': 1, 'title': "First todo", 'done': false, '_local_id': '3'}
   ],
   'projects': [
-    {'id': 1, 'name': "Sproutcore todolist", '_storeKey': '12'}
+    {'id': 1, 'name': "Sproutcore todolist", '_local_id': '12'}
   ]
   'errors': {
     'todos': {

data/lib/bulk/collection.rb

@@ -36,7 +36,12 @@ module Bulk
       each do |id, record|
         next if errors.get(id)
         response[name] ||= []
-        response[name] << (only_ids ? record.id : record.as_json(options[:as_json_options]) )
+        response[name] << if only_ids
+          record.id
+        else
+          opts = options[:as_json_options] ? options[:as_json_options].dup : {}
+          record.as_json(opts)
+        end
       end
 
       errors.each do |id, error|

data/lib/bulk/engine.rb

@@ -7,18 +7,8 @@ module Bulk
       ActiveRecord::Base.include_root_in_json = false
     end
 
-    initializer "require sproutcore Rack app" do
-      # fix some failz from sass and haml, TODO: investigate
-      require 'haml/util'
-      require 'sass/util'
-
-      # it needs to be done after rails load, otherwise haml freaks out
-      require 'bulk/sproutcore'
-    end
-
     initializer "config paths" do |app|
       app.config.paths.add "app/bulk", :eager_load => true
-      app.config.paths.add "app/sproutcore"
     end
   end
 end

data/lib/bulk/resource.rb

@@ -76,7 +76,8 @@ module Bulk
           collection = resource_object.send(method, hash)
           as_json_options = resource_object.send(:as_json_options, resource_object.send(:klass))
           options = {:only_ids => (method == 'delete'), :as_json_options => as_json_options}
-          response.deep_merge! collection.to_hash(resource_object.resource_name.to_sym, options)
+          hash = resource_object.send(:as_json, collection.to_hash(resource_object.resource_name.to_sym, options))
+          response.deep_merge! hash
         end
 
         { :json => response }
@@ -183,6 +184,10 @@ module Bulk
       {}
     end
 
+    def as_json(hash)
+      hash
+    end
+
     private
     delegate :abstract?, :to => "self.class"
 
@@ -261,7 +266,7 @@ module Bulk
 
       if filter
         attributes.delete_if do |k, v|
-          delete_if = filter.include?(k)
+          delete_if = filter.include?(k.to_sym)
           type == :accessible ? !delete_if : delete_if
         end
       end

data/lib/generators/bulk/install/install_generator.rb

@@ -4,18 +4,13 @@ module Bulk
 
       desc <<DESC
 Description:
-    Creates initializer with configuration and adds required routes
+    Creates initializer with configuration.
 DESC
 
       def self.source_root
         @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
       end
 
-      def routes_entry
-        route 'bulk_routes "/api/bulk"'
-        route 'mount Bulk::Sproutcore.new => "/_sproutcore"'
-      end
-
       def copy_app_bulk_application_resource
         template 'app/bulk/application_resource.rb'
       end

metadata

@@ -1,55 +1,39 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bulk_api
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.9
   prerelease: 
-  version: 0.0.8
 platform: ruby
-authors: 
+authors:
 - Piotr Sarnacki
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-19 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152755020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: sproutcore
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.6.0.rc.1
-  type: :runtime
-  version_requirements: *id002
+  version_requirements: *2152755020
 description: Easy integration of rails apps with sproutcore.
 email: 
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - app/controllers/bulk/api_controller.rb
 - lib/bulk/abstract_collection.rb
 - lib/bulk/collection.rb
 - lib/bulk/engine.rb
 - lib/bulk/resource.rb
 - lib/bulk/routes.rb
-- lib/bulk/sproutcore.rb
 - lib/bulk_api.rb
 - lib/generators/bulk/install/install_generator.rb
 - lib/generators/bulk/install/templates/app/bulk/application_resource.rb
@@ -62,30 +46,26 @@ files:
 - README.markdown
 homepage: 
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.7.1
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Easy integration of rails apps with sproutcore.
 test_files: []
-

data/lib/bulk/sproutcore.rb

@@ -1,19 +0,0 @@
-require 'sproutcore'
-require 'sproutcore/rack/service'
-require 'sproutcore/models/project'
-
-module Bulk
-  class Sproutcore
-    def sproutcore
-      @sproutcore ||= begin
-        project = SC::Project.load Rails.application.paths["app/sproutcore"].first, :parent => SC.builtin_project
-        SC::Rack::Service.new(project)
-      end
-    end
-
-    def call(env)
-      env["PATH_INFO"] = "/" if env["PATH_INFO"].blank?
-      sproutcore.call(env)
-    end
-  end
-end