parse-stack 1.5.3 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54b0162fed5af5493439188b14b21db3eb1c7ff9
-  data.tar.gz: 17f07ddd2e7a79157f54769c46cee32b4aa03b97
+  metadata.gz: 521333b9d84cd7319911a0e9b368fbfa6133e98e
+  data.tar.gz: 543f3204ab4f4a9df14cbe88aa71be7bd0c69c47
 SHA512:
-  metadata.gz: 93ae12440065bd3aeb3563457048bda7b60b07b08d2169381676d1638ea7acf364f3c9c1d033a741883bc21537f3decd8508bc83968a8ce326fae8004c60c5bd
-  data.tar.gz: cd29ad6665369388220d1599aa375323bbf872e6054541a34a660ebd71b206ddb87a3b8252391b6564c7fe2a0d4481d776ee910efef2509e772c30170469e867
+  metadata.gz: 08b3de4ccf9cd5fdaa9045676b1147600bd3698d0cb99bc526d5172defbedc93e039d994f28350c291ad384470b96830d0e5186dbc5b6710255a95445af57a3b
+  data.tar.gz: 206b597203c7df406463f4a778934c7d79cf3ac76a950803c843bd5fd8b9c5020bdda7b6cd69938c1c738034973114759307b25c6ce1f451e998ac3c15b0797a

data/Changes.md

@@ -1,5 +1,28 @@
 ## Parse-Stack Changelog
 
+### 1.6.0
+- NEW: Auto generate models based on your remote schema.
+- The default server url is now 'http://localhost:1337/parse'.
+- Improves thread-safety of Webhooks middleware.
+- Performance improvements.
+- BeforeSave change payloads do not include the className field.
+- Reaches 100% documentation (will try to keep it up).
+- Retry mechanism now configurable per client through `retry_limit`.
+- Retry now follows sampling back-off delay algorithm.
+- Adds `schemas` API to retrieve all schemas for an application.
+- :number can now be used as an alias for the :integer data type.
+- :geo_point can now be used as an alias for the :geopoint data type.
+- Support accessing properties of Parse::Object subclasses through the [] operator.
+- Support setting properties of Parse::Object subclasses through the []= operator.
+- :to_s method of Parse::Date returns the iso8601(3) by default, if no arguments are provided.
+- Parse::ConstraintError has been removed in favor of ArgumentError.
+- Parse::Payload has been placed under Parse::Webhooks::Payload for clarity.
+- Parse::WebhookErrorResponse has been moved to Parse::Webhooks::ResponseError.
+- Moves Parse::Object modular functionality under Core namespace
+- Renames ClassBuilder to Parse::Model::Builder
+- Renamed SaveFailureError to RecordNotSaved for ActiveRecord similarity.
+- All Parse errors inherit from Parse::Error.
+
 ### 1.5.3
 - Several fixes and performance improvements.
 - Major revisions to documentation.
@@ -18,6 +41,7 @@
 - Parse::File now has a `force_ssl` option that makes sure all urls returned are `https`.
 - Documentation
 - ParseConstraintError is now Parse::ConstraintError.
+- All constraint subclasses are under the Constraint namespace.
 
 ### 1.5.1
 - BREAKING CHANGE: The default `has_many` implementation is `:query` instead of `:array`.
@@ -101,7 +125,7 @@
 ### 1.3.0
 - **IMPORTANT**: __Raising an error no longer sends an error response back to
 the client in a Webhook trigger. You must now call `error!('...')` instead of
-calling `raise '...'`.__ The webhook block is now binded to the Parse::Payload
+calling `raise '...'`.__ The webhook block is now binded to the Parse::Webhooks::Payload
 instance, removing the need to pass `payload` object; use the instance methods directly.
 See updated README.md for more details.
 - **Parse-Stack will throw new exceptions** depending on the error code returned by Parse. These

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    parse-stack (1.5.3)
+    parse-stack (1.6.0)
       active_model_serializers (>= 0.9, < 1)
       activemodel (>= 4.2.1, < 6)
       activesupport (>= 4.2.1, < 6)
@@ -48,10 +48,10 @@ GEM
     debug_inspector (0.0.2)
     dotenv (2.1.1)
     erubis (2.7.0)
-    faraday (0.9.2)
+    faraday (0.10.0)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.10.0)
-      faraday (>= 0.7.4, < 0.10)
+    faraday_middleware (0.10.1)
+      faraday (>= 0.7.4, < 1.0)
     i18n (0.7.0)
     jsonapi (0.1.1.beta6)
       jsonapi-parser (= 0.1.1.beta3)

data/README.md

@@ -1,5 +1,8 @@
-# Parse-Stack - The Parse Server Ruby SDK
-Parse-Stack is a [Parse Server](https://github.com/ParsePlatform/parse-server) SDK and ORM framework for Ruby. It provides a client adapter, a query engine, an object relational mapper (ORM) and a Cloud Code Webhooks rack application.
+<img src='https://raw.githubusercontent.com/modernistik/parse-stack/master/.github/parse-ruby-sdk.png?raw=true' width='500' alt='Ruby Parse SDK'/>
+
+Parse-Stack is the [Parse Server](https://github.com/ParsePlatform/parse-server) SDK 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.
 
 ### Code Status
 [![Gem Version](https://badge.fury.io/rb/parse-stack.svg)](https://badge.fury.io/rb/parse-stack)
@@ -31,7 +34,7 @@ Parse-Stack comes with support for Rails by adding additional rake tasks and gen
 
 For a more details on the rails integration see [Parse-Stack Rails Example](https://github.com/modernistik/parse-stack-rails-example).
 
-## Table Of Contents
+# Parse-Stack - The Parse Server Ruby SDK
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
@@ -45,6 +48,7 @@ For a more details on the rails integration see [Parse-Stack Rails Example](http
 - [Field Naming Conventions](#field-naming-conventions)
 - [Connection Setup](#connection-setup)
   - [Connection Options](#connection-options)
+- [Working With Existing Schemas](#working-with-existing-schemas)
 - [Parse Config](#parse-config)
 - [Core Classes](#core-classes)
   - [Parse::Pointer](#parsepointer)
@@ -147,7 +151,6 @@ For a more details on the rails integration see [Parse-Stack Rails Example](http
   - [Register Webhooks](#register-webhooks)
 - [Parse REST API Client](#parse-rest-api-client)
   - [Request Caching](#request-caching)
-- [Installation](#installation)
 - [Development](#development)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -159,15 +162,15 @@ Parse-Stack is a full stack framework that utilizes several ideas behind [DataMa
 
 require 'parse/stack'
 
-Parse.setup app_id: APP_ID,
+Parse.setup server_url: 'https://localhost:1337/parse',
+            app_id: APP_ID,
             api_key: REST_API_KEY,
-            master_key: YOUR_MASTER_KEY,
-            server_url: 'https://api.parse.com/1/'
+            master_key: YOUR_MASTER_KEY # optional
 
-# login
-user = Parse::User.login(username, passwd)
+# Automatically build models based on your Parse application schemas.
+Parse.auto_generate_models!
 
-# Custom Subclasses
+# or define custom Subclasses (Highly Recommended)
 class Song < Parse::Object
   property :name
   property :play, :integer
@@ -191,6 +194,9 @@ end
 # updates schemas for your Parse app based on your models (non-destructive)
 Parse.auto_upgrade!
 
+# login
+user = Parse::User.login(username, passwd)
+
 artist = Artist.new(name: "Frank Sinatra", genres: ["swing", "jazz"])
 artist.fans << user
 artist.save
@@ -316,6 +322,19 @@ Sets the default cache expiration time (in seconds) for successful non-empty `GE
 #### `:faraday`
 You may pass a hash of options that will be passed to the `Faraday` constructor.
 
+## Working With Existing Schemas
+If you already have a Parse application with defined schemas and collections, you can have Parse-Stack automatically generate the ruby Parse::Object subclasses instead of writing them on your own. Through this process, the framework will download all the defined schemas of all your collections, and infer the properties and associations defined. While this method is useful for getting started with the framework with an existing app, we highly recommend definiting your own models. This would allow you to customize and utilize all the features availabling in Parse::Stack.
+
+```ruby
+  # after you have called Parse.setup
+  # Assume you have a Song and Artist collections defined remotely
+  Parse.auto_generate_models!
+
+  # You can now use them as if you defined them
+  artist = Artist.first
+  Song.all(artist: artist)
+```
+
 ## Parse Config
 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
 
@@ -1295,7 +1314,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.
 
 #### 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::SaveFailureError`.
+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`.
 
 ```ruby
  # globally across all models
@@ -1306,7 +1325,7 @@ By default, we return `true` or `false` for save and destroy operations. If you
  song.save!
 ```
 
-When enabled, if an error is returned by Parse due to saving or destroying a record, due to your `before_save` or `before_delete` validation cloud code triggers, `Parse::Object` will return the a `Parse::SaveFailureError` exception type. This exception has an instance method of `#object` which contains the object that failed to save.
+When enabled, if an error is returned by Parse due to saving or destroying a record, due to your `before_save` or `before_delete` validation cloud code triggers, `Parse::Object` will return the a `Parse::RecordNotSaved` exception type. This exception has an instance method of `#object` which contains the object that failed to save.
 
 ### Modifying Associations
 Similar to `:array` types of properties, a `has_many` association is backed by a collection proxy class and requires the use of `#add` and `#remove` to modify the contents of the association in order for it to correctly manage changes and updates with Parse. Using `has_many` for associations has the additional functionality that we will only add items to the association if they are of a `Parse::Pointer` or `Parse::Object` type. By default, these associations are fetched with only pointer data. To fetch all the objects in the association, you can call `#fetch` or `#fetch!` on the collection. Note that because the framework supports chaining, it is better to only request the objects you need by utilizing their accessors.
@@ -1386,8 +1405,7 @@ songs.destroy
 ```
 
 ### Magic `save_all`
-By default, all Parse queries have a maximum fetch limit of 1000. While using the `:max` option, Parse-Stack can increase this up to 11,000. In the cases where you need to update a large number of objects, you can utilize the `Parse::Object#save_all` method
-to fetch, modify and save objects.
+By default, all Parse queries have a maximum fetch limit of 1000. While using the `:max` option, Parse-Stack can increase this up to 11,000. In the cases where you need to update a large number of objects, you can utilize the `Parse::Object#save_all` method to fetch, modify and save objects.
 
 This methodology works by continually fetching and saving older records related to the time you begin a `save_all` request (called an "anchor date"), until there are no records left to update. To enable this to work, you must have confidence that any modifications you make to the records will successfully save through you validations that may be present in your `before_save`. This is important, as saving a record will set its `updated_at` date to one newer than the "anchor date" of when the `save_all` started. This `save_all` process will stop whenever no more records match the provided constraints that are older than the "anchor date", or when an object that was previously updated, is seen again in a future fetch (_which means the object failed to save_). Note that `save_all` will automatically manage the correct `updated_at` constraints in the query, so it is recommended that you do not use it as part of the initial constraints.
 
@@ -1400,6 +1418,8 @@ This methodology works by continually fetching and saving older records related
   end
 ```
 
+If you plan on using this feature in a lot of places, we recommend making sure you have set a MongoDB index of at least `{ "_updated_at" : 1 }`.
+
 ### Deleting
 You can destroy a Parse record, just call the `#destroy` method. It will return a boolean value whether it was successful.
 
@@ -2084,7 +2104,7 @@ Push notifications are implemented through the `Parse::Push` class. To send push
 ```
 
 ## Cloud Code Webhooks
-Parse Parse allows you to receive Cloud Code webhooks on your own hosted server. The `Parse::Webhooks` class is a lightweight Rack application that routes incoming Cloud Code webhook requests and payloads to locally registered handlers. The payloads are `Parse::Payload` type of objects that represent that data that Parse sends webhook handlers. You can register any of the Cloud Code webhook trigger hooks (`beforeSave`, `afterSave`, `beforeDelete`, `afterDelete`) and function hooks.
+Parse Parse allows you to receive Cloud Code webhooks on your own hosted server. The `Parse::Webhooks` class is a lightweight Rack application that routes incoming Cloud Code webhook requests and payloads to locally registered handlers. The payloads are `Parse::Webhooks::Payload` type of objects that represent that data that Parse sends webhook handlers. You can register any of the Cloud Code webhook trigger hooks (`beforeSave`, `afterSave`, `beforeDelete`, `afterDelete`) and function hooks.
 
 ### Cloud Code Functions
 You can use the `route()` method to register handler blocks. The last value returned by the block will be returned back to the client in a success response. If `error!(value)` is called inside the block, we will return the correct Parse error response with the value you provided.
@@ -2092,7 +2112,7 @@ You can use the `route()` method to register handler blocks. The last value retu
 ```ruby
 # Register handling the 'helloWorld' function.
 Parse::Webhooks.route(:function, :helloWorld) do
-  #  use the Parse::Payload instance methods in this block
+  #  use the Parse::Webhooks::Payload instance methods in this block
   name = params['name'].to_s #function params
   puts "CloudCode Webhook helloWorld called in Ruby!"
   # will return proper error response
@@ -2133,7 +2153,7 @@ end
 ```
 
 ### Cloud Code Triggers
-You can register webhooks to handle the different object triggers: `:before_save`, `:after_save`, `:before_delete` and `:after_delete`. The `payload` object, which is an instance of `Parse::Payload`, contains several properties that represent the payload. One of the most important ones is `parse_object`, which will provide you with the instance of your specific Parse object. In `:before_save` triggers, this object already contains dirty tracking information of what has been changed.
+You can register webhooks to handle the different object triggers: `:before_save`, `:after_save`, `:before_delete` and `:after_delete`. The `payload` object, which is an instance of `Parse::Webhooks::Payload`, contains several properties that represent the payload. One of the most important ones is `parse_object`, which will provide you with the instance of your specific Parse object. In `:before_save` triggers, this object already contains dirty tracking information of what has been changed.
 
 ```ruby
   # recommended way
@@ -2309,20 +2329,6 @@ Song.client.clear_cache!
 
 ```
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'parse-stack'
-```
-
-or install it locally
-
-```ruby
-$ gem install parse-stack
-```
-
 ## Development
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 

data/bin/console

@@ -11,6 +11,9 @@ Parse.setup
 puts "[ParseServerURL] #{Parse.client.server_url}"
 puts "[ParseAppID]     #{Parse.client.app_id}"
 
+Parse.auto_generate_models!.each do |model|
+  puts "Generated #{model}"
+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/lib/parse/api/all.rb

@@ -11,7 +11,8 @@ require_relative "cloud_functions"
 require_relative "hooks"
 require_relative "objects"
 require_relative "push"
-require_relative "schemas"
+require_relative "schema"
+require_relative "server"
 require_relative "sessions"
 require_relative "users"
 

data/lib/parse/api/apps.rb

@@ -4,11 +4,14 @@
 module Parse
 
   module API
+    # @deprecated These specific APIs will no longer be available after Jan 28th, 2017.
     # Defines the Apps interface for the Parse REST API
     module Apps
 
+      # @!visibility private
       APPS_PATH = "apps"
 
+      # @deprecated This method will no longer be available after Jan 28th, 2017.
       # Fetch the application keys.
       # @param appid [String] the application id.
       # @param email [String] your hosted Parse account email.
@@ -16,11 +19,14 @@ module Parse
       # @param headers [Hash] additional HTTP headers to send with the request.
       # @note Only supported by the hosted Parse platform and not the open source Parse-Server.
       # @return [Parse::Response]
+      # @deprecated
       def fetch_app_keys(appid, email, password, headers: {})
+        warn "[Parse::Client#fetch_app_keys] This method will no longer be available after Jan 28th, 2017."
         headers.merge!( { Parse::Protocol::EMAIL => email, Parse::Protocol::PASSWORD => password } )
         request :get, "#{APPS_PATH}/#{appid}", headers: headers
       end
 
+      # @deprecated This method will no longer be available after Jan 28th, 2017.
       # Fetch the applications.
       # @param email [String] your hosted Parse account email.
       # @param password [String] your hosted Parse account password.
@@ -28,10 +34,12 @@ module Parse
       # @note Only supported by the hosted Parse platform and not the open source Parse-Server.
       # @return [Parse::Response]
       def fetch_apps(email, password, headers: {})
+        warn "[Parse::Client#fetch_apps] This method will no longer be available after Jan 28th, 2017."
         headers.merge!( { Parse::Protocol::EMAIL => email, Parse::Protocol::PASSWORD => password } )
         request :get, APPS_PATH, headers: headers
       end
 
+      # @deprecated This method will no longer be available after Jan 28th, 2017.
       # Create a new application in the hosted Parse Platform.
       # @param body [Hash] parameters for creating the app.
       # @param email [String] your hosted Parse account email.
@@ -40,10 +48,13 @@ module Parse
       # @note Only supported by the hosted Parse platform and not the open source Parse-Server.
       # @return [Parse::Response]
       def create_app(body, email, password, headers: {})
+        warn "[Parse::Client#create_app] This method will no longer be available after Jan 28th, 2017."
         headers.merge!( { Parse::Protocol::EMAIL => email, Parse::Protocol::PASSWORD => password } )
         request :post, APPS_PATH, body: body, headers: headers
       end
 
+      # @deprecated This method will no longer be available after Jan 28th, 2017.
+      # Updates information about a particular app.
       # @param appid [String] the application id.
       # @param body [Hash] parameters to update the app.
       # @param email [String] your hosted Parse account email.
@@ -52,6 +63,7 @@ module Parse
       # @note Only supported by the hosted Parse platform and not the open source Parse-Server.
       # @return [Parse::Response]
       def update_app(appid, body, email, password, headers: {})
+        warn "[Parse::Client#update_app] This method will no longer be available after Jan 28th, 2017."
         headers.merge!( { Parse::Protocol::EMAIL => email, Parse::Protocol::PASSWORD => password } )
         request :put, "#{APPS_PATH}/#{appid}", body: body, headers: headers
       end

data/lib/parse/api/config.rb

@@ -6,8 +6,12 @@ module Parse
   module API
     # Defines the Config interface for the Parse REST API
     module Config
-      # @return [Hash] the cached config hash for the client.
+
+      # @!attribute config
+      #  @return [Hash] the cached config hash for the client.
       attr_accessor :config
+
+      # @!visibility private
       CONFIG_PATH = "config"
 
       # @return [Hash] force fetch the application configuration hash.

data/lib/parse/api/files.rb

@@ -9,6 +9,7 @@ module Parse
   module API
     # Defines the Parse Files interface for the Parse REST API
     module Files
+      # @!visibility private
       FILES_PATH = "files"
 
       # Upload and create a Parse file.

data/lib/parse/api/hooks.rb

@@ -7,6 +7,7 @@ module Parse
   module API
     # Defines the Parse webhooks interface for the Parse REST API
     module Hooks
+      # @!visibility private
       HOOKS_PREFIX = "hooks/"
       # The allowed set of Parse triggers.
       TRIGGER_NAMES = [:beforeSave, :afterSave, :beforeDelete, :afterDelete].freeze

data/lib/parse/api/objects.rb

@@ -10,8 +10,10 @@ module Parse
     # REST API methods for fetching CRUD operations on Parse objects.
     module Objects
       # The class prefix for fetching objects.
+      # @!visibility private
       CLASS_PATH_PREFIX = "classes/"
-      # The class prefix mapping for fetching objects.
+
+      # @!visibility private
       PREFIX_MAP = { installation: "installations", _installation: "installations",
         user: "users", _user: "users",
         role: "roles", _role: "roles",
@@ -23,6 +25,7 @@ module Parse
         base.extend(ClassMethods)
       end
 
+      # Class methods to be applied to {Parse::Client}
       module ClassMethods
         # Get the API path for this class.
         # @param className [String] the name of the Parse collection.

data/lib/parse/api/push.rb

@@ -6,6 +6,7 @@ module Parse
   module API
     # Defines the Parse Push notification service interface for the Parse REST API
     module Push
+      # @!visibility private
       PUSH_PATH = "push"
 
       # Update the schema for a collection.

data/lib/parse/api/{schemas.rb → schema.rb}

@@ -6,8 +6,15 @@ module Parse
   module API
     # Defines the Schema interface for the Parse REST API
     module Schema
+      # @!visibility private
       SCHEMAS_PATH = "schemas"
 
+      # Get all the schemas for the application.
+      # @return [Parse::Response]
+      def schemas
+        request :get, SCHEMAS_PATH
+      end
+
       # Get the schema for a collection.
       # @param className [String] the name of the remote Parse collection.
       # @return [Parse::Response]

data/lib/parse/api/server.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+module Parse
+
+  module API
+    # APIs related to the open source Parse Server.
+    module Server
+
+      # @!attribute server_info
+      #  @return [Hash] the information about the server.
+      attr_accessor :server_info
+
+      # @!visibility private
+      SERVER_INFO_PATH = 'serverInfo'
+
+      # Fetch and cache information about the Parse server configuration. This
+      # hash contains information specifically to the configuration of the running
+      # parse server.
+      # @return (see #server_info!)
+      def server_info
+        return @server_info if @server_info.present?
+        response = request :get, SERVER_INFO_PATH
+        @server_info = response.error? ? nil :
+                       response.result.with_indifferent_access
+      end
+
+      # Force fetches the server information.
+      # @return [Hash] a hash containing server configuration if available.
+      def server_info!
+        @server_info = nil
+        server_info
+      end
+
+      # Returns the version of the Parse server the client is connected to.
+      # @return [String] a version string (ex. '2.2.25') if available.
+      def server_version
+        server_info.present? ? @server_info[:parseServerVersion] : nil
+      end
+
+    end
+  end
+
+end