warpcore 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64d39ad237b3b431d752615c8aa39cdd8d51c8cf
-  data.tar.gz: 833178d0157e183c2b9ec1440705a7723c5f0caa
+  metadata.gz: 49d5997abb7a9c1c8329fec10bf2d19aa6aeae4b
+  data.tar.gz: 6e08ceef2a0f355be9cac56c68174146a3863afb
 SHA512:
-  metadata.gz: b5e9dd10e1b7864584a4c6affc62030fb7a4bb18dc1dfd8bcef96e0daaeb9cb1b01512b5aecba526fd42507b6bd9480d2341d641ec4e340701d2110cc5b273d5
-  data.tar.gz: 4f0a1fcb27a0cac559041192fc6f43abb618468d7a61a81adeef81d90854a1d028f5010e31866bf1c3ab291437596f943e30b05d311008e304072a5c1db879be
+  metadata.gz: 45ab49dbaf5614ff6bbbb6ece565b256066c895aad4f4fb083f293795f459b3eb5bcd1cc5ddb44cae3774cb06763cf11d0bd0ca5d5c2e1717a58cd30d5dce5ba
+  data.tar.gz: 00a4006ed3ce3eddac21f199ad3d26f428aaf1d4c0d5d1e02b872aa022c01f76b55a01dda3c185cc8c795e60c36fcf2c563a0e8239ccff07f74a2256b0c26955

data/lib/warpcore.rb

@@ -7,6 +7,7 @@ require 'sucker_punch'
 require 'redis'
 require 'moneta'
 require 'dotenv'
+require_relative 'warpcore/config'
 require_relative 'warpcore/cache'
 require_relative 'warpcore/dispatch'
 require_relative 'warpcore/sidekiq'

data/lib/warpcore/cache.rb

@@ -3,7 +3,7 @@ require 'active_support'
 require 'active_support/core_ext'
 
 module WarpCore
-  # cache helper
+
   def self.cache(key,opts = {})
     if block_given?
       WarpCore::Cache.get( key, opts, Proc.new )
@@ -12,6 +12,8 @@ module WarpCore
     end
   end
 
+  # A class helper to manage a Moneta cache store that can be used throughout the
+  # system.
   class Cache
     class << self
       attr_accessor :store

data/lib/warpcore/config.rb

@@ -0,0 +1,32 @@
+require 'open-uri'
+require 'active_support'
+require 'active_support/core_ext'
+
+module WarpCore
+  # Class provides a helper method to load
+  class Env
+    # Applies a remote JSON hash containing the ENV keys and values from a remote
+    # URL. Values from the JSON hash are only applied to the current ENV hash ONLY if
+    # it does not already have a value. Therefore local ENV values will take precedence
+    # over remote ones. By default, it uses the url in value in ENV['ENV_URL'].
+    # @param url [String] the remote url that responds with the JSON body.
+    # @return [Boolean] true if the JSON hash was found and applied successfully.
+    def self.load_url!(url = nil)
+      url ||= ENV["ENV_URL"]
+      if url.present?
+        begin
+          remote_config = JSON.load open( url )
+          remote_config.each do |key,value|
+            k = key.upcase
+            ENV[k] ||= value.to_s
+          end
+          return true
+        rescue => e
+          warn "[WarpCore::Config] Error loading config: #{url} (#{e})"
+        end
+      end
+      false
+    end
+
+  end
+end

data/lib/warpcore/dispatch.rb

@@ -3,24 +3,29 @@ require 'active_support'
 require 'active_support/core_ext'
 
 module WarpCore
-
+  # A class to support running blocks in a serial queue on a background thread.
   class SerialDispatchQueue
     include SuckerPunch::Job
     workers 1 # serial queue
-
+    # @!visibility private
     def perform(block = nil)
       block.call() if block.respond_to?(:call)
     end
   end
 
+  # A class to support running blocks in concurrent queue on a background thread.
   class ParallelDispatchQueue
     include SuckerPunch::Job
-
+    # @!visibility private
     def perform(block = nil)
       block.call() if block.respond_to?(:call)
     end
   end
 
+  # Helper method to run a block on a background thread.
+  # @param type [Symbol] the queue to use when dispatching the block.
+  #   * :serial - use the {SerialDispatchQueue}
+  #   * :parallel - use the {ParallelDispatchQueue}
   def self.async(type = :serial)
     raise "You need to pass a block to async." unless block_given?
     if type == :parallel
@@ -30,6 +35,10 @@ module WarpCore
     end
   end
 
+  # Helper method to run a block on a background thread.
+  # @param type (see WarpCore.async)
+  #   * :serial - use the {SerialDispatchQueue}
+  #   * :parallel - use the {ParallelDispatchQueue}
   def self.delay_by(seconds, type = :serial)
     raise "You need to pass a block to delay_by." unless block_given?
     if type == :parallel

data/lib/warpcore/parse_stack.rb

@@ -3,7 +3,9 @@ require_relative 'dispatch'
 
 module Parse
   class Object
-
+    # Adds support for saving a Parse::Object instance in the background.
+    # If an exception is thrown, it is handled silently.
+    # @yield A block to call after the save has completed successfully
     def save_eventually
       block = block_given? ? Proc.new : nil
       WarpCore.async do
@@ -16,6 +18,11 @@ module Parse
       end
     end
 
+    # Same as {save_eventually}, but calls `save` on an object in the if it is
+    # new, otherwise it calls `update!`.
+    # If an exception is thrown, it is handled silently.
+    # @yield (see Parse::Object#save_eventually)
+    # @see #save_eventually
     def save_eventually!
         WarpCore.async do
           begin

data/lib/warpcore/sidekiq.rb

@@ -5,10 +5,17 @@ require 'active_support/core_ext'
 
 module WarpCore
 
+  # @return [RedisPoolInstance] a usable redis instance shared by Sidekiq.
   def self.redis
     WarpCore::RedisPoolInstance.new
   end
 
+  # Asynchronously dispatch a Sidekiq worker with the provided arguments. This
+  # is equivalent to calling the worker directly with `perform_async`.
+  # @example
+  #   WarpCore.dispatch 'Workers::MyWorker', argument1, argument2.....
+  # @param worker_name [String] the full class path of the worker (ex. `Workers::MyWorker`)
+  # @param args [Array] the arguments to pass to the worker.
   def self.dispatch(worker_name, *args)
     klass = worker_name.constantize
     if klass.respond_to?(:perform_async)
@@ -23,6 +30,13 @@ module WarpCore
     nil
   end
 
+  # Asynchronously dispatch a Sidekiq worker at a later time with the provided
+  # arguments. This is equivalent to calling the worker directly with `perform_in`.
+  # @example
+  #   WarpCore.dispatch_in 'Workers::MyWorker', 10.seconds, argument1, argument2.....
+  # @param worker_name (see WarpCore.dispatch)
+  # @param args [Array] the arguments to pass to the worker. The first argument
+  #  should be the amount of time to wait before dispatching the worker.
   def self.dispatch_in(worker_name, *args)
     klass = worker_name.constantize
     if klass.respond_to?(:perform_async)
@@ -37,6 +51,13 @@ module WarpCore
     nil
   end
 
+  # Synchronously dispatch a Sidekiq worker with the provided
+  # arguments. This is equivalent to instantiating the worker instance directly
+  # and calling `perform` on it.
+  # @example
+  #   WarpCore.dispatch_sync 'Workers::MyWorker', argument1, argument2.....
+  # @param worker_name (see WarpCore.dispatch)
+  # @param args [Array] the arguments to pass to the worker.
   def self.dispatch_sync(worker_name, *args)
     klass = worker_name.constantize
     object = klass.new
@@ -52,19 +73,16 @@ module WarpCore
     nil
   end
 
-  # Because +Sidekiq.redis+ requires passing a block,
-  # we can't pass it straight to +Redis::Semaphore+.
-  # This class simply delegates every method call to
-  # the Sidekiq connection.
-  # use RedisPoolInstance.new to get a shared redis connection
+  # This class simply delegates every method call to the Sidekiq redis connection.
+  # Use RedisPoolInstance.new to get a shared redis connection.
   class RedisPoolInstance
-
+    # @!visibility private
     def method_missing(meth, *args, &block)
       Sidekiq.redis do |connection|
         connection.send(meth, *args, &block)
       end
     end
-
+    # @!visibility private
     def respond_to_missing?(meth)
       Sidekiq.redis do |connection|
         connection.respond_to?(meth)

data/lib/warpcore/version.rb

@@ -1,3 +1,6 @@
+# This module provides a set of classes and components to build large scale, scalable
+# and easier to maintain ruby-based applications with Parse.
 module WarpCore
-  VERSION = "0.1.4"
+  # Version number
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warpcore
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Anthony Persaud
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-06 00:00:00.000000000 Z
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -200,6 +200,7 @@ extra_rdoc_files: []
 files:
 - lib/warpcore.rb
 - lib/warpcore/cache.rb
+- lib/warpcore/config.rb
 - lib/warpcore/dispatch.rb
 - lib/warpcore/parse_stack.rb
 - lib/warpcore/sidekiq.rb