easy_poller 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b58ca12b6b121ba52fb30fefd1f2042879227e32
+  data.tar.gz: 33b7d9df8e84520423e24b7492b5f68c97059e33
+SHA512:
+  metadata.gz: e063212b07d888b27a5c9fc1756b586ac427d4685034610fc3c5818433bcc38519d26f6f80a8ced2339aa5eabd2bf093fe08e60943cea8833b99b5ee9b244d8b
+  data.tar.gz: cad63c705ce9016d025885b80929c4a41fd4cd922e3b0a4c34018f4619489c65d1e9568b8c209306ae017e34676196175d63e0865da1ce4540719522d568a8d4

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 fabrouy
+
+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,110 @@
+# Easy Poller
+
+Very simple helper to poll for changes. Just give it an URL and voila.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easy_poller'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_poller
+
+
+## Usage
+
+In `application.js`, add:
+
+```js
+//= require easy_poller
+```
+
+Add a polling container.
+
+```erb
+<%= easy_poller count_users_path %>
+```
+
+This will create something like this and start polling for changes to the given URL. Container's inner html will be replaced with your endpoint's response.
+
+```html
+<div class="easy_poller" data-poll="true" data-interval="3000" data-url="/users/count"></div>
+```
+
+Now make your controller return something useful.
+
+```ruby
+class UsersController < ApplicationController
+  def count
+    render text: User.count
+  end
+end
+```
+
+That's it!
+
+### Options
+
+Poll every 10 seconds. _Default: 3_
+
+```erb
+<%= easy_poller count_users_path, interval: 10_000 %>
+```
+
+Do not start polling automatically. You can later start polling [interacting directly with the plugin](#plugin-interaction). _Default: true_
+
+```erb
+<%= easy_poller count_users_path, poll: false %>
+```
+
+Add HTML properties to the container
+
+```erb
+<%= easy_poller count_users_path, id: 'users-count-poller', class: 'user poller' %>
+```
+
+### Plugin interaction
+
+Stop polling
+
+```js
+$("#users-count-poller").easyPoller("stop");
+```
+
+Start polling
+
+```js
+$("#users-count-poller").easyPoller("start");
+```
+
+Start all pollers
+
+```js
+$(".easy_poller").easyPoller("start");
+```
+
+Set options
+
+```js
+$("#users-count-poller").easyPoller("options", "loadingMessage", "Please wait...");
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/fabrouy/easy_poller.
+Feel free to suggest/add new features.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :test

data/app/assets/javascripts/easy_poller.js

@@ -0,0 +1,68 @@
+$.widget("nmk.easyPoller", {
+
+    options: {
+      loadingMessage: 'Loading...'
+    },
+
+    _create: function() {
+      if (this.element.data('poll') === true) {
+        this.start();
+      }
+    },
+
+    start: function() {
+      this.element.html(this.options.loadingMessage);
+      var $wid = this;
+
+      var $element = this.element;
+
+      $wid._request($element);
+
+      intId = setInterval(function() {
+        $wid._request($element);
+      }, this._interval());
+
+      this.intervalId = intId;
+    },
+
+    stop: function() {
+      clearInterval(this.intervalId);
+    },
+
+    _url: function() {
+      return this.element.data("url");
+    },
+
+    _interval: function() {
+      return this.element.data("interval");
+    },
+
+    _replace: function(content) {
+      return this.element.html(content);
+    },
+
+    _request: function(element) {
+      var $widget = this;
+
+      $.ajax({
+        url: this._url()
+      }).always((function(_this) {
+        return function(data, textStatus, jqXHR) {
+          if (jqXHR.status === 200) {
+            return $widget._replace(data);
+          }
+        };
+      })(this));
+    },
+
+    _setOption: function(key, value) {
+      this.options[key] = value;
+    }
+
+});
+
+$(function() {
+  return $(".easy_poller").each(function(i, div) {
+    return $(div).easyPoller();
+  });
+});

data/bin/console

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

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_poller/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_poller"
+  spec.version       = EasyPoller::VERSION
+  spec.authors       = ["Fabricio Solanes"]
+  spec.email         = ["fabrouy@gmail.com"]
+  spec.summary       = %q{Very easy to use helper to poll for changes.}
+  spec.description   = %q{Very easy to use helper to poll for changes. Just give it an URL and voila.}
+  spec.license       = "MIT"
+
+  # 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'] = "TODO: Set to 'http://mygemserver.com'"
+  # 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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/easy_poller.rb

@@ -0,0 +1,7 @@
+require "easy_poller/version"
+require "easy_poller/helper"
+require "easy_poller/rails" if defined?(Rails)
+require "easy_poller/sinatra" if defined?(Sinatra)
+
+module EasyPoller
+end

data/lib/easy_poller/engine.rb

@@ -0,0 +1,20 @@
+module EasyPoller
+  class Engine < ::Rails::Engine
+    initializer "precompile", group: :all do |app|
+      if app.config.respond_to?(:assets)
+        if defined?(Sprockets) && Gem::Version.new(Sprockets::VERSION) >= Gem::Version.new("4.0.0.beta1")
+          app.config.assets.precompile << "easy_poller.js"
+        else
+          # use a proc instead of a string
+          app.config.assets.precompile << proc { |path| path == "easy_poller.js" }
+        end
+      end
+    end
+
+    initializer "helper" do
+      ActiveSupport.on_load(:action_view) do
+        include Helper
+      end
+    end
+  end
+end

data/lib/easy_poller/helper.rb

@@ -0,0 +1,27 @@
+module EasyPoller
+  module Helper
+    require 'erb'
+
+    def easy_poller(url, poll: true, interval: 3000, **html_options)
+      klasses = (html_options.delete(:class) || '').split.unshift('easy_poller').join(' ')
+
+      parsed_html_opts = ''
+      html_options.each do |key, array|
+        parsed_html_opts << " #{key}=\"#{array}\""
+      end
+      parsed_html_opts.rstrip!
+
+      replace = {
+        html_options: parsed_html_opts,
+        klasses: ERB::Util.html_escape(klasses),
+        poll: ERB::Util.html_escape(poll),
+        url: ERB::Util.html_escape(url),
+        interval: ERB::Util.html_escape(interval)
+      }
+
+      html = %(<div%{html_options} class="%{klasses}" data-poll="%{poll}" data-interval="%{interval}" data-url="%{url}"></div>) % replace
+
+      html.respond_to?(:html_safe) ? html.html_safe : html
+    end
+  end
+end

data/lib/easy_poller/rails.rb

@@ -0,0 +1,5 @@
+if Rails.version >= "3.1"
+  require "easy_poller/engine"
+else
+  ActionView::Base.send :include, EasyPoller::Helper
+end

data/lib/easy_poller/sinatra.rb

@@ -0,0 +1,5 @@
+require "sinatra/base"
+
+class Sinatra::Base
+  helpers EasyPoller::Helper
+end

data/lib/easy_poller/version.rb

@@ -0,0 +1,3 @@
+module EasyPoller
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: easy_poller
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fabricio Solanes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  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: Very easy to use helper to poll for changes. Just give it an URL and
+  voila.
+email:
+- fabrouy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/easy_poller.js
+- bin/console
+- bin/setup
+- easy_poller.gemspec
+- lib/easy_poller.rb
+- lib/easy_poller/engine.rb
+- lib/easy_poller/helper.rb
+- lib/easy_poller/rails.rb
+- lib/easy_poller/sinatra.rb
+- lib/easy_poller/version.rb
+homepage: 
+licenses:
+- MIT
+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.8
+signing_key: 
+specification_version: 4
+summary: Very easy to use helper to poll for changes.
+test_files: []