simple_poller 0.0.1

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.DS_Store
+.bundle
+/.idea
+.rvmrc
+public/javascripts
+spec/javascripts/*.js

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'coffeescript', :input => 'app/assets/javascripts', :output => 'public/javascripts'
+guard 'coffeescript', :input => 'spec/coffeescripts', :output => 'spec/javascripts'

data/README.md

@@ -0,0 +1,25 @@
+## Simple Poller
+
+### Introduction
+
+Here goes introduction
+
+### Installation
+
+Here goes installation
+
+### Contributing
+
+All contributions are welcomed! :)
+
+In order to install the gem for development you should:
+
+    - git clone the repository
+    - create a gemset and run bundle
+    - execute guard to compile all the coffeescript into javascript -> bundle exec guard
+    - Add jquery 1.9 to public directory
+    - execute jasmine to run the tests -> bundle exec rake jasmine (visit localhost:8888)
+
+
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end

data/app/assets/javascripts/polling_manager.js.coffee

@@ -0,0 +1,19 @@
+#***** TURBOLINKS COMPATIBILITY **************
+
+#$(window).bind('page:fetch', function () {
+#    stop_all_pollers();
+#});
+
+#***** END TURBOLINKS COMPATIBILITY **************
+
+#Global Clocks Array
+window.active_pollers = []
+
+window.stop_all_pollers = ->
+  for poller in window.active_pollers
+    clearInterval(poller.clock_id)
+  window.active_pollers = []
+
+
+
+

data/app/assets/javascripts/resource_loader.js.coffee

@@ -0,0 +1,16 @@
+class window.ResourceLoader
+
+  constructor: (request_url, resource) ->
+    @request_url = request_url
+    @resource = resource
+
+  load: ->
+    that = @
+    $.ajax
+      url: this.request_url
+      type: 'GET'
+      dataType: 'JSON'
+      success: (data) ->
+        that.resource.load_callback(data)
+      error: ->
+        #TODO Manage error

data/app/assets/javascripts/simple_poller.js.coffee

@@ -0,0 +1,32 @@
+class window.SimplePoller
+
+  constructor: (resource_loader, timeout) ->
+    @resource_loader = resource_loader
+    @timeout = timeout
+    @clock_id = null
+
+  start: ->
+    @clock_id = @poll()
+    @add_poller_globally()
+
+  stop: ->
+    clearInterval(@clock_id)
+
+  update_timeout: (timeout) ->
+    clearInterval(@clock_id)
+    @timeout = timeout
+    @start()
+
+  # ------- Private -------
+
+  poll: ->
+    that = @
+    return setInterval(->
+      that.resource_loader.load()
+    , @timeout)
+
+  add_poller_globally: ->
+    window.active_pollers.push(@) if window.active_pollers
+
+
+

data/lib/simple_poller.rb

@@ -0,0 +1,8 @@
+require "simple_poller/version"
+
+module SimplePoller
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/simple_poller/version.rb

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

data/simple_poller.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simple_poller/version"
+
+Gem::Specification.new do |s|
+  s.name        = "simple_poller"
+  s.version     = SimplePoller::VERSION
+  s.authors     = ["jd-erreape"]
+  s.email       = ["juandediosherrero@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Write a gem summary}
+  s.description = %q{Write a gem description}
+
+  s.rubyforge_project = "simple_poller"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-coffeescript'
+  s.add_development_dependency 'jasmine'
+  # s.add_runtime_dependency "rest-client"
+  s.add_dependency 'railties', '~> 3.1'
+
+end

data/spec/coffeescripts/polling_manager_spec.js.coffee

@@ -0,0 +1,27 @@
+describe 'Polling Manager Functions', ->
+
+  beforeEach ->
+    @resource_loader_1 = jasmine.createSpyObj('resource_loader',['load'])
+    @resource_loader_2 = jasmine.createSpyObj('resource_loader',['load'])
+    @timeout = 500
+    jasmine.Clock.useMock();
+    @simple_poller_1 = new SimplePoller(@resource_loader_1, @timeout)
+    @simple_poller_2 = new SimplePoller(@resource_loader_2, @timeout)
+
+  it 'can delete all the pollers', ->
+    @simple_poller_1.start()
+    @simple_poller_2.start()
+    expect(window.active_pollers.length).toBe(2)
+    window.stop_all_pollers()
+    expect(window.active_pollers.length).toBe(0)
+
+  it 'can stop all the pollers', ->
+    @simple_poller_1.start()
+    @simple_poller_2.start()
+    jasmine.Clock.tick(@timeout+1)
+    expect(@resource_loader_1.load.callCount).toBe(1)
+    expect(@resource_loader_2.load.callCount).toBe(1)
+    window.stop_all_pollers()
+    jasmine.Clock.tick(@timeout+1)
+    expect(@resource_loader_1.load.callCount).toBe(1)
+    expect(@resource_loader_2.load.callCount).toBe(1)

data/spec/coffeescripts/resource_loader_spec.js.coffee

@@ -0,0 +1,17 @@
+describe 'ResourceLoader', ->
+
+  beforeEach ->
+    that = @
+    @fakeData = {a: 1, b: 2, c: 3};
+    @fakeUrl = 'http://www.test.com/ajax'
+    spyOn($, "ajax").andCallFake( (e) ->
+      e.success(that.fakeData)
+    )
+
+  it 'perform an ajax request for a json and load a resource', ->
+    @resource = jasmine.createSpyObj('resource',['load_callback'])
+    @resource_loader = new ResourceLoader(@fakeUrl, @resource)
+    @resource_loader.load();
+    expect(@resource.load_callback).toHaveBeenCalledWith(@fakeData)
+
+

data/spec/coffeescripts/simple_poller_spec.js.coffee

@@ -0,0 +1,66 @@
+describe 'A SimplePoller', ->
+
+  beforeEach ->
+    @resource_loader = jasmine.createSpyObj('resource_loader',['load'])
+    @timeout = 500
+    jasmine.Clock.useMock();
+    @simple_clock = new SimplePoller(@resource_loader, @timeout)
+
+  it 'will load a resource given a timeout', ->
+    @simple_clock.start()
+    expect(@resource_loader.load).not.toHaveBeenCalled()
+    jasmine.Clock.tick((@timeout*2)+1)
+    expect(@resource_loader.load.callCount).toBe(2)
+
+  it 'will stop the load', ->
+    @simple_clock.start()
+    jasmine.Clock.tick(@timeout+1)
+    expect(@resource_loader.load.callCount).toBe(1)
+    @simple_clock.stop()
+    jasmine.Clock.tick(@timeout+1)
+    expect(@resource_loader.load.callCount).toBe(1)
+
+  it 'will update the timeout', ->
+    @simple_clock.start()
+    jasmine.Clock.tick(@timeout+1)
+    expect(@resource_loader.load.callCount).toBe(1)
+    @simple_clock.update_timeout(@timeout/2)
+    jasmine.Clock.tick(@timeout)
+    expect(@resource_loader.load.callCount).toBe(3)
+
+describe 'Two SimplePollers', ->
+
+  beforeEach ->
+    @resource_loader_1 = jasmine.createSpyObj('resource_loader',['load'])
+    @resource_loader_2 = jasmine.createSpyObj('resource_loader',['load'])
+    @timeout = 500
+    jasmine.Clock.useMock();
+    @simple_poller_1 = new SimplePoller(@resource_loader_1, @timeout)
+    @simple_poller_2 = new SimplePoller(@resource_loader_2, @timeout)
+
+  it 'will start independently', ->
+    @simple_poller_1.start()
+    @simple_poller_2.start()
+    jasmine.Clock.tick(@timeout+1)
+    expect(@resource_loader_1.load.callCount).toBe(1)
+    expect(@resource_loader_2.load.callCount).toBe(1)
+
+  it 'will stop independently', ->
+    @simple_poller_1.start()
+    jasmine.Clock.tick(@timeout+1)
+    expect(@resource_loader_1.load.callCount).toBe(1)
+    expect(@resource_loader_2.load).not.toHaveBeenCalled()
+    @simple_poller_1.stop()
+    @simple_poller_2.start()
+    jasmine.Clock.tick(@timeout+1)
+    expect(@resource_loader_1.load.callCount).toBe(1)
+    expect(@resource_loader_2.load.callCount).toBe(1)
+
+  it 'will update timeouts independently', ->
+    @simple_poller_1.update_timeout(@timeout/2)
+    @simple_poller_2.start()
+    jasmine.Clock.tick(@timeout+1)
+    expect(@resource_loader_1.load.callCount).toBe(2)
+    expect(@resource_loader_2.load.callCount).toBe(1)
+
+

data/spec/javascripts/helpers/SpecHelper.js

@@ -0,0 +1,9 @@
+beforeEach(function() {
+  this.addMatchers({
+    toBePlaying: function(expectedSong) {
+      var player = this.actual;
+      return player.currentlyPlayingSong === expectedSong && 
+             player.isPlaying;
+    }
+  });
+});

data/spec/javascripts/support/jasmine.yml

@@ -0,0 +1,88 @@
+# src_files
+#
+# Return an array of filepaths relative to src_dir to include before jasmine specs.
+# Default: []
+#
+# EXAMPLE:
+#
+# src_files:
+#   - lib/source1.js
+#   - lib/source2.js
+#   - dist/**/*.js
+#
+src_files:
+    - public/javascripts/**/*.js
+
+# stylesheets
+#
+# Return an array of stylesheet filepaths relative to src_dir to include before jasmine specs.
+# Default: []
+#
+# EXAMPLE:
+#
+# stylesheets:
+#   - css/style.css
+#   - stylesheets/*.css
+#
+stylesheets:
+
+# helpers
+#
+# Return an array of filepaths relative to spec_dir to include before jasmine specs.
+# Default: ["helpers/**/*.js"]
+#
+# EXAMPLE:
+#
+# helpers:
+#   - helpers/**/*.js
+#
+helpers:
+  - 'helpers/**/*.js'
+# spec_files
+#
+#  Return an array of filepaths relative to spec_dir to include.
+# Default: ["**/*[sS]pec.js"]
+#
+# EXAMPLE:
+#
+# spec_files:
+#   - **/*[sS]pec.js
+#
+spec_files:
+  - '**/*[sS]pec.js'
+
+# src_dir
+#
+# Source directory path. Your src_files must be returned relative to this path. Will use root if left blank.
+# Default: project root
+#
+# EXAMPLE:
+#
+# src_dir: public
+#
+src_dir:
+
+# spec_dir
+#
+# Spec directory path. Your spec_files must be returned relative to this path.
+# Default: spec/javascripts
+#
+# EXAMPLE:
+#
+# spec_dir: spec/javascripts
+#
+spec_dir:
+
+# spec_helper
+#
+# Ruby file that Jasmine server will require before starting.
+# Returned relative to your root path
+# Default spec/support/jasmine_helper.rb
+#
+# EXAMPLE:
+#
+# spec_helper: spec/support/jasmine_helper.rb
+#
+spec_helper: spec/support/jasmine_helper.rb
+
+

data/spec/javascripts/support/jasmine_helper.rb

@@ -0,0 +1,11 @@
+#Use this file to set/override Jasmine configuration options
+#You can remove it if you don't need it.
+#This file is loaded *after* jasmine.yml is interpreted.
+#
+#Example: using a different boot file.
+#Jasmine.configure do |config|
+#   config.boot_dir = '/absolute/path/to/boot_dir'
+#   config.boot_files = lambda { ['/absolute/path/to/boot_dir/file.js'] }
+#end
+#
+

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: simple_poller
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- jd-erreape
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70171192964980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70171192964980
+- !ruby/object:Gem::Dependency
+  name: guard-coffeescript
+  requirement: &70171192964360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70171192964360
+- !ruby/object:Gem::Dependency
+  name: jasmine
+  requirement: &70171192963380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70171192963380
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &70171192962780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70171192962780
+description: Write a gem description
+email:
+- juandediosherrero@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- app/assets/javascripts/polling_manager.js.coffee
+- app/assets/javascripts/resource_loader.js.coffee
+- app/assets/javascripts/simple_poller.js.coffee
+- lib/simple_poller.rb
+- lib/simple_poller/version.rb
+- simple_poller.gemspec
+- spec/coffeescripts/polling_manager_spec.js.coffee
+- spec/coffeescripts/resource_loader_spec.js.coffee
+- spec/coffeescripts/simple_poller_spec.js.coffee
+- spec/javascripts/helpers/SpecHelper.js
+- spec/javascripts/resource_loader_spec.js
+- spec/javascripts/support/jasmine.yml
+- spec/javascripts/support/jasmine_helper.rb
+homepage: ''
+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: simple_poller
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Write a gem summary
+test_files:
+- spec/coffeescripts/polling_manager_spec.js.coffee
+- spec/coffeescripts/resource_loader_spec.js.coffee
+- spec/coffeescripts/simple_poller_spec.js.coffee
+- spec/javascripts/helpers/SpecHelper.js
+- spec/javascripts/resource_loader_spec.js
+- spec/javascripts/support/jasmine.yml
+- spec/javascripts/support/jasmine_helper.rb