asyncable 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aabe4e759a2c4de508c15a37967de123dfcdc14b
+  data.tar.gz: a0279830b3c30b57f313aa66860ab731ee76ce95
+SHA512:
+  metadata.gz: aac35efbe2799031d8546f973ec6aafb707fbce7afb8d027af589f30347c85569328077092840e93d92e4b6908857f11339ad2c295cdde7ee77ed7010b8f2feb
+  data.tar.gz: 7c125fc7fdffc1e94fed3dd97e5cc4fd81487a99e972ca4d05645d0311c43acc45ee2c37ed5f540697381d1f801ab666d6e7bc81d2f4ed628b9ea63fe80c7438

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in asyncable.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# Asyncable
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/asyncable`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'asyncable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install asyncable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/asyncable.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/asyncable.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'asyncable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "asyncable"
+  spec.version       = Asyncable::VERSION
+  spec.authors       = ["Ryan Francis"]
+  spec.email         = ["ryan@launchpadlab.com"]
+
+  spec.summary       = %q{Handle async operations with ease}
+  spec.description   = %q{Simple ruby gem to provide an API for managing async processes}
+  spec.homepage      = "https://github.com/LaunchPadLab/asyncable"
+
+  # 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'] = "https://rubygems.org"
+  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 { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "asyncable"
+
+# 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/asyncable/version.rb

@@ -0,0 +1,3 @@
+module Asyncable
+  VERSION = "0.1.1"
+end

data/lib/asyncable.rb

@@ -0,0 +1,75 @@
+require "asyncable/version"
+
+module Asyncable
+  module Statuses
+    PROCESSING = 'processing'
+    FAILED = 'failed'
+    SUCCEEDED = 'succeeded'
+  end
+
+  # === CLASS HOOKS ===
+  def self.handle_asynchronously(method)
+  end
+  # === END CLASS HOOKS ===
+
+  def start_async
+    self.status = Statuses::PROCESSING
+    save
+    process_in_background
+  end
+
+  def succeeded?
+    status == Statuses::SUCCEEDED
+  end
+
+  def failed?
+    status == Statuses::FAILED
+  end
+
+  def processing?
+    status == Statuses::PROCESSING
+  end
+
+  private
+
+  def process_in_background
+    begin
+      async_operation
+      complete!
+    rescue Exception => e
+      failed!(e)
+    end
+  end
+  handle_asynchronously :process_in_background
+
+
+  def complete!
+    self.status = Statuses::SUCCEEDED
+    save
+    after_async_complete
+  end
+
+  def failed!(error)
+    self.status = Statuses::FAILED
+    save
+    handle_async_error(error)
+  end
+
+  # === INTERFACE ===
+  def async_operation
+    fail "async_operation method is required for #{self.class.name}"
+  end
+
+  def save
+    fail "save method is required for #{self.class.name}"
+  end
+  # === END INTERFACE ===
+
+  # === HOOKS ===
+  def after_async_complete
+  end
+
+  def handle_async_error(_error)
+  end
+  # === END HOOKS ===
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: asyncable
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ryan Francis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple ruby gem to provide an API for managing async processes
+email:
+- ryan@launchpadlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- asyncable.gemspec
+- bin/console
+- bin/setup
+- lib/asyncable.rb
+- lib/asyncable/version.rb
+homepage: https://github.com/LaunchPadLab/asyncable
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Handle async operations with ease
+test_files: []