parsecom 0.0.6 → 0.1.0

data/README.md

@@ -87,12 +87,12 @@ another is using Parse::Object as a facade of a query object.
 # useing Query object directly
 query = Parse::Query.new GameScore
 query.where :objectId => 'Ed1nuqPvcm'
-results = query.invoke
+results = query.run
 
 # using Query object through Parse::Object
 results = GameScore.find :where => {:objectId => 'Ed1nuqPvcm'}
 # if you would like to find by objectId, you can easily pass it directly
-result = GameScore.find 'Ed1nuqPvcm'
+result = GameScore.find_by_id 'Ed1nuqPvcm'
 ```
 
 More complex query
@@ -123,9 +123,9 @@ To know more about retrieving objects, see spec/parse_query_spec.rb
 To update attributes, just update the attribute and save.
 
 ```ruby
-result = GameScore.find 'Ed1nuqPvcm'
-result.score = 73453
-result.save
+game_score = GameScore.find_by_id 'Ed1nuqPvcm'
+game_score.score = 73453
+game_score.save
 ```
 
 If you want to update attributes without retrieving the object, you can use
@@ -135,9 +135,61 @@ the Parse::Client object for it.
 Parse::Client.default.update :GaemScore, 'Ed1nuqPvcm', :score => 73453
 ```
 
+#### Counters
+
+```ruby
+game_score = GameScore.find_by_id 'Ed1nuqPvcm'
+game_score.score = Parse::Op::Increment.new 1
+game_score.save
+```
+
+#### Arrays
+
+```ruby
+game_score = GameScore.find_by_id 'Ed1nuqPvcm'
+game_score.skils = Parse::Op::AddUnique.new 'flying', 'kungfu'
+game_score.save
+```
+
+#### Relations
+
+```ruby
+game_score = GameScore.find_by_id 'Ed1nuqPvcm'
+game_score.opponents = Parse::Op::AddRelation.new player.pointer
+game_score.save
+```
+
+```ruby
+game_score = GameScore.find_by_id 'Ed1nuqPvcm'
+game_score.opponents = Parse::Op::RemoveRelation.new player.pointer
+game_score.save
+```
+
 ### Deleting Objects
 
-TBD
+```ruby
+game_score = GameScore.find_by_id 'Ed1nuqPvcm'
+game_score.delete
+```
+
+```ruby
+game_score = GameScore.find_by_id 'Ed1nuqPvcm'
+game_score.opponents = Parse::Op::Delete.new
+game_score.save
+```
+
+### Batch Operations
+
+```ruby
+seans_score = GameScore.new 'score' => 1337, 'playerName' => 'Sean Plott'
+zerocools_score = GameScore.new 'score' => 1338, 'playerName' => 'ZeroCool'
+batch = Parse::Batch.new
+batch.add_request do
+  seans_score.save
+  zerocools_score.save
+end
+result = batch.run
+```
 
 ### Sign up
 

data/lib/parse/batch.rb

@@ -0,0 +1,37 @@
+module Parse
+  class Batch
+    def initialize &block
+      @blocks = []
+      @blocks << block if block
+    end
+
+    def add_request &block
+      @blocks << block if block
+    end
+
+    def run
+      default_client = Parse::Client.default
+      default_http_client = default_client.http_client
+      batch_http_client = Parse::BatchHttpClient.new default_http_client.host
+      default_client.http_client = batch_http_client
+      begin
+        @blocks.map &:call
+      ensure
+        default_client.http_client = default_http_client
+      end
+
+      default_client.call_api :post, 'batch', %Q|{"requests":#{batch_http_client.requests.to_json}}| do |responses|
+        responses.each.with_index do |r, i|
+          if after_block = batch_http_client.after_blocks[i]
+            if r['success']
+              after_block.call r['success']
+            elsif r['error']
+              # do something
+              raise StandardError.new(r['error'].to_s)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/parse/batch_http_client.rb

@@ -0,0 +1,22 @@
+module Parse
+  class BatchHttpClient < HttpClient
+    attr_accessor :requests, :after_blocks
+
+    def initialize host
+      @host = host
+      @requests = []
+      @after_blocks = []
+    end
+
+    def request method, endpoint, headers={}, body=nil, &block
+      raise 'find cannot be in a batch request.' if method.to_s.upcase == 'GET'
+
+      @after_blocks << block
+      @requests << {
+        "method" => method.to_s.upcase,
+        "path" => endpoint,
+        "body" => JSON.parse(body) # TODO: ??
+      }
+    end
+  end
+end

data/lib/parse/client.rb

@@ -11,6 +11,10 @@ module Parse
       @@default_client ||= new
     end
 
+    def self.default= default_client
+      @@default_client = default_client
+    end
+
     def initialize application_id=nil, api_key=nil, master_key=nil, http_client=nil
       @application_id = application_id || Parse.application_id
       @api_key = api_key || Parse.api_key
@@ -126,22 +130,16 @@ module Parse
       query.invoke
     end
 
-    def create parse_class_name, values
-      call_api :post, "classes/#{parse_class_name}", values.to_json do |resp_body|
-        resp_body
-      end
+    def create parse_class_name, values, &block
+      call_api :post, "classes/#{parse_class_name}", values.to_json, &block
     end
 
-    def update parse_class_name, parse_object_id, values
-      call_api :put, "classes/#{parse_class_name}/#{parse_object_id}", values.to_json do |resp_body|
-        resp_body
-      end
+    def update parse_class_name, parse_object_id, values, &block
+      call_api :put, "classes/#{parse_class_name}/#{parse_object_id}", values.to_json, &block
     end
 
-    def delete parse_class_name, parse_object_id
-      call_api :delete, "classes/#{parse_class_name}/#{parse_object_id}" do |resp_body|
-        resp_body
-      end
+    def delete parse_class_name, parse_object_id, &block
+      call_api :delete, "classes/#{parse_class_name}/#{parse_object_id}", &block
     end
 
     def call_function name, param
@@ -168,8 +166,11 @@ module Parse
       return @use_master_key unless block
 
       tmp, @use_master_key = @use_master_key, true
-      ret = block.call
-      @use_master_key = tmp
+      begin
+        ret = block.call
+      ensure
+        @use_master_key = tmp
+      end
       ret
     end
 

data/lib/parse/http_client.rb

@@ -1,6 +1,8 @@
 # coding:utf-8
 module Parse
   class HttpClient
+    attr_accessor :host
+
     def initialize host
       @host = host
     end
@@ -15,7 +17,7 @@ module Parse
         resp = client.request req
         resp_body = JSON.parse resp.body
         raise StandardError.new "error calling #{endpoint}: #{
-          resp_body['error']}" if resp_body.has_key? 'error'
+          resp_body['error']}" if resp_body.is_a?(Hash) && resp_body.has_key?('error')
         block.call resp_body if block
       end
     end

data/lib/parse/object.rb

@@ -146,7 +146,7 @@ module Parse
       hash = string_keyed_hash hash
       @updated_hash.update hash
       method = use_master_key ? :create! : :create
-      parse_client.send(method, self.parse_class_name, @updated_hash).tap do |response|
+      parse_client.send(method, self.parse_class_name, @updated_hash) do |response|
         @parse_object_id = response['objectId']
         @created_at = Date.parse response['createdAt']
         @updated_at = @created_at
@@ -163,11 +163,11 @@ module Parse
     def update hash, use_master_key=false
       check_deleted!
       hash = string_keyed_hash hash
-      #parse_client.update(self, hash).tap do |response|
       method = use_master_key ? :update! : :update
-      parse_client.send(method, parse_class_name, parse_object_id, hash).tap do |response|
-        @updated_at = Date.parse response['updatedAt']
+      parse_client.send(method, parse_class_name, parse_object_id, hash) do |response|
         @raw_hash.update @updated_hash
+        @raw_hash.update response
+        @updated_at = Date.parse response['updatedAt']
         @updated_hash.clear
       end
     end
@@ -180,7 +180,7 @@ module Parse
       raise 'You cannot delete new object' if new?
       check_deleted!
       method = use_master_key ? :delete! : :delete
-      parse_client.send(method, parse_class_name, parse_object_id).tap do |response|
+      parse_client.send(method, parse_class_name, parse_object_id) do |response|
         @deleted = true
       end
     end
@@ -216,7 +216,7 @@ module Parse
       @updated_hash[name] = value
     end
 
-    def to_pointer
+    def pointer
       Pointer.new 'className' => parse_class_name, 'objectId' => parse_object_id
     end
 

data/lib/parse/op/add.rb

@@ -0,0 +1,13 @@
+module Parse
+  module Op
+    class Add
+      def initialize *objects
+        @objects = objects
+      end
+
+      def to_json *args
+        %Q|{"__op":"Add","objects":#{@objects.inspect}}|
+      end
+    end
+  end
+end

data/lib/parse/op/add_relation.rb

@@ -0,0 +1,13 @@
+module Parse
+  module Op
+    class AddRelation
+      def initialize *pointers
+        @pointers = pointers
+      end
+
+      def to_json *args
+        %Q|{"__op":"AddRelation","objects":[#{@pointers.map(&:to_json).join(',')}]}|
+      end
+    end
+  end
+end

data/lib/parse/op/add_unique.rb

@@ -0,0 +1,13 @@
+module Parse
+  module Op
+    class AddUnique
+      def initialize *objects
+        @objects = objects
+      end
+
+      def to_json *args
+        %Q|{"__op":"AddUnique","objects":#{@objects.inspect}}|
+      end
+    end
+  end
+end

data/lib/parse/op/delete.rb

@@ -0,0 +1,9 @@
+module Parse
+  module Op
+    class Delete
+      def to_json *args
+        %Q|{"__op":"Delete"}|
+      end
+    end
+  end
+end

data/lib/parse/op/increment.rb

@@ -0,0 +1,13 @@
+module Parse
+  module Op
+    class Increment
+      def initialize amount
+        @amount = amount
+      end
+
+      def to_json *args
+        %Q|{"__op":"Increment","amount":#{@amount}}|
+      end
+    end
+  end
+end

data/lib/parse/op/remove.rb

@@ -0,0 +1,13 @@
+module Parse
+  module Op
+    class Remove
+      def initialize *objects
+        @objects = objects
+      end
+
+      def to_json *args
+        %Q|{"__op":"Remove","objects":#{@objects.inspect}}|
+      end
+    end
+  end
+end

data/lib/parse/op/remove_relation.rb

@@ -0,0 +1,13 @@
+module Parse
+  module Op
+    class RemoveRelation
+      def initialize *pointers
+        @pointers = pointers
+      end
+
+      def to_json *args
+        %Q|{"__op":"RemoveRelation","objects":[#{@pointers.map(&:to_json).join(',')}]}|
+      end
+    end
+  end
+end

data/lib/parse/relation.rb

@@ -9,7 +9,7 @@ module Parse
 
     def load parse_client=Parse::Client.default
       unless @objects
-        pointer = @parent_object.to_pointer
+        pointer = @parent_object.pointer
         key = @column_name
         related_class = Parse::Object @raw_hash['className']
         @objects = related_class.find :where => proc {

data/lib/parse/version.rb

@@ -1,3 +1,3 @@
 module Parse
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 end

data/lib/parsecom.rb

@@ -18,6 +18,15 @@ require 'parse/installation'
 require 'parse/pointer'
 require 'parse/relation'
 require 'parse/file'
+require 'parse/op/increment'
+require 'parse/op/add'
+require 'parse/op/add_unique'
+require 'parse/op/remove'
+require 'parse/op/add_relation'
+require 'parse/op/remove_relation'
+require 'parse/op/delete'
+require 'parse/batch'
+require 'parse/batch_http_client'
 
 module Parse
   @@application_id = ENV['PARSE_APPLICATION_ID']

data/spec/fixtures/vcr_cassettes/batch.yml

@@ -0,0 +1,109 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.parse.com/1/classes/ClassA?limit=1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Parse-Application-Id:
+      - <X-Parse-Application-Id>
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - A parse.com client for ruby
+      X-Parse-Rest-Api-Key:
+      - <X-Parse-REST-API-Key>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Request-Method:
+      - ! '*'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 15 Oct 2013 12:50:22 GMT
+      Etag:
+      - ! '"e305fd3b81a57c52f61e6ae93b8eda1f"'
+      Server:
+      - nginx/1.4.2
+      Set-Cookie:
+      - <COOKIE-KEY>
+      Status:
+      - 200 OK
+      X-Runtime:
+      - '0.124765'
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Content-Length:
+      - '252'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"results":[{"columnA":"Hello, parse.com","columnD":{"__type":"Relation","className":"ClassB"},"columnC":{"__type":"Relation","className":"ClassB"},"createdAt":"2013-10-04T04:25:12.585Z","updatedAt":"2013-10-04T04:25:12.585Z","objectId":"4Ks88ukAUE"}]}'
+    http_version: 
+  recorded_at: Tue, 15 Oct 2013 12:50:22 GMT
+- request:
+    method: post
+    uri: https://api.parse.com/1/batch
+    body:
+      encoding: US-ASCII
+      string: ! '{"requests":[{"method":"POST","path":"/1/classes/ClassA","body":{"columnA":"hello"}},{"method":"POST","path":"/1/classes/ClassA","body":{"columnA":"world"}},{"method":"PUT","path":"/1/classes/ClassA/4Ks88ukAUE","body":{"columnA":"updated!"}}]}'
+    headers:
+      X-Parse-Application-Id:
+      - <X-Parse-Application-Id>
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - A parse.com client for ruby
+      X-Parse-Rest-Api-Key:
+      - <X-Parse-REST-API-Key>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Request-Method:
+      - ! '*'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 15 Oct 2013 12:50:23 GMT
+      Etag:
+      - ! '"2d26115f97cbd8d4143d8fb6e9a0b296"'
+      Server:
+      - nginx/1.4.2
+      Set-Cookie:
+      - <COOKIE-KEY>
+      Status:
+      - 200 OK
+      X-Runtime:
+      - '0.154472'
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Content-Length:
+      - '208'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '[{"success":{"createdAt":"2013-10-15T12:50:23.934Z","objectId":"za4TGQV39W"}},{"success":{"createdAt":"2013-10-15T12:50:23.951Z","objectId":"Y3ypX9OJ0v"}},{"success":{"updatedAt":"2013-10-15T12:50:23.977Z"}}]'
+    http_version: 
+  recorded_at: Tue, 15 Oct 2013 12:50:24 GMT
+recorded_with: VCR 2.4.0

data/spec/fixtures/vcr_cassettes/object_increment.yml

@@ -0,0 +1,109 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.parse.com/1/classes/ClassA?limit=1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Parse-Application-Id:
+      - <X-Parse-Application-Id>
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - A parse.com client for ruby
+      X-Parse-Rest-Api-Key:
+      - <X-Parse-REST-API-Key>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Request-Method:
+      - ! '*'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sun, 13 Oct 2013 08:48:13 GMT
+      Etag:
+      - ! '"21f1d56465316b4627e035fe84754e22"'
+      Server:
+      - nginx/1.4.2
+      Set-Cookie:
+      - <COOKIE-KEY>
+      Status:
+      - 200 OK
+      X-Runtime:
+      - '0.051473'
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Content-Length:
+      - '199'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"results":[{"columnA":"Hello, parse.com","columnD":{"__type":"Relation","className":"ClassB"},"createdAt":"2013-10-04T04:24:31.089Z","updatedAt":"2013-10-04T04:24:31.089Z","objectId":"OGKnxa5IiZ"}]}'
+    http_version: 
+  recorded_at: Sun, 13 Oct 2013 08:48:15 GMT
+- request:
+    method: put
+    uri: https://api.parse.com/1/classes/ClassA/OGKnxa5IiZ
+    body:
+      encoding: UTF-8
+      string: ! '{"columnB":{"__op":"Increment","amount":1}}'
+    headers:
+      X-Parse-Application-Id:
+      - <X-Parse-Application-Id>
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - A parse.com client for ruby
+      X-Parse-Rest-Api-Key:
+      - <X-Parse-REST-API-Key>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Request-Method:
+      - ! '*'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sun, 13 Oct 2013 08:48:14 GMT
+      Etag:
+      - ! '"89006920f12e748cde369d09a7b90cd5"'
+      Server:
+      - nginx/1.4.2
+      Set-Cookie:
+      - <COOKIE-KEY>
+      Status:
+      - 200 OK
+      X-Runtime:
+      - '0.045789'
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Content-Length:
+      - '52'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"columnB":1,"updatedAt":"2013-10-13T08:48:14.448Z"}'
+    http_version: 
+  recorded_at: Sun, 13 Oct 2013 08:48:16 GMT
+recorded_with: VCR 2.4.0

data/spec/parse_batch_spec.rb

@@ -0,0 +1,26 @@
+# coding:utf-8
+require 'spec_helper'
+require 'parsecom'
+
+describe Parse::Batch, 'when executing a batch request' do
+  it 'should be success' do
+    VCR.use_cassette 'batch' do
+      a1 = ClassA.new 'columnA' => 'hello'
+      a2 = ClassA.new 'columnA' => 'world'
+      a3 = ClassA.find(:all, :limit =>1).first
+      a3.columnA = 'updated!'
+      a3_updated_at = a3.updatedAt
+      batch = Parse::Batch.new
+      batch.add_request do
+        a1.save
+        a2.save
+        a3.save
+      end
+      batch.run
+      a1.parse_object_id.should_not be_nil
+      a2.parse_object_id.should_not be_nil
+      a3.columnA.should == 'updated!'
+      a3.updatedAt.should_not == a3_updated_at
+    end
+  end
+end

data/spec/parse_object_spec.rb

@@ -60,3 +60,24 @@ describe Parse::Object, 'when it creates a new parse object' do
   end
 end
 
+describe Parse::Object, 'when it updates an existing parse object' do
+  it 'should increment a field' do
+    VCR.use_cassette 'object_increment' do
+      class_a = ClassA.find(:all, :limit =>1).first
+      val = class_a.columnB || 0
+      class_a.columnB = Parse::Op::Increment.new 1
+      class_a.save
+      class_a.columnB.should == (val + 1)
+    end
+  end
+
+#  it 'should add unique objects to an array field' do
+#    VCR.use_cassette 'object_add_unique' do
+#      class_a = ClassA.find(:all, :limit =>1).first
+#      size = class_a.columnF.size
+#      class_a.columnF = Parse::Op::AddUnique.new 'flying', 'kungfu'
+#      class_a.save
+#      class_a.columnF.size.should == (size + 2)
+#    end
+#  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parsecom
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-12 00:00:00.000000000 Z
+date: 2013-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -72,6 +72,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/parse/batch.rb
+- lib/parse/batch_http_client.rb
 - lib/parse/client.rb
 - lib/parse/cloud_code.rb
 - lib/parse/ext/string.rb
@@ -79,6 +81,13 @@ files:
 - lib/parse/http_client.rb
 - lib/parse/installation.rb
 - lib/parse/object.rb
+- lib/parse/op/add.rb
+- lib/parse/op/add_relation.rb
+- lib/parse/op/add_unique.rb
+- lib/parse/op/delete.rb
+- lib/parse/op/increment.rb
+- lib/parse/op/remove.rb
+- lib/parse/op/remove_relation.rb
 - lib/parse/pointer.rb
 - lib/parse/query.rb
 - lib/parse/relation.rb
@@ -87,11 +96,14 @@ files:
 - lib/parse/version.rb
 - lib/parsecom.rb
 - parsecom.gemspec
+- spec/fixtures/vcr_cassettes/batch.yml
 - spec/fixtures/vcr_cassettes/object_find.yml
+- spec/fixtures/vcr_cassettes/object_increment.yml
 - spec/fixtures/vcr_cassettes/object_new.yml
 - spec/fixtures/vcr_cassettes/user_find.yml
 - spec/fixtures/vcr_cassettes/user_log_in.yml
 - spec/fixtures/vcr_cassettes/user_sign_up.yml
+- spec/parse_batch_spec.rb
 - spec/parse_client_spec.rb
 - spec/parse_object_spec.rb
 - spec/parse_query_spec.rb
@@ -123,11 +135,14 @@ signing_key:
 specification_version: 3
 summary: Pure Ruby version of parse.com client
 test_files:
+- spec/fixtures/vcr_cassettes/batch.yml
 - spec/fixtures/vcr_cassettes/object_find.yml
+- spec/fixtures/vcr_cassettes/object_increment.yml
 - spec/fixtures/vcr_cassettes/object_new.yml
 - spec/fixtures/vcr_cassettes/user_find.yml
 - spec/fixtures/vcr_cassettes/user_log_in.yml
 - spec/fixtures/vcr_cassettes/user_sign_up.yml
+- spec/parse_batch_spec.rb
 - spec/parse_client_spec.rb
 - spec/parse_object_spec.rb
 - spec/parse_query_spec.rb