parsecom 0.3.0 → 0.4.0

data/README.md

@@ -42,15 +42,16 @@ Yet-Another Parse.com Library written in Pure Ruby
       - [Uploading Files](#uploading-files)
       - [Associating with Objects](#associating-with-objects)
       - [Deleting Files](#deleting-files)
-    - [Analytics](#analytics)
-      - [TBD](#tbd-2)
-    - [Push Notifications](#push-notifications)
-      - [TBD](#tbd-3)
     - [Installations](#installations)
-      - [TBD](#tbd-4)
+      - [Uploading Installation Data](#uploading-installation-data)
+      - [Retrieving Installations](#retrieving-installations)
+      - [Updating Installations](#updating-installations)
+      - [Querying Installations](#querying-installations)
+      - [Deleting Installations](#deleting-installations)
     - [Cloud Functions](#cloud-functions)
     - [GeoPoints](#geopoints)
-      - [TBD](#tbd-5)
+      - [GeoPoint](#geopoint)
+      - [Geo Queries](#geo-queries)
     - [Security](#security)
 
 ## Usage
@@ -345,7 +346,7 @@ game_scores = GameScore.find :where => proc {
 
 #### Counting Objects
 
-##### TBD
+TBD
 
 #### Compound Queries
 
@@ -404,7 +405,7 @@ user.delete
 
 #### Linking Users
 
-##### TBD
+TBD
 
 ### Roles
 
@@ -487,15 +488,47 @@ file.delete!
 
 ### Analytics
 
-#### TBD
+TBD
 
 ### Push Notifications
 
-#### TBD
+TBD
 
 ### Installations
 
-#### TBD
+#### Uploading Installation Data
+
+```ruby
+installation = Parse::Installation.new :deviceType => 'ios', :deviceToken => '0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef', :channels => ['']
+installation.save
+```
+
+#### Retrieving Installations
+
+```ruby
+installation = Parse::Installation.find_by_id :mrmBZvsErB
+```
+
+#### Updating Installations
+
+```ruby
+installation = Parse::Installation.find_by_id :mrmBZvsErB
+installation.channels = ['', 'foo']
+installation.save
+```
+
+#### Querying Installations
+
+```ruby
+installations = Parse::Installation.find! :all
+```
+
+#### Deleting Installations
+
+```ruby
+installation = Parse::Installation.find_by_id :mrmBZvsErB
+installation.delete!
+```
 
 ### Cloud Functions
 
@@ -506,7 +539,36 @@ client.hello
 
 ### GeoPoints
 
-#### TBD
+#### GeoPoint
+
+```ruby
+geo_point = Parse::GeoPoint.new :latitude => 40.0, :longitude => -30.0
+place = PlaceObject.new :location => geo_point
+```
+
+#### Geo Queries
+
+```ruby
+place = PlaceObject.find :limit => 10, :where => proc {
+  geo_point = Parse::GeoPoint.new :latitude => 30.0, :longitude => -20.0
+  column(:location).near_sphere geop_point
+}
+```
+
+```ruby
+places = PlaceObject.find :limit => 10, :where => proc {
+  geo_point = Parse::GeoPoint.new :latitude => 30.0, :longitude => -20.0
+  column(:location).near_sphere(geop_point).max_distance_in_miles(10.0)
+}
+```
+
+```ruby
+places = PizzaPlaceObject.find :limit => 10, :where => proc {
+  southwest = Parse::GeoPoint.new :latitude => 37.71, :longitude => -122.53
+  northeast = Parse::GeoPoint.new :latitude => 30.82, :longitude => -122.37
+  column(:location).within(southwest, northeast)
+}
+```
 
 ### Security
 

data/lib/parse/client.rb

@@ -29,11 +29,8 @@ module Parse
     end
 
     def canonical_endpoint endpoint
-      case endpoint
-      when %r|/#{API_VERSION}/classes/_User|
-        endpoint.sub %r|/#{API_VERSION}/classes/_User|, "/#{API_VERSION}/users"
-      when %r|/#{API_VERSION}/classes/_Role|
-        endpoint.sub %r|/#{API_VERSION}/classes/_Role|, "/#{API_VERSION}/roles"
+      if endpoint =~ %r</#{API_VERSION}/classes/_(User|Role|Installation)>
+        endpoint.sub %r</#{API_VERSION}/classes/_(User|Role|Installation)>, "/#{API_VERSION}/#{$1.downcase}s"
       else
         endpoint
       end

data/lib/parse/file.rb

@@ -1,10 +1,13 @@
 # encoding:utf-8
 module Parse
   class File
+    include Util
+
     attr_accessor :name, :url, :content, :type
 
     def initialize hash
-      @name = hash['name'] || hash[:name]
+      hash = string_keyed_hash hash
+      @name = hash['name']
       raise 'name is mandatory' unless @name
       @url = hash['url']
       @content = hash['content']

data/lib/parse/geo_point.rb

@@ -0,0 +1,26 @@
+# coding:utf-8
+module Parse
+  class GeoPoint
+    include Util
+
+    attr_accessor :latitude, :longitude
+
+    def initialize hash={}
+      hash = string_keyed_hash hash
+      @latitude = hash['latitude']
+      @longitude = hash['longitude']
+    end
+
+    def to_h
+      {
+        "__type" => "GeoPoint",
+        "latitude" => @latitude,
+        "longitude" => @longitude
+      }
+    end
+
+    def to_json *args
+      to_h.to_json
+    end
+  end
+end

data/lib/parse/installation.rb

@@ -1,6 +1,10 @@
 # coding:utf-8
 module Parse
   class Installation < Object
-    # TODO
+    class << self
+      def parse_class_name
+        '_Installation'
+      end
+    end
   end
 end

data/lib/parse/object.rb

@@ -7,6 +7,8 @@ module Parse
   }
 
   class Object
+    include Parse::Util
+
     @@parse_class_vs_class_table = {}
 
     class << self
@@ -97,6 +99,8 @@ module Parse
               Parse::Pointer.new v, self
             when 'Relation'
               Parse::Relation.new self, k, v
+            when 'GeoPoint'
+              Parse::GeoPoint.new v
             else
               v
             end
@@ -241,14 +245,6 @@ module Parse
 
     private
 
-    def string_keyed_hash hash
-      new_hash = {}
-      hash.each do |k, v|
-        new_hash[k.to_s] = v
-      end
-      new_hash
-    end
-
     def check_deleted!
       raise 'This object has already been deleted.' if deleted?
     end

data/lib/parse/query.rb

@@ -236,6 +236,33 @@ module Parse
         @query.where.push or_cond
       end
 
+      # conditions for GeoPoints
+
+      def near_sphere geo_point
+        @conditions.push ['$nearSphere', geo_point]
+        self
+      end
+
+      def max_distance_in_miles miles
+        @conditions.push ['$maxDistanceInMiles', miles]
+        self
+      end
+
+      def max_distance_in_kilometers kilometers
+        @conditions.push ['$maxDistanceInKilometers', kilometers]
+        self
+      end
+
+      def max_distance_in_radians radians
+        @conditions.push ['$maxDistanceInRadians', radians]
+        self
+      end
+
+      def within southwest_geo_point, northeast_geo_point
+        @conditions.push WithinCondition.new(southwest_geo_point, northeast_geo_point)
+        self
+      end
+
       def to_s
         if @conditions.size == 1 && !@conditions[0].is_a?(Array)
           "#{@column_name.to_s.inspect}:#{condition_to_s @conditions[0]}"
@@ -253,8 +280,11 @@ module Parse
         case val
         when Parse::Object
           %Q|{"__type":"Pointer","className":"#{val.parse_class_name}","objectId":"#{val.parse_object_id}"}|
+        when Parse::GeoPoint
+          val.to_json
         else
           val.inspect
+          #val.to_json
         end
       end
 
@@ -293,6 +323,17 @@ module Parse
         %Q|"$relatedTo":{"object":#{@pointer.to_json},"key":"#{@column_name}"}|
       end
     end
+
+    class WithinCondition
+      def initialize southwest_geo_point, northeast_geo_point
+        @southwest_geo_point = southwest_geo_point
+        @northeast_geo_point = northeast_geo_point 
+      end
+
+      def to_s
+        %Q|{"$within":{"$box":[#{@southwest_geo_point.to_json},#{@northeast_geo_point.to_json}]}}|
+      end
+    end
   end
 
   def Query parse_class_name=nil

data/lib/parse/util.rb

@@ -0,0 +1,11 @@
+module Parse
+  module Util
+    def string_keyed_hash hash
+      new_hash = {}
+      hash.each do |k, v|
+        new_hash[k.to_s] = v
+      end
+      new_hash
+    end
+  end
+end

data/lib/parse/version.rb

@@ -1,3 +1,3 @@
 module Parse
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/parsecom.rb

@@ -8,6 +8,7 @@ require 'date'
 require 'net/https'
 require 'uri'
 require 'parse/ext/string'
+require 'parse/util'
 require 'parse/http_client'
 require 'parse/client'
 require 'parse/query'
@@ -16,6 +17,7 @@ require 'parse/object'
 require 'parse/user'
 require 'parse/role'
 require 'parse/installation'
+require 'parse/geo_point'
 require 'parse/pointer'
 require 'parse/relation'
 require 'parse/file'

data/spec/parse_query_spec.rb

@@ -132,6 +132,26 @@ describe Parse::Query, 'when it builds conditions' do
     end
     query.to_params.should have_params('where' => '{"$or":[{"wins":{"$gt":150}},{"wins":{"$lt":5}},{"loses":{"$lt":5}}]}')
     query.where.clear
+
+    geo_point1 = Parse::GeoPoint.new :latitude => 12, :longitude => 34
+    geo_point2 = Parse::GeoPoint.new :latitude => 56, :longitude => 78
+    query.where do
+      column(:location).near_sphere(geo_point1)
+    end
+    query.to_params.should have_params('where' => '{"location":{"$nearSphere":{"__type":"GeoPoint","latitude":12,"longitude":34}}}')
+    query.where.clear
+
+    query.where do
+      column(:location).near_sphere(geo_point1).max_distance_in_miles(10)
+    end
+    query.to_params.should have_params('where' => '{"location":{"$nearSphere":{"__type":"GeoPoint","latitude":12,"longitude":34},"$maxDistanceInMiles":10}}')
+    query.where.clear
+
+    query.where do
+      column(:location).within(geo_point1, geo_point2)
+    end
+    query.to_params.should have_params('where' => '{"location":{"$within":{"$box":[{"__type":"GeoPoint","latitude":12,"longitude":34},{"__type":"GeoPoint","latitude":56,"longitude":78}]}}}')
+    query.where.clear
   end
   
   it 'should build a correct "order" parameter' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parsecom
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-19 00:00:00.000000000 Z
+date: 2013-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -79,6 +79,7 @@ files:
 - lib/parse/cloud_code.rb
 - lib/parse/ext/string.rb
 - lib/parse/file.rb
+- lib/parse/geo_point.rb
 - lib/parse/http_client.rb
 - lib/parse/installation.rb
 - lib/parse/object.rb
@@ -94,6 +95,7 @@ files:
 - lib/parse/relation.rb
 - lib/parse/role.rb
 - lib/parse/user.rb
+- lib/parse/util.rb
 - lib/parse/version.rb
 - lib/parsecom.rb
 - parsecom.gemspec