parse-stack 1.6.13 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1be0d0741ab2d2b2c1fb6113f3b4763dfd6d6b1d
-  data.tar.gz: 83ebaed1bfae4f8a86291bdc23eda363a852f29b
+  metadata.gz: 48e731586682a18f7800110c166f20536c46b717
+  data.tar.gz: e5cd663b12a7935acb772ff881ca471709de076b
 SHA512:
-  metadata.gz: 2a54f519b4aa5561cfa10b6d514024f664652c0614c2291e6e57c9921bb9356e8038618e17fbbe22bc7c5c258d83cad3ff4d3ca5cafe79adb24c804bc7442cb7
-  data.tar.gz: c398da3567d2b00d506823cb9edc4a2ee064d6f685db654b460655358bf7ade01d4f5b9364ebae4869b0eed9171096832750ef9f70829fe41ae4dec0aa7d2b6f
+  metadata.gz: 79a487df290f8e3f7efc843b8f7b079fccd5dee56e52f3821a20f75f3b391675da33ce03e23a01ed9c442305017d2cee5e1d6dcfb52074bca218ee5f8f986044
+  data.tar.gz: b54958ad9b82dd8fddc10b6c1701e20eea11701482d27403cc92c41e4db883573feb77a9ab17915738092b940ee319a6b6c394f7afa6d7360790d1b916d524b9

data/Changes.md

@@ -1,5 +1,12 @@
 ## Parse-Stack Changelog
 
+### 1.7.0
+- NEW: You can use `set_default_acl` to set default ACLs for your subclasses.
+- NEW: Support for `withinPolygon` query constraint.
+- Refactoring of the default ACL system and deprecation of `Parse::Object.acl`
+- Parse::ACL.everyone returns an ACL instance with public read and writes.
+- Documentation updates.
+
 ### 1.6.12
 - NEW: Parse.use_shortnames! to utilize shorter class methods. (optional)
 - NEW: parse-console supports `--url` option to load config from JSON url.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    parse-stack (1.6.13)
+    parse-stack (1.7.0)
       active_model_serializers (>= 0.9, < 1)
       activemodel (>= 4.2.1, < 6)
       activesupport (>= 4.2.1, < 6)

data/README.md

@@ -2,9 +2,9 @@
 
 # Parse Stack - The Parse Server Ruby Client SDK
 
-[Parse Stack](https://github.com/modernistik/parse-stack) is the [Parse Server](https://github.com/ParsePlatform/parse-server) SDK, REST Client and ORM framework for [Ruby](https://www.ruby-lang.org/en/). It provides a client adapter, a query engine, an object relational mapper (ORM) and a Cloud Code Webhooks rack application.
+[Parse Stack](https://github.com/modernistik/parse-stack) is the [Parse Server](http://parseplatform.org/) SDK, REST Client and ORM framework for [Ruby](https://www.ruby-lang.org/en/). It provides a client adapter, a query engine, an object relational mapper (ORM) and a Cloud Code Webhooks rack application.
 
-Below is a [quick start guide](https://github.com/modernistik/parse-stack#overview), but you can also check out the full *[API Reference](https://www.modernistik.com/gems/parse-stack/)* for more detailed information about our Parse Server SDK.
+Below is a [quick start guide](https://github.com/modernistik/parse-stack#overview), but you can also check out the full *[API Reference](https://www.modernistik.com/gems/parse-stack/index.html)* for more detailed information about our Parse Server SDK.
 
 #### Tutorial Videos
 1. Getting Started: https://youtu.be/zoYSGmciDlQ
@@ -15,7 +15,7 @@ Below is a [quick start guide](https://github.com/modernistik/parse-stack#overvi
 [![Gem Version](https://img.shields.io/gem/v/parse-stack.svg)](https://github.com/modernistik/parse-stack)
 [![Downloads](https://img.shields.io/gem/dt/parse-stack.svg)](https://rubygems.org/gems/parse-stack)
 [![Build Status](https://travis-ci.org/modernistik/parse-stack.svg?branch=master)](https://travis-ci.org/modernistik/parse-stack)
-[![API Reference](http://img.shields.io/badge/api-docs-blue.svg)](https://www.modernistik.com/gems/parse-stack/)
+[![API Reference](http://img.shields.io/badge/api-docs-blue.svg)](https://www.modernistik.com/gems/parse-stack/index.html)
 
 ### Questions?
 [![Gitter](https://badges.gitter.im/modernistik/parse-stack.svg)](https://gitter.im/modernistik/parse-stack?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
@@ -57,12 +57,12 @@ Master : true
 ```
 
 ## Overview
-Parse-Stack is a full stack framework that utilizes several ideas behind [DataMapper](http://datamapper.org/docs/find.html) and [ActiveModel](https://github.com/rails/rails/tree/master/activemodel) to manage and maintain larger scale ruby applications and tools that utilize the [Parse Server Platform](https://github.com/ParsePlatform/parse-server). If you are familiar with these technologies, the framework should feel familiar to you.
+Parse-Stack is a full stack framework that utilizes several ideas behind [DataMapper](http://datamapper.org/docs/find.html) and [ActiveModel](https://github.com/rails/rails/tree/master/activemodel) to manage and maintain larger scale ruby applications and tools that utilize the [Parse Server Platform](http://parseplatform.org/). If you are familiar with these technologies, the framework should feel familiar to you.
 
 ```ruby
 require 'parse/stack'
 
-Parse.setup server_url: 'https://localhost:1337/parse',
+Parse.setup server_url: 'http://localhost:1337/parse',
             app_id: APP_ID,
             api_key: REST_API_KEY,
             master_key: YOUR_MASTER_KEY # optional
@@ -80,6 +80,9 @@ class Song < Parse::Object
   belongs_to :artist
   # `like` is a Parse Relation to User class
   has_many :likes, as: :user, through: :relation
+
+  # deny public write to Song records by default
+  set_default_acl :public, read: true, write: false
 end
 
 class Artist < Parse::Object
@@ -153,6 +156,7 @@ result = Parse.call_function :myFunctionName, {param: value}
   - [Parse::ACL](#parseacl)
   - [Parse::Session](#parsesession)
   - [Parse::Installation](#parseinstallation)
+  - [Parse::Product](#parseproduct)
   - [Parse::Role](#parserole)
   - [Parse::User](#parseuser)
     - [Signup](#signup)
@@ -188,6 +192,7 @@ result = Parse.call_function :myFunctionName, {param: value}
 - [Creating, Saving and Deleting Records](#creating-saving-and-deleting-records)
   - [Create](#create)
   - [Saving](#saving)
+  - [Saving applying User ACLs](#saving-applying-user-acls)
     - [Raising an exception when save fails](#raising-an-exception-when-save-fails)
   - [Modifying Associations](#modifying-associations)
   - [Batch Requests](#batch-requests)
@@ -229,6 +234,7 @@ result = Parse.call_function :myFunctionName, {param: value}
   - [Geo Queries](#geo-queries)
     - [Max Distance Constraint](#max-distance-constraint)
     - [Bounding Box Constraint](#bounding-box-constraint)
+    - [Polygon Area Constraint](#polygon-area-constraint)
   - [Relational Queries](#relational-queries)
   - [Compound Queries](#compound-queries)
 - [Query Scopes](#query-scopes)
@@ -244,7 +250,8 @@ result = Parse.call_function :myFunctionName, {param: value}
   - [Register Webhooks](#register-webhooks)
 - [Parse REST API Client](#parse-rest-api-client)
   - [Request Caching](#request-caching)
-- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -590,11 +597,27 @@ All `Parse::Object` subclasses have an `acl` property by default. With this prop
 
   artist.save
 ```
+You may also set default ACLs for newly created insatnces of your subclasses using `set_default_acl`:
+
+```ruby
+class AdminData < Parse::Object
+
+  # Disable public read and write
+  set_default_acl :public, read: false, write: false
+
+  # but allow members of the Admin role to read and write
+  set_default_acl 'Admin', role: true, read: true, write: true
+
+end
+
+data = AdminData.new
+data.acl # => ACL({"role:Admin"=>{"read"=>true, "write"=>true}})
+```
 
 For more information about Parse record ACLs, see the documentation at  [Security](http://docs.parseplatform.org/rest/guide/#security)
 
 ### [Parse::Session](https://www.modernistik.com/gems/parse-stack/Parse/Session.html)
-This class represents the data and columns contained in the standard Parse `_Session` collection. You may add additional properties and methods to this class. See [Session API Reference](https://www.modernistik.com/gems/parse-stack/Parse/Session). You may call `Parse.use_shortnames!` to use `Session` in addition to `Parse::Session`.
+This class represents the data and columns contained in the standard Parse `_Session` collection. You may add additional properties and methods to this class. See [Session API Reference](https://www.modernistik.com/gems/parse-stack/Parse/Session.html). You may call `Parse.use_shortnames!` to use `Session` in addition to `Parse::Session`.
 
 You can get a specific `Parse::Session` given a session_token by using the `session` method. You can also find the user tied to a specific Parse session or session token with `Parse::User.session`.
 
@@ -606,25 +629,25 @@ session.user # the Parse user for this session
 # or fetch user with a session token
 user = Parse::User.session(token)
 
-# save an object with the priviledges (ACLs) of this user
+# save an object with the privileges (ACLs) of this user
 some_object.save( session: user.session_token )
 
-# delete an object with the priviledges of this user
+# delete an object with the privileges of this user
 some_object.destroy( session: user.session_token )
 
 ```
 
-### [Parse::Installation](https://www.modernistik.com/gems/parse-stack/Parse/Installation)
-This class represents the data and columns contained in the standard Parse `_Installation` collection. You may add additional properties and methods to this class. See [Installation API Reference](https://www.modernistik.com/gems/parse-stack/Parse/Installation). You may call `Parse.use_shortnames!` to use `Installation` in addition to `Parse::Installation`.
+### [Parse::Installation](https://www.modernistik.com/gems/parse-stack/Parse/Installation.html)
+This class represents the data and columns contained in the standard Parse `_Installation` collection. You may add additional properties and methods to this class. See [Installation API Reference](https://www.modernistik.com/gems/parse-stack/Parse/Installation.html). You may call `Parse.use_shortnames!` to use `Installation` in addition to `Parse::Installation`.
 
-### [Parse::Product](https://www.modernistik.com/gems/parse-stack/Parse/Product)
-This class represents the data and columns contained in the standard Parse `_Product` collection. You may add additional properties and methods to this class. See [Product API Reference](https://www.modernistik.com/gems/parse-stack/Parse/Product). You may call `Parse.use_shortnames!` to use `Product` in addition to `Parse::Product`.
+### [Parse::Product](https://www.modernistik.com/gems/parse-stack/Parse/Product.html)
+This class represents the data and columns contained in the standard Parse `_Product` collection. You may add additional properties and methods to this class. See [Product API Reference](https://www.modernistik.com/gems/parse-stack/Parse/Product.html). You may call `Parse.use_shortnames!` to use `Product` in addition to `Parse::Product`.
 
-### [Parse::Role](https://www.modernistik.com/gems/parse-stack/Parse/Role)
-This class represents the data and columns contained in the standard Parse `_Role` collection. You may add additional properties and methods to this class. See [Roles API Reference](https://www.modernistik.com/gems/parse-stack/Parse/Role). You may call `Parse.use_shortnames!` to use `Role` in addition to `Parse::Role`.
+### [Parse::Role](https://www.modernistik.com/gems/parse-stack/Parse/Role.html)
+This class represents the data and columns contained in the standard Parse `_Role` collection. You may add additional properties and methods to this class. See [Roles API Reference](https://www.modernistik.com/gems/parse-stack/Parse/Role.html). You may call `Parse.use_shortnames!` to use `Role` in addition to `Parse::Role`.
 
-### [Parse::User](https://www.modernistik.com/gems/parse-stack/Parse/User)
-This class represents the data and columns contained in the standard Parse `_User` collection. You may add additional properties and methods to this class. See [User API Reference](https://www.modernistik.com/gems/parse-stack/Parse/User). You may call `Parse.use_shortnames!` to use `User` in addition to `Parse::User`.
+### [Parse::User](https://www.modernistik.com/gems/parse-stack/Parse/User.html)
+This class represents the data and columns contained in the standard Parse `_User` collection. You may add additional properties and methods to this class. See [User API Reference](https://www.modernistik.com/gems/parse-stack/Parse/User.html). You may call `Parse.use_shortnames!` to use `User` in addition to `Parse::User`.
 
 #### Signup
 You can signup new users in two ways. You can either use a class method `Parse::User.signup` to create a new user with the minimum fields of username, password and email, or create a `Parse::User` object can call the `signup!` method. If signup fails, it will raise the corresponding exception.
@@ -638,7 +661,7 @@ user.signup!
 ```
 
 ##### Third-Party Services
-You can signup users using third-party services like Facebook and Twitter as described in: [Signing Up and Logging In](http://docs.parseplatform.org/rest/guide/#signing-up). To do this with Parse-Stack, you can call the `Parse::User.autologin_service` method by passing the service name and the corresponding authentication hash data. For a listing of supported third-party authentication services, see [OAuth](https://github.com/ParsePlatform/parse-server/wiki/OAuth).
+You can signup users using third-party services like Facebook and Twitter as described in: [Signing Up and Logging In](http://docs.parseplatform.org/rest/guide/#signing-up). To do this with Parse-Stack, you can call the `Parse::User.autologin_service` method by passing the service name and the corresponding authentication hash data. For a listing of supported third-party authentication services, see [OAuth](http://docs.parseplatform.org/parse-server/guide/#oauth-and-3rd-party-authentication).
 
 ```ruby
 fb_auth = {}
@@ -1374,7 +1397,7 @@ To commit a new record or changes to an existing record to Parse, use the `#save
 The save operation can handle both creating and updating existing objects. If you do not want to update the association data of a changed object, you may use the `#update` method to only save the changed property values. In the case where you want to force update an object even though it has not changed, to possibly trigger your `before_save` hooks, you can use the `#update!` method. In addition, just like with other ActiveModel objects, you may call `reload!` to fetch the current record again from the data store.
 
 ### Saving applying User ACLs
-You may save and delete objects from Parse on behalf of a logged in user by passing the session token to the call to `save` or `destroy`. Doing so will allow Parse to apply the ACLs of this user against the record to see if the user is authorized to read or write the record. See [Parse::Actions](https://www.modernistik.com/gems/parse-stack/Parse/Actions).
+You may save and delete objects from Parse on behalf of a logged in user by passing the session token to the call to `save` or `destroy`. Doing so will allow Parse to apply the ACLs of this user against the record to see if the user is authorized to read or write the record. See [Parse::Actions](https://www.modernistik.com/gems/parse-stack/Parse/Core/Actions.html).
 
 ```ruby
   user = Parse::User.login('myuser','pass')
@@ -1745,7 +1768,7 @@ The `where` clause is based on utilizing a set of constraints on the defined col
 { :column.constraint => value }
 ```
 
-## Query Constraints
+## [Query Constraints](https://www.modernistik.com/gems/parse-stack/Parse/Constraint.html)
 Most of the constraints supported by Parse are available to `Parse::Query`. Assuming you have a column named `field`, here are some examples. For an explanation of the constraints, please see [Parse Query Constraints documentation](http://docs.parseplatform.org/rest/guide/#queries). You can build your own custom query constraints by creating a `Parse::Constraint` subclass. For all these `where` clauses assume `q` is a `Parse::Query` object.
 
 #### Equals
@@ -1958,7 +1981,7 @@ Song.all :artist => Artist.pointer(artist_id)
 Song.all :artist => Parse::Pointer.new("Artist", artist_id)
 ```
 
-### Geo Queries
+### [Geo Queries](https://www.modernistik.com/gems/parse-stack/Parse/Constraint/NearSphereQueryConstraint.html)
 Equivalent to the `$nearSphere` Parse query operation. This is only applicable if the field is of type `GeoPoint`. This will query Parse and return a list of results ordered by distance with the nearest object being first.
 
 ```ruby
@@ -1984,7 +2007,7 @@ PlaceObject.all :location.near => geopoint.max_miles(10)
 
 We will support `$maxDistanceInKilometers` (for kms) and `$maxDistanceInRadians` (for radian angle) in the future.
 
-#### Bounding Box Constraint
+#### [Bounding Box Constraint](https://www.modernistik.com/gems/parse-stack/Parse/Constraint/WithinGeoBoxQueryConstraint.html)
 Equivalent to the `$within` Parse query operation and `$box` geopoint constraint. The rectangular bounding box is defined by a southwest point as the first parameter, followed by the a northeast point. Please note that Geo box queries that cross the international date lines are not currently supported by Parse.
 
 ```ruby
@@ -1999,6 +2022,22 @@ ne = Parse::GeoPoint.new 36.12, -115.31 # Las Vegas
 PlaceObject.all :location.within_box => [sw,ne]
 ```
 
+#### [Polygon Area Constraint](https://www.modernistik.com/gems/parse-stack/Parse/Constraint/WithinPolygonQueryConstraint.html)
+Equivalent to the `$geoWithin` Parse query operation and `$polygon` geopoint constraint. The polygon area is described by a list of `Parse::GeoPoint` objects and should contain 3 or more points. This feature is only available in Parse-Server version 2.4.2 and later.
+
+```ruby
+ # As many points as you want, minimum 3
+ q.where :field.within_polygon => [geopoint1, geopoint2, geopoint3]
+
+ # Polygon for the Bermuda Triangle
+ bermuda  = Parse::GeoPoint.new 32.3078000,-64.7504999 # Bermuda
+ miami    = Parse::GeoPoint.new 25.7823198,-80.2660226 # Miami, FL
+ san_juan = Parse::GeoPoint.new 18.3848232,-66.0933608 # San Juan, PR
+
+ # get all sunken ships inside the Bermuda Triangle
+ SunkenShip.all :location.within_polygon => [bermuda, san_juan, miami]
+```
+
 ### Relational Queries
 Equivalent to the `$relatedTo` Parse query operation. If you want to retrieve objects that are members of a `Relation` field in your Parse class.
 

data/Rakefile

@@ -29,6 +29,6 @@ end
 
 YARD::Rake::YardocTask.new do |t|
  t.files   = ['lib/**/*.rb']   # optional
- # t.options = ['--any', '--extra', '--opts'] # optional
+ t.options = ['-o', 'doc/parse-stack' ] # optional
  t.stats_options = ['--list-undoc']         # optional
 end

data/bin/console

@@ -6,16 +6,24 @@ require 'dotenv'
 require 'byebug'
 Dotenv.load
 
-Parse.setup # cache: 'redis://localhost:6379'
+def setup
+  Parse.setup # cache: 'redis://localhost:6379'
 
-puts "[ParseServerURL] #{Parse.client.server_url}"
-puts "[ParseAppID]     #{Parse.client.app_id}"
+  puts "[ParseServerURL] #{Parse.client.server_url}"
+  puts "[ParseAppID]     #{Parse.client.app_id}"
 
-if Parse.client.master_key.present?
-  Parse.auto_generate_models!.each do |model|
-    puts "Generated #{model}"
+  if Parse.client.master_key.present?
+    Parse.auto_generate_models!.each do |model|
+      puts "Generated #{model}"
+    end
   end
+
 end
+puts "Type 'setup' to connect to Parse-Server"
+
+# Create shortnames
+Parse.use_shortnames!
+
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 

data/bin/parse-console

@@ -3,7 +3,8 @@
 require 'optparse'
 require 'json'
 require 'open-uri'
-require 'active_support/all'
+require 'active_support'
+require 'active_support/core_ext'
 
 DEFAULT_CONFIG_FILE = 'config.json'
 DEFAULT_CONFIG_CONTENTS = {

data/lib/parse/api/analytics.rb

@@ -10,7 +10,7 @@ module Parse
       # Send analytics data.
       # @param event_name [String] the name of the event.
       # @param metrics [Hash] the metrics to attach to event.
-      # @see https://parseplatform.github.io/docs/rest/guide/#analytics-app-open-analytics Parse Analytics
+      # @see http://docs.parseplatform.org/rest/guide/#analytics Parse Analytics
       def send_analytics(event_name, metrics = {})
         request :post, "events/#{event_name}", body: metrics
       end

data/lib/parse/api/push.rb

@@ -12,7 +12,7 @@ module Parse
       # Update the schema for a collection.
       # @param payload [Hash] the paylod for the Push notification.
       # @return [Parse::Response]
-      # @see https://parseplatform.github.io/docs/rest/guide/#sending-pushes Sending Pushes
+      # @see http://docs.parseplatform.org/rest/guide/#sending-pushes Sending Pushes
       def push(payload = {})
         request :post, PUSH_PATH, body: payload.as_json
       end

data/lib/parse/model/acl.rb

@@ -39,10 +39,10 @@ module Parse
   # An ACL represents the dirty-trackable Parse Permissions object used for
   # each record. In Parse, it is composed a hash-like object that represent
   # {Parse::User} objectIds and/or a set of {Parse::Role} names. For each entity
-  # (ex. User/Role/Public), you can define read/write priviledges on a particular
+  # (ex. User/Role/Public), you can define read/write privileges on a particular
   # record through a {Parse::ACL::Permission} instance.
   #
-  # If you want to give priviledges for an action (ex. read/write),
+  # If you want to give privileges for an action (ex. read/write),
   # you set that particular permission it to true. If you want to deny a
   # permission, then you set it to false. Any denied permissions will not be
   # part of the final hash structure that is sent to parse, as omission of a permission
@@ -82,8 +82,26 @@ module Parse
   #  artist.acl.apply_role "Admins", true, true
   #
   #  artist.save
+  #
+  # You may also set default ACLs for your subclasses by using {Parse::Object.set_default_acl}.
+  # These will be get applied for newly created instances. All subclasses have
+  # public read and write enabled by default.
+  #
+  #  class AdminData < Parse::Object
+  #
+  #    # Disable public read and write
+  #    set_default_acl :public, read: true, write: false
+  #
+  #    # Allow Admin roles to read/write
+  #    set_default_acl 'Admin', role: true, read: true, write: true
+  #
+  #  end
+  #
+  #  data = AdminData.new
+  #  data.acl # => ACL({"role:Admin"=>{"read"=>true, "write"=>true}})
+  #
   # For more information about Parse record ACLs, see the documentation on
-  # {https://parseplatform.github.io/docs/rest/guide/#security Security}.
+  # {http://docs.parseplatform.org/rest/guide/#security Security}.
   class ACL < DataType
 
     # @!attribute permissions
@@ -101,20 +119,28 @@ module Parse
       @permissions ||= {}
     end
     # The key field value for public permissions.
-    PUBLIC = "*"
+    PUBLIC = "*".freeze
 
     # Create a new ACL with default Public read/write permissions and any
     # overrides from the input hash format.
     # @param acls [Hash] a Parse-compatible hash acl format.
     # @param owner [Parse::Object] a delegate to receive notifications of acl changes.
     #  This delegate must support receiving `acl_will_change!` method.
-    def initialize(acls = {}, owner: nil)
-      everyone(true, true) # sets Public read/write
+    def initialize(acls = nil, owner: nil)
+      acls = acls.as_json if acls.is_a?(ACL)
+      self.attributes = acls if acls.is_a?(Hash)
       @delegate = owner
-      if acls.is_a?(Hash)
-        self.attributes = acls
-      end
+    end
 
+    # Create a new ACL with default Public read/write permissions and any
+    # overrides from the input hash format.
+    # @param read [Boolean] the read permissions for PUBLIC (default: true)
+    # @param write [Boolean] the write permissions for PUBLIC (default: true)
+    # @version 1.7.0
+    def self.everyone(read = true, write = true)
+      acl = Parse::ACL.new
+      acl.everyone(read, write)
+      acl
     end
 
     # Create a new ACL::Permission instance with the supplied read and write values.
@@ -125,12 +151,27 @@ module Parse
     def self.permission(read, write = nil)
         ACL::Permission.new(read, write)
     end
-
-    # @return [Boolean] whether two ACLs have the same set of priviledges.
+    # Determines whether two ACLs or a Parse-ACL hash is equivalent to this object.
+    # @example
+    #  acl = Parse::ACL.new
+    #  # create a public read-only ACL
+    #  acl.apply :public, true, false
+    #  acl.as_json # => {'*' => { "read" => true }}
+    #
+    #  create a second instance with similar privileges
+    #  acl2 = Parse::ACL.everyone(true, false)
+    #  acl2.as_json # => {'*' => { "read" => true }}
+    #
+    #  acl == acl2 # => true
+    #  acl == {'*' => { "read" => true }} # hash ok too
+    #
+    #  acl2.apply_role 'Admin', true, true # rw for Admins
+    #  acl == acl2 # => false
+    #
+    # @return [Boolean] whether two ACLs have the same set of privileges.
     def ==(other_acl)
-      return false unless other_acl.is_a?(self.class)
-      return false if permissions.keys != other_acl.permissions.keys
-      permissions.keys.all? { |per| permissions[per] == other_acl.permissions[per] }
+      return false unless other_acl.is_a?(self.class) || other_acl.is_a?(Hash)
+      as_json == other_acl.as_json
     end
 
     # Set the public read and write permissions.
@@ -162,7 +203,7 @@ module Parse
       end
     end
 
-    # Apply a new permission with a given objectId (or tag)
+    # Apply a new permission with a given objectId, tag or :public.
     # @overload apply(user, read = nil, write = nil)
     #  Set the read and write permissions for this user on this ACL.
     #  @param user [Parse::User] the user object.
@@ -175,7 +216,8 @@ module Parse
     #  @param write [Boolean] the write permission.
     # @overload apply(id, read = nil, write = nil)
     #  Set the read and write permissions for this objectId on this ACL.
-    #  @param id [String] the objectId for a {Parse::User}.
+    #  @param id [String|:public] the objectId for a {Parse::User}. If :public is passed,
+    #      then the {Parse::ACL::PUBLIC} read and write permissions will be modified.
     #  @param read [Boolean] the read permission.
     #  @param write [Boolean] the write permission.
     # @return [Hash] the current set of permissions.
@@ -183,12 +225,14 @@ module Parse
     def apply(id, read = nil, write = nil)
       return apply_role(id,read,write) if id.is_a?(Parse::Role)
       id = id.id if id.is_a?(Parse::Pointer)
-      return unless id.present?
+      unless id.present?
+        raise ArgumentError, "Invalid argument applying ACLs: must be either objectId, role or :public"
+      end
+      id = PUBLIC if id.to_sym == :public
       # create a new Permissions
       permission = ACL.permission(read, write)
       # if the input is already an Permission object, then set it directly
       permission = read if read.is_a?(Parse::ACL::Permission)
-
       if permission.is_a?(ACL::Permission)
         if permissions[id.to_s] != permission
           will_change! # dirty track
@@ -215,6 +259,8 @@ module Parse
 
     # Used for object conversion when formatting the input/output value in
     # Parse::Object properties
+    # @param value [Hash] a Parse ACL hash to construct a Parse::ACL instance.
+    # @param delegate [Object] any object that would need to be notified of changes.
     # @return [ACL]
     # @see Parse::DataType
     def self.typecast(value, delegate = nil)
@@ -224,8 +270,7 @@ module Parse
     # Used for JSON serialization. Only if an attribute is non-nil, do we allow it
     # in the Permissions hash, since omission means denial of priviledge. If the
     # permission value has neither read or write, then the entire record has been denied
-    # all priviledges
-
+    # all privileges
     # @return [Hash]
     def attributes
       permissions.select {|k,v| v.present? }.as_json
@@ -280,7 +325,7 @@ module Parse
       # @return [Boolean] whether this permission is allowed.
       attr_reader :write
 
-      # Create a new permission with the given read and write priviledges.
+      # Create a new permission with the given read and write privileges.
       # @overload new(read = nil, write = nil)
       #  @param read [Boolean] whether reading is allowed.
       #  @param write [Boolean] whether writing is allowed.
@@ -293,7 +338,7 @@ module Parse
       #
       def initialize(r_perm = nil, w_perm = nil)
         if r_perm.is_a?(Hash)
-          r_perm.symbolize_keys!
+          r_perm = r_perm.symbolize_keys
           @read = r_perm[:read].present?
           @write = r_perm[:write].present?
         else

data/lib/parse/model/associations/has_many.rb

@@ -15,7 +15,7 @@ module Parse
     # to implement your associations, will affect how `has_many` works in
     # Parse-Stack. Parse natively supports one-to-many and many-to-many
     # relationships using `Array` and `Relations`, as described in
-    # {https://parseplatform.github.io/docs/js/guide/#relational-data Parse Relational Data}.
+    # {http://docs.parseplatform.org/js/guide/#relations Parse Relational Data}.
     # Both of these methods require you define a specific column type in your
     # Parse table that will be used to store information about the association.
     #
@@ -169,7 +169,7 @@ module Parse
     # *ParseRelation-Approach*
     #
     # Other than the use of arrays, Parse supports native one-to-many and many-to-many
-    # associations through what is referred to as a {https://parseplatform.github.io/docs/js/guide/#many-to-many-relationships Parse Relation}.
+    # associations through what is referred to as a {http://docs.parseplatform.org/js/guide/#many-to-many Parse Relation}.
     # This is implemented by defining a column to be of type `Relation` which
     # refers to a foreign class. Parse-Stack supports this by passing the
     # `through: :relation` option to the `has_many` method. Designating a column
@@ -183,7 +183,7 @@ module Parse
     #
     # *3*. Applying query constraints for a set of records within a relation is performed against the foreign table class, not the class having the relational column.
     #
-    # The Parse documentation provides more details on associations, see {http://parseplatform.github.io/docs/ios/guide/#relations Parse Relations Guide}.
+    # The Parse documentation provides more details on associations, see {http://docs.parseplatform.org/ios/guide/#relations Parse Relations Guide}.
     # Parse-Stack will handle the work for (2) and (3) automatically.
     #
     # In the example below, a `Band` can have thousands of `Fans`. We setup a

data/lib/parse/model/classes/user.rb

@@ -74,11 +74,11 @@ module Parse
   # *OAuth-Login*
   #
   # You can signup users using third-party services like Facebook and Twitter as
-  # described in {https://parseplatform.github.io/docs/rest/guide/#signing-up-and-logging-in
+  # described in {http://docs.parseplatform.org/rest/guide/#signing-up
   # Signing Up and Logging In}. To do this with Parse-Stack, you can call the
   # {Parse::User.autologin_service} method by passing the service name and the
   # corresponding authentication hash data. For a listing of supported third-party
-  # authentication services, see {https://github.com/ParsePlatform/parse-server/wiki/OAuth OAuth}.
+  # authentication services, see {http://docs.parseplatform.org/parse-server/guide/#oauth-and-3rd-party-authentication OAuth}.
   #
   #  fb_auth = {}
   #  fb_auth[:id] = "123456789"
@@ -105,12 +105,12 @@ module Parse
   #
   # You can link or unlink user accounts with third-party services like
   # Facebook and Twitter as described in:
-  # {https://parseplatform.github.io/docs/rest/guide/#linking Linking and Unlinking Users}.
+  # {http://docs.parseplatform.org/rest/guide/#linking-users Linking and Unlinking Users}.
   # To do this, you must first get the corresponding authentication data for the
   # specific service, and then apply it to the user using the linking and
   # unlinking methods. Each method returns true or false if the action was
   # successful. For a listing of supported third-party authentication services,
-  # see {https://github.com/ParsePlatform/parse-server/wiki/OAuth OAuth}.
+  # see {http://docs.parseplatform.org/parse-server/guide/#oauth-and-3rd-party-authentication OAuth}.
   #
   #  user = Parse::User.first
   #

data/lib/parse/model/core/actions.rb

@@ -157,8 +157,8 @@ module Parse
         # @see Parse::Model.autosave_on_create
         def first_or_create(query_attrs = {}, resource_attrs = {})
 
-          query_attrs.symbolize_keys!
-          resource_attrs.symbolize_keys!
+          query_attrs = query_attrs.symbolize_keys
+          resource_attrs = resource_attrs.symbolize_keys
           obj = query(query_attrs).first
 
           if obj.blank?
@@ -511,7 +511,7 @@ module Parse
       # we will create the object. If the object has an id, we will update the record.
       #
       # You may pass a session token to the `session` argument to perform this actions
-      # with the priviledges of a certain user.
+      # with the privileges of a certain user.
       #
       # You can define before and after :save callbacks
       # autoraise: set to true will automatically raise an exception if the save fails

data/lib/parse/model/geopoint.rb

@@ -116,7 +116,7 @@ module Parse
     # or with an array of two items where the first is the lat and the second is the lng (ex. [32.22,-118.81])
     def attributes=(h)
       if h.is_a?(Hash)
-        h.symbolize_keys!
+        h = h.symbolize_keys
         @latitude = h[:latitude].to_f || h[:lat].to_f || @latitude
         @longitude = h[:longitude].to_f || h[:lng].to_f ||  @longitude
       elsif h.is_a?(Array) && h.count == 2

data/lib/parse/model/object.rb

@@ -165,12 +165,12 @@ module Parse
     # to set it to something different.
     class << self
 
-      attr_accessor :disable_serialized_string_date, :parse_class, :acl
-
+      attr_accessor :disable_serialized_string_date, :parse_class
+      attr_reader :default_acls
       # @!attribute disable_serialized_string_date
       #  Disables returning a serialized string date properties when encoding to JSON.
       #  This affects created_at and updated_at fields in order to be backwards compatible with old SDKs.
-      #  @return [Boolean]
+      #  @return [Boolean] the disabled status of whether string dates should be serialized.
 
       # The class method to override the implicitly assumed Parse collection name
       # in your Parse database. The default Parse collection name is the singular form
@@ -195,16 +195,51 @@ module Parse
         @parse_class
       end
 
-      # A method to override the default ACLs for new objects for this particular
-      # subclass.
-      # @param acls [Hash] a hash with key value pairs of ACLs permissions.
-      # @return [ACL] the default ACLs for this class.
-      def acl(acls = {}, owner: nil)
-        acls = {"*" => {read: true, write: false} }.merge( acls ).symbolize_keys
-        @acl ||= Parse::ACL.new(acls, owner: owner)
+      # The set of default ACLs to be applied on newly created instances of this class.
+      # By default, public read and write are enabled.
+      # @see Parse::ACL.everyone
+      # @return [Parse::ACL] the current default ACLs for this class.
+      def default_acls
+        @default_acls ||= Parse::ACL.everyone # default public read/write
       end
 
-    end
+      # A method to set default ACLs to be applied for newly created
+      # instances of this class. All subclasses have public read and write enabled
+      # by default.
+      # @example
+      #  class AdminData < Parse::Object
+      #
+      #    # Disable public read and write
+      #    set_default_acl :public, read: false, write: false
+      #
+      #    # but allow members of the Admin role to read and write
+      #    set_default_acl 'Admin', role: true, read: true, write: true
+      #
+      #  end
+      #
+      #  data = AdminData.new
+      #  data.acl # => ACL({"role:Admin"=>{"read"=>true, "write"=>true}})
+      #
+      # @param id [String|:public] The name for ACL entry. This can be an objectId, a role name or :public.
+      # @param read [Boolean] Whether to allow read permissions (default: false).
+      # @param write [Boolean] Whether to allow write permissions (default: false).
+      # @param role [Boolean] Whether the `id` argument should be applied as a role name.
+      # @see Parse::ACL#apply_role
+      # @see Parse::ACL#apply
+      # @version 1.7.0
+      def set_default_acl(id, read: false, write: false, role: false)
+        unless id.present?
+          raise ArgumentError, "Invalid argument applying #{self}.default_acls : must be either objectId, role or :public"
+        end
+        role ? default_acls.apply_role(id, read, write) : default_acls.apply(id, read, write)
+      end
+
+      # @!visibility private
+      def acl(acls, owner: nil)
+        raise "[#{self}.acl DEPRECATED] - Use `#{self}.default_acl` instead."
+      end
+
+    end # << self
 
     # @return [String] the Parse class for this object.
     # @see Parse::Object.parse_class
@@ -255,9 +290,10 @@ module Parse
         apply_attributes!(opts, dirty_track: !dirty_track)
       end
 
-      if self.acl.blank?
-        self.acl = self.class.acl({}, owner: self) || Parse::ACL.new(owner: self)
-      end
+      # if no ACLs, then apply the class default acls
+      # ACL.typecast will auto convert of Parse::ACL
+      self.acl = self.class.default_acls.as_json if self.acl.nil?
+
       clear_changes! if @id.present? #then it was an import
 
       # do not apply defaults on a pointer because it will stop it from being

data/lib/parse/query.rb

@@ -13,7 +13,7 @@ require 'active_support/core_ext'
 
 module Parse
   # The {Parse::Query} class provides the lower-level querying interface for
-  # your Parse collections by utilizing the {http://parseplatform.github.io/docs/rest/guide/#queries
+  # your Parse collections by utilizing the {http://docs.parseplatform.org/rest/guide/#queries
   # REST Querying interface}. This is the main engine behind making Parse queries
   # on remote collections. It takes a set of constraints and generates the
   # proper hash parameters that are passed to an API request in order to retrive
@@ -58,7 +58,7 @@ module Parse
   # Most of the constraints supported by Parse are available to `Parse::Query`.
   # Assuming you have a column named `field`, here are some examples. For an
   # explanation of the constraints, please see
-  # {http://parseplatform.github.io/docs/rest/guide/#queries Parse Query Constraints documentation}.
+  # {http://docs.parseplatform.org/rest/guide/#queries Parse Query Constraints documentation}.
   # You can build your own custom query constraints by creating a `Parse::Constraint`
   # subclass. For all these `where` clauses assume `q` is a `Parse::Query` object.
   class Query
@@ -131,7 +131,7 @@ module Parse
     # @!attribute [rw] session_token
     #  Set the session token to send with this API request. A session token is tied to
     #  a logged in {Parse::User}. When sending a session_token in the request,
-    #  this performs the query on behalf of the user (with their allowed priviledges).
+    #  this performs the query on behalf of the user (with their allowed privileges).
     #  Using the short hand (inline) form, you can also pass an authenticated {Parse::User} instance
     #  or a {Parse::Session} instance.
     #  @example

data/lib/parse/query/constraint.rb

@@ -107,7 +107,7 @@ module Parse
         d = { __type: Parse::Model::TYPE_DATE, iso: d.iso8601(3) } if d.respond_to?(:iso8601)
         d = d.pointer if d.respond_to?(:pointer) #simplified query object
         d = d.to_s if d.is_a?(Regexp)
-        #d = d.pointer if d.is_a?(Parse::Object) #simplified query object
+        # d = d.pointer if d.is_a?(Parse::Object) #simplified query object
         #  d = d.compile
         if d.is_a?(Parse::Query)
           compiled = d.compile(encode: false, includeClassName: true)

data/lib/parse/query/constraints.rb

@@ -663,6 +663,50 @@ module Parse
       end
     end
 
+    # Equivalent to the `$geoWithin` Parse query operation and `$polygon` geopoints
+    # constraint. The polygon area is defined by a list of {Parse::GeoPoint}
+    # objects that make up the enclosed area. A polygon query should have 3 or more geopoints.
+    # Please note that some Geo queries that cross the international date lines are not currently
+    # supported by Parse.
+    #
+    #  # As many points as you want, minimum 3
+    #  q.where :field.within_polygon => [geopoint1, geopoint2, geopoint3]
+    #
+    #  # Polygon for the Bermuda Triangle
+    #  bermuda  = Parse::GeoPoint.new 32.3078000,-64.7504999 # Bermuda
+    #  miami    = Parse::GeoPoint.new 25.7823198,-80.2660226 # Miami, FL
+    #  san_juan = Parse::GeoPoint.new 18.3848232,-66.0933608 # San Juan, PR
+    #
+    #  # get all sunken ships inside the Bermuda Triangle
+    #  SunkenShip.all :location.within_polygon => [bermuda, san_juan, miami]
+    #
+    class WithinPolygonQueryConstraint < Constraint
+      # @!method within_polygon
+      # A registered method on a symbol to create the constraint. Maps to Parse
+      # operator "$geoWithin" with "$polygon" subconstraint. Takes an array of {Parse::GeoPoint} objects.
+      # @example
+      #  # As many points as you want
+      #  q.where :field.within_polygon => [geopoint1, geopoint2, geopoint3]
+      # @return [WithinPolygonQueryConstraint]
+      # @version 1.7.0 (requires Server v2.4.2 or later)
+      contraint_keyword :$geoWithin
+      register :within_polygon
+
+      # @return [Hash] the compiled constraint.
+      def build
+        geopoint_values = formatted_value
+        unless geopoint_values.is_a?(Array) &&
+               geopoint_values.all? {|point| point.is_a?(Parse::GeoPoint) } &&
+               geopoint_values.count > 2
+          raise ArgumentError, '[Parse::Query] Invalid query value parameter passed to'\
+                      ' `within_polygon` constraint: Value must be an array with 3'\
+                      ' or more `Parse::GeoPoint` objects'
+        end
+
+        { @operation.operand => { :$geoWithin => { :$polygon => geopoint_values } } }
+      end
+    end
+
   end
 
 end

data/lib/parse/stack/version.rb

@@ -6,6 +6,6 @@ module Parse
   # The Parse Server SDK for Ruby
   module Stack
     # The current version.
-    VERSION = "1.6.13"
+    VERSION = "1.7.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parse-stack
 version: !ruby/object:Gem::Version
-  version: 1.6.13
+  version: 1.7.0
 platform: ruby
 authors:
 - Anthony Persaud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-09 00:00:00.000000000 Z
+date: 2017-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel