parse-ruby-client 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  # - rbx-19mode # currently in active development, may or may not work for your project
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/README.md

@@ -15,16 +15,37 @@ This currently depends on the gems 'json' and 'patron' for JSON support and HTTP
 
 # Getting Started
 
+## Installation
+
+`gem "parse-ruby-client", "~> 0.0.3"`
+
 ---
 
 To get started, load the parse.rb file and call Parse.init to initialize the client object with
 your application ID and API key values, which you can obtain from the parse.com dashboard.
 
 ```ruby
+require 'parse-ruby-client'
+
 Parse.init :application_id => "<your_app_id>",
            :api_key        => "<your_api_key>"
 ```
 
+If you don't like pasting this stuff in every time you fire up irb, save your api keys to `.bash_profile` or similar:
+
+```bash
+export PARSE_APPLICATION_ID="12345678"
+export PARSE_REST_API_KEY="ABCDEFGH"
+```
+
+Now you can just do this:
+
+```ruby
+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.
+
 ## Creating and Saving Objects
 
 Create an instance of ```Parse::Object``` with your class name supplied as a string, set some keys, and call ```save()```.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/parse/client.rb

@@ -18,6 +18,7 @@ module Parse
       @application_id = data[:application_id]
       @api_key        = data[:api_key]
       @session        = Patron::Session.new
+      @session.timeout = 10
 
       @session.base_url                 = "https://#{host}"
       @session.headers["Content-Type"]  = "application/json"
@@ -42,9 +43,9 @@ module Parse
 
       response = @session.request(method, uri, {}, options)
       if response.status >= 400
-        raise ParseProtocolError, response
+        raise ParseError, "#{JSON.parse(response.body)['code']}: #{JSON.parse(response.body)['error']}"
       else
-        if response.body
+        if response
           return JSON.parse response.body
         end
       end
@@ -79,9 +80,15 @@ module Parse
   # Initialize the singleton instance of Client which is used
   # by all API methods. Parse.init must be called before saving
   # or retrieving any objects.
-  def Parse.init(data)
+  def Parse.init(data = {:application_id => ENV["PARSE_APPLICATION_ID"], :api_key => ENV["PARSE_REST_API_KEY"]})
     @@client = Client.new(data)
   end
+  
+  # Used mostly for testing. Lets you delete the api key global vars.
+  def Parse.destroy
+    @@client = nil
+    self
+  end
 
   def Parse.client
     if !@@client

data/lib/parse/datatypes.rb

@@ -60,15 +60,77 @@ module Parse
 
     def initialize(data)
       bytes = data["base64"]
-      value = Base64.decode(bytes)
+      @value = Base64.decode64(bytes)
     end
 
     def to_json(*a)
       {
           Protocol::KEY_TYPE => Protocol::TYPE_BYTES,
-          "base64" => Base64.encode(@value)
+          "base64" => Base64.encode64(@value)
       }.to_json(*a)
     end
   end
+  
+  # Increment and Decrement
+  # ------------------------------------------------------------
+  
+  class Increment
+    # '{"score": {"__op": "Increment", "amount": 1 } }'
+    attr_accessor :amount
+    
+    def initialize(amount)
+      @amount = amount
+    end
+    
+    def to_json(*a)
+      {
+          Protocol::KEY_OP => Protocol::KEY_INCREMENT,
+          Protocol::KEY_AMOUNT => @amount
+      }.to_json(*a)
+    end
+  end
+  
+  class Decrement
+    # '{"score": {"__op": "Decrement", "amount": 1 } }'
+    attr_accessor :amount
+    
+    def initialize(amount)
+      @amount = amount
+    end
+    
+    def to_json(*a)
+      {
+          Protocol::KEY_OP => Protocol::KEY_DECREMENT,
+          Protocol::KEY_AMOUNT => @amount
+      }.to_json(*a)
+    end
+  end
+  
+  # GeoPoint
+  # ------------------------------------------------------------
+  
+  class GeoPoint
+    # '{"location": {"__type":"GeoPoint", "latitude":40.0, "longitude":-30.0}}'
+    attr_accessor :longitude, :latitude
+    
+    def initialize(data)
+      @longitude = data["longitude"]
+      @latitude  = data["latitude"]
+      
+      if !@longitude && !@latitude
+        @longitude = data[:longitude]
+        @latitude  = data[:latitude]
+      end
+    end
+    
+    def to_json(*a)
+      {
+          Protocol::KEY_TYPE => Protocol::TYPE_GEOPOINT,
+          "latitude" => @latitude,
+          "longitude" => @longitude
+      }.to_json(*a)
+    end
+  end
+  
 
 end

data/lib/parse/error.rb

@@ -3,7 +3,7 @@ module Parse
   # Base exception class for errors thrown by the Parse
   # client library. ParseError will be raised by any
   # network operation if Parse.init() has not been called.
-  class ParseError < Exception
+  class ParseError < StandardError #Exception ... why? A:http://www.skorks.com/2009/09/ruby-exceptions-and-exception-handling/
   end
 
   # An exception class raised when the REST API returns an error.
@@ -15,12 +15,14 @@ module Parse
     attr_accessor :response
 
     def initialize(response)
-      @response = response
-      if response.body
-        data = JSON.parse response.body
-        @code = data["code"]
-        @message = data["error"]
-      end
+      #@response = response
+      #if response.body
+      #  data = JSON.parse response.body
+      #  @code = data["code"]
+      #  @message = data["error"]
+      #end
+      
+      #{}"#{@code}: #{@message}"
     end
   end
   

data/lib/parse/object.rb

@@ -28,7 +28,7 @@ module Parse
 
     # Merge a hash parsed from the JSON representation into
     # this instance. This will extract the reserved fields,
-    # merge the hash keys, and then insure that the reserved
+    # merge the hash keys, and then ensure that the reserved
     # fields do not occur in the underlying hash storage.
     def parse(data)
       if !data
@@ -45,14 +45,16 @@ module Parse
         @updated_at = DateTime.parse data[Protocol::KEY_UPDATED_AT]
       end
 
-			data.each { |k,v|
-				if k.is_a? Symbol
-					k = k.to_s
-				end
-				if !Protocol::RESERVED_KEYS.include? k
-					self[k] = v
-				end
-			}
+      self.merge! data
+
+			#data.each { |k,v|
+			#	if k.is_a? Symbol
+			#		k = k.to_s
+			#	end
+			#	if !Protocol::RESERVED_KEYS.include? k
+			#		self[k] = v
+			#	end
+			#}
     end
     private :parse
 
@@ -61,6 +63,7 @@ module Parse
     # a new object, otherwise it will update the existing stored object.
     def save
       method   = @parse_object_id ? :put : :post
+      Protocol::RESERVED_KEYS.each { |k| self.delete(k) }
       body     = self.to_json
 
       data = Parse.client.request(self.uri, method, body)
@@ -92,26 +95,34 @@ module Parse
 
     # Increment the given field by an amount, which defaults to 1.
     def increment(field, amount = 1)
-      value = (self[field] || 0) + amount
-      self[field] = value
-      if !@parse_object_id
-        # TODO - warn that the object must be stored first
-        return nil
-      end
-
-      if amount != 0
-        op = amount > 0 ? Protocol::OP_INCREMENT : Protocol::OP_DECREMENT
-        body = "{\"#{field}\": {\"#{Protocol::KEY_OP}\": \"#{op}\", \"#{Protocol::KEY_AMOUNT}\" : #{amount.abs}}}"
-        data = Parse.client.request( self.uri, :put, body)
-        parse data
-      end
+      #value = (self[field] || 0) + amount
+      #self[field] = value
+      #if !@parse_object_id
+      #  # TODO - warn that the object must be stored first
+      #  return nil
+      #end
+
+      #if amount != 0
+      #  op = amount > 0 ? Protocol::OP_INCREMENT : Protocol::OP_DECREMENT
+      #  body = "{\"#{field}\": {\"#{Protocol::KEY_OP}\": \"#{op}\", \"#{Protocol::KEY_AMOUNT}\" : #{amount.abs}}}"
+      #  data = Parse.client.request( self.uri, :put, body)
+      #  parse data
+      #end
+      #self
+      body = {field => Parse::Increment.new(amount)}.to_json
+      data = Parse.client.request(self.uri, :put, body)
+      parse data
       self
     end
 
     # Decrement the given field by an amount, which defaults to 1.
     # A synonym for increment(field, -amount).
     def decrement(field, amount = 1)
-      increment field, -amount
+      #increment field, -amount
+      body = {field => Parse::Decrement.new(amount)}.to_json
+      data = Parse.client.request(self.uri, :put, body)
+      parse data
+      self
     end
 
   end

data/lib/parse/protocol.rb

@@ -49,6 +49,8 @@ module Parse
     # The JSON key used to identify an operator in the increment/decrement
     # API call.
     KEY_OP          = "__op"
+    KEY_INCREMENT   = "Increment"
+    KEY_DECREMENT   = "Decrement"
 
     # The JSON key used to identify the datatype of a special value.
     KEY_TYPE        = "__type"

data/lib/parse/query.rb

@@ -24,7 +24,7 @@ module Parse
         where[field] = constraint
       end
     end
-    private :add_constraint
+    #private :add_constraint
 
     def eq(field, value)
       add_constraint field, value

data/parse-ruby-client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "parse-ruby-client"
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alan deLevie", "Adam Alpern"]
-  s.date = "2012-02-05"
+  s.date = "2012-02-20"
   s.description = "A simple Ruby client for the parse.com REST API"
   s.email = "adelevie@gmail.com"
   s.extra_rdoc_files = [
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -34,11 +35,14 @@ Gem::Specification.new do |s|
     "lib/parse/util.rb",
     "parse-ruby-client.gemspec",
     "pkg/parse-ruby-client-0.0.1.gem",
+    "pkg/parse-ruby-client-0.0.2.gem",
     "pkg/parse-ruby-client-1-0.0.1.gem",
     "pkg/parse-ruby-client.gem",
     "test/helper.rb",
     "test/test_client.rb",
-    "test/test_parse-ruby-client.rb"
+    "test/test_datatypes.rb",
+    "test/test_init.rb",
+    "test/test_query.rb"
   ]
   s.homepage = "http://github.com/adelevie/parse-ruby-client"
   s.licenses = ["MIT"]

data/test/test_client.rb

@@ -1,7 +1,32 @@
 require 'helper'
 
 class TestClient < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  def setup
+    Parse.init
+  end
+  
+  def test_simple_save
+    test_save = Parse::Object.new "TestSave"
+    test_save["foo"] = "bar"
+    test_save.save
+
+    assert_equal test_save["foo"], "bar"
+    assert_equal test_save[Parse::Protocol::KEY_CREATED_AT].class, String
+    assert_equal test_save[Parse::Protocol::KEY_OBJECT_ID].class, String
+  end
+  
+  def test_update
+    foo = Parse::Object.new "TestSave"
+    foo["age"] = 20
+    foo.save
+    
+    assert_equal foo["age"], 20
+    assert_equal foo[Parse::Protocol::KEY_UPDATED_AT], nil
+    
+    foo["age"] = 40
+    foo.save
+    
+    assert_equal foo["age"], 40
+    assert_equal foo[Parse::Protocol::KEY_UPDATED_AT].class, String
   end
 end

data/test/test_datatypes.rb

@@ -0,0 +1,60 @@
+require 'helper'
+
+class TestDatatypes < Test::Unit::TestCase
+  def test_pointer
+    data = {
+      Parse::Protocol::KEY_CLASS_NAME => "DatatypeTestClass",
+      Parse::Protocol::KEY_OBJECT_ID => "12345abcd"
+    }
+    p = Parse::Pointer.new data
+    
+    assert_equal p.to_json, "{\"__type\":\"Pointer\",\"#{Parse::Protocol::KEY_CLASS_NAME}\":\"DatatypeTestClass\",\"#{Parse::Protocol::KEY_OBJECT_ID}\":\"12345abcd\"}" 
+  end
+  
+  def test_date
+    date_time = DateTime.now
+    data = date_time
+    parse_date = Parse::Date.new data
+    
+    assert_equal parse_date.value, date_time
+    assert_equal JSON.parse(parse_date.to_json)["iso"], date_time.iso8601
+  end
+  
+  def test_bytes
+    data = {
+      "base64" => Base64.encode64("testing bytes!")
+    }
+    byte = Parse::Bytes.new data
+
+    assert_equal byte.value, "testing bytes!"
+    assert_equal JSON.parse(byte.to_json)[Parse::Protocol::KEY_TYPE], Parse::Protocol::TYPE_BYTES
+    assert_equal JSON.parse(byte.to_json)["base64"], Base64.encode64("testing bytes!")
+  end
+  
+  def test_increment
+    amount = 5
+    increment = Parse::Increment.new amount
+    
+    assert_equal increment.to_json, "{\"__op\":\"Increment\",\"amount\":#{amount}}"
+  end
+  
+  def test_decrement
+    amount = 5
+    increment = Parse::Decrement.new amount
+    
+    assert_equal increment.to_json, "{\"__op\":\"Decrement\",\"amount\":#{amount}}"
+  end
+  
+  def test_geopoint
+    # '{"location": {"__type":"GeoPoint", "latitude":40.0, "longitude":-30.0}}'
+    data = {
+      "longitude" => 40.0,
+      "latitude" => -30.0
+    }
+    gp = Parse::GeoPoint.new data
+    
+    assert_equal JSON.parse(gp.to_json)["longitude"], data["longitude"] 
+    assert_equal JSON.parse(gp.to_json)["latitude"], data["latitude"]
+    assert_equal JSON.parse(gp.to_json)[Parse::Protocol::KEY_TYPE], Parse::Protocol::TYPE_GEOPOINT
+  end
+end

data/test/test_init.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+#Parse.init :application_id => $PARSE_APPLICATION_ID, :api_key => $PARSE_REST_API_KEY
+
+class TestInit < Test::Unit::TestCase
+  def setup
+    Parse.destroy
+  end
+  
+  def test_no_api_keys_error
+    fake = Parse::Object.new "shouldNeverExist"
+    fake["foo"] = "bar"
+    
+    begin
+      fake.save
+    rescue
+      error_triggered = true
+    end
+    
+    assert_equal error_triggered, true
+    assert_equal fake[Parse::Protocol::KEY_OBJECT_ID], nil
+  end
+end

data/test/test_query.rb

@@ -0,0 +1,26 @@
+require 'helper'
+
+Parse.init
+
+class TestQuery < Test::Unit::TestCase
+  def test_add_contraint
+    # I know this method *should* be private.
+    # But then it would be a PITA to test.
+    # I'd rather test this one method than pointlessly test many others.
+    # Thus is life.
+
+    q = Parse::Query.new "TestQuery"
+    q.add_constraint("points", 5)
+    assert_equal q.where["points"], 5
+    q.add_constraint("player", { "$regex" => "regex voodoo"})
+    assert_equal q.where["player"], { "$regex" => "regex voodoo"}
+  end
+  
+  def test_eq
+    q = Parse::Query.new "TestQuery"
+    q.eq("points", 5)
+    assert_equal q.where, {"points" => 5}
+    q.eq("player", "michael@jordan.com")
+    assert_equal q.where, {"points" =>  5, "player" => "michael@jordan.com"}
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parse-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-05 00:00:00.000000000Z
+date: 2012-02-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: patron
-  requirement: &70137258765420 !ruby/object:Gem::Requirement
+  requirement: &70330439891380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70137258765420
+  version_requirements: *70330439891380
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70137258764800 !ruby/object:Gem::Requirement
+  requirement: &70330439890500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70137258764800
+  version_requirements: *70330439890500
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70137258740360 !ruby/object:Gem::Requirement
+  requirement: &70330439889720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70137258740360
+  version_requirements: *70330439889720
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70137258739700 !ruby/object:Gem::Requirement
+  requirement: &70330439889080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70137258739700
+  version_requirements: *70330439889080
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70137258738920 !ruby/object:Gem::Requirement
+  requirement: &70330439888560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,7 +66,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70137258738920
+  version_requirements: *70330439888560
 description: A simple Ruby client for the parse.com REST API
 email: adelevie@gmail.com
 executables: []
@@ -75,6 +75,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -92,11 +93,14 @@ files:
 - lib/parse/util.rb
 - parse-ruby-client.gemspec
 - pkg/parse-ruby-client-0.0.1.gem
+- pkg/parse-ruby-client-0.0.2.gem
 - pkg/parse-ruby-client-1-0.0.1.gem
 - pkg/parse-ruby-client.gem
 - test/helper.rb
 - test/test_client.rb
-- test/test_parse-ruby-client.rb
+- test/test_datatypes.rb
+- test/test_init.rb
+- test/test_query.rb
 homepage: http://github.com/adelevie/parse-ruby-client
 licenses:
 - MIT
@@ -112,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1562453630510493430
+      hash: -4138204071645448362
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/test/test_parse-ruby-client.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestParseRubyClient < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end