em-throttled_queue 1.0.3 → 1.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle
+pkg
+*.gem
+.DS_Store
+.yardoc/
+doc/
+Gemfile.lock

data/README.markdown

@@ -1,3 +1,9 @@
+# THIS LIBRARY HAS BEEN ABANDONED!
+
+If somebody wants to take on the project and make something useful of it, go on ahead. I, personally, will not be doing *any* more work on this.
+
+---
+
 # EM-Throttled_Queue is a throttled queue (surprise, surprise!)
 [ThrottledQueue](http://rdoc.info/github/Burgestrand/em-throttled_queue/master/EventMachine/ThrottledQueue) is just like an [EM::Queue](http://rdoc.info/github/eventmachine/eventmachine/master/EventMachine/Queue), but will pop items off itself at a pace specified by you!
 
@@ -27,12 +33,6 @@ Usage
 
 Gem is on rubygems.org, so installation is a mere `gem install em-throttled_queue`.
 
-What problem does EM-Throttled_Queue solve?
--------------------------------------------
-At [radiofy](http://radiofy.se/) we consume a lot of external services. As we are rebuilding our internal structures we will be using EventMachine for the consumption of said services. Some of them have an applied rate-limit that will punish you if you don’t restrain how many queries you execute.
-
-As a result, we need to call our blocks of code within the allowed rate-limit. For example, the [Spotify Metadata API](http://developer.spotify.com/en/metadata-api/overview/) allow a maximum of 10 requests per second, and if exceeded will force you to wait 10 seconds (essentially losing 90 reqs/10 seconds). EM::ThrottledQueue will allow us to easily limit how many calls we make per second to their API.
-
 How do I contribute?
 --------------------
 Fork, add tests (important!), add your code and send a pull request. If you wish to report an issue, please use the GitHub issue tracker. I can also be contacted by mail (visible on [my GitHub user page](http://github.com/Burgestrand)).

data/Rakefile

@@ -1,24 +1,7 @@
-require 'bundler/setup'
-
-require 'jeweler'
-require './lib/em/throttled_queue/version'
-Jeweler::Tasks.new do |gem|
-  gem.name     = "em-throttled_queue"
-  gem.homepage = "http://github.com/Burgestrand/em-throttled_queue"
-  
-  gem.license  = "X11 License"
-  
-  gem.summary = "A rate-limited Queue for EventMachine"
-  gem.authors = ["Kim Burgestrand"]
-  gem.email   = "kim@burgestrand.se"
-  
-  gem.version = EventMachine::ThrottledQueue::VERSION
-  gem.required_ruby_version = '~> 1.9'
-end
-Jeweler::RubygemsDotOrgTasks.new
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
 require 'yard'
-require 'yard/rake/yardoc_task'
 YARD::Rake::YardocTask.new
 
 require 'rake/testtask'
@@ -26,5 +9,4 @@ Rake::TestTask.new(:spec) do |t|
   t.pattern = 'spec/*.rb'
 end
 
-task :release => ['gemspec:release', 'git:release', 'gemcutter:release']
-task :default => :spec
+task :default => :spec

data/em-throttled_queue.gemspec

@@ -1,66 +1,25 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+require './lib/em/throttled_queue/version'
 
-Gem::Specification.new do |s|
-  s.name = %q{em-throttled_queue}
-  s.version = "1.0.3"
+Gem::Specification.new do |gem|
+  gem.name        = 'em-throttled_queue'
+  gem.summary     = 'A rate-limited Queue for EventMachine'
+  gem.homepage    = 'http://github.com/Burgestrand/em-throttled_queue'
+  gem.authors     = ["Kim Burgestrand"]
+  gem.email       = ['kim@burgestrand.se']
+  gem.license     = 'X11 License'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Kim Burgestrand"]
-  s.date = %q{2011-02-20}
-  s.email = %q{kim@burgestrand.se}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.markdown"
-  ]
-  s.files = [
-    ".yardopts",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE",
-    "README.markdown",
-    "Rakefile",
-    "em-throttled_queue.gemspec",
-    "lib/em-throttled_queue.rb",
-    "lib/em/throttled_queue.rb",
-    "lib/em/throttled_queue/version.rb",
-    "lib/eventmachine/throttled_queue.rb",
-    "spec/throttled_queue.rb"
-  ]
-  s.homepage = %q{http://github.com/Burgestrand/em-throttled_queue}
-  s.licenses = ["X11 License"]
-  s.require_paths = ["lib"]
-  s.required_ruby_version = Gem::Requirement.new("~> 1.9")
-  s.rubygems_version = %q{1.5.0}
-  s.summary = %q{A rate-limited Queue for EventMachine}
-  s.test_files = [
-    "spec/throttled_queue.rb"
-  ]
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = []
+  gem.require_paths = ["lib"]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  gem.version     = EventMachine::ThrottledQueue::VERSION
+  gem.platform    = Gem::Platform::RUBY
+  gem.required_ruby_version = '~> 1.9'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5"])
-      s.add_development_dependency(%q<rake>, [">= 0"])
-      s.add_development_dependency(%q<yard>, [">= 0"])
-      s.add_development_dependency(%q<rdiscount>, [">= 0"])
-    else
-      s.add_dependency(%q<eventmachine>, [">= 0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5"])
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<yard>, [">= 0"])
-      s.add_dependency(%q<rdiscount>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<eventmachine>, [">= 0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5"])
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<yard>, [">= 0"])
-    s.add_dependency(%q<rdiscount>, [">= 0"])
-  end
+  gem.add_dependency 'eventmachine'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'rdiscount'
+  gem.add_development_dependency 'bundler'
 end
-

data/lib/em/throttled_queue/version.rb

@@ -1,7 +1,20 @@
+unless defined?(EventMachine)
+  module EventMachine
+    class Queue
+      # this is an ugly hack, really, and if you find
+      # a better solution that:
+      # - don’t require me to require eventmachine
+      # - don’t require me to keep version in two places
+      # - i like (:d)
+      # then, I will buy you an ice cream
+    end
+  end
+end
+
 module EventMachine
   class ThrottledQueue < Queue
     # Gem version, following Semantic Versioning since v1.0.2
     # @see http://semver.org/
-    VERSION = [1, 0, 3].join('.')
+    VERSION = [1, 1, 0].join('.')
   end
-end
+end

data/lib/em/throttled_queue.rb

@@ -15,11 +15,15 @@ module EventMachine
     # 
     #   EM::ThrottledQueue.new(10)
     #   # => allows maximum 10 deqs every second
+    #
+    #   EM::ThrottledQueue.new(5, 10)
+    #   # => allows maximum 5 deqs every 10 seconds
     # 
-    # @param [Fixnum] maximum of dequeues every second
-    def initialize(limit)
+    # @param [Fixnum] maximum of dequeues every +refresh_interval+
+    # @param [Fixnum] how many seconds between each refresh of tokens. Default: 1 (second)
+    def initialize(limit, refresh_interval = 1)
       @credits = @limit = limit.to_i
-      @ticker  = EM::add_periodic_timer(1) do
+      @ticker  = EM::add_periodic_timer(refresh_interval) do
         @credits = @limit
         scheduled_dequeue
       end

data/spec/throttled_queue.rb

@@ -54,7 +54,27 @@ describe EM::ThrottledQueue do
     
     ticker.call(ticker)
   end
-  
+
+  it "handles slower refresh rates than every second" do
+    deqs = 0
+
+    queue = EM::ThrottledQueue.new(1, 2) # 1 requests per 2 seconds, meaning 2 seconds between requests
+    queue.push(*(1..100))
+    queue.size.must_equal 100
+
+    EM::add_timer(1.5) do
+      deqs.must_equal 1
+      EM::stop
+    end
+
+    ticker = proc do |me|
+      queue.pop { deqs += 1 }
+      EM::next_tick { me.call(me) }
+    end
+
+    ticker.call(ticker)
+  end
+
   it "should not build up credits over time" do
     deqs = 0
     

metadata

@@ -1,86 +1,70 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: em-throttled_queue
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  version: 1.0.3
 platform: ruby
-authors: 
+authors:
 - Kim Burgestrand
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-20 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-07-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2157029440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: jeweler
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.5"
-  type: :development
-  prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2157029440
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2157028880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: yard
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2157028880
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &2157028280 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rdiscount
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2157028280
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2157027500 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *2157027500
 description: 
-email: kim@burgestrand.se
+email:
+- kim@burgestrand.se
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.markdown
-files: 
+extra_rdoc_files: []
+files:
+- .gitignore
 - .yardopts
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.markdown
 - Rakefile
@@ -90,33 +74,30 @@ files:
 - lib/em/throttled_queue/version.rb
 - lib/eventmachine/throttled_queue.rb
 - spec/throttled_queue.rb
-has_rdoc: true
 homepage: http://github.com/Burgestrand/em-throttled_queue
-licenses: 
+licenses:
 - X11 License
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
+  requirements:
   - - ~>
-    - !ruby/object:Gem::Version 
-      version: "1.9"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: A rate-limited Queue for EventMachine
-test_files: 
+test_files:
 - spec/throttled_queue.rb

data/Gemfile.lock

@@ -1,22 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    eventmachine (0.12.10)
-    git (1.2.5)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    rake (0.8.7)
-    rdiscount (1.6.8)
-    yard (0.6.4)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  eventmachine
-  jeweler (~> 1.5)
-  rake
-  rdiscount
-  yard