polling_request 0.0.1

data/README.md

@@ -0,0 +1,100 @@
+# Polling Request [![Build Status](https://secure.travis-ci.org/jch/polling_request.png)](http://travis-ci.org/jch/polling_request)
+
+jQuery helper object for AJAX polling a [progress-aware endpoint](#progress-aware-endpoint).
+
+## Usage
+
+```coffeescript
+req = new PollingRequest
+  url: "/states.csv"
+  interval: 1000   # polling interval in milliseconds
+  progress: (n)->
+    console.log "Progress: #{n} percent"
+  success: (res)->
+    console.log "Response body: #{res}"
+  error: (status, response)->
+    console.log("Status: #{status}, Body: #{response}")
+  complete: (status, response)->
+    console.log("This is called after everything else")
+
+req.status   # 'pending'
+req.start()
+req.status   # 'running'
+req.progress # 0
+
+# sometime later
+req.status   # 'running'
+req.progress # 50
+
+# much later
+req.status   # 'success'
+req.progress # 100
+
+# example of setting a hard timeout
+setTimeout ->
+  req.stop()
+, 5000
+```
+
+## Progress Aware Endpoint
+
+PollingRequests will have a header `X-POLLING-REQUEST` set. It expects an HTTP
+endpoint to respond with a [202 Accepted][202] status code when there is more
+processing to be done. The JSON response body can optionally include a
+`progress` property whose value is an integer 0..100 inclusive to indicate the
+percentage of processing completed.
+
+```bash
+$ curl -i http://localhost/endpoint
+HTTP/1.1 202 Accepted
+{ progress: 0 }
+
+$ curl -i http://localhost/endpoint
+HTTP/1.1 202 Accepted
+{ progress: 50 }
+
+$ curl -i http://localhost/endpoint
+HTTP/1.1 200 Success
+Content-Type: text/plain
+Successful responses can be any content type
+```
+
+[202]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.3
+
+## Rails
+
+To access PollingRequest from the asset pipeline, add the following to your
+Gemfile:
+
+```ruby
+gem 'polling_request'
+```
+
+And this to your asset manifest:
+
+```javascript
+//= require polling_request
+```
+
+## Development
+
+Tests are written with QUnit and can be run in a browser by opening
+`test/test.html`. Continuous integration is run with phantomjs:
+
+```bash
+$ phantomjs test/runner.js test/test.html
+```
+
+## Wish List
+
+* Better docs for building and installing project
+* Bower compatibility
+* Travis CI
+
+## Contributing
+
+1. [Fork it](https://help.github.com/articles/fork-a-repo)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new [Pull Request](https://help.github.com/articles/using-pull-requests)

data/lib/polling_request.rb

@@ -0,0 +1,9 @@
+require 'rails/railtie'
+
+module PollingRequest
+  class Railtie < ::Rails::Railtie
+    config.to_prepare do
+      Rails.application.config.assets.paths << File.expand_path('../../src', __FILE__)
+    end
+  end
+end

data/src/polling_request.coffee

@@ -0,0 +1,63 @@
+# Options:
+#
+#  url: progress aware HTTP endpoint. See README.md
+#  interval: to poll in milliseconds
+#  success: callback for response body
+#  progress: callback for integer percentage
+#  error: callback with status code and response body
+#  stopped: callback after request stops
+class PollingRequest
+  constructor: (@options) ->
+    @progress = 0
+    @status   = 'pending'
+    @options.interval or= 1000
+    @options.success  or= ->
+    @options.progress or= ->
+    @options.error    or= ->
+    @options.stopped  or= ->
+
+  # Public: schedule polling by `options.interval`
+  start: ->
+    return if @timer
+    @timer = setInterval =>
+      @_run()
+    , @options.interval
+
+  # Public: stop polling. Status becomes 'stopped'
+  stop: ->
+    @status = 'stopped'
+    clearInterval(@timer)
+    @timer = null
+    @options.stopped()
+
+  # Public: one of 'pending', 'running', 'stopped'
+  status: ->
+    @status
+
+  # Public: integer 0..100 inclusive indicating percentage complete
+  progress: ->
+    @progress
+
+  # Private: runs the actual ajax request
+  _run: ->
+    $.ajax
+      url: @options.url
+      beforeSend: (jqXHR, settings) =>
+        @status = 'running'
+      statusCode:
+        # The request has succeeded.
+        200: (data, textStatus, jqXHR) =>
+          @progress = 100
+          @options.success(data)
+          @stop()
+
+        # The request has been accepted for processing, but the processing has
+        # not been completed.
+        202: (data, textStatus, jqXHR) =>
+          @progress = data.progress or 0
+          @options.progress(@progress)
+      error: (jqXHR, textStatus, errorThrown) =>
+        @options.error(jqXHR.status, jqXHR.responseText)
+        @stop()
+
+(exports ? this).PollingRequest = PollingRequest

data/src/polling_request.js

@@ -0,0 +1,72 @@
+// Generated by CoffeeScript 1.6.3
+(function() {
+  var PollingRequest;
+
+  PollingRequest = (function() {
+    function PollingRequest(options) {
+      var _base, _base1, _base2, _base3;
+      this.options = options;
+      this.progress = 0;
+      this.status = 'pending';
+      (_base = this.options).interval || (_base.interval = 1000);
+      (_base1 = this.options).success || (_base1.success = function() {});
+      (_base2 = this.options).progress || (_base2.progress = function() {});
+      (_base3 = this.options).error || (_base3.error = function() {});
+    }
+
+    PollingRequest.prototype.start = function() {
+      var _this = this;
+      if (this.timer) {
+        return;
+      }
+      return this.timer = setInterval(function() {
+        return _this._run();
+      }, this.options.interval);
+    };
+
+    PollingRequest.prototype.stop = function() {
+      this.status = 'stopped';
+      clearInterval(this.timer);
+      return this.timer = null;
+    };
+
+    PollingRequest.prototype.status = function() {
+      return this.status;
+    };
+
+    PollingRequest.prototype.progress = function() {
+      return this.progress;
+    };
+
+    PollingRequest.prototype._run = function() {
+      var _this = this;
+      return $.ajax({
+        url: this.options.url,
+        beforeSend: function(jqXHR, settings) {
+          return _this.status = 'running';
+        },
+        statusCode: {
+          200: function(data, textStatus, jqXHR) {
+            _this.progress = 100;
+            _this.options.success(data);
+            return _this.stop();
+          },
+          202: function(data, textStatus, jqXHR) {
+            _this.progress = data.progress || 0;
+            return _this.options.progress(data.progress);
+          }
+        },
+        error: function(jqXHR, textStatus, errorThrown) {
+          _this.options.error(jqXHR.status, jqXHR.responseText);
+          return _this.stop();
+        }
+      });
+    };
+
+    return PollingRequest;
+
+  })();
+
+  (typeof exports !== "undefined" && exports !== null ? exports : this).PollingRequest = PollingRequest;
+
+}).call(this);

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: polling_request
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jerry Cheung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem adds polling_request Javascript assets to Rail's asset pipeline
+email:
+- jch@whatcodecraves.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/polling_request.rb
+- src/polling_request.coffee
+- src/polling_request.js
+- README.md
+homepage: https://github.com/jch/polling_request
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Railtie for progress aware AJAX polling
+test_files: []