parse-stack 1.6.1 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6f2fcd731c3e5c535c2fcd5b6ad7de0411ee3b8
-  data.tar.gz: d43b5c15e4ca7ff3528d53c09d9f333ea5cca2cd
+  metadata.gz: 8fe3974386a315a6858707bdfe4c70ad41d9757e
+  data.tar.gz: ae7f69099d57799341027a1f1776529be848740b
 SHA512:
-  metadata.gz: 7521b1712daddb91201f06062a327443f65467c4098441b68e06de9a53b862c5e2fe36d5f66abb68d974aae098b5a9218315e9de0ab494b47032ad02a81c0a94
-  data.tar.gz: 75e194bbed8d4aebbb8c1ab2fd08f1d4b6c1b1c58191df19bcaf356bfceac761c40874321049e2a83b622b02b68cdf1b167652cac9f796c3f2a1a59aca062297
+  metadata.gz: 943d2a2607014404c125680ad77b75b95edb46fa310bb4185e7945eb090003a09abb1c3165e2b229ba0691293386d25249b34ba0d2ebe68b80ee47210362c914
+  data.tar.gz: 00a8dcfb89c494f21d2763bc7fb6305b65b80e51bfd701e9d73293c9e86902db1faa3a92557b782d6c52b98b6bd5c59522f3c29cc9cb8cd03ba3e577d63c26b4

data/Changes.md

@@ -1,5 +1,14 @@
 ## Parse-Stack Changelog
 
+### 1.6.4
+- Fixes #20: All temporary headers values are strings.
+- Reduced cache storage consumption by only storing response body and headers.
+- Increased maximum cache content length size to 1.25 MB.
+- You may pass a redis url to the :cache option of setup.
+- Fixes issue with invalid struct size of Faraday::Env with old caching keys.
+- Added server_info and health check APIs for Parse-Server +2.2.25.
+- Updated test to validate against MT6.
+
 ### 1.6.1
 - NEW: Batch requests are now parallelized.
 - `skip` in queries no longer capped to 10,000.

data/Gemfile

@@ -3,10 +3,10 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in parse-stack.gemspec
 gemspec
 
-gem 'dotenv'
-gem 'rake'
-
 group :test, :development do
+  gem 'dotenv'
+  gem 'redis'
+  gem 'rake'
   gem 'byebug'
   gem 'minitest'
   gem 'pry'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    parse-stack (1.6.1)
+    parse-stack (1.6.4)
       active_model_serializers (>= 0.9, < 1)
       activemodel (>= 4.2.1, < 6)
       activesupport (>= 4.2.1, < 6)
@@ -59,12 +59,12 @@ GEM
       nokogiri (>= 1.5.9)
     method_source (0.8.2)
     mini_portile2 (2.1.0)
-    minitest (5.9.1)
-    moneta (0.8.0)
+    minitest (5.10.1)
+    moneta (0.8.1)
     multipart-post (2.0.0)
     nokogiri (1.6.8.1)
       mini_portile2 (~> 2.1.0)
-    parallel (1.9.0)
+    parallel (1.10.0)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -82,7 +82,8 @@ GEM
       nokogiri (~> 1.6.0)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    rake (11.3.0)
+    rake (12.0.0)
+    redis (3.3.2)
     slop (3.6.0)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
@@ -100,6 +101,7 @@ DEPENDENCIES
   pry-nav
   pry-stack_explorer
   rake
+  redis
 
 BUNDLED WITH
-   1.13.3
+   1.13.6

data/README.md

@@ -1,6 +1,8 @@
 <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.
+# Parse-Stack - The Parse Ruby Client SDK
+
+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.
 
@@ -34,11 +36,83 @@ 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).
 
-# Parse-Stack - The Parse Server Ruby SDK
+## 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',
+            app_id: APP_ID,
+            api_key: REST_API_KEY,
+            master_key: YOUR_MASTER_KEY # optional
+
+# Automatically build models based on your Parse application schemas.
+Parse.auto_generate_models!
+
+# or define custom Subclasses (Highly Recommended)
+class Song < Parse::Object
+  property :name
+  property :play, :integer
+  property :audio_file, :file
+  property :tags, :array
+  property :released, :date
+  belongs_to :artist
+  # `like` is a Parse Relation to User class
+  has_many :likes, as: :user, through: :relation
+end
+
+class Artist < Parse::Object
+  property :name
+  property :genres, :array
+  has_many :fans, as: :user
+  has_one :manager, as: :user
+
+  scope :recent, ->(x) { query(:created_at.after => x) }
+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
+
+# Query
+artist = Artist.first(:name.like => /Sinatra/, :genres.in => ['swing'])
+
+# more examples
+song = Song.new name: "Fly Me to the Moon"
+song.artist = artist
+# Parse files - upload a file and attach to object
+song.audio_file = Parse::File.create("http://path_to.mp3")
+
+# relations - find a User matching username and add it to relation.
+song.likes.add Parse::User.first(username: "persaud")
+
+# saves both attributes and relations
+song.save
+
+# find songs
+songs = Song.all(artist: artist, :plays.gt => 100, :released.on_or_after => 30.days.ago)
+
+songs.each { |s| s.tags.add "awesome" }
+# batch saves
+songs.save
+
+# Call Cloud Code functions
+result = Parse.call_function :myFunctionName, {param: value}
+
+```
+## Table of Contents
+
 <!-- 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)
@@ -113,7 +187,7 @@ For a more details on the rails integration see [Parse-Stack Rails Example](http
     - [:skip](#skip)
     - [:cache](#cache)
     - [:use_master_key](#use_master_key)
-    - [:session_token](#session_token)
+    - [:session](#session)
     - [:where](#where)
 - [Query Constraints](#query-constraints)
     - [Equals](#equals)
@@ -155,79 +229,6 @@ For a more details on the rails integration see [Parse-Stack Rails Example](http
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-## 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',
-            app_id: APP_ID,
-            api_key: REST_API_KEY,
-            master_key: YOUR_MASTER_KEY # optional
-
-# Automatically build models based on your Parse application schemas.
-Parse.auto_generate_models!
-
-# or define custom Subclasses (Highly Recommended)
-class Song < Parse::Object
-  property :name
-  property :play, :integer
-  property :audio_file, :file
-  property :tags, :array
-  property :released, :date
-  belongs_to :artist
-  # `like` is a Parse Relation to User class
-  has_many :likes, as: :user, through: :relation
-end
-
-class Artist < Parse::Object
-  property :name
-  property :genres, :array
-  has_many :fans, as: :user
-  has_one :manager, as: :user
-
-  scope :recent, ->(x) { query(:created_at.after => x) }
-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
-
-# Query
-artist = Artist.first(:name.like => /Sinatra/, :genres.in => ['swing'])
-
-# more examples
-song = Song.new name: "Fly Me to the Moon"
-song.artist = artist
-# Parse files - upload a file and attach to object
-song.audio_file = Parse::File.create("http://path_to.mp3")
-
-# relations - find a User matching username and add it to relation.
-song.likes.add Parse::User.first(username: "persaud")
-
-# saves both attributes and relations
-song.save
-
-# find songs
-songs = Song.all(artist: artist, :plays.gt => 100, :released.on_or_after => 30.days.ago)
-
-songs.each { |s| s.tags.add "awesome" }
-# batch saves
-songs.save
-
-# Call Cloud Code functions
-result = Parse.call_function :myFunctionName, {param: value}
-
-```
-
 ## Architecture
 The architecture of `Parse::Stack` is broken into four main components.
 
@@ -316,6 +317,18 @@ The connection adapter. By default it uses the `Faraday.default_adapter` which i
 #### `:cache`
 A caching adapter of type `Moneta::Transformer`. Caching queries and object fetches can help improve the performance of your application, even if it is for a few seconds. Only successful `GET` object fetches and queries (non-empty) will be cached. You may set the default expiration time with the `expires` option. See related: [Moneta](https://github.com/minad/moneta). At any point in time you may clear the cache by calling the `clear_cache!` method on the client connection.
 
+```ruby
+  store = Moneta.new :Redis, url: 'redis://localhost:6379'
+   # use a Redis cache store with an automatic expire of 10 seconds.
+  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.
+
+```ruby
+  Parse.setup(cache: 'redis://localhost:6379', ...)
+```
+
 #### `:expires`
 Sets the default cache expiration time (in seconds) for successful non-empty `GET` requests when using the caching middleware. The default value is 3 seconds. If `:expires` is set to 0, caching will be disabled. You can always clear the current state of the cache using the `clear_cache!` method on your `Parse::Client` instance.
 
@@ -1652,13 +1665,15 @@ A true/false value. If you provided a master key as part of `Parse.setup()`, it
 Song.all limit: 3, use_master_key: false
 ```
 
-#### :session_token
-A Parse session token string. If you would like to perform a query as a particular user, you may pass their session token in the query. This will make sure that the query is performed on behalf (and with the privileges) of that user which will cause record ACLs to be enforced. If a session token is provided, caching will be disabled for this request.
+#### :session
+This will make sure that the query is performed on behalf (and with the privileges) of an authenticated user which will cause record ACLs to be enforced. If a session token is provided, caching will be disabled for this request. You may pass a string representing the session token, an authenticated `Parse::User` instance or a `Parse::Session` instance.
 
 ```ruby
 # disable sending the master key in the request if configured
 # and perform this request as a Parse user represented by this token
-Song.all limit: 3, session_token: "<session_token>"
+Song.all limit: 3, session: "<session_token>"
+Song.all limit: 3, session: user # a logged-in Parse::User
+Song.all limit: 3, session: session # Parse::Session
 ```
 
 #### :where

data/bin/console

@@ -6,7 +6,7 @@ require 'dotenv'
 require 'byebug'
 Dotenv.load
 
-Parse.setup
+Parse.setup # cache: 'redis://localhost:6379'
 
 puts "[ParseServerURL] #{Parse.client.server_url}"
 puts "[ParseAppID]     #{Parse.client.app_id}"

data/lib/parse/api/server.rb

@@ -13,7 +13,7 @@ module Parse
 
       # @!visibility private
       SERVER_INFO_PATH = 'serverInfo'
-
+      SERVER_HEALTH_PATH = 'health'
       # Fetch and cache information about the Parse server configuration. This
       # hash contains information specifically to the configuration of the running
       # parse server.
@@ -25,6 +25,13 @@ module Parse
                        response.result.with_indifferent_access
       end
 
+      # Fetches the status of the server based on the health check.
+      # @return [Boolean] whether the server is 'OK'.
+      def server_health
+        response = request :get, SERVER_HEALTH_PATH
+        response.success?
+      end
+
       # Force fetches the server information.
       # @return [Hash] a hash containing server configuration if available.
       def server_info!

data/lib/parse/client.rb

@@ -1,6 +1,7 @@
 require 'faraday'
 require 'faraday_middleware'
 require 'active_support'
+require 'moneta'
 require 'active_model_serializers'
 require 'active_support/inflector'
 require 'active_support/core_ext/object'
@@ -267,6 +268,16 @@ module Parse
         end
 
         if opts[:cache].present? && opts[:expires].to_i > 0
+          # advanced: provide a REDIS url, we'll configure a Moneta Redis store.
+          if opts[:cache].is_a?(String) && opts[:cache].starts_with?("redis://")
+            begin
+              opts[:cache] = Moneta.new(:Redis, url: opts[:cache])
+            rescue LoadError
+              puts "[Parse::Middleware::Caching] Did you forget to load the redis gem (Gemfile)?"
+              raise
+            end
+          end
+
           unless opts[:cache].is_a?(Moneta::Transformer)
             raise ArgumentError, "Parse::Client option :cache needs to be a type of Moneta::Transformer store."
           end
@@ -379,7 +390,7 @@ module Parse
         headers[Parse::Middleware::Caching::CACHE_CONTROL] = "no-cache"
       elsif opts[:cache].is_a?(Numeric)
         # specify the cache duration of this request
-        headers[Parse::Middleware::Caching::CACHE_EXPIRES_DURATION] = opts[:cache].to_i
+        headers[Parse::Middleware::Caching::CACHE_EXPIRES_DURATION] = opts[:cache].to_s
       end
 
       if opts[:use_master_key] == false

data/lib/parse/client/caching.rb

@@ -130,12 +130,29 @@ module Parse
 
         begin
           if method == :get && @cache_key.present? && @store.key?(@cache_key)
-            puts("[Parse::Cache::Hit] >> #{url}") if self.class.logging.present?
+            puts("[Parse::Cache] Hit >> #{url}") if self.class.logging.present?
             response = Faraday::Response.new
-            res_env = @store[@cache_key] # previous cached response
-            body = res_env.respond_to?(:body) ? res_env.body : nil
-            if body.present?
-              response.finish({status: 200, response_headers: { CACHE_RESPONSE_HEADER => true }, body: body })
+            begin
+              cache_data = @store[@cache_key] # previous cached response
+            rescue => e
+              puts "[Parse::Cache] Error: #{e}"
+              cache_data = nil
+            end
+
+            # check if the store was from a legacy parse-stack cache value which
+            # is stored as Faraday::Env. T\he new system stores less content in a simple hash
+            # for improved interoperability and access time.
+            if cache_data.is_a?(Faraday::Env)
+              body = cache_data.respond_to?(:body) ? cache_data.body : nil
+              response_headers = cache_data.response_headers || {}
+            elsif cache_data.is_a?(Hash)
+              body = cache_data[:body]
+              response_headers = cache_data[:headers] || {}
+            end
+
+            if cache_data.present? && body.present?
+              response_headers[CACHE_RESPONSE_HEADER] = 'true'
+              response.finish({status: 200, response_headers: response_headers, body: body })
               return response
             else
               @store.delete @cache_key
@@ -148,7 +165,7 @@ module Parse
             @store.delete "mk:#{url.to_s}" # master key cache-key
             @store.delete @cache_key # final key
           end
-        rescue Errno::EINVAL, Redis::CannotConnectError, Redis::TimeoutError => e
+        rescue ::TypeError, Errno::EINVAL, Redis::CannotConnectError, Redis::TimeoutError => e
           # if the cache store fails to connect, catch the exception but proceed
           # with the regular request, but turn off caching for this request. It is possible
           # that the cache connection resumes at a later point, so this is temporary.
@@ -161,9 +178,11 @@ module Parse
           # is between 20 bytes and 1MB. Otherwise they could be errors, successes and empty result sets.
 
           if @enabled && method == :get &&  CACHEABLE_HTTP_CODES.include?(response_env.status) &&
-              response_env.present? && response_env.response_headers[CONTENT_LENGTH_KEY].to_i.between?(20,1_000_000)
+              response_env.body.present? && response_env.response_headers[CONTENT_LENGTH_KEY].to_i.between?(20,1_250_000)
               begin
-                @store.store(@cache_key, response_env, expires: @expires) # ||= response_env.body
+                @store.store(@cache_key,
+                            { headers: response_env.response_headers, body: response_env.body },
+                            expires: @expires)
               rescue => e
                 puts "[Parse::Cache] Store Error: #{e}"
               end

data/lib/parse/client/response.rb

@@ -73,7 +73,8 @@ module Parse
       @batch_response = false # by default, not a batch response
       @result = nil
       # If a string is used for initializing, treat it as JSON
-      res = JSON.parse(res) if res.is_a?(String)
+      # check for string to not be 'OK' since that is the health check API response
+      res = JSON.parse(res) if res.is_a?(String) && res != "OK".freeze
       # If it is a hash (or parsed JSON), then parse the result.
       parse_result!(res) if res.is_a?(Hash)
       # if the result is an Array, then most likely it is a set of responses

data/lib/parse/query.rb

@@ -132,9 +132,15 @@ module Parse
     #  Set the session token to send with this API request. A session token is tied to
     #  a logged in {Parse::User}. When sending a session_token in the request,
     #  this performs the query on behalf of the user (with their allowed priviledges).
+    #  Using the short hand (inline) form, you can also pass an authenticated {Parse::User} instance
+    #  or a {Parse::Session} instance.
     #  @example
     #   # perform this query as user represented by session_token
-    #   query = Parse::Query.new("_User", :name => "Bob", :session_token => "r:XyX123...")
+
+    #   query = Parse::Query.new("_User", :name => "Bob")
+    #   query.session_token = "r:XyX123..."
+    #   # or inline
+    #   query = Parse::Query.new("_User", :name => "Bob", :session => "r:XyX123...")
     #  @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

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.1"
+    VERSION = "1.6.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parse-stack
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.4
 platform: ruby
 authors:
 - Anthony Persaud
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2016-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -274,7 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Parse-Server Ruby Client and Relational Mapper