parse-ruby-client 0.1.7 → 0.1.8

data/README.md

@@ -19,7 +19,7 @@ This currently depends on the gems 'json' and 'patron' for JSON support and HTTP
 
 ## Installation
 
-`gem "parse-ruby-client", "~> 0.1.7"`
+`gem "parse-ruby-client", "~> 0.1.8"`
 
 ---
 
@@ -48,7 +48,7 @@ Parse.init
 
 The test folder assumes this naming convention for environment variables, so if you want to run the tests, you *must* do this. But it's easy. And good for you, too.
 
-### New: Load API keys from `global.json` created by Cloud Code
+### Load API keys from `global.json` created by Cloud Code
 
 ```ruby
 Parse.init_from_cloud_code("path/to/global.json")
@@ -155,6 +155,21 @@ push = Parse::Push.new({"alert" => "I'm sending this push to all my app users!"}
 push.save
 ```
 
+## Batch Requests
+
+```ruby
+batch = Parse::Batch.new
+batch.add_request({
+  "method" => "POST",
+  "path" => "/1/classes/GameScore",
+  "body" => {
+    "score" => 1337,
+    "playerName" => "Sean Plott"
+  }
+})
+resp = batch.run!
+```
+
 ## Cloud Code
 
 ```ruby

data/VERSION

@@ -1 +1 @@
-0.1.7
+0.1.8

data/fixtures/vcr_cassettes/test_batch_run.yml

@@ -0,0 +1,83 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.parse.com/1/batch
+    body:
+      encoding: UTF-8
+      string: ! '{"requests":[{"method":"POST","path":"/1/classes/GameScore","body":{"score":1337,"playerName":"Sean
+        Plott"}}]}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - Parse for Ruby, 0.0
+      X-Parse-Master-Key:
+      - ''
+      X-Parse-Rest-Api-Key:
+      - D3Y8jNCQk6kpkKhpRGnWLYTrFGQ7j8dtDVnWZRnZ
+      X-Parse-Application-Id:
+      - PPVk6L5M9R1R8GVk8Ye9jT8f5SQNBIeoJUDJLmkT
+      X-Parse-Session-Token:
+      - ''
+      Expect:
+      - ''
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "QWNjZXNzLUNvbnRyb2wtQWxsb3ctT3JpZ2lu":
+      - !binary |-
+        Kg==
+      !binary "QWNjZXNzLUNvbnRyb2wtUmVxdWVzdC1NZXRob2Q=":
+      - !binary |-
+        Kg==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bWF4LWFnZT0wLCBwcml2YXRlLCBtdXN0LXJldmFsaWRhdGU=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbjsgY2hhcnNldD11dGYtOA==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAwNSBKYW4gMjAxMyAyMjo1NToyMSBHTVQ=
+      !binary "RXRhZw==":
+      - !binary |-
+        IjYyYTEwM2MzYmY1ZGFlMDM4M2ZkYWQ4NTM1MTE0ZmUzIg==
+      !binary "U2VydmVy":
+      - !binary |-
+        bmdpbngvMS4yLjI=
+      !binary "U2V0LUNvb2tpZQ==":
+      - !binary |-
+        X3BhcnNlX3Nlc3Npb249QkFoN0Jra2lEM05sYzNOcGIyNWZhV1FHT2daRlJp
+        SWxOV05qTlRnNU1XWTVNVEEzWVRRMU9UQmlOak15WmpNd1lXTXdNMkUyTVdJ
+        JTNELS03YTZlOGQyNmFhMTlhOWMzNTJiNWMzYzgxZGNjNWE0ZGY5NTgxYWRk
+        OyBkb21haW49LnBhcnNlLmNvbTsgcGF0aD0vOyBleHBpcmVzPVRodSwgMDUt
+        SmFuLTIwMjMgMjI6NTU6MjEgR01UOyBzZWN1cmU7IEh0dHBPbmx5
+      !binary "U3RhdHVz":
+      - !binary |-
+        MjAwIE9L
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC44NjczMjQ=
+      !binary "WC1VYS1Db21wYXRpYmxl":
+      - !binary |-
+        SUU9RWRnZSxjaHJvbWU9MQ==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        Nzg=
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        a2VlcC1hbGl2ZQ==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        W3sic3VjY2VzcyI6eyJjcmVhdGVkQXQiOiIyMDEzLTAxLTA1VDIyOjU1OjIx
+        LjA3NloiLCJvYmplY3RJZCI6Imh4dTVaeVdNZDgifX1d
+    http_version: 
+  recorded_at: Sat, 05 Jan 2013 22:55:24 GMT
+recorded_with: VCR 2.0.1

data/fixtures/vcr_cassettes/test_new_model.yml

@@ -80,4 +80,76 @@ http_interactions:
         Y3RJZCI6IlJMTlVHakswek0ifQ==
     http_version: 
   recorded_at: Sat, 05 Jan 2013 17:09:06 GMT
+- request:
+    method: get
+    uri: https://api.parse.com/1/batch
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - Parse for Ruby, 0.0
+      X-Parse-Master-Key:
+      - ''
+      X-Parse-Rest-Api-Key:
+      - D3Y8jNCQk6kpkKhpRGnWLYTrFGQ7j8dtDVnWZRnZ
+      X-Parse-Application-Id:
+      - PPVk6L5M9R1R8GVk8Ye9jT8f5SQNBIeoJUDJLmkT
+      X-Parse-Session-Token:
+      - ''
+      Expect:
+      - ''
+  response:
+    status:
+      code: 404
+      message: !binary |-
+        Tm90IEZvdW5k
+    headers:
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9odG1sOyBjaGFyc2V0PXV0Zi04
+      !binary "RGF0ZQ==":
+      - !binary |-
+        U2F0LCAwNSBKYW4gMjAxMyAyMjozNjo0MiBHTVQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        bmdpbngvMS4yLjI=
+      !binary "U3RhdHVz":
+      - !binary |-
+        NDA0IE5vdCBGb3VuZA==
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC4wMDQwMzY=
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        NzI4
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        a2VlcC1hbGl2ZQ==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        PCFET0NUWVBFIGh0bWw+CjxodG1sPgo8aGVhZD4KICA8dGl0bGU+VGhlIHBh
+        Z2UgeW91IHdlcmUgbG9va2luZyBmb3IgZG9lc24ndCBleGlzdCAoNDA0KTwv
+        dGl0bGU+CiAgPHN0eWxlIHR5cGU9InRleHQvY3NzIj4KICAgIGJvZHkgeyBi
+        YWNrZ3JvdW5kLWNvbG9yOiAjZmZmOyBjb2xvcjogIzY2NjsgdGV4dC1hbGln
+        bjogY2VudGVyOyBmb250LWZhbWlseTogYXJpYWwsIHNhbnMtc2VyaWY7IH0K
+        ICAgIGRpdi5kaWFsb2cgewogICAgICB3aWR0aDogMjVlbTsKICAgICAgcGFk
+        ZGluZzogMCA0ZW07CiAgICAgIG1hcmdpbjogNGVtIGF1dG8gMCBhdXRvOwog
+        ICAgICBib3JkZXI6IDFweCBzb2xpZCAjY2NjOwogICAgICBib3JkZXItcmln
+        aHQtY29sb3I6ICM5OTk7CiAgICAgIGJvcmRlci1ib3R0b20tY29sb3I6ICM5
+        OTk7CiAgICB9CiAgICBoMSB7IGZvbnQtc2l6ZTogMTAwJTsgY29sb3I6ICNm
+        MDA7IGxpbmUtaGVpZ2h0OiAxLjVlbTsgfQogIDwvc3R5bGU+CjwvaGVhZD4K
+        Cjxib2R5PgogIDwhLS0gVGhpcyBmaWxlIGxpdmVzIGluIHB1YmxpYy80MDQu
+        aHRtbCAtLT4KICA8ZGl2IGNsYXNzPSJkaWFsb2ciPgogICAgPGgxPlRoZSBw
+        YWdlIHlvdSB3ZXJlIGxvb2tpbmcgZm9yIGRvZXNuJ3QgZXhpc3QuPC9oMT4K
+        ICAgIDxwPllvdSBtYXkgaGF2ZSBtaXN0eXBlZCB0aGUgYWRkcmVzcyBvciB0
+        aGUgcGFnZSBtYXkgaGF2ZSBtb3ZlZC48L3A+CiAgPC9kaXY+CjwvYm9keT4K
+        PC9odG1sPgo=
+    http_version: 
+  recorded_at: Sat, 05 Jan 2013 22:36:45 GMT
 recorded_with: VCR 2.0.1

data/lib/parse-ruby-client.rb

@@ -24,4 +24,5 @@ require 'parse/protocol'
 require 'parse/user'
 require 'parse/push'
 require 'parse/cloud'
-require 'parse/model'
+require 'parse/model'
+require 'parse/batch'

data/lib/parse/batch.rb

@@ -0,0 +1,21 @@
+require 'json'
+
+module Parse
+  class Batch
+    attr_reader :requests
+
+    def initialize
+      @requests ||= []
+    end
+
+    def add_request(request)
+      @requests << request
+    end
+
+    def run!
+      uri = Parse::Protocol.batch_request_uri
+      body = {:requests => @requests}.to_json
+      Parse.client.request(uri, :post, body)
+    end
+  end
+end

data/lib/parse/protocol.rb

@@ -122,6 +122,8 @@ module Parse
 
     CLOUD_FUNCTIONS_PATH = "functions"
 
+    BATCH_REQUEST_URI = "batch"
+
     # URI Helpers
     # ----------------------------------------
 
@@ -159,5 +161,9 @@ module Parse
     def Protocol.cloud_function_uri(function_name)
       "/#{VERSION}/#{CLOUD_FUNCTIONS_PATH}/#{function_name}"
     end
+
+    def Protocol.batch_request_uri
+      "/#{VERSION}/#{BATCH_REQUEST_URI}"
+    end
   end
 end

data/parse-ruby-client.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "parse-ruby-client"
-  s.version = "0.1.7"
+  s.version = "0.1.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alan deLevie", "Adam Alpern"]
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "example.rb",
     "fixtures/vcr_cassettes/test_array_add.yml",
+    "fixtures/vcr_cassettes/test_batch_run.yml",
     "fixtures/vcr_cassettes/test_cloud_function.yml",
     "fixtures/vcr_cassettes/test_created_at.yml",
     "fixtures/vcr_cassettes/test_deep_parse.yml",
@@ -43,6 +44,7 @@ Gem::Specification.new do |s|
     "fixtures/vcr_cassettes/test_updated_at.yml",
     "fixtures/vcr_cassettes/test_user_save.yml",
     "lib/parse-ruby-client.rb",
+    "lib/parse/batch.rb",
     "lib/parse/client.rb",
     "lib/parse/cloud.rb",
     "lib/parse/datatypes.rb",
@@ -58,6 +60,7 @@ Gem::Specification.new do |s|
     "test/cloud_functions/MyCloudCode/cloud/main.js",
     "test/config/global.json",
     "test/helper.rb",
+    "test/test_batch.rb",
     "test/test_client.rb",
     "test/test_cloud.rb",
     "test/test_datatypes.rb",

data/test/test_batch.rb

@@ -0,0 +1,59 @@
+require 'helper'
+
+class TestBatch < Test::Unit::TestCase
+  def setup
+    Parse.init
+  end
+
+  def test_initialize
+    batch = Parse::Batch.new
+    assert_equal batch.class, Parse::Batch
+  end
+
+  def test_add_request
+    batch = Parse::Batch.new
+    batch.add_request({
+      :method => "POST",
+      :path => "/1/classes/GameScore",
+      :body => {
+        :score => 1337,
+        :playerName => "Sean Plott"
+      }
+    })
+    batch.add_request({
+      :method => "POST",
+      :path => "/1/classes/GameScore",
+      :body => {
+        :score => 1338,
+        :playerName => "ZeroCool"
+      }
+    })
+    assert_equal batch.requests.class, Array
+    assert_equal batch.requests.length, 2
+    assert_equal batch.requests.first[:path], "/1/classes/GameScore"
+  end
+
+  def test_protocol_uri
+    uri = Parse::Protocol.batch_request_uri
+    assert_equal uri, "/1/batch"
+  end
+
+  def test_run
+    VCR.use_cassette('test_batch_run', :record => :new_episodes) do
+      batch = Parse::Batch.new
+      batch.add_request({
+        "method" => "POST",
+        "path" => "/1/classes/GameScore",
+        "body" => {
+          "score" => 1337,
+          "playerName" => "Sean Plott"
+        }
+      })
+      resp = batch.run!
+      assert_equal resp.length, batch.requests.length
+      assert resp.first["success"]
+      assert_equal resp.first["success"]["objectId"].class, String
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parse-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -173,6 +173,7 @@ files:
 - VERSION
 - example.rb
 - fixtures/vcr_cassettes/test_array_add.yml
+- fixtures/vcr_cassettes/test_batch_run.yml
 - fixtures/vcr_cassettes/test_cloud_function.yml
 - fixtures/vcr_cassettes/test_created_at.yml
 - fixtures/vcr_cassettes/test_deep_parse.yml
@@ -190,6 +191,7 @@ files:
 - fixtures/vcr_cassettes/test_updated_at.yml
 - fixtures/vcr_cassettes/test_user_save.yml
 - lib/parse-ruby-client.rb
+- lib/parse/batch.rb
 - lib/parse/client.rb
 - lib/parse/cloud.rb
 - lib/parse/datatypes.rb
@@ -205,6 +207,7 @@ files:
 - test/cloud_functions/MyCloudCode/cloud/main.js
 - test/config/global.json
 - test/helper.rb
+- test/test_batch.rb
 - test/test_client.rb
 - test/test_cloud.rb
 - test/test_datatypes.rb
@@ -230,7 +233,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -55766238074805369
+      hash: 3206718523214024845
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: