parse-stack-async 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94d9c71af58dc061d67d03bfdfaa7db2be5bbef6
+  data.tar.gz: d1c020f62f64081b9d277513143b1b26ae493c62
+SHA512:
+  metadata.gz: 5f41fd7996bdcb6c1b73076de5d0ed15b629b8be2b42f2863f060ed24d69c41e5f34ec40e330b63dab6fb95edb4689f563dba77fdb87aa3d3bbfad2aadded68e
+  data.tar.gz: 06b0c10fa6455fd154157268391ba14dc0e76a4b7f8653248894adba98817b2c7fc64fc86bf968c91e952b60962a7be5c6e868d3f0436f59960cfcff876b272c

data/.gitignore

@@ -0,0 +1,44 @@
+.DS_Store
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+bin/.env
+bin/config.json
+.byebug_history
+/.env
+/node_modules
+/bin/parse-dashboard-config.json
+logs

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in parse-stack-async.gemspec
+gemspec
+
+group :test, :development do
+  gem 'dotenv'
+  gem 'rake'
+  gem 'byebug'
+  gem 'minitest'
+  gem 'pry'
+  gem 'pry-stack_explorer'
+  gem 'pry-nav'
+  gem 'yard'
+  gem 'redcarpet'
+    gem 'thin'
+end

data/Gemfile.lock

@@ -0,0 +1,126 @@
+PATH
+  remote: .
+  specs:
+    parse-stack-async (0.1.0)
+      parse-stack (~> 1, >= 1.6)
+      sucker_punch (~> 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.0.1)
+      actionview (= 5.0.1)
+      activesupport (= 5.0.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.1)
+      activesupport (= 5.0.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    active_model_serializers (0.10.4)
+      actionpack (>= 4.1, < 6)
+      activemodel (>= 4.1, < 6)
+      case_transform (>= 0.2)
+      jsonapi (= 0.1.1.beta6)
+    activemodel (5.0.1)
+      activesupport (= 5.0.1)
+    activesupport (5.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    builder (3.2.2)
+    byebug (9.0.6)
+    case_transform (0.2)
+      activesupport
+    coderay (1.1.1)
+    concurrent-ruby (1.0.4)
+    daemons (1.2.4)
+    debug_inspector (0.0.2)
+    dotenv (2.1.1)
+    erubis (2.7.0)
+    eventmachine (1.2.1)
+    faraday (0.10.1)
+      multipart-post (>= 1.2, < 3)
+    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)
+      jsonapi-renderer (= 0.1.1.beta1)
+    jsonapi-parser (0.1.1.beta3)
+    jsonapi-renderer (0.1.1.beta1)
+    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)
+    multipart-post (2.0.0)
+    nokogiri (1.7.0.1)
+      mini_portile2 (~> 2.1.0)
+    parallel (1.10.0)
+    parse-stack (1.6.7)
+      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)
+      parallel (>= 1.6, < 2)
+      rack (< 3)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    pry-stack_explorer (0.4.9.2)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    rake (12.0.0)
+    redcarpet (3.4.0)
+    slop (3.6.0)
+    sucker_punch (2.0.2)
+      concurrent-ruby (~> 1.0.0)
+    thin (1.7.0)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    yard (0.9.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  dotenv
+  minitest
+  parse-stack-async!
+  pry
+  pry-nav
+  pry-stack_explorer
+  rake
+  redcarpet
+  thin
+  yard
+
+BUNDLED WITH
+   1.13.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2017 Anthony Persaud, Modernistik LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# Parse Stack - Async
+
+This [Parse Stack](https://github.com/modernistik/parse-stack) plugin adds support for background saves and deletes, similar to the use of `saveInBackground` and `saveEventually` in other [Parse Server](https://github.com/ParsePlatform/parse-server) SDKs. It utilizes [SuckerPunch](https://github.com/brandonhilkert/sucker_punch) to perform the asynchronous processing of the API operation in a separate queue.
+
+[![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:
+
+```ruby
+gem 'parse-stack-async'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install parse-stack-async
+
+## Usage
+This plugin for Parse Stack allows you to save and delete objects in an asynchronous manner, without blocking the main thread of an application. This is useful when saving objects in a web application like Rails.
+
+This plugin adds two methods to all `Parse::Object` subclasses: `save_eventually` and `destroy_eventually`, which mimic the same API in the mobile SDKs for Parse. These take an optional block that will provide you information whether it was successful in performing the corresponding operation.
+
+```ruby
+
+require 'parse/stack'
+require 'parse/stack/async'
+
+object = Parse::User.first # get a user
+object.username = 'newUserName'
+
+# saves object in a background thread.
+object.save_eventually do |success|
+  puts "Successfully saved in Parse!" if success
+end
+
+# Or delete asynchronously
+anotherObject.destroy_eventually do |success|
+  puts "Deleted object from Parse!" if success
+end
+
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/modernistik/parse-stack-async.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/parse/stack'
+  t.test_files = FileList['test/lib/**/*_test.rb']
+  t.warning = false
+  t.verbose = true
+end
+task :default => :test
+
+
+task :console do
+  exec './bin/console'
+end
+task :c => :console
+
+desc 'List undocumented methods'
+task 'yard:stats' do
+  exec 'yard stats --list-undoc'
+end
+
+desc 'Start the yard server'
+task 'yard' do
+  exec 'rm -rf ./yard && yard server --reload'
+end

data/bin/console

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'dotenv'
+require 'byebug'
+require "parse/stack/async"
+Dotenv.load
+
+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}"
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/parse/stack/async.rb

@@ -0,0 +1,113 @@
+require 'sucker_punch'
+require 'active_support'
+require 'active_support/core_ext'
+require 'parse/stack'
+require "parse/stack/async/version"
+
+# This module is defined in the Parse-Stack gem.
+# @see {Parse::Stack}
+module Parse
+  # This module is defined in the Parse-Stack gem.
+  # @see {Parse::Stack}
+  module Stack
+    # This is a plugin to Parse Stack that allows objects to be saved and deleted in a
+    # background thread, while providing you a callback block.
+    module Async
+
+      # A class to support running blocks in serial queue on a background thread.
+      # @!visibility private
+      class SerialDispatchQueue
+        include SuckerPunch::Job
+        workers 1 # serial queue
+        # @!visibility private
+        def perform(block = nil)
+          block.call() if block.respond_to?(:call)
+          block = nil # help gc
+        end
+      end # Serial
+
+      # A class to support running blocks in concurrent queue on a background thread.
+      # @!visibility private
+      class ParallelDispatchQueue
+        include SuckerPunch::Job
+        # @!visibility private
+        def perform(block = nil)
+          block.call() if block.respond_to?(:call)
+          block = nil # help gc
+        end
+      end # Parallel
+
+      # Helper method to run a block on a background thread.
+      # @param type [Symbol] the queue to use when dispatching the block.
+      #   * :serial - add the request to a serial queue.
+      #   * :parallel - add the request to a concurrent queue.
+      def self.run(type = :parallel)
+        raise "You need to pass a block to async." unless block_given?
+        if type == :parallel
+          ParallelDispatchQueue.perform_async Proc.new
+        else
+          SerialDispatchQueue.perform_async Proc.new
+        end
+      end
+
+    end # Async
+  end # Stack
+
+  # Additions to the Parse::Object class.
+  class Object < Pointer
+    # Adds support for saving a Parse object in the background.
+    # @example
+    #  object.save_eventually do |success|
+    #     puts "Saved successfully" if success
+    #  end
+    # @yield A block to call after the save has completed.
+    # @yieldparam [Boolean] success whether the save was successful.
+    # @return [Boolean] whether the job was enqueued.
+    def save_eventually
+      block = block_given? ? Proc.new : nil
+      _self = self
+      Parse::Stack::Async.run do
+        begin
+          result = true
+          _self.save!
+        rescue => e
+          result = false
+          puts "[SaveEventually] Failed for object #{_self.parse_class}##{_self.id}: #{e}"
+        ensure
+          block.call(result) if block
+          block = nil
+          _self = nil
+        end # begin
+      end # do
+    end # save_eventually
+
+    # Adds support for deleting a Parse object in the background.
+    # @example
+    #  object.destroy_eventually do |success|
+    #     puts 'Deleted successfully' if success
+    #  end
+    # @yield A block to call after the deletion has completed.
+    # @yieldparam [Boolean] success whether the save was successful.'
+    # @return [Boolean] whether the job was enqueued.
+    def destroy_eventually
+      block = block_given? ? Proc.new : nil
+      _self = self
+      Parse::Stack::Async.run do
+        begin
+          result = true
+          _self.destroy
+        rescue => e
+          result = false
+          puts "[DestroyEventually] Failed for object #{_self.parse_class}##{_self.id}: #{e}"
+        ensure
+          block.call(result) if block
+          block = nil
+          _self = nil
+        end # begin
+      end # do
+    end # destroy_eventually
+    alias_method :delete_eventually, :destroy_eventually
+
+  end # Object
+
+end # Parse

data/lib/parse/stack/async/version.rb

@@ -0,0 +1,8 @@
+module Parse
+  module Stack
+    module Async
+      # Version number for this gem
+      VERSION = "0.1.0"
+    end
+  end
+end

data/parse-stack-async.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'parse/stack/async/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "parse-stack-async"
+  spec.version       = Parse::Stack::Async::VERSION
+  spec.authors       = ["Anthony Persaud"]
+  spec.email         = ["persaud@modernistik.com"]
+
+  spec.summary       = %q{Parse Server operations asynchronously.}
+  spec.description   = %q{Perform Parse Server operations asynchronously. This is a plugin to the Parse Stack that allows for CRUD operations to be done in a background thread.}
+  spec.homepage      = "https://github.com/modernistik/parse-stack-async"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "parse-stack", ['~> 1', '>= 1.6']
+  spec.add_runtime_dependency "sucker_punch", '~> 2'
+end
+
+## Development
+# After checking out the repo, run `bin/setup` to install dependencies. You can 
+# also run `bin/console` for an interactive prompt that will allow you to experiment.
+#
+# To install this gem onto your local machine, run `bundle exec rake install`.
+# To release a new version, update the version number in `version.rb`, and then run
+# `bundle exec rake release`, which will create a git tag for the version,
+# push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: parse-stack-async
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anthony Persaud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parse-stack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: sucker_punch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Perform Parse Server operations asynchronously. This is a plugin to the
+  Parse Stack that allows for CRUD operations to be done in a background thread.
+email:
+- persaud@modernistik.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/parse/stack/async.rb
+- lib/parse/stack/async/version.rb
+- parse-stack-async.gemspec
+homepage: https://github.com/modernistik/parse-stack-async
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Parse Server operations asynchronously.
+test_files: []