parse-stack 1.7.3 → 1.9.1

data/README.md

@@ -1,15 +1,12 @@
-<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 Server Ruby Client SDK](https://raw.githubusercontent.com/modernistik/parse-stack/master/parse-stack.png?raw=true)
 
-# Parse Stack - The Parse Server Ruby Client SDK
-
-[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.
+A full featured Active Model ORM and Ruby REST API for Parse-Server. [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/index.html)* for more detailed information about our Parse Server SDK.
 
-#### Tutorial Videos
-1. Getting Started: https://youtu.be/zoYSGmciDlQ
-2. Custom Classes and Relations: https://youtu.be/tfSesotfU7w
-3. Working with Existing Schemas: https://youtu.be/EJGPT7YWyXA
+### Hire Us
+
+Interested in our work? You can find us here: [https://www.modernistik.com](https://www.modernistik.com)
 
 ### Code Status
 [![Gem Version](https://img.shields.io/gem/v/parse-stack.svg)](https://github.com/modernistik/parse-stack)
@@ -17,8 +14,12 @@ Below is a [quick start guide](https://github.com/modernistik/parse-stack#overvi
 [![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/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)
+#### Tutorial Videos
+1. Getting Started: https://youtu.be/zoYSGmciDlQ
+2. Custom Classes and Relations: https://youtu.be/tfSesotfU7w
+3. Working with Existing Schemas: https://youtu.be/EJGPT7YWyXA
+
+Any other questions, please post them on StackOverflow with the proper parse-stack / parse-server / ruby tags.
 
 ## Installation
 
@@ -135,7 +136,7 @@ result = Parse.call_function :myFunctionName, {param: value}
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-- [Overview](#overview)
+
 - [Architecture](#architecture)
   - [Parse::Client](#parseclient)
   - [Parse::Query](#parsequery)
@@ -204,6 +205,7 @@ result = Parse.call_function :myFunctionName, {param: value}
 - [Advanced Querying](#advanced-querying)
   - [Results Caching](#results-caching)
   - [Counting](#counting)
+  - [Distinct Aggregation](#distinct-aggregation)
   - [Query Expressions](#query-expressions)
     - [:order](#order)
     - [:keys](#keys)
@@ -236,6 +238,7 @@ result = Parse.call_function :myFunctionName, {param: value}
     - [Max Distance Constraint](#max-distance-constraint)
     - [Bounding Box Constraint](#bounding-box-constraint)
     - [Polygon Area Constraint](#polygon-area-constraint)
+    - [Full Text Search Constraint](#full-text-search-constraint)
   - [Relational Queries](#relational-queries)
   - [Compound Queries](#compound-queries)
 - [Query Scopes](#query-scopes)
@@ -350,7 +353,7 @@ A caching adapter of type `Moneta::Transformer`. Caching queries and object fetc
   Parse.setup(cache: store, expires: 10, ...)
 ```
 
-As a shortcut, if you are planning on using REDIS and have configured the use of `redis` in your `Gemfile`, you can just pass the redis connection string directly to the cache option.
+As a shortcut, if you are planning on using REDIS and have configured the use of `redis` in your `Gemfile`, you can just pass the REDIS connection string directly to the cache option.
 
 ```ruby
   Parse.setup(cache: 'redis://localhost:6379', ...)
@@ -363,7 +366,7 @@ Sets the default cache expiration time (in seconds) for successful non-empty `GE
 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.
+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 defining your own models. This would allow you to customize and utilize all the features available in Parse Stack.
 
 ```ruby
   # after you have called Parse.setup
@@ -516,8 +519,6 @@ This class manages dates in the special JSON format it requires for properties o
   song.save # ok
 ```
 
-One important note with dates, is that `created_at` and `updated_at` columns do not follow this convention all the time. Depending on the Cloud Code SDK, they can be the Parse ISO hash date format or the `iso8601` string format. By default, these are serialized as `iso8601` when sent as responses to Parse for backwards compatibility with some clients. To use the Parse ISO hash format for these fields instead, set `Parse::Object.disable_serialized_string_date = true`.
-
 ### [Parse::GeoPoint](https://www.modernistik.com/gems/parse-stack/Parse/GeoPoint.html)
 This class manages the GeoPoint data type that Parse provides to support geo-queries. To define a GeoPoint property, use the `:geopoint` data type. Please note that latitudes should not be between -90.0 and 90.0, and longitudes should be between -180.0 and 180.0.
 
@@ -627,7 +628,7 @@ 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`:
+You may also set default ACLs for newly created instances of your subclasses using `set_default_acl`:
 
 ```ruby
 class AdminData < Parse::Object
@@ -864,7 +865,7 @@ end
 
 After properties are defined, you can use appropriate getter and setter methods to modify the values. As properties become modified, the model will keep track of the changes using the [dirty tracking feature of ActiveModel](http://api.rubyonrails.org/classes/ActiveModel/Dirty.html). If an attribute is modified in-place then make use of **[attribute_name]_will_change!** to mark that the attribute is changing. Otherwise ActiveModel can't track changes to in-place attributes.
 
-To support dirty tracking on properties of data type of `:array`, we utilize a proxy class called `Parse::CollectionProxy`. This class has special functionality which allows lazy loading of content as well and keeping track of the changes that are made. While you are able to access the internal array on the collection through the `#collection` method, it is important not to make in-place edits to the object. You should use the preferred methods of `#add` and `#remove` to modify the contents of the collection. When `#save` is called on the object, the changes will be commited to Parse.
+To support dirty tracking on properties of data type of `:array`, we utilize a proxy class called `Parse::CollectionProxy`. This class has special functionality which allows lazy loading of content as well and keeping track of the changes that are made. While you are able to access the internal array on the collection through the `#collection` method, it is important not to make in-place edits to the object. You should use the preferred methods of `#add` and `#remove` to modify the contents of the collection. When `#save` is called on the object, the changes will be committed to Parse.
 
 ```ruby
 post = Post.first
@@ -1525,7 +1526,7 @@ For the cases when you want to modify the items in this association without havi
   artist.songs.add! song # Add operation
   artist.songs.add_unique! other_song # AddUnique operation
   artist.songs.remove! another_song # Remove operation
-  artist.save # noop. operations were sent directly to Parse
+  artist.save # no-op. (no operations were sent directly to Parse)
 
   artist.songs.destroy! # Delete operation of all Songs
 ```
@@ -1648,7 +1649,7 @@ However, Parse-Stack performs automatic fetching of associations when the associ
   song.artist.name
 
   # You can manually do the same with `fetch` and `fetch!`
-  song.artist.fetch # considered "fetch if needed". Noop if not needed.
+  song.artist.fetch # considered "fetch if needed". No-op if not needed.
   song.artist.fetch! # force fetch regardless of state.
 ```
 
@@ -1733,7 +1734,8 @@ When a query API is made, the results are cached in the query object in case you
 ```
 
 ### Counting
-If you only need to know the result count for a query, provide count a non-zero value. However, if you need to perform a count query, use `count()` method instead.
+If you only need to know the result count for a query, provide count a
+non-zero value. However, if you need to perform a count query, use `count()` method instead.
 
 ```ruby
  # get number of songs with a play_count > 10
@@ -1746,6 +1748,23 @@ If you only need to know the result count for a query, provide count a non-zero
 
 ```
 
+### Distinct Aggregation
+Finds the distinct values for a specified field across a single collection or
+view and returns the results in an array. You may mix this with additional query constraints.
+
+```ruby
+ # Return a list of unique city names
+ # for users created in the last 10 days.
+ User.distinct :city, :created_at.after => 10.days.ago
+ # ex. ["San Diego", "Los Angeles", "San Juan"]
+
+ # same
+ query = Parse::Query.new("_User")
+ query.where :created_at.after => 10.days.ago
+ query.distinct(:city) #=> ["San Diego", "Los Angeles", "San Juan"]
+
+```
+
 ### 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._ 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.
 
@@ -1788,16 +1807,16 @@ Use on Pointer columns to return the full object. You may chain multiple columns
 ```
 
 #### :limit
-Limit the number of objects returned by the query. The default is 100, with Parse allowing a maximum of 1000. The framework also allows a value of `:max`. Utilizing this will have the framework continually intelligently utilize `:skip` to continue to paginate through results until an empty result set is received or the `:skip` limit is reached (10,000). When utilizing `all()`, `:max` is the default option for `:limit`.
+Limit the number of objects returned by the query. The default is 100, with Parse allowing a maximum of 1000. The framework also allows a value of `:max`. Utilizing this will have the framework continually intelligently utilize `:skip` to continue to paginate through results until an empty result set is received or the `:skip` limit is reached. When utilizing `all()`, `:max` is the default option for `:limit`.
 
 ```ruby
  Song.all :limit => 1 # same as Song.first
  Song.all :limit => 1000 # maximum allowed by Parse
- Song.all :limit => :max # up to 11,000 records (theoretical).
+ Song.all :limit => :max
 ```
 
 #### :skip
-Use with limit to paginate through results. Default is 0 with maximum value being 10,000.
+Use with limit to paginate through results. Default is 0.
 
 ```ruby
  # get the next 3 songs after the first 10
@@ -2153,6 +2172,30 @@ Equivalent to the `$geoWithin` Parse query operation and `$polygon` geopoint con
  SunkenShip.all :location.within_polygon => [bermuda, san_juan, miami]
 ```
 
+#### [Full Text Search Constraint](https://www.modernistik.com/gems/parse-stack/Parse/Constraint/FullTextSearchQueryConstraint.html)
+Equivalent to the `$text` Parse query operation and `$search` parameter constraint for efficient search capabilities. By creating indexes on one or more columns your strings are turned into tokens for full text search functionality. The `$search` key can take any number of parameters in hash form. *Requires Parse Server 2.5.0 or later*
+
+```ruby
+ # Do a full text search on "anthony"
+ q.where :field.text_search => "anthony"
+
+ # perform advance searches
+ q.where :field.text_search => {term: "anthony", case_insensitive: true}
+ # equivalent
+ q.where :field.text_search => {:$term => "anthony", :$caseInsensitive => true}
+```
+
+You may use the following keys for the parameters clause.
+
+| Parameter | Use |
+| :--- | :----- |
+| `$term`               | Specify a field to search (**Required**)|
+| `$language`           | Determines the list of stop words and the rules for tokenizer.|
+| `$caseSensitive`      | Enable or disable case sensitive search.|
+| `$diacriticSensitive` | Enable or disable diacritic sensitive search.|
+
+For additional details, please see [Query on String Values](https://docs.parseplatform.org/rest/guide/#queries-on-string-values).
+
 ### 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.
 
@@ -2615,7 +2658,7 @@ end
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/modernistik/parse-stack.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/modernistik/parse-stack](https://github.com/modernistik/parse-stack).
 
 ## License
 

data/Rakefile

@@ -1,11 +1,11 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
-require 'yard'
-require 'rake/testtask'
+require "yard"
+require "rake/testtask"
 
 Rake::TestTask.new do |t|
-  t.libs << 'lib/parse/stack'
-  t.test_files = FileList['test/lib/**/*_test.rb']
+  t.libs << "lib/parse/stack"
+  t.test_files = FileList["test/lib/**/*_test.rb"]
   t.warning = false
   t.verbose = true
 end
@@ -13,22 +13,22 @@ end
 task :default => :test
 
 task :console do
-  exec './bin/console'
+  exec "./bin/console"
 end
 task :c => :console
 
-desc 'List undocumented methods'
-task 'yard:stats' do
-  exec 'yard stats --list-undoc'
+desc "List undocumented methods"
+task "yard:stats" do
+  exec "yard stats --list-undoc"
 end
 
-desc 'Start the yard server'
-task 'docs' do
-  exec 'rm -rf ./yard && yard server --reload'
+desc "Start the yard server"
+task "docs" do
+  exec "rm -rf ./yard && yard server --reload"
 end
 
 YARD::Rake::YardocTask.new do |t|
- t.files   = ['lib/**/*.rb']   # optional
- t.options = ['-o', 'doc/parse-stack' ] # optional
- t.stats_options = ['--list-undoc']         # optional
+  t.files = ["lib/**/*.rb"]   # optional
+  t.options = ["-o", "doc/parse-stack"] # optional
+  t.stats_options = ["--list-undoc"]         # optional
 end

data/bin/parse-console

@@ -62,6 +62,7 @@ opt_parser = OptionParser.new do |o|
       file = File.read(filepath)
       config = JSON.parse file
       app = config["apps"].is_a?(Array) ?  config["apps"].first : config["apps"]
+      app = config if app.nil? # uses parse-server config.json
       opts[:server_url] ||= app["serverURL"]
       opts[:app_id] ||= app["appId"]
       opts[:api_key] ||= app["restAPIKey"]

data/lib/parse/api/aggregate.rb

@@ -0,0 +1,59 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext"
+require_relative "./objects"
+
+module Parse
+  module API
+    # REST API methods for fetching CRUD operations on Parse objects.
+    module Aggregate
+      # The class prefix for fetching objects.
+      # @!visibility private
+      PATH_PREFIX = "aggregate/"
+
+      # @!visibility private
+      PREFIX_MAP = Parse::API::Objects::PREFIX_MAP
+
+      # @!visibility private
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      # Class methods to be applied to {Parse::Client}
+      module ClassMethods
+        # Get the aggregate API path for this class.
+        # @param className [String] the name of the Parse collection.
+        # @return [String] the API uri path
+        def aggregate_uri_path(className)
+          if className.is_a?(Parse::Pointer)
+            id = className.id
+            className = className.parse_class
+          end
+          "#{PATH_PREFIX}#{className}"
+        end
+      end
+
+      # Get the API path for this class.
+      # @param className [String] the name of the Parse collection.
+      # @return [String] the API uri path
+      def aggregate_uri_path(className)
+        self.class.aggregate_uri_path(className)
+      end
+
+      # Aggregate a set of matching objects for a query.
+      # @param className [String] the name of the Parse collection.
+      # @param query [Hash] The set of query constraints.
+      # @param opts [Hash] additional options to pass to the {Parse::Client} request.
+      # @param headers [Hash] additional HTTP headers to send with the request.
+      # @return [Parse::Response]
+      # @see Parse::Query
+      def aggregate_objects(className, query = {}, headers: {}, **opts)
+        response = request :get, aggregate_uri_path(className), query: query, headers: headers, opts: opts
+        response.parse_class = className if response.present?
+        response
+      end
+    end #Aggregate
+  end #API
+end

data/lib/parse/api/all.rb

@@ -1,8 +1,9 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
-require_relative '../client'
+require_relative "../client"
 require_relative "analytics"
+require_relative "aggregate"
 require_relative "batch"
 require_relative "config"
 require_relative "files"

data/lib/parse/api/analytics.rb

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 module Parse
-
   module API
     # Defines the Analytics interface for the Parse REST API
     module Analytics
@@ -14,8 +13,6 @@ module Parse
       def send_analytics(event_name, metrics = {})
         request :post, "events/#{event_name}", body: metrics
       end
-
     end
   end
-
 end

data/lib/parse/api/batch.rb

@@ -1,12 +1,11 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
-require 'parallel'
-require 'active_support'
-require 'active_support/core_ext'
+require "parallel"
+require "active_support"
+require "active_support/core_ext"
 
 module Parse
-
   module API
     # Defines the Batch interface for the Parse REST API
     # @see Parse::BatchOperation
@@ -30,7 +29,6 @@ module Parse
         response = request(:post, "batch", body: batch_operations.as_json)
         response.success? && response.batch? ? response.batch_responses : response
       end
-
     end
   end
 end

data/lib/parse/api/cloud_functions.rb

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 module Parse
-
   module API
     # Defines the CloudCode interface for the Parse REST API
     module CloudFunctions
@@ -22,8 +21,6 @@ module Parse
       def trigger_job(name, body = {})
         request :post, "jobs/#{name}", body: body
       end
-
     end
   end
-
 end

data/lib/parse/api/config.rb

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 module Parse
-
   module API
     # Defines the Config interface for the Parse REST API
     module Config
@@ -44,9 +43,6 @@ module Parse
         @config.merge!(params) if result && @config.present?
         result
       end
-
     end
-
   end
-
 end

data/lib/parse/api/files.rb

@@ -1,11 +1,10 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
-require 'active_support'
-require 'active_support/core_ext'
+require "active_support"
+require "active_support/core_ext"
 
 module Parse
-
   module API
     # Defines the Parse Files interface for the Parse REST API
     module Files
@@ -19,14 +18,11 @@ module Parse
       # @return [Parse::Response]
       def create_file(fileName, data = {}, content_type = nil)
         headers = {}
-        headers.merge!( { Parse::Protocol::CONTENT_TYPE => content_type.to_s } ) if content_type.present?
+        headers.merge!({ Parse::Protocol::CONTENT_TYPE => content_type.to_s }) if content_type.present?
         response = request :post, "#{FILES_PATH}/#{fileName}", body: data, headers: headers
         response.parse_class = Parse::Model::TYPE_FILE
         response
       end
-
     end
-
   end
-
 end

data/lib/parse/api/hooks.rb

@@ -2,8 +2,6 @@
 # frozen_string_literal: true
 
 module Parse
-
-
   module API
     # Defines the Parse webhooks interface for the Parse REST API
     module Hooks
@@ -23,7 +21,7 @@ module Parse
       # Fetch all defined cloud code functions.
       # @return [Parse::Response]
       def functions
-        opts = {cache: false}
+        opts = { cache: false }
         request :get, "#{HOOKS_PREFIX}functions", opts: opts
       end
 
@@ -39,7 +37,7 @@ module Parse
       # @param url [String] the url endpoint for this cloud code function.
       # @return [Parse::Response]
       def create_function(functionName, url)
-        request :post, "#{HOOKS_PREFIX}functions", body: {functionName: functionName, url: url}
+        request :post, "#{HOOKS_PREFIX}functions", body: { functionName: functionName, url: url }
       end
 
       # Updated the endpoint url for a registered cloud code webhook function.
@@ -62,7 +60,7 @@ module Parse
       # Get the set of registered triggers.
       # @return [Parse::Response]
       def triggers
-        opts = {cache: false}
+        opts = { cache: false }
         request :get, "#{HOOKS_PREFIX}triggers", opts: opts
       end
 
@@ -84,7 +82,7 @@ module Parse
       # @see Parse::API::Hooks::TRIGGER_NAMES
       def create_trigger(triggerName, className, url)
         triggerName = _verify_trigger(triggerName)
-        body = {className: className, triggerName: triggerName, url: url }
+        body = { className: className, triggerName: triggerName, url: url }
         request :post, "#{HOOKS_PREFIX}triggers", body: body
       end
 
@@ -108,8 +106,6 @@ module Parse
         triggerName = _verify_trigger(triggerName)
         request :put, "#{HOOKS_PREFIX}triggers/#{className}/#{triggerName}", body: { __op: "Delete" }
       end
-
     end
   end
-
 end