resque-poll 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42a70fa63c42ea38dbe133b2d9d390691ec81281
+  data.tar.gz: 9f958909b5186766beb043b7903c5d612acff9b3
+SHA512:
+  metadata.gz: 62d23d4d941f13cca8e7f85b51a4a86872b61cd3bf8eb48b31921e0a6b01055843b393d4c73afea63ff25c62756dde9c7d9071fe0b2fb8b07669ecdd3b78f19e
+  data.tar.gz: fdc12f80f6d37b60a961f3c460011f925245f1e19120c5bc32095887d1b40d0c6cef88c4cad3bec8f820ab1d2479c0809740076a7acf145197602759573cab61

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Lumos Labs
+
+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,74 @@
+[![Build Status](https://api.travis-ci.org/lumoslabs/resque-poll.png)](https://travis-ci.org/lumoslabs/resque-poll)
+
+# resque-poll
+
+resque-poll is a Rails engine that allows you to easily do long polling for Resque jobs. resque-poll depends on [resque-status](https://github.com/quirkey/resque-status).
+
+## Installation
+
+Include resque-poll in your Gemfile:
+
+```ruby
+gem 'resque-poll'
+```
+
+Mount the engine in your `routes.rb`:
+
+```ruby
+mount ResquePoll::Engine => '/resque_poll'
+```
+
+Require the javascript files & the dependencies inyour application.js javascript file (requires Asset Pipeline):
+
+```js
+//= require jquery
+//= require resque_poll
+```
+
+## Usage
+
+In a form, the `data-resque-poll` attribute to your form tag:
+
+```erb
+<%= form_for @movie, html: { data: { 'resque-poll' => true } } do |f| %>
+  <%= f.input :title %>
+  <%= f.submit %>
+```
+
+Your controller can then use ResquePoll to return the appropriate response to begin polling:
+
+```ruby
+class MoviesController < ApplicationController
+  def create
+    poll = ResquePoll.create(LongRunningMoveJob, {title: params[:title]})
+    render json: poll.to_json
+  end
+end
+```
+
+resque-poll will fire events when the polling has completed (successfully or unsuccessfully). To make use of this, you can hook into the triggered events and take action on them. Any data passed back from the resque job will also be available to you in the response.
+
+The following events are fired:
+
+* `resque:poll:stopped` - fired when processing has finished successfully or unsuccessfully
+* `resque:poll:success` - fired when processing has finished successfully
+* `resque:poll:stopped` - fired when processing has finished unsuccessfully
+
+Continuing with our form from above:
+
+```javascript
+$('form')
+  .bind('resque:poll:stopped', function(event, response) {
+    console.log('Processing finished!');
+  }).bind('resque:poll:success', function(event, response) {
+    console.log('Processing successful!');
+  }).bind('resque:poll:error', function(event, response) {
+    console.log('Processing failed!');
+  });
+```
+
+Since a common use case would be to enable/disable the submit button during the course of processing the background job, the `resque-poll-disable-with` attribute can be used to automatically disable/enable a button with a given value when processing has begun or completed.
+
+```erb
+<%= f.submit :'data-resque-poll-disable-with' => 'Creating...' %>
+```

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ResquePoll'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/resque_poll/index.coffee

@@ -0,0 +1,5 @@
+#= require_tree .
+
+$ ->
+  $(document).on 'ajax:success', 'form[data-resque-poll]', (data, status, xhr) ->
+    new ResquePoller(elem: $(this), url: status.poll) if status.poll

data/app/assets/javascripts/resque_poll/poller.coffee

@@ -0,0 +1,38 @@
+class ResquePoller
+  @INTERVAL: 2000
+
+  constructor: (opts) ->
+    @$elem      = opts.elem
+    @url        = opts.url
+    @intervalID = setInterval(@_poll, opts.interval || ResquePoller.INTERVAL)
+
+  # private
+
+  _poll: => $.getJSON @url, (resp) => @_handleResponse(resp)
+
+  _handleResponse: (resp) ->
+    return if resp.status is 'queued'
+    clearInterval @intervalID if @intervalID
+    switch resp.status
+      when 'completed'
+        @$elem.trigger 'resque:poll:stopped', resp
+        @$elem.trigger 'resque:poll:success', resp
+      when 'failed'
+        @$elem.trigger 'resque:poll:stopped', resp
+        @$elem.trigger 'resque:poll:error', resp
+
+window.ResquePoller = ResquePoller
+
+$ ->
+  $(document).on 'ajax:before', 'form[data-resque-poll]', ->
+    $(this).find('[data-resque-poll-disable-with]').each (i) ->
+      $(this)
+        .data('resque-poll-enable-with', $(this).val())
+        .attr('disabled', 'disabled')
+        .attr('value', $(this).data('resque-poll-disable-with'))
+
+  $(document).on 'resque:poll:stopped', 'form[data-resque-poll]', ->
+    $(this).find('[data-resque-poll-disable-with]').each (i) ->
+      $(this)
+        .removeAttr('disabled')
+        .attr('value', $(this).data('resque-poll-enable-with'))

data/app/controllers/resque_poll/application_controller.rb

@@ -0,0 +1,5 @@
+module ResquePoll
+  class ApplicationController < ActionController::Base
+    include ::SslRequirement
+  end
+end

data/app/controllers/resque_poll/jobs_controller.rb

@@ -0,0 +1,14 @@
+class ResquePoll::JobsController < ResquePoll::ApplicationController
+  respond_to :json
+
+  ssl_allowed :show
+
+  def show
+    status = Resque::Plugins::Status::Hash.get(params.require(:id))
+    if status.nil?
+      head :not_found
+    else
+      render json: status, status: :ok
+    end
+  end
+end

data/app/models/resque_poll/job.rb

@@ -0,0 +1,29 @@
+class ResquePoll::Job
+  extend ActiveModel::Naming
+
+  attr_reader :klass, :params, :job_id
+
+  def initialize(klass, params)
+    @klass  = klass
+    @params = params
+  end
+
+  def self.create(*args)
+    new(*args).create
+  end
+
+  def create
+    @job_id = klass.create(params)
+    self
+  end
+
+  def as_json(options = {})
+    {poll: job_path}
+  end
+
+  private
+
+  def job_path
+    job_id ? ResquePoll::Engine.routes.url_helpers.job_path(id: job_id) : nil
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+ResquePoll::Engine.routes.draw do
+  resources :jobs, only: :show
+end

data/lib/resque-poll.rb

@@ -0,0 +1,5 @@
+require "resque_poll/engine"
+require "ssl_requirement"
+
+module ResquePoll
+end

data/lib/resque_poll/engine.rb

@@ -0,0 +1,5 @@
+module ResquePoll
+  class Engine < ::Rails::Engine
+    isolate_namespace ResquePoll
+  end
+end

data/lib/resque_poll/version.rb

@@ -0,0 +1,3 @@
+module ResquePoll
+  VERSION = "1.0.0"
+end

data/lib/tasks/resque-poll_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :resque-poll do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: resque-poll
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Anthony Zacharakis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bartt-ssl_requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.15
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.15
+- !ruby/object:Gem::Dependency
+  name: resque-status
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: strong_parameters
+  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: fakeredis
+  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: pry
+  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-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: A resque-based web poller
+email:
+- anthony@lumoslabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/resque_poll/index.coffee
+- app/assets/javascripts/resque_poll/poller.coffee
+- app/controllers/resque_poll/application_controller.rb
+- app/controllers/resque_poll/jobs_controller.rb
+- app/models/resque_poll/job.rb
+- config/routes.rb
+- lib/resque-poll.rb
+- lib/resque_poll/engine.rb
+- lib/resque_poll/version.rb
+- lib/tasks/resque-poll_tasks.rake
+homepage: https://www.lumosity.com
+licenses: []
+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.4.1
+signing_key: 
+specification_version: 4
+summary: A resque-based web poller
+test_files: []
+has_rdoc: