order_up 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0392de83ad625960ba348387295c0b7e0422d3f
+  data.tar.gz: 150b6ec39d532ce066e03c412b4b375f49cf42a9
+SHA512:
+  metadata.gz: 78e7fd477baab3081fb0613fe9200947cc05310b795dfeab401a97f0bcafa01ff565e9db36e9fac1da3377a234a899df7315d42b831009df04be87fce1ca3218
+  data.tar.gz: 1f96da7e4f6fbacca7c99086b3cfce234c526cf24378d177a375278c041011fff8a69027e2bda9badeec595f53ae41b8e00f9392a5452893acd6a6323b7c1c38

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,15 @@
+##########################################################################
+# Copyright 2014 Data Curation Experts
+# Additional copyright may be held by others, as reflected in the commit log
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

data/README.md

@@ -0,0 +1,83 @@
+# OrderUp 
+
+A queue agnostic interface for Rails. Currently only Resque is supported, but we'd like to add other implementations if you want to contribute one.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'order_up'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install order_up
+
+## Usage
+
+Create a config file: `config/resque.yml`
+
+```yaml
+  development: localhost:6379
+  test: localhost:6379
+  production: redis1.ae.github.com:6379
+```
+
+Then make an initializer that reads the yaml file and sets up Resque:
+
+```ruby
+  # config/initializers/resque.rb
+  rails_root = ENV['RAILS_ROOT'] || File.dirname(__FILE__) + '/../..'
+  rails_env = ENV['RAILS_ENV'] || 'development'
+
+  config = YAML::load_file(rails_root + '/config/resque.yml')
+  Resque.redis = config[rails_env]
+
+  Resque.inline = rails_env == 'test'
+  Resque.redis.namespace = "myproject:#{rails_env}"
+```
+
+Now you can push jobs into the queue:
+```ruby
+class MyJob
+  def initialize(file_id, message)
+    @file_id = file_id
+    @message = message
+  end
+
+  def run
+    File.find(@file_id).deliver(@message)
+  end
+end
+
+my_job = MyJob.new(123, "It works!")
+OrderUp.push(my_job)
+```
+
+The initalizer will be called when the job is created, and the `run` method
+will be invoked when the job is processed asynchronously.
+
+### Running the background workers
+First add to your `Rakefile`
+```ruby
+require 'resque/tasks'
+```
+Then you can invoke the rake task:
+
+```bash
+$ QUEUE=* rake environment resque:work
+```
+
+### See also
+(https://github.com/resque/resque/tree/1-x-stable)
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/order_up/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |config|
+end

data/lib/order_up.rb

@@ -0,0 +1,28 @@
+require 'resque'
+require 'active_support'
+module OrderUp
+  extend ActiveSupport::Autoload
+  autoload :Resque
+  def self.config
+      @@config ||= Configuration.new
+      yield @@config if block_given?
+      return @@config
+  end
+
+  def self.push(val)
+    instance.push(val)
+  end
+
+  private 
+  def self.instance
+    @@instance ||= config.queue.new('hydra')
+  end
+
+  class Configuration
+    attr_writer :queue
+
+    def queue
+      @queue || OrderUp::Resque
+    end
+  end
+end

data/lib/order_up/resque.rb

@@ -0,0 +1,40 @@
+require 'active_support'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/json/encoding' # in rails 4.0
+#require 'active_support/core_ext/object/json' # in rails 4.1
+module OrderUp
+  class Resque
+    attr_reader :default_queue_name
+
+    ENCAPSULATED_CLASS = "_encapsulated_class".freeze
+
+    def initialize(default_queue_name)
+      @default_queue_name = default_queue_name
+    end
+
+    def push(job)
+      queue = job.respond_to?(:queue_name) ? job.queue_name : default_queue_name
+      # this can raise a Redis::CannotConnectError
+      ::Resque.enqueue_to queue, JsonJob, JsonJob.serialize(job)
+    end
+
+    class JsonJob
+      def self.perform(job_data)
+        deserialize(job_data).run
+      end
+      def self.serialize(job)
+        job.as_json.merge(ENCAPSULATED_CLASS => job.class.name).to_json
+      end
+
+      def self.deserialize(job_data)
+        data = JSON.parse(job_data)
+        class_name = data.delete(ENCAPSULATED_CLASS)
+        class_name.constantize.allocate.tap do |obj|
+          data.each do |key, value|
+            obj.instance_variable_set(:"@#{key}", value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/order_up/version.rb

@@ -0,0 +1,3 @@
+module OrderUp
+  VERSION = "0.0.1"
+end

data/order_up.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'order_up/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "order_up"
+  spec.version       = OrderUp::VERSION
+  spec.authors       = ["Justin Coyne"]
+  spec.email         = ["justin@curationexperts.com"]
+  spec.summary       = %q{Backend agnostic queuing implementation}
+  spec.description       = %q{Backend agnostic queuing implementation}
+  spec.homepage      = "http://projecthydra.org"
+  spec.license       = "APACHE2"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "resque", "~>1.25"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/lib/hydra/queue_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'active_support/core_ext/class/attribute'
+
+describe OrderUp do
+  before do
+    OrderUp.config do |config|
+      config.queue = OrderUp::Resque
+    end
+  end
+  class TestJob
+    class_attribute :worked
+    attr_accessor :name
+
+    def initialize(name)
+      self.name = name
+    end
+
+    def run
+      self.class.worked = name
+    end
+  end
+  it "should do work in the background" do
+    OrderUp.push TestJob.new('test message')
+    TestJob.worked.should == 'test message'
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'order_up'
+
+Resque.inline = true
+RSpec.configure do |config|
+  # config.treat_symbols_as_metadata_keys_with_true_values = true
+  # config.run_all_when_everything_filtered = true
+  # config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: order_up
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Coyne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Backend agnostic queuing implementation
+email:
+- justin@curationexperts.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/order_up.rb
+- lib/order_up/resque.rb
+- lib/order_up/version.rb
+- order_up.gemspec
+- spec/lib/hydra/queue_spec.rb
+- spec/spec_helper.rb
+homepage: http://projecthydra.org
+licenses:
+- APACHE2
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Backend agnostic queuing implementation
+test_files:
+- spec/lib/hydra/queue_spec.rb
+- spec/spec_helper.rb
+has_rdoc: