parse-ruby-client 0.1.10 → 0.1.11

data/README.md

@@ -19,7 +19,9 @@ This currently depends on the gems 'json' and 'patron' for JSON support and HTTP
 
 ## Installation
 
-`gem "parse-ruby-client", "~> 0.1.10"`
+[![Gem Version](https://badge.fury.io/rb/parse-ruby-client.png)](http://badge.fury.io/rb/parse-ruby-client)
+
+`gem "parse-ruby-client"`
 
 ---
 
@@ -148,6 +150,24 @@ Parse::Query.new("GameScore")           \
 
 ```
 
+### Relational Data
+
+```ruby
+post = Parse::Object.new "Post"
+post.save
+
+comment = Parse::Object.new "Comment"
+comment.save
+
+post.array_add_relation("comments", comment.pointer)
+post.save
+
+q = Parse::Query.new("Comment")
+q.related_to("comments", post.pointer)
+comments = q.get
+assert_equal comments.first["objectId"], comment["objectId"]
+```
+
 ## Push Notifications
 
 ```ruby

data/VERSION

@@ -1 +1 @@
-0.1.10
+0.1.11

data/features.md

@@ -0,0 +1,135 @@
+## Summary
+
+parse-ruby-client lets you interact with Parse using Ruby. There are many uses. For example:
+
+- A webserver can show data from Parse on a website.
+- You can upload large amounts of data that will later be consumed in a mobile app.
+- You can download recent data to run your own custom analytics.
+- You can export all of your data if you no longer want to use Parse.
+
+### Quick Reference
+
+#### Installation
+
+`gem install parse-ruby-client` or add `gem "parse-ruby-client"` to your `Gemfile.`
+
+#### Configuration
+
+```ruby
+require 'parse-ruby-client'
+
+Parse.init :application_id => "<your_app_id>",
+           :api_key        => "<your_api_key>"
+```
+
+## Objects
+
+The design philosophy behind parse-ruby-client is to stay out of the way as much as possible. Parse Objects, at the most basic level, act like Ruby `Hash` objects with Parse-specific methods tacked on.
+
+### Creating Objects
+
+```ruby
+game_score = Parse::Object.new("GameScore")
+game_score["score"] = 1337
+game_score["playerName"] = "Sean Plott"
+game_score["cheatMode"] = false
+result = game_score.save
+puts result
+```
+
+This will return:
+
+```ruby
+{"score"=>1337,
+ "playerName"=>"Sean Plott",
+ "cheatMode"=>false,
+ "createdAt"=>"2013-01-19T21:01:33.562Z",
+ "objectId"=>"GeqPWJdNqp"}
+```
+
+### Retrieving Objects
+
+The easiest way to retrieve Objects is with `Parse::Query`:
+
+```ruby
+game_score_query = Parse::Query.new("GameScore")
+game_score_query.eq("objectId", "GeqPWJdNqp")
+game_score = game_score_query.get
+puts game_score
+```
+
+This will return:
+
+```ruby
+[{"score"=>1337,
+  "playerName"=>"Sean Plott",
+  "createdAt"=>"2013-01-19T21:01:33.562Z",
+  "updatedAt"=>"2013-01-19T21:01:33.562Z",
+  "objectId"=>"GeqPWJdNqp"}]
+```
+
+Notice that this is an `Array` of results. For more information on queries, see TODO.
+
+When retrieving objects that have pointers to children, you can fetch child objects by setting the `include` attribute. For instance, to fetch the object pointed to by the "game" key:
+
+```ruby
+game_score_query = Parse::Query.new("GameScore")
+game_score_query.eq("objectId", "GeqPWJdNqp")
+game_score_query.include = "game"
+game_score = game_score_query.get
+```
+
+You can include multiple children pointers by separating key names by commas:
+
+```ruby
+game_score_query.include = "game,genre"
+```
+
+### Updating Objects
+
+To change the data on an object that already exists, just call `Parse::Object#save` on it. Any keys you don't specify will remain unchanged, so you can update just a subset of the object's data. For example, if we wanted to change the score field of our object:
+
+```ruby
+game_score = Parse::Query.new("GameScore").eq("objectId", "GeqPWJdNqp").get.first
+game_score["score"] = 73453
+result = game_score.save
+puts result
+```
+
+This will return:
+
+```ruby
+{"score"=>73453,
+ "playerName"=>"Sean Plott",
+ "createdAt"=>"2013-01-19T21:01:33.562Z",
+ "updatedAt"=>"2013-01-19T21:16:34.395Z",
+ "objectId"=>"GeqPWJdNqp"}
+```
+
+#### Counters
+
+To help with storing counter-type data, Parse provides the ability to atomically increment (or decrement) any number field. So, we can increment the score field like so:
+
+```ruby
+game_score = Parse::Query.new("GameScore").eq("objectId", "GeqPWJdNqp").get.first
+game_score["score"] = Parse::Increment.new(1)
+game_score.save
+```
+
+You can also use `Parse::Decrement.new(amount)`.
+
+#### Arrays
+
+## Queries
+
+## Users
+
+## Roles
+
+## Files
+
+## Push Notifications
+
+## Installations
+
+## Geopoints

data/fixtures/vcr_cassettes/test_array_add_relation.yml

@@ -0,0 +1,321 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.parse.com/1/classes/Post
+    body:
+      encoding: UTF-8
+      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:
+      - PsXOTylMvpCsyhx7njRh06BzSsehrwywuYwD9UiN
+      X-Parse-Application-Id:
+      - X4gXxFjSqK9VHZZPFR32Cvp5wntIhDI5TESO18jB
+      X-Parse-Session-Token:
+      - ''
+      Expect:
+      - ''
+  response:
+    status:
+      code: 201
+      message: !binary |-
+        Q3JlYXRlZA==
+    headers:
+      !binary "QWNjZXNzLUNvbnRyb2wtQWxsb3ctT3JpZ2lu":
+      - !binary |-
+        Kg==
+      !binary "QWNjZXNzLUNvbnRyb2wtUmVxdWVzdC1NZXRob2Q=":
+      - !binary |-
+        Kg==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bm8tY2FjaGU=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbjsgY2hhcnNldD11dGYtOA==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        V2VkLCAxNiBKYW4gMjAxMyAxNDo0MDoxOCBHTVQ=
+      !binary "TG9jYXRpb24=":
+      - !binary |-
+        aHR0cHM6Ly9hcGkucGFyc2UuY29tLzEvY2xhc3Nlcy9Qb3N0L1M2T2lZbzdy
+        bkM=
+      !binary "U2VydmVy":
+      - !binary |-
+        bmdpbngvMS4yLjI=
+      !binary "U2V0LUNvb2tpZQ==":
+      - !binary |-
+        X3BhcnNlX3Nlc3Npb249QkFoN0Jra2lEM05sYzNOcGIyNWZhV1FHT2daRlJp
+        SWxOakk1WldVME1tVTVaV0l3TURGa1pESXdNek00T1dKaE16TTROMlExTm1Z
+        JTNELS01OGMwZmI1MjNhMmY0NTgwMmMyNmI2MDY0MzVmZjMyNjhjMTBkNDQ1
+        OyBkb21haW49LnBhcnNlLmNvbTsgcGF0aD0vOyBleHBpcmVzPU1vbiwgMTYt
+        SmFuLTIwMjMgMTQ6NDA6MTggR01UOyBzZWN1cmU7IEh0dHBPbmx5
+      !binary "U3RhdHVz":
+      - !binary |-
+        MjAxIENyZWF0ZWQ=
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC4xNzU4OTc=
+      !binary "WC1VYS1Db21wYXRpYmxl":
+      - !binary |-
+        SUU9RWRnZSxjaHJvbWU9MQ==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        NjQ=
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        a2VlcC1hbGl2ZQ==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJjcmVhdGVkQXQiOiIyMDEzLTAxLTE2VDE0OjQwOjE4LjUyN1oiLCJvYmpl
+        Y3RJZCI6IlM2T2lZbzdybkMifQ==
+    http_version: 
+  recorded_at: Wed, 16 Jan 2013 14:40:18 GMT
+- request:
+    method: post
+    uri: https://api.parse.com/1/classes/Comment
+    body:
+      encoding: UTF-8
+      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:
+      - PsXOTylMvpCsyhx7njRh06BzSsehrwywuYwD9UiN
+      X-Parse-Application-Id:
+      - X4gXxFjSqK9VHZZPFR32Cvp5wntIhDI5TESO18jB
+      X-Parse-Session-Token:
+      - ''
+      Expect:
+      - ''
+  response:
+    status:
+      code: 201
+      message: !binary |-
+        Q3JlYXRlZA==
+    headers:
+      !binary "QWNjZXNzLUNvbnRyb2wtQWxsb3ctT3JpZ2lu":
+      - !binary |-
+        Kg==
+      !binary "QWNjZXNzLUNvbnRyb2wtUmVxdWVzdC1NZXRob2Q=":
+      - !binary |-
+        Kg==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bm8tY2FjaGU=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbjsgY2hhcnNldD11dGYtOA==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        V2VkLCAxNiBKYW4gMjAxMyAxNDo0MDoxOCBHTVQ=
+      !binary "TG9jYXRpb24=":
+      - !binary |-
+        aHR0cHM6Ly9hcGkucGFyc2UuY29tLzEvY2xhc3Nlcy9Db21tZW50L2FQRVRX
+        WWZvQmk=
+      !binary "U2VydmVy":
+      - !binary |-
+        bmdpbngvMS4yLjI=
+      !binary "U2V0LUNvb2tpZQ==":
+      - !binary |-
+        X3BhcnNlX3Nlc3Npb249QkFoN0Jra2lEM05sYzNOcGIyNWZhV1FHT2daRlJp
+        SWxaVGMxT1RObFpUVTRaVFZrWWpsak9EazVPV1JpWVRNMllqa3hNMkkzTlRZ
+        JTNELS05Zjg4MGNmNWU4MTZkM2NiZGQ2MmUwMDUzYjRhZTJmYjkzNmFhOGYx
+        OyBkb21haW49LnBhcnNlLmNvbTsgcGF0aD0vOyBleHBpcmVzPU1vbiwgMTYt
+        SmFuLTIwMjMgMTQ6NDA6MTggR01UOyBzZWN1cmU7IEh0dHBPbmx5
+      !binary "U3RhdHVz":
+      - !binary |-
+        MjAxIENyZWF0ZWQ=
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC4xNjYyNzE=
+      !binary "WC1VYS1Db21wYXRpYmxl":
+      - !binary |-
+        SUU9RWRnZSxjaHJvbWU9MQ==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        NjQ=
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        a2VlcC1hbGl2ZQ==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJjcmVhdGVkQXQiOiIyMDEzLTAxLTE2VDE0OjQwOjE4LjczN1oiLCJvYmpl
+        Y3RJZCI6ImFQRVRXWWZvQmkifQ==
+    http_version: 
+  recorded_at: Wed, 16 Jan 2013 14:40:18 GMT
+- request:
+    method: put
+    uri: https://api.parse.com/1/classes/Post/S6OiYo7rnC
+    body:
+      encoding: UTF-8
+      string: ! '{"comments":{"__op":"AddRelation","objects":[{"__type":"Pointer","className":"Comment","objectId":"aPETWYfoBi"}]}}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - Parse for Ruby, 0.0
+      X-Parse-Master-Key:
+      - ''
+      X-Parse-Rest-Api-Key:
+      - PsXOTylMvpCsyhx7njRh06BzSsehrwywuYwD9UiN
+      X-Parse-Application-Id:
+      - X4gXxFjSqK9VHZZPFR32Cvp5wntIhDI5TESO18jB
+      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 |-
+        V2VkLCAxNiBKYW4gMjAxMyAxNDo0MDoxOSBHTVQ=
+      !binary "RXRhZw==":
+      - !binary |-
+        ImRkYWZhMDJhMjM4MjNkZWI4ZTM0YTI0ODk2NjllODM2Ig==
+      !binary "U2VydmVy":
+      - !binary |-
+        bmdpbngvMS4yLjI=
+      !binary "U2V0LUNvb2tpZQ==":
+      - !binary |-
+        X3BhcnNlX3Nlc3Npb249QkFoN0Jra2lEM05sYzNOcGIyNWZhV1FHT2daRlJp
+        SWxORGN6T1dWaU1qUXlNVFptT1dZME9EbG1NRE0wTldFeVpUZzJNbVptTlRB
+        JTNELS0wN2MyOWZiYjQwYTY0MzllNGQ2ZTk3ZmNiODg1OGYxYzYyNTJlNzJi
+        OyBkb21haW49LnBhcnNlLmNvbTsgcGF0aD0vOyBleHBpcmVzPU1vbiwgMTYt
+        SmFuLTIwMjMgMTQ6NDA6MTkgR01UOyBzZWN1cmU7IEh0dHBPbmx5
+      !binary "U3RhdHVz":
+      - !binary |-
+        MjAwIE9L
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC4zMzQxMjU=
+      !binary "WC1VYS1Db21wYXRpYmxl":
+      - !binary |-
+        SUU9RWRnZSxjaHJvbWU9MQ==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        NDA=
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        a2VlcC1hbGl2ZQ==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJ1cGRhdGVkQXQiOiIyMDEzLTAxLTE2VDE0OjQwOjE4Ljk3N1oifQ==
+    http_version: 
+  recorded_at: Wed, 16 Jan 2013 14:40:19 GMT
+- request:
+    method: get
+    uri: https://api.parse.com/1/classes/Comment?where=%7B%22$relatedTo%22:%7B%22object%22:%7B%22__type%22:%22Pointer%22,%22className%22:%22Post%22,%22objectId%22:%22S6OiYo7rnC%22%7D,%22key%22:%22comments%22%7D%7D
+    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:
+      - PsXOTylMvpCsyhx7njRh06BzSsehrwywuYwD9UiN
+      X-Parse-Application-Id:
+      - X4gXxFjSqK9VHZZPFR32Cvp5wntIhDI5TESO18jB
+      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 |-
+        V2VkLCAxNiBKYW4gMjAxMyAxNDo0MDoyMCBHTVQ=
+      !binary "RXRhZw==":
+      - !binary |-
+        IjY5OTYyM2M3NTY5ZDk0MzA4OTVjMDE1NmRhNjhlOWFlIg==
+      !binary "U2VydmVy":
+      - !binary |-
+        bmdpbngvMS4yLjI=
+      !binary "U2V0LUNvb2tpZQ==":
+      - !binary |-
+        X3BhcnNlX3Nlc3Npb249QkFoN0Jra2lEM05sYzNOcGIyNWZhV1FHT2daRlJp
+        SWxObVEyT1ROalpUQTBPV0U0WWpVNE5Ea3hOakUzTURJeU9EWTFOVFptTW1F
+        JTNELS0xYmM5MzE0Nzk0OTE5NmZmOGI2YmNkZjliNTM4ZWIyNzk1YTY3NjEy
+        OyBkb21haW49LnBhcnNlLmNvbTsgcGF0aD0vOyBleHBpcmVzPU1vbiwgMTYt
+        SmFuLTIwMjMgMTQ6NDA6MjAgR01UOyBzZWN1cmU7IEh0dHBPbmx5
+      !binary "U3RhdHVz":
+      - !binary |-
+        MjAwIE9L
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC42ODY4Mzg=
+      !binary "WC1VYS1Db21wYXRpYmxl":
+      - !binary |-
+        SUU9RWRnZSxjaHJvbWU9MQ==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        MTE3
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        a2VlcC1hbGl2ZQ==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJyZXN1bHRzIjpbeyJjcmVhdGVkQXQiOiIyMDEzLTAxLTE2VDE0OjQwOjE4
+        LjczN1oiLCJ1cGRhdGVkQXQiOiIyMDEzLTAxLTE2VDE0OjQwOjE4LjczN1oi
+        LCJvYmplY3RJZCI6ImFQRVRXWWZvQmkifV19
+    http_version: 
+  recorded_at: Wed, 16 Jan 2013 14:40:20 GMT
+recorded_with: VCR 2.0.1

data/fixtures/vcr_cassettes/test_include.yml

@@ -0,0 +1,180 @@
+--- 
+http_interactions: 
+- request: 
+    method: post
+    uri: https://api.parse.com/1/classes/Post
+    body: 
+      encoding: UTF-8
+      string: "{\"title\":\"foo\"}"
+    headers: 
+      Content-Type: 
+      - application/json
+      Accept: 
+      - application/json
+      User-Agent: 
+      - Parse for Ruby, 0.0
+      X-Parse-Master-Key: 
+      - ""
+      X-Parse-Rest-Api-Key: 
+      - jYdptjS76YHikuIFfJEgHD8UMIjH6cp2rWz4fo2C
+      X-Parse-Application-Id: 
+      - hnJRtntbYPvWfjqcqLZsdFaOKT0F3SfNU7Kc7woN
+      X-Parse-Session-Token: 
+      - ""
+      Expect: 
+      - ""
+  response: 
+    status: 
+      code: 201
+      message: Created
+    headers: 
+      Access-Control-Allow-Origin: 
+      - "*"
+      Access-Control-Request-Method: 
+      - "*"
+      Cache-Control: 
+      - no-cache
+      Content-Type: 
+      - application/json; charset=utf-8
+      Date: 
+      - Thu, 17 Jan 2013 17:13:34 GMT
+      Location: 
+      - https://api.parse.com/1/classes/Post/0ylGAv4qfA
+      Server: 
+      - nginx/1.2.2
+      Set-Cookie: 
+      - _parse_session=BAh7BkkiD3Nlc3Npb25faWQGOgZFRiIlYzliMjZiMzllZGFjMDA3Yzk5ZjE3ZjUwMDBlZGEwN2M%3D--f4d278f69aa2353017fa480914551a210a78d2c7; domain=.parse.com; path=/; expires=Tue, 17-Jan-2023 17:13:34 GMT; secure; HttpOnly
+      Status: 
+      - 201 Created
+      X-Runtime: 
+      - "0.072524"
+      X-Ua-Compatible: 
+      - IE=Edge,chrome=1
+      Content-Length: 
+      - "64"
+      Connection: 
+      - keep-alive
+    body: 
+      encoding: ASCII-8BIT
+      string: "{\"createdAt\":\"2013-01-17T17:13:34.358Z\",\"objectId\":\"0ylGAv4qfA\"}"
+    http_version: 
+  recorded_at: Thu, 17 Jan 2013 17:13:34 GMT
+- request: 
+    method: post
+    uri: https://api.parse.com/1/classes/Post
+    body: 
+      encoding: UTF-8
+      string: "{\"title\":\"bar\",\"other\":{\"__type\":\"Pointer\",\"className\":\"Post\",\"objectId\":\"0ylGAv4qfA\"}}"
+    headers: 
+      Content-Type: 
+      - application/json
+      Accept: 
+      - application/json
+      User-Agent: 
+      - Parse for Ruby, 0.0
+      X-Parse-Master-Key: 
+      - ""
+      X-Parse-Rest-Api-Key: 
+      - jYdptjS76YHikuIFfJEgHD8UMIjH6cp2rWz4fo2C
+      X-Parse-Application-Id: 
+      - hnJRtntbYPvWfjqcqLZsdFaOKT0F3SfNU7Kc7woN
+      X-Parse-Session-Token: 
+      - ""
+      Expect: 
+      - ""
+  response: 
+    status: 
+      code: 201
+      message: Created
+    headers: 
+      Access-Control-Allow-Origin: 
+      - "*"
+      Access-Control-Request-Method: 
+      - "*"
+      Cache-Control: 
+      - no-cache
+      Content-Type: 
+      - application/json; charset=utf-8
+      Date: 
+      - Thu, 17 Jan 2013 17:13:34 GMT
+      Location: 
+      - https://api.parse.com/1/classes/Post/i0HlajhFXX
+      Server: 
+      - nginx/1.2.2
+      Set-Cookie: 
+      - _parse_session=BAh7BkkiD3Nlc3Npb25faWQGOgZFRiIlMDExMzk3ZTdlOTEzNDEyYjMyZGZkZDE5MWY4MDY4YWE%3D--ec2534ca428c5a0c73ac3cf5634bcb7881447eef; domain=.parse.com; path=/; expires=Tue, 17-Jan-2023 17:13:34 GMT; secure; HttpOnly
+      Status: 
+      - 201 Created
+      X-Runtime: 
+      - "0.254273"
+      X-Ua-Compatible: 
+      - IE=Edge,chrome=1
+      Content-Length: 
+      - "64"
+      Connection: 
+      - keep-alive
+    body: 
+      encoding: ASCII-8BIT
+      string: "{\"createdAt\":\"2013-01-17T17:13:34.465Z\",\"objectId\":\"i0HlajhFXX\"}"
+    http_version: 
+  recorded_at: Thu, 17 Jan 2013 17:13:34 GMT
+- request: 
+    method: get
+    uri: https://api.parse.com/1/classes/Post?include=other&where=%7B%22objectId%22:%22i0HlajhFXX%22%7D
+    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: 
+      - jYdptjS76YHikuIFfJEgHD8UMIjH6cp2rWz4fo2C
+      X-Parse-Application-Id: 
+      - hnJRtntbYPvWfjqcqLZsdFaOKT0F3SfNU7Kc7woN
+      X-Parse-Session-Token: 
+      - ""
+      Expect: 
+      - ""
+  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: 
+      - Thu, 17 Jan 2013 17:13:35 GMT
+      Etag: 
+      - "\"0c16d470804a385fb35d9e40b4928e34\""
+      Server: 
+      - nginx/1.2.2
+      Set-Cookie: 
+      - _parse_session=BAh7BkkiD3Nlc3Npb25faWQGOgZFRiIlNDQ1NzVkYTExZTBjOTVlOWExOTQwNmNmZDFiZTE3NGU%3D--781e16e0634f86cdd9a44ba4baa2c12fe9a8d531; domain=.parse.com; path=/; expires=Tue, 17-Jan-2023 17:13:35 GMT; secure; HttpOnly
+      Status: 
+      - 200 OK
+      X-Runtime: 
+      - "0.269586"
+      X-Ua-Compatible: 
+      - IE=Edge,chrome=1
+      Content-Length: 
+      - "294"
+      Connection: 
+      - keep-alive
+    body: 
+      encoding: ASCII-8BIT
+      string: "{\"results\":[{\"title\":\"bar\",\"other\":{\"title\":\"foo\",\"createdAt\":\"2013-01-17T17:13:34.358Z\",\"updatedAt\":\"2013-01-17T17:13:34.358Z\",\"objectId\":\"0ylGAv4qfA\",\"__type\":\"Object\",\"className\":\"Post\"},\"createdAt\":\"2013-01-17T17:13:34.465Z\",\"updatedAt\":\"2013-01-17T17:13:34.465Z\",\"objectId\":\"i0HlajhFXX\"}]}"
+    http_version: 
+  recorded_at: Thu, 17 Jan 2013 17:13:35 GMT
+recorded_with: VCR 2.0.1

data/lib/parse/datatypes.rb

@@ -48,6 +48,10 @@ module Parse
     def get
       Parse.get @class_name, @parse_object_id if @parse_object_id
     end
+
+    def to_s
+      "#{@class_name}:#{@parse_object_id}"
+    end
   end
 
   # Date
@@ -294,6 +298,10 @@ module Parse
     def to_json(*a)
         as_json.to_json(*a)
     end
+
+    def to_s
+      "(#{latitude}, #{longitude})"
+    end
   end
 
   # File
@@ -334,4 +342,4 @@ module Parse
   end
 
 
-end
+end

data/lib/parse/error.rb

@@ -16,8 +16,10 @@ module Parse
 
     def initialize(response)
       @response = response
-      @code = response["code"]
-      @error = response["error"]
+      if response
+        @code = response["code"]
+        @error = response["error"]
+      end
 
       super("#{@code}: #{@error}")
     end

data/lib/parse/object.rb

@@ -133,6 +133,14 @@ module Parse
       as_json.to_json(*a)
     end
 
+    def to_s
+      "#{@class_name}:#{@parse_object_id} #{super}"
+    end
+
+    def inspect
+      "#{@class_name}:#{@parse_object_id} #{super}"
+    end
+
     # Update the fields of the local Parse object with the current
     # values from the API.
     def refresh
@@ -161,6 +169,10 @@ module Parse
       array_op(field, Protocol::KEY_ADD, value)
     end
 
+    def array_add_relation(field, value)
+      array_op(field, Protocol::KEY_ADD_RELATION, value)
+    end
+
     def array_add_unique(field, value)
       array_op(field, Protocol::KEY_ADD_UNIQUE, value)
     end
@@ -217,6 +229,9 @@ module Parse
       when Protocol::KEY_ADD
         self[field] ||= []
         self[field] << value
+      when Protocol::KEY_ADD_RELATION
+        self[field] ||= []
+        self[field] << value
       when Protocol::KEY_ADD_UNIQUE
         self[field] ||= []
         self[field] << value unless self[field].include?(value)
@@ -225,4 +240,4 @@ module Parse
       end
     end
   end
-end
+end

data/lib/parse/protocol.rb

@@ -65,6 +65,7 @@ module Parse
     # array ops
     KEY_OBJECTS     = "objects"
     KEY_ADD         = "Add"
+    KEY_ADD_RELATION= "AddRelation"
     KEY_ADD_UNIQUE  = "AddUnique"
     KEY_REMOVE      = "Remove"
 
@@ -73,8 +74,6 @@ module Parse
     # The JSON key used to identify the datatype of a special value.
     KEY_TYPE        = "__type"
 
-    TYPE_OBJECT     = "Object"
-
     # The JSON key used to specify the numerical value in the
     # increment/decrement API call.
     KEY_AMOUNT      = "amount"
@@ -90,6 +89,8 @@ module Parse
     # Operation name for decrementing an objects field value remotely
     OP_DECREMENT    = "Decrement"
 
+    # The data type name for special JSON objects representing a full object
+    TYPE_OBJECT     = "Object"
 
     # The data type name for special JSON objects representing a reference
     # to another Parse object.
@@ -170,4 +171,4 @@ module Parse
       "/#{VERSION}/#{BATCH_REQUEST_URI}"
     end
   end
-end
+end

data/lib/parse/query.rb

@@ -86,6 +86,11 @@ module Parse
       self
     end
 
+    def related_to(field,value)
+      h = {"object" => value, "key" => field} 
+      add_constraint("$relatedTo", h )
+    end
+
     def exists(field, value = true)
       add_constraint field, { "$exists" => value }
       self
@@ -131,11 +136,11 @@ module Parse
       query.merge!(:order => order_string)
     end
 
-    def merge_attribute(attribute, query)
+    def merge_attribute(attribute, query, query_field = nil)
       value = self.instance_variable_get("@#{attribute.to_s}")
       return if value.nil?
-      query.merge!(attribute => value)
+      query.merge!((query_field || attribute) => value)
     end
   end
 
-end
+end

data/lib/parse/util.rb

@@ -7,7 +7,6 @@ module Parse
   # @param class_name [Object]
   # @param obj [Object]
   def Parse.parse_json(class_name, obj)
-
     if obj.nil?
       nil
 
@@ -48,7 +47,7 @@ module Parse
       when Protocol::TYPE_FILE
         Parse::File.new obj
       when Protocol::TYPE_OBJECT # used for relation queries, e.g. "?include=post"
-        Parse::Object.new(obj[Parse::Protocol::KEY_CLASS_NAME], obj)
+        Parse::Object.new obj[Protocol::KEY_CLASS_NAME], Hash[obj.map{|k,v| [k, parse_json(nil, v)]}]
     end
   end
 end

data/parse-ruby-client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "parse-ruby-client"
-  s.version = "0.1.10"
+  s.version = "0.1.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alan deLevie", "Adam Alpern"]
-  s.date = "2013-01-12"
+  s.date = "2013-01-24"
   s.description = "A simple Ruby client for the parse.com REST API"
   s.email = "adelevie@gmail.com"
   s.extra_rdoc_files = [
@@ -25,7 +25,9 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "example.rb",
+    "features.md",
     "fixtures/vcr_cassettes/test_array_add.yml",
+    "fixtures/vcr_cassettes/test_array_add_relation.yml",
     "fixtures/vcr_cassettes/test_batch_create_object.yml",
     "fixtures/vcr_cassettes/test_batch_delete_object.yml",
     "fixtures/vcr_cassettes/test_batch_run.yml",
@@ -35,6 +37,7 @@ Gem::Specification.new do |s|
     "fixtures/vcr_cassettes/test_deep_parse.yml",
     "fixtures/vcr_cassettes/test_destroy.yml",
     "fixtures/vcr_cassettes/test_get.yml",
+    "fixtures/vcr_cassettes/test_include.yml",
     "fixtures/vcr_cassettes/test_new_model.yml",
     "fixtures/vcr_cassettes/test_new_object.yml",
     "fixtures/vcr_cassettes/test_nils_delete_keys.yml",

data/test/test_object.rb

@@ -122,4 +122,22 @@ class TestObject < Test::Unit::TestCase
       assert_equal ["hello", "goodbye"], post["chapters"]
     end
   end
+
+  def test_array_add_relation
+    VCR.use_cassette('test_array_add_relation', :record => :new_episodes) do
+      post = Parse::Object.new "Post"
+      post.save
+
+      comment = Parse::Object.new "Comment"
+      comment.save
+
+      post.array_add_relation("comments", comment.pointer)
+      post.save
+      
+      q = Parse::Query.new("Comment")
+      q.related_to("comments", post.pointer)
+      comments = q.get
+      assert_equal comments.first["objectId"], comment["objectId"] 
+    end
+  end
 end

data/test/test_query.rb

@@ -30,6 +30,16 @@ class TestQuery < Test::Unit::TestCase
     assert_equal q.where["player"], { "$regex" => "regex voodoo"}
   end
 
+  def test_related_to
+    q = Parse::Query.new "Comment"
+    pointer = Parse::Pointer.new(class_name: "Post", parse_object_id: '1234')
+    q.related_to("comments", pointer)
+
+    assert_not_nil q.where["$relatedTo"]
+    assert_equal pointer, q.where["$relatedTo"]["object"]
+    assert_equal q.where["$relatedTo"]["key"], "comments"
+  end
+
   def test_eq
     q = Parse::Query.new "TestQuery"
     q.eq("points", 5)
@@ -59,6 +69,25 @@ class TestQuery < Test::Unit::TestCase
     end
   end
 
+  def test_include
+    VCR.use_cassette('test_include', :record => :new_episodes) do
+      post_1 = Parse::Object.new "Post"
+      post_1['title'] = 'foo'
+      post_1.save
+
+      post_2 = Parse::Object.new "Post"
+      post_2['title'] = 'bar'
+      post_2['other'] = post_1.pointer
+      post_2.save
+
+      q = Parse::Query.new "Post"
+      q.eq('objectId', post_2.parse_object_id)
+      q.include = 'other'
+
+      assert_equal 'foo', q.get.first['other']['title']
+    end
+  end
+
   def test_or
     #VCR.use_cassette('test_or', :record => :new_episodes) do
       foo = Parse::Object.new "Post"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parse-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-12 00:00:00.000000000 Z
+date: 2013-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: patron
@@ -172,7 +172,9 @@ files:
 - Rakefile
 - VERSION
 - example.rb
+- features.md
 - fixtures/vcr_cassettes/test_array_add.yml
+- fixtures/vcr_cassettes/test_array_add_relation.yml
 - fixtures/vcr_cassettes/test_batch_create_object.yml
 - fixtures/vcr_cassettes/test_batch_delete_object.yml
 - fixtures/vcr_cassettes/test_batch_run.yml
@@ -182,6 +184,7 @@ files:
 - fixtures/vcr_cassettes/test_deep_parse.yml
 - fixtures/vcr_cassettes/test_destroy.yml
 - fixtures/vcr_cassettes/test_get.yml
+- fixtures/vcr_cassettes/test_include.yml
 - fixtures/vcr_cassettes/test_new_model.yml
 - fixtures/vcr_cassettes/test_new_object.yml
 - fixtures/vcr_cassettes/test_nils_delete_keys.yml
@@ -237,7 +240,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1980852008607816263
+      hash: 4089803935142513409
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: