parse-stack 1.6.11 → 1.6.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e8c593e13180e83fb349eff383cab24f11e70e6
-  data.tar.gz: 3e97c6ab5b0d7ef055f67553541178734d815fd6
+  metadata.gz: 641ab5a564cc0fc19b55697f77db532aab40b2b0
+  data.tar.gz: 2cebf9bd8e0337137801d0eb269e30a90d22ad42
 SHA512:
-  metadata.gz: ed75d26379dd431857a469010d2497121c44bff4520076d72906164491dcee17e1a54b047a1c9ed8d2f9d8bc4eb482cd10d5414bf551d40f89a2961a253e8b99
-  data.tar.gz: bcf0da08fd9a257b8ae6c6d9bda80e83de4ec5172b9bb0d6733ce3a3b0152a263bd5cae95d909d5a4a9a197a248af744ab0af64e273e1bb47892e8c45773ac52
+  metadata.gz: a8a5e7a2e7bbdb41adff46994b3fef930c070bd7d9842d8646180d571fa7a6e81007da0e2d07b2edd1d275732f99b81db8e8f2588c94dca762c4e04b0fc55ca4
+  data.tar.gz: 46f3b106aae7687d969b9193498a5258f648e1f5ae97d908f99f58bd9d465ca5bd2bd14ac89f5cf368d0f7509d142d46f9afa573100afd5d2a8694dba1d69970

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/Changes.md

@@ -1,5 +1,19 @@
 ## Parse-Stack Changelog
 
+### 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.
+- FIXES: Issue #27 where core classes could not be auto-upgraded if they were missing.
+- Warnings are now printed if auto_upgrade! is called without the master key.
+- Use `Parse.use_shortnames!` to use short name class names Ex. Parse::User -> User
+- Hosting documentation on https://www.modernistik.com/gems/parse-stack/ since rubydoc.info doesn't
+  use latest yard features.
+- Parse::Query will raise an exception if a non-nil value is passed to `:session` that
+  does not provide a valid session token string.
+- `save` and `destroy` will raise an exception if a non-nil `session` argument is passed
+ that does not provide a valid session token string.
+- Additional documentation changes and tests.
+
 ### 1.6.11
 - NEW: Parse::Object#sig method to get quick information about an instance.
 - FIX: Typo fix when using Array#objectIds.

data/Gemfile.lock

@@ -1,28 +1,28 @@
 PATH
   remote: .
   specs:
-    parse-stack (1.6.11)
+    parse-stack (1.6.12)
       active_model_serializers (>= 0.9, < 1)
       activemodel (>= 4.2.1, < 6)
       activesupport (>= 4.2.1, < 6)
       faraday (>= 0.8, < 1)
       faraday_middleware (>= 0.9, < 1)
-      moneta (>= 0.7, < 1)
+      moneta (< 2)
       parallel (>= 1.6, < 2)
       rack (< 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.1.0)
-      actionview (= 5.1.0)
-      activesupport (= 5.1.0)
+    actionpack (5.1.1)
+      actionview (= 5.1.1)
+      activesupport (= 5.1.1)
       rack (~> 2.0)
       rack-test (~> 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.0)
-      activesupport (= 5.1.0)
+    actionview (5.1.1)
+      activesupport (= 5.1.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
@@ -32,9 +32,9 @@ GEM
       activemodel (>= 4.1, < 6)
       case_transform (>= 0.2)
       jsonapi-renderer (>= 0.1.1.beta1, < 0.2)
-    activemodel (5.1.0)
-      activesupport (= 5.1.0)
-    activesupport (5.1.0)
+    activemodel (5.1.1)
+      activesupport (= 5.1.1)
+    activesupport (5.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -48,7 +48,7 @@ GEM
     coderay (1.1.1)
     concurrent-ruby (1.0.5)
     daemons (1.2.4)
-    debug_inspector (0.0.2)
+    debug_inspector (0.0.3)
     dotenv (2.2.1)
     erubi (1.6.0)
     eventmachine (1.2.3)
@@ -56,18 +56,18 @@ GEM
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.11.0.1)
       faraday (>= 0.7.4, < 1.0)
-    i18n (0.8.1)
+    i18n (0.8.4)
     jsonapi-renderer (0.1.2)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     method_source (0.8.2)
-    mini_portile2 (2.1.0)
-    minitest (5.10.1)
-    moneta (0.8.1)
+    mini_portile2 (2.2.0)
+    minitest (5.10.2)
+    moneta (1.0.0)
     multipart-post (2.0.0)
-    nokogiri (1.7.1)
-      mini_portile2 (~> 2.1.0)
-    parallel (1.11.1)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
+    parallel (1.11.2)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -77,12 +77,12 @@ GEM
     pry-stack_explorer (0.4.9.2)
       binding_of_caller (>= 0.7)
       pry (>= 0.9.11)
-    rack (2.0.1)
+    rack (2.0.3)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails-dom-testing (2.0.2)
-      activesupport (>= 4.2.0, < 6.0)
-      nokogiri (~> 1.6)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
     rake (12.0.0)
@@ -116,4 +116,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   1.13.7
+   1.15.1

data/README.md

@@ -1,10 +1,10 @@
-<img src='https://raw.githubusercontent.com/modernistik/parse-stack/master/.github/parse-ruby-sdk.png?raw=true' width='500' alt='Ruby Parse SDK'/>
+<img src='https://raw.githubusercontent.com/modernistik/parse-stack/master/.github/parse-ruby-sdk.png?raw=true' width='500' alt='Ruby Parse Server SDK'/>
 
-# Parse Stack - The Parse Ruby Client SDK
+# 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.
 
-Below is a [quick start guide](https://github.com/modernistik/parse-stack#overview), but you can also check out the full [API Reference](http://www.rubydoc.info/github/modernistik/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/)* for more detailed information about our Parse Server SDK.
 
 #### Tutorial Videos
 1. Getting Started: https://youtu.be/zoYSGmciDlQ
@@ -15,52 +15,51 @@ 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)](http://www.rubydoc.info/github/modernistik/parse-stack)
+[![API Reference](http://img.shields.io/badge/api-docs-blue.svg)](https://www.modernistik.com/gems/parse-stack/)
 
 ### 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)
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'parse-stack'
-
+Add this line to your application's `Gemfile`:
+```ruby
+gem 'parse-stack'
+```
 And then execute:
-
-    $ bundle
-
+```bash
+$ bundle
+```
 Or install it yourself as:
-
-    $ gem install parse-stack
-
+```bash
+$ gem install parse-stack
+```
 ### Rack / Sinatra
 Parse-Stack API, models and webhooks easily integrate in your existing Rack/Sinatra based applications. For more details see [Parse-Stack Rack Example](https://github.com/modernistik/parse-stack-example).
 
 ### Rails
 Parse-Stack comes with support for Rails by adding additional rake tasks and generators. After adding `parse-stack` as a gem dependency in your Gemfile and running `bundle`, you should run the install script:
-
-    $ rails g parse_stack:install
-
+```bash
+$ rails g parse_stack:install
+```
 For a more details on the rails integration see [Parse-Stack Rails Example](https://github.com/modernistik/parse-stack-rails-example).
 
 ### Interactive Command Line Playground
 You can also used the bundled `parse-console` command line to connect and interact with your Parse Server and its data in an IRB-like console. This is useful for trying concepts and debugging as it will automatically connect to your Parse Server, and if provided the master key, automatically generate all the models entities.
 
 ```bash
-    $ parse-console -h # see all options
-    $ parse-console -v -a myAppId -m myMasterKey http://localhost:1337/parse
-    Server : http://localhost:1337/parse
-    App Id : myAppId
-    Master : true
-    2.4.0 > Parse::User.first
+$ parse-console -h # see all options
+$ parse-console -v -a myAppId -m myMasterKey http://localhost:1337/parse
+Server : http://localhost:1337/parse
+App Id : myAppId
+Master : true
+2.4.0 > Parse::User.first
 ```
 
 ## 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.
 
 ```ruby
-
 require 'parse/stack'
 
 Parse.setup server_url: 'https://localhost:1337/parse',
@@ -252,16 +251,16 @@ result = Parse.call_function :myFunctionName, {param: value}
 ## Architecture
 The architecture of `Parse::Stack` is broken into four main components.
 
-### Parse::Client
+### [Parse::Client](https://www.modernistik.com/gems/parse-stack/Parse/Client.html)
 This class is the core and low level API for the Parse Server REST interface that is used by the other components. It can manage multiple sessions, which means you can have multiple client instances pointing to different Parse Server applications at the same time. It handles sending raw requests as well as providing Request/Response objects for all API handlers. The connection engine is Faraday, which means it is open to add any additional middleware for features you'd like to implement.
 
-### Parse::Query
-This class implements the [Parse REST Querying](http://parseplatform.github.io/docs/rest/guide/#queries) interface in the [DataMapper finder syntax style](http://datamapper.org/docs/find.html). It compiles a set of query constraints and utilizes `Parse::Client` to send the request and provide the raw results. This class can be used without the need to define models.
+### [Parse::Query](https://www.modernistik.com/gems/parse-stack/Parse/Query.html)
+This class implements the [Parse REST Querying](http://docs.parseplatform.org/rest/guide/#queries) interface in the [DataMapper finder syntax style](http://datamapper.org/docs/find.html). It compiles a set of query constraints and utilizes `Parse::Client` to send the request and provide the raw results. This class can be used without the need to define models.
 
-### Parse::Object
+### [Parse::Object](https://www.modernistik.com/gems/parse-stack/Parse/Object.html)
 This component is main class for all object relational mapping subclasses for your application. It provides features in order to map your remote Parse records to a local ruby object. It implements the Active::Model interface to provide a lot of additional features, CRUD operations, querying, including dirty tracking, JSON serialization, save/destroy callbacks and others. While we are overlooking some functionality, for simplicity, you will mainly be working with Parse::Object as your superclass. While not required, it is highly recommended that you define a model (Parse::Object subclass) for all the Parse classes in your application.
 
-### Parse::Webhooks
+### [Parse::Webhooks](https://www.modernistik.com/gems/parse-stack/Parse/Webhooks.html)
 Parse provides a feature called [Cloud Code Webhooks](http://blog.parse.com/announcements/introducing-cloud-code-webhooks/). For most applications, save/delete triggers and cloud functions tend to be implemented by Parse's own hosted Javascript solution called Cloud Code. However, Parse provides the ability to have these hooks utilize your hosted solution instead of their own, since their environment is limited in terms of resources and tools.
 
 ## Field Naming Conventions
@@ -387,7 +386,7 @@ You can always combine both approaches by defining special attributes before you
 
 ```
 
-## Parse Config
+## [Parse Config](https://www.modernistik.com/gems/parse-stack/Parse/API/Config.html)
 Getting your configuration variables once you have a default client setup can be done with `Parse.config`. The first time this method is called, Parse-Stack will get the configuration from Parse Server, and cache it. To force a reload of the config, use `config!`. You
 
 ```ruby
@@ -410,7 +409,7 @@ Getting your configuration variables once you have a default client setup can be
 ## Core Classes
 While some native data types are similar to the ones supported by Ruby natively, other ones are more complex and require their dedicated classes.
 
-### Parse::Pointer
+### [Parse::Pointer](https://www.modernistik.com/gems/parse-stack/Parse/Pointer.html)
 An important concept is the `Parse::Pointer` class. This is the superclass of `Parse::Object` and represents the pointer type in Parse. A `Parse::Pointer` only contains data about the specific Parse class and the `id` for the object. Therefore, creating an instance of any Parse::Object subclass with only the `:id` field set will be considered in "pointer" state even though its specific class is not `Parse::Pointer` type. The only case that you may have a Parse::Pointer is in the case where an object was received for one of your classes and the framework has no registered class handler for it. Using the example above, assume you have the tables `Post`, `Comment` and `Author` defined in your remote Parse application, but have only defined `Post` and `Commentary` locally.
 
 ```ruby
@@ -446,7 +445,7 @@ comment.post.pointer? # false, it is now a full object.
 
 The effect is that for any unknown classes that the framework encounters, it will generate Parse::Pointer instances until you define those classes with valid properties and associations. While this might be ok for some classes you do not use, we still recommend defining all your Parse classes locally in the framework.
 
-### Parse::File
+### [Parse::File](https://www.modernistik.com/gems/parse-stack/Parse/File.html)
 This class represents a Parse file pointer. `Parse::File` has helper methods to upload Parse files directly to Parse and manage file associations with your classes. Using our Song class example:
 
 ```ruby
@@ -500,7 +499,7 @@ file.url # => https://www.example.com/file.png
 
 ```
 
-### Parse::Date
+### [Parse::Date](https://www.modernistik.com/gems/parse-stack/Parse/Date.html)
 This class manages dates in the special JSON format it requires for properties of type `:date`. `Parse::Date` subclasses `DateTime`, which allows you to use any features or methods available to `DateTime` with `Parse::Date`. While the conversion between `Time` and `DateTime` objects to a `Parse::Date` object is done implicitly for you, you can use the added special methods, `DateTime#parse_date` and `Time#parse_date`, for special occasions.
 
 ```ruby
@@ -543,7 +542,7 @@ We include helper methods to calculate distances between GeoPoints: `distance_in
 	# ~180.793 km
 ```
 
-### Parse::Bytes
+### [Parse::Bytes](https://www.modernistik.com/gems/parse-stack/Parse/Bytes.html)
 The `Bytes` data type represents the storage format for binary content in a Parse column. The content is needs to be encoded into a base64 string.
 
 ```ruby
@@ -555,7 +554,7 @@ The `Bytes` data type represents the storage format for binary content in a Pars
   decoded = bytes.decoded # same as Base64.decode64
 ```
 
-### Parse::ACL
+### [Parse::ACL](https://www.modernistik.com/gems/parse-stack/Parse/ACL.html)
 The `ACL` class represents the access control lists for each record. An ACL is represented by a JSON object with the keys being `Parse::User` object ids or the special key of `*`, which indicates the public access permissions.
 The value of each key in the hash is a `Parse::ACL::Permission` object which defines the boolean permission state for `read` and `write`.
 
@@ -592,10 +591,10 @@ All `Parse::Object` subclasses have an `acl` property by default. With this prop
   artist.save
 ```
 
-For more information about Parse record ACLs, see the documentation at  [Security](https://parseplatform.github.io/docs/rest/guide/#security)
+For more information about Parse record ACLs, see the documentation at  [Security](http://docs.parseplatform.org/rest/guide/#security)
 
-### 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](http://www.rubydoc.info/github/modernistik/parse-stack/Parse/Session).
+### [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`.
 
 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`.
 
@@ -607,16 +606,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
+some_object.save( session: user.session_token )
+
+# delete an object with the priviledges of this user
+some_object.destroy( session: user.session_token )
+
 ```
 
-### 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](http://www.rubydoc.info/github/modernistik/parse-stack/Parse/Installation).
+### [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::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::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](http://www.rubydoc.info/github/modernistik/parse-stack/Parse/Role).
+### [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::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](http://www.rubydoc.info/github/modernistik/parse-stack/Parse/User).
+### [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`.
 
 #### 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.
@@ -630,7 +638,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](https://parseplatform.github.io/docs/rest/guide/#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 [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](https://github.com/ParsePlatform/parse-server/wiki/OAuth).
 
 ```ruby
 fb_auth = {}
@@ -686,7 +694,7 @@ user.logout # deletes the corresponding session
 ```
 
 #### Linking and Unlinking
-You can link or unlink user accounts with third-party services like Facebook and Twitter as described in: [Linking and Unlinking Users](https://parseplatform.github.io/docs/rest/guide/#linking). 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 [OAuth](https://github.com/ParsePlatform/parse-server/wiki/OAuth).
+You can link or unlink user accounts with third-party services like Facebook and Twitter as described in: [Linking and Unlinking Users](http://docs.parseplatform.org/rest/guide/#linking-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 [OAuth](http://docs.parseplatform.org/parse-server/guide/#oauth-and-3rd-party-authentication).
 
 ```ruby
 
@@ -995,7 +1003,7 @@ band.drummer # Artist object
 ###### `:field`
 This option allows you to set the name of the remote Parse column for this property. Using this will explicitly set the remote property name to the value of this option. The value provided for this option will affect the name of the alias method that is generated when `alias` option is used. **By default, the name of the remote column is the lower-first camel case version of the property name. As an example, for a property with key `:my_property_name`, the framework will implicitly assume that the remote column is `myPropertyName`.**
 
-#### Has One
+#### [Has One](https://www.modernistik.com/gems/parse-stack/Parse/Associations/HasOne.html)
 The `has_one` creates a one-to-one association with another Parse class. This association says that the other class in the association contains a foreign pointer column which references instances of this class. If your model contains a column that is a Parse pointer to another class, you should use `belongs_to` for that association instead.
 
 Defining a `has_one` property generates a helper query method to fetch a particular record from a foreign class. This is useful for setting up the inverse relationship accessors of a `belongs_to`. In the case of the `has_one` relationship, the `:field` option represents the name of the column of the foreign class where the Parse pointer is stored. By default, the lower-first camel case version of the Parse class name is used.
@@ -1054,8 +1062,8 @@ user.band_by_status(false)
 
 ```
 
-#### Has Many
-Parse has many ways to implement one-to-many and many-to-many associations: `Array`, `Parse Relation` or through a `Query`. How you decide 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 [Relational Data](https://parseplatform.github.io/docs/js/guide/#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.
+#### [Has Many](https://www.modernistik.com/gems/parse-stack/Parse/Associations/HasMany.html)
+Parse has many ways to implement one-to-many and many-to-many associations: `Array`, `Parse Relation` or through a `Query`. How you decide 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 [Relational Data](http://docs.parseplatform.org/js/guide/#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.
 
 In addition to `Array` and `Relation`, Parse-Stack also implements the standard `has_many` behavior prevalent in other frameworks through a query where the associated class contains a foreign pointer to the local class, usually the inverse of a `belongs_to`. This requires that the associated class has a defined column
 that contains a pointer the refers to the defining class.
@@ -1170,13 +1178,13 @@ band.save
 ```
 
 ##### Parse Relation
-Other than the use of arrays, Parse supports native one-to-many and many-to-many associations through what is referred to as a [Parse Relation](https://parseplatform.github.io/docs/js/guide/#many-to-many-relationships). 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 as a Parse relation to another class type, will create a one-way intermediate "join-list" between the local class and the foreign class. One important distinction of this compared to other types of data stores (ex. PostgresSQL) is that:
+Other than the use of arrays, Parse supports native one-to-many and many-to-many associations through what is referred to as a [Parse Relation](http://docs.parseplatform.org/js/guide/#many-to-many-relationships). 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 as a Parse relation to another class type, will create a one-way intermediate "join-list" between the local class and the foreign class. One important distinction of this compared to other types of data stores (ex. PostgresSQL) is that:
 
 1. The inverse relationship association is not available automatically. Therefore, having a column of `artists` in a `Band` class that relates to members of the band (as `Artist` class), does not automatically make a set of `Band` records available to `Artist` records for which they have been related. If you need to maintain both the inverse relationship between a foreign class to its associations, you will need to manually manage that by adding two Parse relation columns in each class, or by creating a separate class (ex. `ArtistBands`) that is used as a join table.
 2. Querying the relation is actually performed against the implicit join table, not the local one.
 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 [Parse Relations Guide](http://parseplatform.github.io/docs/ios/guide/#relations). Parse-Stack will handle the work for (2) and (3) automatically.
+The Parse documentation provides more details on associations, see [Parse Relations Guide](http://docs.parseplatform.org/ios/guide/#relations). 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 `Relation<Fan>` column in the `Band` class that references the `Fan` class. Parse-Stack provides methods to manage the relationship under the [Parse::RelationCollectionProxy](https://github.com/modernistik/parse-stack/blob/master/lib/parse/model/associations/relation_collection_proxy.rb) class.
 
@@ -1261,7 +1269,7 @@ author.posts # => Posts where author's name is a tag
 ```
 
 ## Creating, Saving and Deleting Records
-This section provides some of the basic methods when creating, updating and deleting objects from Parse. To illustrate the various methods available for saving Parse records, we use this example class:
+This section provides some of the basic methods when creating, updating and deleting objects from Parse. Additional documentation for these APIs can be found under [Parse::Core::Actions](https://www.modernistik.com/gems/parse-stack/Parse/Core/Actions.html). To illustrate the various methods available for saving Parse records, we use this example class:
 
 ```ruby
 
@@ -1365,6 +1373,20 @@ 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).
+
+```ruby
+  user = Parse::User.login('myuser','pass')
+
+  song = Song.first
+  song.title = "My New Title"
+  # save this song as if you were this user.
+  # If the user does not have access rights, it will fail
+  song.save session: user.session_token
+  # shorthand: song.save session: user
+```
+
 #### Raising an exception when save fails
 By default, we return `true` or `false` for save and destroy operations. If you prefer to have `Parse::Object` raise an exception instead, you can tell to do so either globally or on a per-model basis. When a save fails, it will raise a `Parse::RecordNotSaved`.
 
@@ -1628,7 +1650,7 @@ If you only need to know the result count for a query, provide count a non-zero
 ```
 
 ### Query Expressions
-The set of supported expressions based on what is available through the Parse REST API. _For those who don't prefer the DataMapper style syntax, we have provided method accessors for each of the expressions._
+The set of supported expressions based on what is available through the Parse REST API. _For those who don't prefer the DataMapper style syntax, we have provided method accessors for each of the expressions._ A full description of supported query  operations, please refer to the [`Parse::Query`](https://www.modernistik.com/gems/parse-stack/Parse/Query.html) API reference.
 
 #### :order
 Specify a field to sort by.
@@ -1724,7 +1746,7 @@ The `where` clause is based on utilizing a set of constraints on the defined col
 ```
 
 ## Query Constraints
-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://parseplatform.github.io/docs/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.
+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
 Default query constraint for matching a field to a single value.
@@ -2118,9 +2140,10 @@ puts song.name # 'My Title'
 There are also a special `:create` callback. A `before_create` will be called whenever a unsaved object will be saved, and `after_create` will be called when a previously unsaved object successfully saved for the first time.
 
 ## Schema Upgrades and Migrations
-You may change your local Parse ruby classes by adding new properties. To easily propagate the changes to your Parse application (MongoDB), you can call `auto_upgrade!` on the class to perform an non-destructive additive schema change. This will create the new columns in Parse for the properties you have defined in your models. Parse Stack will calculate the changes and only modify the tables which need new columns to be added. *It will not destroy columns or data*
+You may change your local Parse ruby classes by adding new properties. To easily propagate the changes to your Parse Server application (MongoDB), you can call `auto_upgrade!` on the class to perform an non-destructive additive schema change. This will create the new columns in Parse for the properties you have defined in your models. Parse Stack will calculate the changes and only modify the tables which need new columns to be added.  This feature does require the use of the master key when configuring the client. *It will NOT destroy columns or data.*
 
 ```ruby
+  # auto_upgrade! requires use of master key
   # upgrade the a class individually
   Song.auto_upgrade!
 
@@ -2233,7 +2256,7 @@ You can register webhooks to handle the different object triggers: `:before_save
 
 For any `after_*` hook, return values are not needed since Parse does not utilize them. You may also register as many `after_save` or `after_delete` handlers as you prefer, all of them will be called.
 
-`before_save` and `before_delete` hooks have special functionality. When the `error!` method is called by the provided block, the framework will return the correct error response to Parse with value provided. Returning an error will prevent Parse from saving the object in the case of `before_save` and will prevent Parse from deleting the object when in a `before_delete`. In addition, for a `before_save`, the last value returned by the block will be the value returned in the success response. If the block returns nil or an `empty?` value, it will return `true` as the default response. You can also return a JSON object in a hash format to override the values that will be saved. However, we recommend modifying the `parse_object` provided since it has dirty tracking, and then returning that same object. This will automatically call your model specific `before_save` callbacks and send the proper payload back to Parse. For more details, see [Cloud Code BeforeSave Webhooks](http://parseplatform.github.io/docs/cloudcode/guide/#cloud-code-advanced-beforesave-webhooks)
+`before_save` and `before_delete` hooks have special functionality. When the `error!` method is called by the provided block, the framework will return the correct error response to Parse with value provided. Returning an error will prevent Parse from saving the object in the case of `before_save` and will prevent Parse from deleting the object when in a `before_delete`. In addition, for a `before_save`, the last value returned by the block will be the value returned in the success response. If the block returns nil or an `empty?` value, it will return `true` as the default response. You can also return a JSON object in a hash format to override the values that will be saved. However, we recommend modifying the `parse_object` provided since it has dirty tracking, and then returning that same object. This will automatically call your model specific `before_save` callbacks and send the proper payload back to Parse. For more details, see [Cloud Code BeforeSave Webhooks](http://docs.parseplatform.org/cloudcode/guide/#beforesave-triggers)
 
 ```ruby
 # recommended way
@@ -2324,7 +2347,7 @@ However, we have predefined a few rake tasks you can use in your application. Ju
 Then you can see the tasks available by typing `rake -T`.
 
 ## Parse REST API Client
-While in most cases you do not have to work with `Parse::Client` directly, you can still utilize it for any raw requests that are not supported by the framework. We provide support for most of the [Parse REST API](http://parseplatform.github.io/docs/rest/guide/#quick-reference) endpoints as helper methods, however you can use the `request()` method to make your own API requests. Parse::Client will handle header authentication, request/response generation and caching.
+While in most cases you do not have to work with `Parse::Client` directly, you can still utilize it for any raw requests that are not supported by the framework. We provide support for most of the [Parse REST API](http://docs.parseplatform.org/rest/guide/#quick-reference) endpoints as helper methods, however you can use the `request()` method to make your own API requests. Parse::Client will handle header authentication, request/response generation and caching.
 
 ```ruby
 client = Parse::Client.new(application_id: <string>, api_key: <string>) do |conn|

data/Rakefile

@@ -1,6 +1,6 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
-
+require 'yard'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
@@ -23,6 +23,12 @@ task 'yard:stats' do
 end
 
 desc 'Start the yard server'
-task 'yard' do
+task 'docs' do
   exec 'rm -rf ./yard && yard server --reload'
 end
+
+YARD::Rake::YardocTask.new do |t|
+ t.files   = ['lib/**/*.rb']   # optional
+ # t.options = ['--any', '--extra', '--opts'] # optional
+ t.stats_options = ['--list-undoc']         # optional
+end

data/bin/console

@@ -11,8 +11,10 @@ Parse.setup # cache: 'redis://localhost:6379'
 puts "[ParseServerURL] #{Parse.client.server_url}"
 puts "[ParseAppID]     #{Parse.client.app_id}"
 
-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
 # 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

@@ -2,6 +2,8 @@
 
 require 'optparse'
 require 'json'
+require 'open-uri'
+
 DEFAULT_CONFIG_FILE = 'config.json'
 DEFAULT_CONFIG_CONTENTS = {
   "apps": [{
@@ -68,6 +70,21 @@ opt_parser = OptionParser.new do |o|
     end
 
   end
+  o.on('--url URL', 'Load the env config from a url.') do |url|
+    begin
+      puts "Loading config: #{url}"
+      json = JSON.load open(url)
+      raise "Contents not a JSON hash." unless json.is_a?(Hash)
+      json.each { |k,v| ENV[k.upcase] = v }
+      opts[:server_url] ||= ENV['PARSE_SERVER_URL']
+      opts[:app_id] ||= ENV['PARSE_APP_ID'] || ENV['PARSE_APPLICATION_ID']
+      opts[:api_key] ||= ENV['PARSE_REST_API_KEY'] || ENV['PARSE_API_KEY']
+      opts[:master_key] ||= ENV['PARSE_MASTER_KEY']
+    rescue Exception => e
+      $stderr.puts "Error: Invalid JSON format for #{url} (#{e})"
+      exit 1
+    end
+  end
 end
 opt_parser.parse!
 
@@ -94,9 +111,9 @@ Parse.setup server_url: opts[:server_url],
 Parse.logging = true if opts[:verbose]
 puts "Server : #{Parse.client.server_url}"
 puts "App Id : #{Parse.client.app_id}"
-puts "Master : #{opts[:master_key].present?}"
+puts "Master : #{Parse.client.master_key.present?}"
 
-if opts[:master_key].present?
+if Parse.client.master_key.present?
   puts "Schema : imported"
   Parse.auto_generate_models!.each do |model|
     puts "Generated #{model}" if opts[:verbose]
@@ -105,11 +122,7 @@ else
   puts "Schema : skipped (requires master key)"
 end
 # Create shortnames
-User = Parse::User
-Installation = Parse::Installation
-Session = Parse::Session
-Role = Parse::Role
-Product = Parse::Product
+Parse.use_shortnames!
 
 if opts[:pry]
   require "pry"

data/lib/parse/model/bytes.rb

@@ -35,8 +35,9 @@ module Parse
     end
 
     # Base64 encode and set the instance contents
-    def encode(s)
-      @base64 = Base64.encode64(s)
+    # @param str the string to encode
+    def encode(str)
+      @base64 = Base64.encode64(str)
     end
 
     # Get the content as decoded base64 bytes

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

@@ -499,18 +499,31 @@ module Parse
         @_session_token
       end
 
+      # @!visibility private
+      def _validate_session_token!(token, action = :save)
+        return nil if token.nil? # user explicitly requests no session token
+        token = token.session_token if token.respond_to?(:session_token)
+        return token if token.is_a?(String) && token.present?
+        raise ArgumentError, "#{self.class}##{action} error: Invalid session token passed (#{token})"
+      end
+
       # saves the object. If the object has not changed, it is a noop. If it is new,
       # 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.
+      #
       # You can define before and after :save callbacks
       # autoraise: set to true will automatically raise an exception if the save fails
       # @raise Parse::RecordNotSaved if the save fails
-      # @param autoraise [Boolean] whether to raise an exception if the save fails.
+      # @raise ArgumentError if a non-nil value is passed to `session` that doesn't provide a session token string.
       # @param session [String] a session token in order to apply ACLs to this operation.
+      # @param autoraise [Boolean] whether to raise an exception if the save fails.
       # @return [Boolean] whether the save was successful.
-      def save(autoraise: false, session: nil)
+      def save(session: nil, autoraise: false)
+        @_session_token = _validate_session_token! session, :save
         return true unless changed?
         success = false
-        @_session_token = session
         run_callbacks :save do
           #first process the create/update action if any
           #then perform any relation changes that need to be performed
@@ -543,6 +556,7 @@ module Parse
 
       # Save this object and raise an exception if it fails.
       # @raise Parse::RecordNotSaved if the save fails
+      # @raise ArgumentError if a non-nil value is passed to `session` that doesn't provide a session token string.
       # @param session (see #save)
       # @return (see #save)
       def save!(session: nil)
@@ -553,10 +567,11 @@ module Parse
       # Delete this record from the Parse collection. Only valid if this object has an `id`.
       # This will run all the `destroy` callbacks.
       # @param session [String] a session token if you want to apply ACLs for a user in this operation.
+      # @raise ArgumentError if a non-nil value is passed to `session` that doesn't provide a session token string.
       # @return [Boolean] whether the operation was successful.
       def destroy(session: nil)
+        @_session_token = _validate_session_token! session, :destroy
         return false if new?
-        @_session_token = session
         success = false
         run_callbacks :destroy do
           res = client.delete_object parse_class, id, session_token: _session_token

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

@@ -70,14 +70,34 @@ module Parse
         # the collection doesn't exist, we create the schema. If the collection already
         # exists, the current schema is fetched, and only add the additional fields
         # that are missing.
-        # @note No columns or fields are removed, this is a safe non-destructive upgrade.
+        # @note This feature requires use of the master_key. No columns or fields are removed, this is a safe non-destructive upgrade.
         # @return [Parse::Response] if the remote schema was modified.
         # @return [Boolean] if no changes were made to the schema, it returns true.
         def auto_upgrade!
+
+          unless client.master_key.present?
+            warn "[Parse] Schema changes for #{parse_class} is only available with the master key!"
+            return false
+          end
+          # fetch the current schema (requires master key)
           response = fetch_schema
+
+          # if it's a core class that doesn't exist, then create the collection without any fields,
+          # since parse-server will automatically create the collection with the set of core fields.
+          # then fetch the schema again, to add the missing fields.
+          if response.error? && self.to_s.start_with?('Parse::') #is it a core class?
+            client.create_schema parse_class, {}
+            response = fetch_schema
+            # if it still wasn't able to be created, raise an error.
+            if response.error?
+              warn "[Parse] Schema error: unable to create class #{parse_class}"
+              return response
+            end
+          end
+
           if response.success?
             #let's figure out the diff fields
-            remote_fields = response.result["fields"]
+            remote_fields = response.result['fields']
             current_schema = schema
             current_schema[:fields] = current_schema[:fields].reduce({}) do |h,(k,v)|
               #if the field does not exist in Parse, then add it to the update list
@@ -87,7 +107,7 @@ module Parse
             return true if current_schema[:fields].empty?
             return update_schema( current_schema )
           end
-          create_schema
+            create_schema
         end
 
     end

data/lib/parse/model/object.rb

@@ -61,6 +61,12 @@ module Parse
     end
   end
 
+  # Alias shorter names of core Parse class names.
+  # Ex, alias Parse::User to User, Parse::Installation to Installation, etc.
+  def self.use_shortnames!
+    require_relative 'shortnames'
+  end
+
   # This is the core class for all app specific Parse table subclasses. This class
   # in herits from Parse::Pointer since an Object is a Parse::Pointer with additional fields,
   # at a minimum, created_at, updated_at and ACLs.

data/lib/parse/model/shortnames.rb

@@ -0,0 +1,9 @@
+
+require_relative 'object'
+
+# Simple include to use short verion of core class names
+::Installation = Parse::Installation unless defined?(::Installation)
+::Role = Parse::Role unless defined?(::Role)
+::Product = Parse::Product unless defined?(::Product)
+::Session = Parse::Session unless defined?(::Session)
+::User = Parse::User unless defined?(::User)

data/lib/parse/query.rb

@@ -136,11 +136,17 @@ module Parse
     #  or a {Parse::Session} instance.
     #  @example
     #   # perform this query as user represented by session_token
-
     #   query = Parse::Query.new("_User", :name => "Bob")
     #   query.session_token = "r:XyX123..."
+    #
     #   # or inline
     #   query = Parse::Query.new("_User", :name => "Bob", :session => "r:XyX123...")
+    #
+    #   # or with a logged in user object
+    #   user = Parse::User.login('user','pass') # => logged in user'
+    #   user.session_token # => "r:XyZ1234...."
+    #   query = Parse::Query.new("_User", :name => "Bob", :session => user)
+    #  @raise ArgumentError if a non-nil value is passed that doesn't provide a session token string.
     #  @note Using a session_token automatically disables sending the master key in the request.
     #  @return [String] the session token to send with this API request.
     attr_accessor :table, :client, :key, :cache, :use_master_key, :session_token
@@ -321,7 +327,6 @@ module Parse
           self.use_master_key = value
         elsif expression == :session
           # you can pass a session token or a Parse::Session
-          value = value.respond_to?(:session_token) ? value.session_token : value
           self.session_token = value
         else
           add_constraint(expression, value)
@@ -334,6 +339,18 @@ module Parse
       @table = t.to_s.camelize
     end
 
+    def session_token=(value)
+      if value.respond_to?(:session_token) && value.session_token.is_a?(String)
+        value = value.session_token
+      end
+
+      if value.nil? || (value.is_a?(String) && value.present?)
+        @session_token = value
+      else
+        raise ArgumentError, "Invalid session token passed to query."
+      end
+    end
+
     # returns the query clause for the particular clause
     # @param clause_name [Symbol] One of supported clauses to return: :keys,
     #  :where, :order, :includes, :limit, :skip

data/lib/parse/stack.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 # frozen_string_literal: true
-# exit # don't use master branch
+
+exit if ENV['MERCURY_URL'] # don't use master branch
 require_relative "stack/version"
 require_relative 'client'
 require_relative 'query'

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.11"
+    VERSION = "1.6.12"
   end
 end

data/parse-stack.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "parallel", [">= 1.6", "< 2"]
   spec.add_runtime_dependency "faraday", [">= 0.8", "< 1"]
   spec.add_runtime_dependency "faraday_middleware", [">= 0.9", "< 1"]
-  spec.add_runtime_dependency "moneta", [">= 0.7", "< 1"]
+  spec.add_runtime_dependency "moneta", "< 2"
   spec.add_runtime_dependency "rack", "< 3"
 
 #   spec.post_install_message = <<UPGRADE

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parse-stack
 version: !ruby/object:Gem::Version
-  version: 1.6.11
+  version: 1.6.12
 platform: ruby
 authors:
 - Anthony Persaud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-05 00:00:00.000000000 Z
+date: 2017-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -134,22 +134,16 @@ dependencies:
   name: moneta
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -177,6 +171,7 @@ files:
 - ".github/parse-ruby-sdk.png"
 - ".gitignore"
 - ".travis.yml"
+- ".yardopts"
 - Changes.md
 - Gemfile
 - Gemfile.lock
@@ -237,6 +232,7 @@ files:
 - lib/parse/model/object.rb
 - lib/parse/model/pointer.rb
 - lib/parse/model/push.rb
+- lib/parse/model/shortnames.rb
 - lib/parse/query.rb
 - lib/parse/query/constraint.rb
 - lib/parse/query/constraints.rb
@@ -278,7 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Parse Server Ruby Client SDK