parse-stack 1.5.2 → 1.5.3

data/lib/parse/client/body_builder.rb

@@ -8,23 +8,29 @@ require_relative 'protocol'
 require 'active_support'
 require 'active_support/core_ext'
 require 'active_model_serializers'
-# This middleware takes an incoming response (after an outgoing request)
-# and creates a Parse::Response object.
+
 module Parse
   module Middleware
+    # This middleware takes an incoming Parse response, after an outgoing request,
+    # and creates a Parse::Response object.
     class BodyBuilder < Faraday::Middleware
+      include Parse::Protocol
+      HTTP_OVERRIDE = 'X-Http-Method-Override'
+
       class << self
+        # Allows logging. Set to `true` to enable logging, `false` to disable.
+        # You may specify `:debug` for additional verbosity.
+        # @return [Boolean]
         attr_accessor :logging
       end
 
-      include Parse::Protocol
-      HTTP_OVERRIDE = 'X-Http-Method-Override'
-
       # thread-safety
+      # @!visibility private
       def call(env)
         dup.call!(env)
       end
 
+      # @!visibility private
       def call!(env)
         # the maximum url size is ~2KB, so if we request a Parse API url greater than this
         # (which is most likely a very complicated query), we need to override the request method
@@ -55,7 +61,7 @@ module Parse
         @app.call(env).on_complete do |response_env|
           # on a response, create a new Parse::Response and replace the :body
           # of the env
-          # TODO: CHECK FOR HTTP STATUS CODES
+          # @todo CHECK FOR HTTP STATUS CODES
           if self.class.logging
             puts "[[Response #{response_env[:status]}]] ----------------------------------"
             puts response_env.body

data/lib/parse/client/caching.rb

@@ -5,13 +5,20 @@ require 'faraday'
 require 'faraday_middleware'
 require 'moneta'
 require_relative 'protocol'
-# This is a caching middleware for Parse queries using Moneta.
+
 module Parse
   module Middleware
     class CachingError < StandardError; end;
+    # This is a caching middleware for Parse queries using Moneta. The caching
+    # middleware will cache all GET requests made to the Parse REST API as long
+    # as the API responds with a successful non-empty result payload.
+    #
+    # Whenever an object is created or updated, the corresponding entry in the cache
+    # when fetching the particular record (using the specific non-Query based API)
+    # will be cleared.
     class Caching < Faraday::Middleware
       include Parse::Protocol
-      # Cache-Control: no-cache
+
       # Internal: List of status codes that can be cached:
          # * 200 - 'OK'
          # * 203 - 'Non-Authoritative Information'
@@ -20,30 +27,53 @@ module Parse
          # * 302 - 'Found'
          # * 404 - 'Not Found' - removed
          # * 410 - 'Gone' - removed
-      CACHEABLE_HTTP_CODES = [200, 203, 300, 301, 302]
+
+      CACHEABLE_HTTP_CODES = [200, 203, 300, 301, 302].freeze
       CACHE_CONTROL = 'Cache-Control'
-      CONTENT_LENGTH_KEY = "content-length"
-      CACHE_RESPONSE_HEADER = "X-Cache-Response"
+      CONTENT_LENGTH_KEY = 'content-length'
+      CACHE_RESPONSE_HEADER = 'X-Cache-Response'
       CACHE_EXPIRES_DURATION = 'X-Parse-Stack-Cache-Expires'
 
       class << self
-        attr_accessor :enabled, :logging
+        # @!attribute enabled
+        # @return [Boolean] whether the caching middleware should be enabled.
+        attr_accessor :enabled
+
+        # @!attribute logging
+        # @return [Boolean] whether the logging should be enabled.
+        attr_accessor :logging
 
         def enabled
            @enabled = true if @enabled.nil?
            @enabled
         end
 
+        # @return [Boolean] whether caching is enabled.
         def caching?
           @enabled
         end
 
       end
 
-      attr_accessor :store, :expires
-
-      def initialize(app, store, opts = {})
-        super(app)
+      # @!attribute [rw] store
+      # The internal moneta cache store instance.
+      # @return [Moneta::Transformer]
+      attr_accessor :store
+
+      # @!attribute [rw] expires
+      # The expiration time in seconds for this particular request.
+      # @return [Integer]
+      attr_accessor :expires
+
+      # Creates a new caching middleware.
+      # @param adapter [Faraday::Adapter] An instance of the Faraday adapter
+      #  used for the connection. Defaults Faraday::Adapter::NetHttp.
+      # @param store [Moneta] An instance of the Moneta cache store to use.
+      # @param opts [Hash] additional options.
+      # @option opts [Integer] :expires the default expiration for a cache entry.
+      # @raise Parse::Middleware::CachingError, if `store` is not a Moneta::Transformer instance.
+      def initialize(adapter, store, opts = {})
+        super(adapter)
         @store = store
         @opts = {expires: 0}
         @opts.merge!(opts) if opts.is_a?(Hash)
@@ -55,10 +85,12 @@ module Parse
 
       end
 
+      # @!visibility private
       def call(env)
         dup.call!(env)
       end
 
+      # @!visibility private
       def call!(env)
         @request_headers =  env[:request_headers]
 

data/lib/parse/client/protocol.rb

@@ -1,9 +1,9 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
-# A module to contain all the main constants.
-module Parse
 
+module Parse
+  # Set of Parse protocol constants.
   module Protocol
       HOST              = 'api.parse.com'
       SERVER_URL        = 'https://api.parse.com/1/'
@@ -19,51 +19,56 @@ module Parse
       CONTENT_TYPE_FORMAT = 'application/json; charset=utf-8'
   end
 
+  # All Parse error codes.
+  # @todo Implement all error codes as StandardError
+  #
+  # List of error codes.
+  #  OtherCause	-1	Error code indicating that an unknown error or an error unrelated to Parse occurred.
+  #  InternalServerError	1	Error code indicating that something has gone wrong with the server. If you get this error code, it is Parse's fault. Please report the bug to https://parse.com/help.
+  #  ConnectionFailed	100	Error code indicating the connection to the Parse servers failed.
+  #  ObjectNotFound	101	Error code indicating the specified object doesn't exist.
+  #  InvalidQuery	102	Error code indicating you tried to query with a datatype that doesn't support it, like exact matching an array or object.
+  #  InvalidClassName	103	Error code indicating a missing or invalid classname. Classnames are case-sensitive. They must start with a letter, and a-zA-Z0-9_ are the only valid characters.
+  #  MissingObjectId	104	Error code indicating an unspecified object id.
+  #  InvalidKeyName	105	Error code indicating an invalid key name. Keys are case-sensitive. They must start with a letter, and a-zA-Z0-9_ are the only valid characters.
+  #  InvalidPointer	106	Error code indicating a malformed pointer. You should not see this unless you have been mucking about changing internal Parse code.
+  #  InvalidJSON	107	Error code indicating that badly formed JSON was received upstream. This either indicates you have done something unusual with modifying how things encode to JSON, or the network is failing badly.
+  #  CommandUnavailable	108	Error code indicating that the feature you tried to access is only available internally for testing purposes.
+  #  NotInitialized	109	You must call Parse.initialize before using the Parse library.
+  #  IncorrectType	111	Error code indicating that a field was set to an inconsistent type.
+  #  InvalidChannelName	112	Error code indicating an invalid channel name. A channel name is either an empty string (the broadcast channel) or contains only a-zA-Z0-9_ characters and starts with a letter.
+  #  PushMisconfigured	115	Error code indicating that push is misconfigured.
+  #  ObjectTooLarge	116	Error code indicating that the object is too large.
+  #  OperationForbidden	119	Error code indicating that the operation isn't allowed for clients.
+  #  CacheMiss	120	Error code indicating the result was not found in the cache.
+  #  InvalidNestedKey	121	Error code indicating that an invalid key was used in a nested JSONObject.
+  #  InvalidFileName	122	Error code indicating that an invalid filename was used for ParseFile. A valid file name contains only a-zA-Z0-9_. characters and is between 1 and 128 characters.
+  #  InvalidACL	123	Error code indicating an invalid ACL was provided.
+  #  Timeout	124	Error code indicating that the request timed out on the server. Typically this indicates that the request is too expensive to run.
+  #  InvalidEmailAddress	125	Error code indicating that the email address was invalid.
+  #  DuplicateValue	137	Error code indicating that a unique field was given a value that is already taken.
+  #  InvalidRoleName	139	Error code indicating that a role's name is invalid.
+  #  ExceededQuota	140	Error code indicating that an application quota was exceeded. Upgrade to resolve.
+  #  ScriptFailed	141	Error code indicating that a Cloud Code script failed.
+  #  ValidationFailed	142	Error code indicating that a Cloud Code validation failed.
+  #  FileDeleteFailed	153	Error code indicating that deleting a file failed.
+  #  RequestLimitExceeded	155	Error code indicating that the application has exceeded its request limit.
+  #  InvalidEventName	160	Error code indicating that the provided event name is invalid.
+  #  UsernameMissing	200	Error code indicating that the username is missing or empty.
+  #  PasswordMissing	201	Error code indicating that the password is missing or empty.
+  #  UsernameTaken	202	Error code indicating that the username has already been taken.
+  #  EmailTaken	203	Error code indicating that the email has already been taken.
+  #  EmailMissing	204	Error code indicating that the email is missing, but must be specified.
+  #  EmailNotFound	205	Error code indicating that a user with the specified email was not found.
+  #  SessionMissing	206	Error code indicating that a user object without a valid session could not be altered.
+  #  MustCreateUserThroughSignup	207	Error code indicating that a user can only be created through signup.
+  #  AccountAlreadyLinked	208	Error code indicating that an an account being linked is already linked to another user.
+  #  InvalidSessionToken	209	Error code indicating that the current session token is invalid.
+  #  LinkedIdMissing	250	Error code indicating that a user cannot be linked to an account because that account's id could not be found.
+  #  InvalidLinkedSession	251	Error code indicating that a user with a linked (e.g. Facebook) account has an invalid session.
+  #  UnsupportedService	252	Error code indicating that a service being linked (e.g. Facebook or Twitter) is unsupported.
   module ErrorCodes
-    # OtherCause	-1	Error code indicating that an unknown error or an error unrelated to Parse occurred.
-    # InternalServerError	1	Error code indicating that something has gone wrong with the server. If you get this error code, it is Parse's fault. Please report the bug to https://parse.com/help.
-    # ConnectionFailed	100	Error code indicating the connection to the Parse servers failed.
-    # ObjectNotFound	101	Error code indicating the specified object doesn't exist.
-    # InvalidQuery	102	Error code indicating you tried to query with a datatype that doesn't support it, like exact matching an array or object.
-    # InvalidClassName	103	Error code indicating a missing or invalid classname. Classnames are case-sensitive. They must start with a letter, and a-zA-Z0-9_ are the only valid characters.
-    # MissingObjectId	104	Error code indicating an unspecified object id.
-    # InvalidKeyName	105	Error code indicating an invalid key name. Keys are case-sensitive. They must start with a letter, and a-zA-Z0-9_ are the only valid characters.
-    # InvalidPointer	106	Error code indicating a malformed pointer. You should not see this unless you have been mucking about changing internal Parse code.
-    # InvalidJSON	107	Error code indicating that badly formed JSON was received upstream. This either indicates you have done something unusual with modifying how things encode to JSON, or the network is failing badly.
-    # CommandUnavailable	108	Error code indicating that the feature you tried to access is only available internally for testing purposes.
-    # NotInitialized	109	You must call Parse.initialize before using the Parse library.
-    # IncorrectType	111	Error code indicating that a field was set to an inconsistent type.
-    # InvalidChannelName	112	Error code indicating an invalid channel name. A channel name is either an empty string (the broadcast channel) or contains only a-zA-Z0-9_ characters and starts with a letter.
-    # PushMisconfigured	115	Error code indicating that push is misconfigured.
-    # ObjectTooLarge	116	Error code indicating that the object is too large.
-    # OperationForbidden	119	Error code indicating that the operation isn't allowed for clients.
-    # CacheMiss	120	Error code indicating the result was not found in the cache.
-    # InvalidNestedKey	121	Error code indicating that an invalid key was used in a nested JSONObject.
-    # InvalidFileName	122	Error code indicating that an invalid filename was used for ParseFile. A valid file name contains only a-zA-Z0-9_. characters and is between 1 and 128 characters.
-    # InvalidACL	123	Error code indicating an invalid ACL was provided.
-    # Timeout	124	Error code indicating that the request timed out on the server. Typically this indicates that the request is too expensive to run.
-    # InvalidEmailAddress	125	Error code indicating that the email address was invalid.
-    # DuplicateValue	137	Error code indicating that a unique field was given a value that is already taken.
-    # InvalidRoleName	139	Error code indicating that a role's name is invalid.
-    # ExceededQuota	140	Error code indicating that an application quota was exceeded. Upgrade to resolve.
-    # ScriptFailed	141	Error code indicating that a Cloud Code script failed.
-    # ValidationFailed	142	Error code indicating that a Cloud Code validation failed.
-    # FileDeleteFailed	153	Error code indicating that deleting a file failed.
-    # RequestLimitExceeded	155	Error code indicating that the application has exceeded its request limit.
-    # InvalidEventName	160	Error code indicating that the provided event name is invalid.
-    # UsernameMissing	200	Error code indicating that the username is missing or empty.
-    # PasswordMissing	201	Error code indicating that the password is missing or empty.
-    # UsernameTaken	202	Error code indicating that the username has already been taken.
-    # EmailTaken	203	Error code indicating that the email has already been taken.
-    # EmailMissing	204	Error code indicating that the email is missing, but must be specified.
-    # EmailNotFound	205	Error code indicating that a user with the specified email was not found.
-    # SessionMissing	206	Error code indicating that a user object without a valid session could not be altered.
-    # MustCreateUserThroughSignup	207	Error code indicating that a user can only be created through signup.
-    # AccountAlreadyLinked	208	Error code indicating that an an account being linked is already linked to another user.
-    # InvalidSessionToken	209	Error code indicating that the current session token is invalid.
-    # LinkedIdMissing	250	Error code indicating that a user cannot be linked to an account because that account's id could not be found.
-    # InvalidLinkedSession	251	Error code indicating that a user with a linked (e.g. Facebook) account has an invalid session.
-    # UnsupportedService	252	Error code indicating that a service being linked (e.g. Facebook or Twitter) is unsupported.
+
   end
 
 end

data/lib/parse/client/response.rb

@@ -1,52 +1,6 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
-# Member name	Value	Description
-# OtherCause	-1	Error code indicating that an unknown error or an error unrelated to Parse occurred.
-# InternalServerError	1	Error code indicating that something has gone wrong with the server. If you get this error code, it is Parse's fault. Please report the bug to https://parse.com/help.
-# ConnectionFailed	100	Error code indicating the connection to the Parse servers failed.
-# ObjectNotFound	101	Error code indicating the specified object doesn't exist.
-# InvalidQuery	102	Error code indicating you tried to query with a datatype that doesn't support it, like exact matching an array or object.
-# InvalidClassName	103	Error code indicating a missing or invalid classname. Classnames are case-sensitive. They must start with a letter, and a-zA-Z0-9_ are the only valid characters.
-# MissingObjectId	104	Error code indicating an unspecified object id.
-# InvalidKeyName	105	Error code indicating an invalid key name. Keys are case-sensitive. They must start with a letter, and a-zA-Z0-9_ are the only valid characters.
-# InvalidPointer	106	Error code indicating a malformed pointer. You should not see this unless you have been mucking about changing internal Parse code.
-# InvalidJSON	107	Error code indicating that badly formed JSON was received upstream. This either indicates you have done something unusual with modifying how things encode to JSON, or the network is failing badly.
-# CommandUnavailable	108	Error code indicating that the feature you tried to access is only available internally for testing purposes.
-# NotInitialized	109	You must call Parse.initialize before using the Parse library.
-# IncorrectType	111	Error code indicating that a field was set to an inconsistent type.
-# InvalidChannelName	112	Error code indicating an invalid channel name. A channel name is either an empty string (the broadcast channel) or contains only a-zA-Z0-9_ characters and starts with a letter.
-# PushMisconfigured	115	Error code indicating that push is misconfigured.
-# ObjectTooLarge	116	Error code indicating that the object is too large.
-# OperationForbidden	119	Error code indicating that the operation isn't allowed for clients.
-# CacheMiss	120	Error code indicating the result was not found in the cache.
-# InvalidNestedKey	121	Error code indicating that an invalid key was used in a nested JSONObject.
-# InvalidFileName	122	Error code indicating that an invalid filename was used for ParseFile. A valid file name contains only a-zA-Z0-9_. characters and is between 1 and 128 characters.
-# InvalidACL	123	Error code indicating an invalid ACL was provided.
-# Timeout	124	Error code indicating that the request timed out on the server. Typically this indicates that the request is too expensive to run.
-# InvalidEmailAddress	125	Error code indicating that the email address was invalid.
-# DuplicateValue	137	Error code indicating that a unique field was given a value that is already taken.
-# InvalidRoleName	139	Error code indicating that a role's name is invalid.
-# ExceededQuota	140	Error code indicating that an application quota was exceeded. Upgrade to resolve.
-# ScriptFailed	141	Error code indicating that a Cloud Code script failed.
-# ValidationFailed	142	Error code indicating that a Cloud Code validation failed.
-# FileDeleteFailed	153	Error code indicating that deleting a file failed.
-# RequestLimitExceeded	155	Error code indicating that the application has exceeded its request limit.
-# InvalidEventName	160	Error code indicating that the provided event name is invalid.
-# UsernameMissing	200	Error code indicating that the username is missing or empty.
-# PasswordMissing	201	Error code indicating that the password is missing or empty.
-# UsernameTaken	202	Error code indicating that the username has already been taken.
-# EmailTaken	203	Error code indicating that the email has already been taken.
-# EmailMissing	204	Error code indicating that the email is missing, but must be specified.
-# EmailNotFound	205	Error code indicating that a user with the specified email was not found.
-# SessionMissing	206	Error code indicating that a user object without a valid session could not be altered.
-# MustCreateUserThroughSignup	207	Error code indicating that a user can only be created through signup.
-# AccountAlreadyLinked	208	Error code indicating that an an account being linked is already linked to another user.
-# InvalidSessionToken	209	Error code indicating that the current session token is invalid.
-# LinkedIdMissing	250	Error code indicating that a user cannot be linked to an account because that account's id could not be found.
-# InvalidLinkedSession	251	Error code indicating that a user with a linked (e.g. Facebook) account has an invalid session.
-# UnsupportedService	252	Error code indicating that a service being linked (e.g. Facebook or Twitter) is unsupported.
-
 require 'active_support'
 require 'active_support/json'
 # This is the model that represents a response from Parse. A Response can also
@@ -58,7 +12,7 @@ module Parse
     include Enumerable
 
     ERROR_INTERNAL = 1
-    ERROR_SERVICE_UNAVAILALBE = 2
+    ERROR_SERVICE_UNAVAILABLE = 2
     ERROR_TIMEOUT = 124
     ERROR_EXCEEDED_BURST_LIMIT = 155
     ERROR_OBJECT_NOT_FOUND = 101