rackjson 0.3.2 → 0.4.1

data/README.markdown

@@ -53,6 +53,8 @@ When creating resources with either the public or private resources the specifie
 
 ### REST API
 
+#### Collections
+
 To see what actions are available on the notes resource:
 
     curl -i -XOPTIONS http://localhost:9292/notes
@@ -148,6 +150,98 @@ Finally a resource can be deleted using a DELETE request
     
     {"ok": "true"}
 
+#### Nested Documents
+
+Rack::JSON fully supports nested documents.  Any element within a document can be accessed directly regardless of how deeply it is nested.  For example if the following document exists at the location `/notes/1`
+
+    {
+      "_id": 1,
+      "title": "Nested Document",
+      "author": {
+        "name": "Bob",
+        "contacts": {
+          "email": "bob@mail.com"
+        }
+      },
+      "viewed_by": [1, 5, 12, 87],
+      "comments": [{
+        "user_id": 1
+        "text": "awesome!"
+      }]
+    }
+
+To get just all the comments we can make a get request to `/notes/1/comments`
+
+    curl -i http://localhost:9292/notes/1/comments
+    
+    HTTP/1.1 200 OK
+    Connection: close
+    Date: Sun, 29 Aug 2010 19:43:09 GMT
+    Content-Type: application/json
+    Content-Length: 33
+    
+    [{"text":"awesome!","user_id":1}]
+
+We can also get just the first comment by passing in the index of that comment in the array, to get the first comment make a GET request to `/notes/1/comments/0`
+
+    curl -i http://localhost:9292/notes/1/comments/0
+    
+    HTTP/1.1 200 OK
+    Connection: close
+    Date: Sun, 29 Aug 2010 19:45:28 GMT
+    Content-Type: application/json
+    Content-Length: 31
+    
+    {"text":"awesome!","user_id":1}
+
+If we try and get a comment that doesn't exist in the array a 404 is returned.
+
+    curl -i http://localhost:9292/notes/1/comments/1
+    
+    HTTP/1.1 404 Not Found
+    Connection: close
+    Date: Sun, 29 Aug 2010 19:46:46 GMT
+    Content-Type: text/plain
+    Content-Length: 15
+    
+    field not found
+
+Any field within the document is accessable in this way, just append the field name or the index of the item within an array to the url.
+
+As well as providing read access to any field within a document Rack::JSON also allows you to modify or remove any field within a document.  To change the value of a field make a PUT request to the fields url and pass the value you want as the body.
+
+Both simple values, numbers and strings, or JSON structures can be set in this way, however if you want to set a field to contain a JSON structure (array or object) you must set the correct content type for the request, application/json.
+
+#### Array Modifiers
+
+Fields within a document that are arrays also support atomic push and pulls for adding and removing items from an array.
+
+To push a new item onto an array we make a post request to _push
+
+    curl -i -XPOST -d'101' http://localhost:9292/notes/1/viewed_by/_push
+
+The above will push the value 101 onto the viewed by array within the note with _id 1.
+
+Similarly an item can be pulled from an array using _pull
+
+    curl -i -XPOST -d'101' http://localhost:9292/notes/1/viewed_by/_pull
+
+This will remove the value 101 from the viewed_by array if it already exists.
+To remove or add more than one item from an array we can use either _pull_all or _push_all passing in an array each time.
+
+Arrays within documents can also be treated like sets and only add items that do not currently exists by using the add_to_set command like below
+
+    curl -i -XPOST -d'101' http://localhost:9292/notes/1/viewed_by/_add_to_set
+
+This will only add the value 101 to the viewed_by array if it doesn't already exist.
+
+#### Incrementing & Decrementing
+
+RackJSON provides a simple means of incrementing and decrementing counters within a document, simply make a post request to either _increment or _decrement as shown below
+
+    curl -i -XPOST http://localhost:9292/notes/1/views/_increment
+    curl -i -XPOST http://localhost:9292/notes/1/views/_decrement
+
 ### JSON Query
 
 RackJSON supports querying of the resources using JSONQuery style syntax.  Pass the JSONQuery as query string parameters when making a get request.

data/Rakefile

@@ -10,7 +10,7 @@ begin
     gem.email = "oliver.n@new-bamboo.co.uk"
     gem.homepage = "http://github.com/olivernn/rackjson"
     gem.authors = ["Oliver Nightingale"]
-    gem.add_dependency('mongo', '>=1.0.0')
+    gem.add_dependency('mongo', '>=1.1.0')
     gem.add_dependency('mongo_ext', '>=0.19.1')
     gem.add_dependency('json', '=1.2.3')
     gem.add_dependency('rack', '>=1.0.1')

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.1

data/lib/rackjson/collection.rb

@@ -1,5 +1,10 @@
+require 'enumerator'
+
 module Rack::JSON
   class Collection
+
+    class Rack::JSON::Collection::DataTypeError < TypeError ; end
+
     def initialize(collection)
       @collection = collection
     end
@@ -8,6 +13,10 @@ module Rack::JSON
       @collection.remove(prepared(selector))
     end
 
+    def delete_field(selector, field)
+      _update(prepared(selector), { "$unset" => { dot_notate(field) => 1 }, "$set" => { :updated_at => Time.now }})
+    end
+
     def exists?(selector)
       !@collection.find(prepared(selector)).to_a.empty?
     end
@@ -16,8 +25,28 @@ module Rack::JSON
       @collection.find(selector, options).inject([]) {|documents, row| documents << Rack::JSON::Document.create(row)}
     end
 
+    def find_field(selector, fields, options={})
+      document = find_one(prepared(selector))
+      document ? document.field(fields) : nil
+    end
+
     def find_one(selector, options={})
-      find(prepared(selector), options).first
+      find(prepared(selector), options.merge(:limit => 0)).first
+    end
+
+    def decrement(selector, field, value=1)
+      _update(prepared(selector), { "$inc" => { dot_notate(field) => -1 * (value || 1) }, "$set" => { :updated_at => Time.now }})
+    end
+
+    def increment(selector, field, value=1)
+      _update(prepared(selector), { "$inc" => { dot_notate(field) => value || 1 }, "$set" => { :updated_at => Time.now }})
+    end
+
+    [:pull, :pull_all, :push, :push_all, :add_to_set].each do |method_name|
+      define_method method_name do |selector, field, value|
+        modifier = "$#{method_name.to_s.split('_').to_enum.each_with_index.map { |w, i| i == 0 ? w : w.capitalize }.join}"
+        _update(prepared(selector), { modifier => { dot_notate(field) => value }, "$set" => { :updated_at => Time.now }})
+      end
     end
 
     def save(document)
@@ -26,16 +55,28 @@ module Rack::JSON
 
     def update(selector, document, query={})
       if exists?(prepared(selector).merge(query))
-        @collection.update(prepared(selector).merge(query), document.to_h, :upsert => false)
+        _update(prepared(selector).merge(query), document.to_h, :upsert => false)
       else
         false
       end
     end
 
+    def update_field(selector, field, value)
+      _update(prepared(selector), { "$set" => { dot_notate(field) => value, :updated_at => Time.now }})
+    end
+
     private
 
+    def dot_notate field
+      field.is_a?(Array) ? field.join(".") : field
+    end
+
     def prepared selector
       selector.is_a?(Hash) ? selector : {:_id => selector}
     end
+
+    def _update(query, hash, options={})
+      @collection.update(query, hash, options)
+    end
   end
 end

data/lib/rackjson/document.rb

@@ -15,11 +15,22 @@ module Rack::JSON
       end
     end
 
-
     def add_attributes(pair)
       attributes.merge!(pair)
     end
 
+    def field(field_names)
+      attrs = attributes
+      Array.wrap(field_names).each do |field_name|
+        if attrs.is_a? Array
+          attrs = attrs[field_name.to_i]
+        else
+          attrs = attrs[field_name]
+        end
+      end
+      attrs
+    end
+
     def set_id(val)
       add_attributes('_id' => val) unless attributes.keys.include? '_id'
     end

data/lib/rackjson/end_point.rb

@@ -3,6 +3,10 @@ module Rack::JSON
 
     private
 
+    def bad_request error
+      error_response error, 400
+    end
+
     def bypass? request
       request.collection.empty? || !(@collections.include? request.collection.to_sym)
     end
@@ -15,8 +19,12 @@ module Rack::JSON
       !@methods.include?(request.request_method.downcase.to_sym)
     end
 
+    def error_response error, status_code
+      render (error.class.to_s + " :" + error.message), :status => status_code
+    end
+
     def invalid_json error
-      render (error.class.to_s + " :" + error.message), :status => 422
+      error_response error, 422
     end
 
     def method_not_allowed? request

data/lib/rackjson/extensions/BSON/object_id.rb

@@ -1,5 +1,5 @@
 module BSON
-  class ObjectID
+  class ObjectId
     def to_json
       to_s
     end

data/lib/rackjson/extensions/core/array.rb

@@ -0,0 +1,12 @@
+class Array
+  def self.wrap(object)
+    case object
+    when nil
+      []
+    when self
+      object
+    else
+      [object]
+    end
+  end
+end

data/lib/rackjson/extensions/core/string.rb

@@ -0,0 +1,13 @@
+class String
+  def numeric?
+    true if Float(self) rescue false
+  end
+
+  def to_number
+    if numeric?
+      f = to_f
+      i = to_i
+      f == i ? i : f
+    end
+  end
+end

data/lib/rackjson/json_document.rb

@@ -17,8 +17,8 @@ module Rack::JSON
     end
 
     def set_attribute_ids
-      attributes["_id"] = BSON::ObjectID.from_string(attributes["_id"].to_s)
-    rescue BSON::InvalidObjectID
+      attributes["_id"] = BSON::ObjectId.from_string(attributes["_id"].to_s)
+    rescue BSON::InvalidObjectId
       return false
     end
 

data/lib/rackjson/json_query.rb

@@ -1,9 +1,10 @@
 module Rack::JSON
   class JSONQuery
 
-    attr_accessor :options, :selector
+    attr_accessor :options, :selector, :resource_id
 
-    def initialize(query_string)
+    def initialize(query_string, options={})
+      @resource_id = options[:resource_id] || nil
       @query_string = query_string
       @conditions = @query_string.split(/\[|\]/).compact.reject {|s| s.empty? }
       @options = {}
@@ -21,6 +22,7 @@ module Rack::JSON
           end
         end
       end
+      add_query_document_id
     end
 
     def comparison(symbol)
@@ -32,6 +34,12 @@ module Rack::JSON
       }[symbol]
     end
 
+    def add_query_document_id
+      if resource_id
+        @selector[:_id] = resource_id
+      end
+    end
+
     def set_query_fields(condition)
       if condition.match /^=\w+$/
         @options[:fields] = condition.sub('=', '').split(',')

data/lib/rackjson/mongo_document.rb

@@ -9,7 +9,7 @@ module Rack::JSON
     private
 
     def set_attribute_ids
-      attributes["_id"] = attributes["_id"].to_s if (attributes["_id"].is_a? BSON::ObjectID)
+      attributes["_id"] = attributes["_id"].to_s if (attributes["_id"].is_a? BSON::ObjectId)
     end
   end
 end

data/lib/rackjson/request.rb

@@ -1,5 +1,8 @@
 module Rack::JSON
   class Request < Rack::Request
+
+    class Rack::JSON::Request::UnrecognisedPathTypeError < StandardError ; end
+
     include Rack::Utils
 
     attr_reader :env
@@ -21,25 +24,82 @@ module Rack::JSON
       self.path_info.match /^\/[\w-]+$/
     end
 
+    def field
+      path_info.split('/')[3] || ""
+    end
+
+    def fields
+      path_info.split('/').slice(3..-1).reject { |f| f.match(/(_increment|_decrement|_push|_pull|_push_all|_pull_all|_add_to_set)/)} || []
+    end
+
+    def field_path?
+      path_info.match(/^\/[\w-]+\/[\w-]+\/[\w-]+(\/[\w-]+)*$/) && !modifier_path?
+    end
+
     def member_path?
-      self.path_info.match /^\/\w+\/[\w-]+$/
+      self.path_info.match /^\/[\w-]+\/[\w-]+$/
+    end
+
+    def modifier
+      modifier_path? ? path_info.split('/').last : nil
+    end
+
+    def modifier_path?
+      path_info.match /^\/[\w-]+\/[\w-]+\/[\w-]+(\/[\w-]+)*\/(_increment|_decrement|_push|_pull|_push_all|_pull_all|_add_to_set)$/
+    end
+
+    def path_type
+      if member_path?
+        :member
+      elsif field_path?
+        :field
+      elsif collection_path?
+        :collection
+      else
+        raise UnrecognisedPathTypeError
+      end
+    end
+
+    def payload
+      if content_type == 'application/json'
+        JSON.parse(raw_body)
+      elsif raw_body.empty?
+        nil
+      else
+        raw_body.numeric? ? raw_body.to_number : raw_body
+      end
+    end
+
+    def property
+      property = path_info.split('/')[4]
+      if property
+        property.match(/^\d+$/)? property.to_i : property
+      else
+        nil
+      end
     end
 
     def json
-      self.body.rewind
-      self.body.read
+      raw_body
     end
 
     def query
-      @query ||= Rack::JSON::JSONQuery.new(unescape(query_string))
+      @query ||= Rack::JSON::JSONQuery.new(unescape(query_string), :resource_id => resource_id)
+    end
+
+    def raw_body
+      self.body.rewind
+      self.body.read
     end
 
     def resource_id
-      id_string = self.path_info.split('/').last.to_s
-      begin
-        BSON::ObjectID.from_string(id_string)
-      rescue BSON::InvalidObjectID
-        id_string.match(/^\d+$/) ? id_string.to_i : id_string
+      unless collection_path?
+        id_string = self.path_info.split('/')[2].to_s
+        begin
+          BSON::ObjectId.from_string(id_string)
+        rescue BSON::InvalidObjectId
+          id_string.match(/^\d+$/) ? id_string.to_i : id_string
+        end
       end
     end
 

data/lib/rackjson/resource.rb

@@ -1,7 +1,7 @@
 module Rack::JSON
   class Resource
     include Rack::JSON::EndPoint
-    HTTP_METHODS = [:get, :post, :put, :delete]
+    HTTP_METHODS = [:get, :post, :put, :delete, :options]
 
     def initialize(app, options)
       @app = app
@@ -24,11 +24,19 @@ module Rack::JSON
 
     private
 
+    def create(request)
+      document = Rack::JSON::Document.create(request.json)
+      @collection.save(document)
+      render document, :status => 201
+    end
+
     def delete(request)
-      if request.member_path?
-        if @collection.delete({:_id => request.resource_id})
-          render "{'ok': true}"
-        end
+      if request.field_path?
+        @collection.delete_field(request.query.selector, request.fields)
+        render "", :status => 204
+      elsif request.member_path?
+        @collection.delete(request.query.selector)
+        render "", :status => 204
       else
         render "", :status => 405
       end
@@ -36,12 +44,28 @@ module Rack::JSON
 
     [:get, :head].each do |method|
       define_method method do |request|
-        request.member_path? ? get_member(request, method) : get_collection(request, method)
+        begin
+          send("get_#{request.path_type}", request, method)
+        rescue Rack::JSON::Request::UnrecognisedPathTypeError => error
+          bad_request error
+        end
+      end
+    end
+
+    def get_collection(request, method)
+      render @collection.find(request.query.selector, request.query.options)
+    end
+
+    def get_field(request, method)
+      field = @collection.find_field(request.query.selector, request.fields, request.query.options)
+      if field
+        render field, :head => (method == :head)
+      else
+        render "field not found", :status => 404, :head => (method == :head)
       end
     end
 
     def get_member(request, method)
-      request.query.selector.merge!({:_id => request.resource_id})
       document = @collection.find_one(request.query.selector, request.query.options)
       if document
         render document, :head => (method == :head)
@@ -50,37 +74,46 @@ module Rack::JSON
       end
     end
 
-    def get_collection(request, method)
-      render @collection.find(request.query.selector, request.query.options)
-    end
-
-    def not_allowed?(request)
-      
-    end
-
     def options(request)
       if request.collection_path?
         headers = { "Allow" => "GET, POST" }
       elsif request.member_path?
         headers = { "Allow" => "GET, PUT, DELETE" }
+      elsif request.field_path?
+        headers = { "Allow" => "GET, PUT, DELETE" }
+      elsif request.modifier_path?
+        headers = { "Allow" => "POST" }
       end
       render "", :headers => headers
     end
 
     def post(request)
-      document = Rack::JSON::Document.create(request.json)
-      @collection.save(document)
-      render document, :status => 201
+      if request.collection_path?
+        create(request)
+      elsif request.modifier_path?
+        @collection.exists?(request.resource_id) ? modify(request) : render("document not found", :status => 404)
+      else
+        render "", :status => 405
+      end
     rescue JSON::ParserError => error
       invalid_json error
     end
 
     def put(request)
-      @collection.exists?(request.resource_id) ? update(request) : upsert(request)
+      if request.field_path?
+        @collection.exists?(request.resource_id) ? update_field(request) : render("document not found", :status => 404)
+      else
+        @collection.exists?(request.resource_id) ? update(request) : upsert(request)
+      end
     rescue JSON::ParserError => error
       invalid_json error
     end
 
+    def modify(request)
+      @collection.send(request.modifier[1..-1], request.query.selector, request.fields, request.payload)
+      render "OK", :status => 200
+    end
+
     def update(request)
       document = Rack::JSON::Document.create(request.json)
       document.set_id(request.resource_id)
@@ -91,6 +124,11 @@ module Rack::JSON
       end
     end
 
+    def update_field(request)
+      @collection.update_field(request.query.selector, request.fields, request.payload)
+      render "OK", :status => 200
+    end
+
     def upsert(request)
       document = Rack::JSON::Document.create(request.json)
       document.set_id(request.resource_id)

data/lib/rackjson/response.rb

@@ -25,11 +25,11 @@ module Rack::JSON
     end
 
     def parse_body(body)
-      if body.is_a?(Rack::JSON::Document) || body.is_a?(Array)
+      if body.is_a?(Rack::JSON::Document) || body.is_a?(Array) || body.is_a?(Hash)
         @body = body.to_json
         @headers["Content-Type"] = "application/json"
-      elsif body.is_a? String
-        @body = body
+      elsif body.is_a?(String) || body.is_a?(Fixnum)
+        @body = body.to_s
         @headers["Content-Type"] = "text/plain"
       else
         raise Rack::JSON::Response::BodyFormatError

data/lib/rackjson.rb

@@ -4,6 +4,8 @@ require 'rack'
 require 'mongo'
 require 'time'
 require 'rackjson/rack/builder'
+require 'rackjson/extensions/core/array'
+require 'rackjson/extensions/core/string'
 
 module Rack::JSON
 
@@ -19,7 +21,7 @@ module Rack::JSON
   autoload :Request, 'rackjson/request'
   autoload :Resource, 'rackjson/resource'
   autoload :Response, 'rackjson/response'
-  autoload :ObjectID, 'rackjson/extensions/bson/object_id'
+  autoload :ObjectId, 'rackjson/extensions/bson/object_id'
   autoload :OrderedHash, 'rackjson/extensions/bson/ordered_hash'
 
 end

data/rackjson.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rackjson}
-  s.version = "0.3.2"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Oliver Nightingale"]
-  s.date = %q{2010-08-17}
+  s.date = %q{2010-10-06}
   s.description = %q{A rack end point for storing json documents.}
   s.email = %q{oliver.n@new-bamboo.co.uk}
   s.extra_rdoc_files = [
@@ -29,6 +29,8 @@ Gem::Specification.new do |s|
      "lib/rackjson/end_point.rb",
      "lib/rackjson/extensions/BSON/object_id.rb",
      "lib/rackjson/extensions/BSON/ordered_hash.rb",
+     "lib/rackjson/extensions/core/array.rb",
+     "lib/rackjson/extensions/core/string.rb",
      "lib/rackjson/filter.rb",
      "lib/rackjson/json_document.rb",
      "lib/rackjson/json_query.rb",
@@ -40,6 +42,7 @@ Gem::Specification.new do |s|
      "rackjson.gemspec",
      "test/helper.rb",
      "test/suite.rb",
+     "test/test_collection.rb",
      "test/test_document.rb",
      "test/test_filter.rb",
      "test/test_json_document.rb",
@@ -57,6 +60,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/helper.rb",
      "test/suite.rb",
+     "test/test_collection.rb",
      "test/test_document.rb",
      "test/test_filter.rb",
      "test/test_json_document.rb",
@@ -64,7 +68,6 @@ Gem::Specification.new do |s|
      "test/test_mongo_document.rb",
      "test/test_rack_builder.rb",
      "test/test_resource.rb",
-     "test/test_resource_modifier.rb",
      "test/test_response.rb"
   ]
 
@@ -73,18 +76,18 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<mongo>, [">= 1.0.0"])
+      s.add_runtime_dependency(%q<mongo>, [">= 1.1.0"])
       s.add_runtime_dependency(%q<mongo_ext>, [">= 0.19.1"])
       s.add_runtime_dependency(%q<json>, ["= 1.2.3"])
       s.add_runtime_dependency(%q<rack>, [">= 1.0.1"])
     else
-      s.add_dependency(%q<mongo>, [">= 1.0.0"])
+      s.add_dependency(%q<mongo>, [">= 1.1.0"])
       s.add_dependency(%q<mongo_ext>, [">= 0.19.1"])
       s.add_dependency(%q<json>, ["= 1.2.3"])
       s.add_dependency(%q<rack>, [">= 1.0.1"])
     end
   else
-    s.add_dependency(%q<mongo>, [">= 1.0.0"])
+    s.add_dependency(%q<mongo>, [">= 1.1.0"])
     s.add_dependency(%q<mongo_ext>, [">= 0.19.1"])
     s.add_dependency(%q<json>, ["= 1.2.3"])
     s.add_dependency(%q<rack>, [">= 1.0.1"])

data/test/test_collection.rb

@@ -0,0 +1,125 @@
+require 'helper'
+
+class CollectionTest < Test::Unit::TestCase
+
+  def setup
+    @db = Mongo::Connection.new.db("test")
+    @doc = @db['resource_test'].insert({:_id => 1, :count => 1, :field => 'foo', :array => [1,2,3,4], :obj => { :field => 'baz'}})
+    @collection = Rack::JSON::Collection.new(@db['resource_test'])
+  end
+
+  def teardown
+    @db['resource_test'].drop
+  end
+
+  test "should be able to retrieve a specific element from a document in the collection" do
+    assert_equal('foo', @collection.find_field(1, ['field']))
+  end
+
+  test "should return nil if there is no matching field" do
+    assert_nil(@collection.find_field(1, ['non-existant-field']))
+  end
+
+  test "should be able to retrieve a specific element form an array" do
+    assert_equal(2, @collection.find_field(1, ['array', 1]))
+  end
+
+  test "should return nil if asking for an array element that doesn't exist" do
+    assert_nil(@collection.find_field(1, ['array', 100]))
+  end
+
+  test "should be able to retrieve a specific element from an embedded object" do
+    assert_equal('baz', @collection.find_field(1, ['obj', 'field']))
+  end
+
+  test "should return nil if asking for an element that doesn't exist on the embeded object" do
+    assert_nil(@collection.find_field(1, ['obj', 'nonexistant']))
+  end
+
+  test "attomic increment" do
+    @collection.increment(1, 'count')
+    assert_equal(2, @collection.find_field(1, 'count'))
+  end
+
+  test "incrementing by more than 1" do
+    @collection.increment(1, 'count', 2)
+    assert_equal(3, @collection.find_field(1, 'count'))
+  end
+
+  test "attomic decrement" do
+    @collection.decrement(1, 'count')
+    assert_equal(0, @collection.find_field(1, 'count'))
+  end
+
+  test "decrementing by more than 1" do
+    @collection.decrement(1, 'count', 2)
+    assert_equal(-1, @collection.find_field(1, 'count'))
+  end
+
+  test "attomic push" do
+    @collection.push(1, 'array', 'pushed value')
+    assert_equal([1,2,3,4,'pushed value'], @collection.find_field(1, 'array'))
+  end
+
+  test "attomic push on a new list" do
+    @collection.push(1, 'new-array', 'pushed value')
+    assert_equal(['pushed value'], @collection.find_field(1, 'new-array'))
+  end
+
+  # mongo isn't throwing an error when doing this, may need to upgrade
+  # still not throwing an error in 1.6
+  # test "attomic push on a non list field should raise a DataTypeError" do
+  #   assert_raises Rack::JSON::Collection::DataTypeError do
+  #     @collection.push(1, 'count', 'pushed value')
+  #   end
+  # end
+
+  test "attomic push all on an existing list" do
+    @collection.push_all(1, 'array', ["a", "b", "c"])
+    assert_equal([1,2,3,4,'a','b','c'], @collection.find_field(1, 'array'))
+  end
+
+  test "attomic push all on to create a new list" do
+    @collection.push_all(1, 'new-array', ["a", "b", "c"])
+    assert_equal(["a", "b", "c"], @collection.find_field(1, 'new-array'))
+  end
+
+  test "attomic pull item form a list" do
+    @collection.pull(1, 'array', 4)
+    assert_equal([1,2,3], @collection.find_field(1, 'array'))
+  end
+
+  test "attomic pull all to remove more than one item from a list" do
+    @collection.pull_all(1, 'array', [1,2,3])
+    assert_equal([4], @collection.find_field(1, 'array'))
+  end
+
+  # currently failing because add to set is supported in mongo v1.3+
+  test "adding an element to an array only if it doesn't already exist in the array" do
+    @collection.add_to_set(1, 'array', 'pushed value')
+    assert_equal([1,2,3,4,'pushed value'], @collection.find_field(1, 'array'))
+    @collection.add_to_set(1, 'array', 1)
+    assert_equal([1,2,3,4,'pushed value'], @collection.find_field(1, 'array'))
+  end
+
+  test "updating a specific field of a document" do
+    @collection.update_field(1, 'field', 'bar')
+    assert_equal('bar', @collection.find_field(1, 'field'))
+  end
+
+  test "updating a field that doesn't currently exist in a document" do
+    @collection.update_field(1, 'new-field', 'bar')
+    assert_equal('bar', @collection.find_field(1, 'new-field'))
+  end
+
+  test "updating a nested field in a document" do
+    @collection.update_field(1, ['obj', 'field'], 'blah')
+    assert_equal('blah', @collection.find_field(1, ['obj', 'field']))
+  end
+
+  test "deleting a specific field from a document" do
+    @collection.delete_field(1, 'field')
+    assert_nil(@collection.find_field(1, 'field'))
+  end
+
+end

data/test/test_document.rb

@@ -29,7 +29,7 @@ class DocumentTest < Test::Unit::TestCase
   def test_creating_from_json_with_id
     json = '{"_id": "4b9f783ba040140525000001", "test":"hello"}'
     document = Rack::JSON::Document.create(json)
-    assert_equal(BSON::ObjectID.from_string('4b9f783ba040140525000001'), document.attributes["_id"])
+    assert_equal(BSON::ObjectId.from_string('4b9f783ba040140525000001'), document.attributes["_id"])
     assert_equal("hello", document.attributes["test"])
     assert_equal(Time.now.to_s, document.attributes["created_at"].to_s)
     assert_equal(Time.now.to_s, document.attributes["updated_at"].to_s)
@@ -82,4 +82,11 @@ class DocumentTest < Test::Unit::TestCase
     assert_equal("01/01/2010", document.attributes["created_at"])
     assert_equal(Time.now.to_s, document.attributes["updated_at"].to_s)
   end
+
+  test "accessing getting a single attribute from a document" do
+    json = '{"test":"hello", "nested":{"foo":"bar"}}'
+    document = Rack::JSON::Document.create(json)
+    assert_equal "hello", document.field(["test"])
+    assert_equal "bar", document.field(["nested", "foo"])
+  end
 end

data/test/test_json_document.rb

@@ -24,7 +24,7 @@ class JSONDocumentTest < Test::Unit::TestCase
   def test_parsing_mongo_object_id
     hash = { "_id" => "4ba7e82ca04014011c000001" }
     doc = JSON.generate hash
-    assert_equal(BSON::ObjectID.from_string("4ba7e82ca04014011c000001"), Rack::JSON::JSONDocument.new(doc).attributes["_id"])
+    assert_equal(BSON::ObjectId.from_string("4ba7e82ca04014011c000001"), Rack::JSON::JSONDocument.new(doc).attributes["_id"])
   end
   
   def test_parsing_non_mongo_object_ids

data/test/test_json_query.rb

@@ -61,6 +61,12 @@ class QueryTest < Test::Unit::TestCase
     assert_equal({:price => {'$lt' => 10}}, query.selector)
   end
 
+  test "automatically merging in the _id from the resource id" do
+    json_query = '[?name=bob!]'
+    query = Rack::JSON::JSONQuery.new(json_query, :resource_id => 1)
+    assert_equal({:_id => 1, :name => 'bob!'}, query.selector)
+  end
+
   # def test_single_greater_than_or_equal_condition
   #   json_query = '[?price=<10]'
   #   query = Rack::JSON::JSONQuery.new(json_query)

data/test/test_mongo_document.rb

@@ -3,7 +3,7 @@ require 'helper'
 class MongoDocumentTest < Test::Unit::TestCase
 
   def test_stringifying_mongo_object_ids
-    hash = {"_id" => BSON::ObjectID.from_string("4ba7e82ca04014011c000001")}
+    hash = {"_id" => BSON::ObjectId.from_string("4ba7e82ca04014011c000001")}
     doc = Rack::JSON::MongoDocument.new(hash).attributes
     assert_equal("4ba7e82ca04014011c000001", doc["_id"])
   end

data/test/test_resource.rb

@@ -94,6 +94,55 @@ class ResourceTest < Test::Unit::TestCase
     assert_equal "document not found", last_response.body
   end
 
+  test "finding a field within a specific document" do
+    @collection.save({:testing => true, :rating => 5, :title => 'testing', :_id => 1})
+    get '/testing/1/title'
+    assert last_response.ok?
+    assert_equal "testing", last_response.body
+  end
+
+  test "trying to find a field within a non-existant document" do
+    get '/testing/1/title'
+    assert_equal 404, last_response.status
+  end
+
+  test "finding an array inside a document" do
+    @collection.save({:obj => { :hello => "world"}, :ratings => [5,2], :title => 'testing', :_id => 1})
+    get '/testing/1/ratings'
+    assert last_response.ok?
+    expected = [5,2]
+    assert_equal expected, JSON.parse(last_response.body)
+  end
+
+  test "finding an element of an array from a specific document" do
+    @collection.save({:testing => true, :ratings => [5,2], :title => 'testing', :_id => 1})
+    get '/testing/1/ratings/0'
+    assert last_response.ok?
+    assert_equal "5", last_response.body
+  end
+
+  test "finding an embedded document" do
+    @collection.save({:obj => { :hello => "world"}, :ratings => [5,2], :title => 'testing', :_id => 1})
+    get '/testing/1/obj'
+    assert last_response.ok?
+    expected = { "hello" => "world" }
+    assert_equal expected, JSON.parse(last_response.body)
+  end
+
+  test "finding a property of an embedded document" do
+    @collection.save({:obj => { :hello => "world"}, :ratings => [5,2], :title => 'testing', :_id => 1})
+    get '/testing/1/obj/hello'
+    assert last_response.ok?
+    assert_equal "world", last_response.body
+  end
+
+  test "incrementing a property of an embedded document" do
+    @collection.save({:obj => { :counter => 1}, :_id => 1})
+    post '/testing/1/obj/counter/_increment'
+    assert last_response.ok?
+    assert_equal 2, @collection.find_one(:_id => 1)["obj"]["counter"]
+  end
+
   test "index method with query parameters" do
     @collection.save({:testing => true, :rating => 5, :title => 'testing'})
     get '/testing?[?title=testing]'
@@ -144,14 +193,128 @@ class ResourceTest < Test::Unit::TestCase
     assert_nil @collection.find_one(:_id => 1, :user_id => 1)
   end
 
+  test "updating a field within a document" do
+    @collection.save({:title => 'testing', :_id => 1})
+    put '/testing/1/title', "updated"
+    assert last_response.ok?
+    assert_equal "updated", @collection.find_one(:_id => 1)['title']
+  end
+
+  test "creating a new field within an existing documennt" do
+    @collection.save({:title => 'testing', :_id => 1})
+    put '/testing/1/new_field', "created"
+    assert last_response.ok?
+    assert_equal "created", @collection.find_one(:_id => 1)['new_field']
+  end
+
+  test "trying to create a new field within a non-existant document" do
+    @collection.save({:title => 'testing', :_id => 1})
+    put '/testing/2/title', "updated"
+    assert_equal 404, last_response.status
+  end
+
+  test "incrementing a value within a document" do
+    @collection.save({:counter => 1, :_id => 1})
+    post '/testing/1/counter/_increment'
+    assert last_response.ok?
+    assert_equal 2, @collection.find_one(:_id => 1)["counter"]
+  end
+
+  test "incrementing a non existant field" do
+    @collection.save({:_id => 1})
+    post '/testing/1/counter/_increment'
+    assert last_response.ok?
+    assert_equal 1, @collection.find_one(:_id => 1)["counter"]
+  end
+
+  test "incrementing a value within a document by a custom amount" do
+    @collection.save({:counter => 1, :_id => 1})
+    post '/testing/1/counter/_increment', '10'
+    assert last_response.ok?
+    assert_equal 11, @collection.find_one(:_id => 1)["counter"]
+  end
+
+  test "incrementing a value on a non existent document" do
+    post '/testing/1/counter/_increment'
+    assert_equal 404, last_response.status
+  end
+
+  test "decrementing a value within a document" do
+    @collection.save({:counter => 1, :_id => 1})
+    post '/testing/1/counter/_decrement'
+    assert last_response.ok?
+    assert_equal 0, @collection.find_one(:_id => 1)["counter"]
+  end
+
+  test "push a simple value onto an array within a document" do
+    @collection.save({:list => [1,2,3], :_id => 1})
+    post '/testing/1/list/_push', '4'
+    assert last_response.ok?
+    assert_equal [1,2,3,4], @collection.find_one(:_id => 1)['list']
+  end
+
+  test "push an object onto an array within a document" do
+    @collection.save({:list => [1,2,3], :_id => 1})
+    header 'Content-Type', 'application/json'
+    post '/testing/1/list/_push', '{"foo": "bar"}'
+    assert last_response.ok?
+    assert_equal [1,2,3,{"foo" => "bar"}], @collection.find_one(:_id => 1)['list']
+  end
+
+  test "push more than one item onto an array within a document" do
+    @collection.save({:list => [1,2,3], :_id => 1})
+    header 'Content-Type', 'application/json'
+    post '/testing/1/list/_push_all', '[4,5,6,7]'
+    assert last_response.ok?
+    assert_equal [1,2,3,4,5,6,7], @collection.find_one(:_id => 1)['list']
+  end
+
+  test "pull a simple value from an array within a document" do
+    @collection.save({:list => [1,2,3], :_id => 1})
+    post '/testing/1/list/_pull', '2'
+    assert last_response.ok?
+    assert_equal [1,3], @collection.find_one(:_id => 1)['list']
+  end
+
+  test "pull an object from an array within a document" do
+    @collection.save({:list => [1,2,3,{"foo" => "bar"}], :_id => 1})
+    header 'Content-Type', 'application/json'
+    post '/testing/1/list/_pull', '{ "foo": "bar" }'
+    assert last_response.ok?
+    assert_equal [1,2,3], @collection.find_one(:_id => 1)['list']
+  end
+
+  test "pull more than one item from an array within a document" do
+    @collection.save({:list => [1,2,3,4,5,6,7], :_id => 1})
+    header 'Content-Type', 'application/json'
+    post '/testing/1/list/_pull_all', '[4,5,6,7]'
+    assert last_response.ok?
+    assert_equal [1,2,3], @collection.find_one(:_id => 1)['list']
+  end
+
+  test "adding an item to a set" do
+    @collection.save({:list => [1,2,3], :_id => 1})
+    post '/testing/1/list/_add_to_set', '4'
+    assert last_response.ok?
+    assert_equal [1,2,3,4], @collection.find_one(:_id => 1)['list']
+  end
+
   test "deleting a document" do
     @collection.save({:title => 'testing', :_id => 1})
     assert @collection.find_one({:_id => 1})
     delete '/testing/1'
-    assert last_response.ok?
+    assert_equal 204, last_response.status
     assert_nil @collection.find_one({:_id => 1})
   end
 
+  test "deleting a field within a document" do
+    @collection.save({:title => 'testing', :_id => 1})
+    assert @collection.find_one({:_id => 1})
+    delete '/testing/1/title'
+    assert_equal 204, last_response.status
+    assert_nil @collection.find_one({:_id => 1})['title']
+  end
+
   test "deleting only with member path" do
     delete '/testing'
     assert_equal 405, last_response.status

data/test/test_response.rb

@@ -38,6 +38,11 @@ class ResponseTest < Test::Unit::TestCase
     assert_match(JSON.parse(response.body)['title'], 'Hello')
   end
 
+  test "sending a number" do
+    response = Rack::JSON::Response.new(1)
+    assert_equal "1", response.body
+  end
+
   def test_head_response
     response = Rack::JSON::Response.new("test", :head => true)
     assert_equal([""], response.to_a[2])

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Oliver Nightingale
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-17 00:00:00 +01:00
+date: 2010-10-06 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,9 +26,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 1
+        - 1
         - 0
-        - 0
-        version: 1.0.0
+        version: 1.1.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -95,6 +95,8 @@ files:
 - lib/rackjson/end_point.rb
 - lib/rackjson/extensions/BSON/object_id.rb
 - lib/rackjson/extensions/BSON/ordered_hash.rb
+- lib/rackjson/extensions/core/array.rb
+- lib/rackjson/extensions/core/string.rb
 - lib/rackjson/filter.rb
 - lib/rackjson/json_document.rb
 - lib/rackjson/json_query.rb
@@ -106,6 +108,7 @@ files:
 - rackjson.gemspec
 - test/helper.rb
 - test/suite.rb
+- test/test_collection.rb
 - test/test_document.rb
 - test/test_filter.rb
 - test/test_json_document.rb
@@ -147,6 +150,7 @@ summary: A rack end point for storing json documents.
 test_files: 
 - test/helper.rb
 - test/suite.rb
+- test/test_collection.rb
 - test/test_document.rb
 - test/test_filter.rb
 - test/test_json_document.rb
@@ -154,5 +158,4 @@ test_files:
 - test/test_mongo_document.rb
 - test/test_rack_builder.rb
 - test/test_resource.rb
-- test/test_resource_modifier.rb
 - test/test_response.rb

data/test/test_resource_modifier.rb

@@ -1,73 +0,0 @@
-# require 'helper'
-# 
-# class ResourceModifierTest < Test::Unit::TestCase
-#   include Rack::Test::Methods
-#   include Rack::Utils
-# 
-#   def setup
-#     @db = Mongo::Connection.new.db("test")
-#     @collection = @db['testing']
-#     @doc = @collection.save(:_id => 1, :count => 0, :likers => [])
-#   end
-# 
-#   def teardown
-#     @collection.drop
-#   end
-# 
-#   def app
-#     Rack::JSON::ResourceModifier.new lambda { |env|
-#       [404, {'Content-Length' => '9', 'Content-Type' => 'text/plain'}, ["Not Found"]]
-#     },  :collections => [:testing], :db => @db
-#   end
-# 
-#   test "ignore non matched resources" do
-#     put '/foo/1'
-#     assert_status_not_found last_response
-#   end
-# 
-#   test "ignore non modifier resources" do
-#     put '/testing/1'
-#     assert_status_not_found last_response
-#   end
-# 
-#   test "ignoring modifier requests with the wrong method" do
-#     post '/testing/1/inc?field=count'
-#     assert_status_not_found last_response
-#   end
-# 
-#   test "incrementing a value" do
-#     put '/testing/1/inc?field=count'
-#     assert_status_ok last_response
-#     assert_equal 1, @collection.find_one({:_id => 1})["count"]
-#   end
-# 
-#   test "decrementing a value" do
-#     put '/testing/1/dec?field=count'
-#     assert_status_ok last_response
-#     assert_equal -1, @collection.find_one({:_id => 1})["count"]
-#   end
-# 
-#   test "incrementing a non-existant field" do
-#     put '/testing/1/inc?field=non_existant'
-#     assert_status_ok last_response
-#     assert_equal 0, @collection.find_one({:_id => 1})["count"]
-#     assert_equal 1, @collection.find_one({:_id => 1})["non_existant"]
-#   end
-# 
-#   test "decrementing a non-existent field" do
-#     put '/testing/1/dec?field=non_existant'
-#     assert_status_ok last_response
-#     assert_equal 0, @collection.find_one({:_id => 1})["count"]
-#     assert_equal -1, @collection.find_one({:_id => 1})["non_existant"]
-#   end
-# 
-#   test "pushing a value onto the end of an array" do
-#     testing/1/counter/_inc
-#     testing/1/counter/_dec
-#     testing/1/likers?operation
-#     put '/testing/1/push?field=asdfa' '{"value": [123] }'
-#     put '/testing/1/push', '{"field": "likers", "value": 1}'
-#     assert_status_ok last_response
-#     assert_equal [1], @collection.find_one({:_id => 1})['likers']
-#   end
-# end