rest-core 1.0.1 → 1.0.2

data/.gitignore

@@ -4,3 +4,4 @@ rdoc
 .bundle
 .yardoc
 Gemfile.lock
+task

data/CHANGES.md

@@ -1,5 +1,15 @@
 # CHANGES
 
+## rest-core 1.0.2 -- 2012-06-05
+
+### Enhancement
+
+* Some internal refactoring.
+
+### Bugs fixes
+
+* Properly handle asynchronous timers for eventmachine and cool.io.
+
 ## rest-core 1.0.1 -- 2012-05-14
 
 * [`Auto`] Check for eventmachine first instead of cool.io

data/Rakefile

@@ -1,8 +1,13 @@
 # encoding: utf-8
 
-require "#{dir = File.dirname(__FILE__)}/task/gemgem"
-Gemgem.dir = dir
+begin
+  require "#{dir = File.dirname(__FILE__)}/task/gemgem"
+rescue LoadError
+  sh "git submodule update --init"
+  exec Gem.ruby, "-S", "rake", *ARGV
+end
 
+Gemgem.dir = dir
 ($LOAD_PATH << File.expand_path("#{Gemgem.dir}/lib" )).uniq!
 
 desc 'Generate gemspec'

data/lib/rest-core/app/coolio-fiber.rb

@@ -11,10 +11,10 @@ class RestCore::CoolioFiber
                                         :url     => request_uri(env)    ,
                                         :payload => env[REQUEST_PAYLOAD],
                                         :headers => env[REQUEST_HEADERS]))
+  rescue FiberError
   end
 
   def process env, response
-    env[TIMER].detach if env[TIMER]
     Thread.current[:coolio_http_client].detach if
       Thread.current[:coolio_http_client].kind_of?(::Coolio::HttpFiber)
 

data/lib/rest-core/app/em-http-request-async.rb

@@ -28,7 +28,7 @@ class RestCore::EmHttpRequestAsync
   end
 
   def respond env, client
-    env[TIMER].cancel if env[TIMER]
+    env[TIMER].cancel if env[TIMER] && !env[TIMER].canceled?
     env[ASYNC].call(env.merge(
       RESPONSE_BODY    => client.response,
       RESPONSE_STATUS  => client.response_header.status,

data/lib/rest-core/app/em-http-request-fiber.rb

@@ -28,8 +28,11 @@ class RestCore::EmHttpRequestFiber
   end
 
   def respond f, env, client
-    env[TIMER].cancel if env[TIMER]
     f.resume(process(env, client)) if f.alive?
+  rescue FiberError
+    # whenever timeout, client.close would be called,
+    # and then errback would be called. in this case,
+    # the fiber is already resumed by the timer
   end
 
   def process env, client

data/lib/rest-core/builder.rb

@@ -6,9 +6,6 @@ class RestCore::Builder
   include RestCore
   include Wrapper
 
-  class << self
-    attr_writer :default_app
-  end
   def self.default_app
     @default_app ||= RestClient
   end

data/lib/rest-core/client.rb

@@ -176,7 +176,7 @@ module RestCore::Client
        FAIL            => []  ,
        LOG             => []  ,
        ASYNC           => if block_given?
-                            lambda{ |response| yield(response) }
+                            lambda{ |res| yield(res) }
                           else
                             nil
                           end}.merge(env)))

data/lib/rest-core/middleware/cache.rb

@@ -23,6 +23,7 @@ class RestCore::Cache
         end
 
     if cached = cache_get(e)
+      env[TIMER].cancel if env[TIMER] && !env[TIMER].canceled?
       wrapped.call(cached)
     else
       if e[ASYNC]

data/lib/rest-core/middleware/timeout.rb

@@ -25,7 +25,10 @@ class RestCore::Timeout
       if root_fiber? && env[ASYNC]
         yield(env.merge(TIMER => timeout_with_callback(env, class_name)))
       else
-        yield(env.merge(TIMER => timeout_with_resume(  env, class_name)))
+        timer = timeout_with_resume(env, class_name)
+        response = yield(env.merge(TIMER => timer))
+        timer.cancel unless timer.canceled?
+        response
       end
     else
       ::Timeout.timeout(timeout(env)){ yield(env) }
@@ -60,6 +63,9 @@ class RestCore::Timeout
       f = Fiber.current
       EventMachineTimer.new(timeout(env), error = timeout_error){
         f.resume(error) if f.alive?
+        # no need to check if the fiber is already resumed or not,
+        # because monitor should have already handled this in the
+        # case of fibers
       }
 
     when /Coolio/

data/lib/rest-core/middleware/timeout/coolio_timer.rb

@@ -1,4 +1,10 @@
 
 class RestCore::Timeout::CoolioTimer < ::Coolio::TimerWatcher
   attr_accessor :error
+
+  alias_method :cancel, :detach
+
+  def canceled?
+    !attached?
+  end
 end

data/lib/rest-core/middleware/timeout/eventmachine_timer.rb

@@ -6,9 +6,19 @@ class RestCore::Timeout::EventMachineTimer < ::EventMachine::Timer
     super(timeout, &block) if block_given?
     self.timeout = timeout
     self.error   = error
+    @canceled    = false
   end
 
   def on_timeout &block
     send(:initialize, timeout, error, &block)
   end
+
+  def cancel
+    super
+    @canceled = true
+  end
+
+  def canceled?
+    @canceled
+  end
 end

data/lib/rest-core/version.rb

@@ -1,4 +1,4 @@
 
 module RestCore
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/lib/rest-core/wrapper.rb

@@ -3,16 +3,21 @@ require 'rest-core'
 
 module RestCore::Wrapper
   include RestCore
+
+  module DefaultApp
+    def default_app
+      @default_app ||= RestCore::Dry
+    end
+  end
+
   def self.included mod
-    mod.send(:attr_reader, :init, :middles, :wrapped)
+    mod.send(:extend, DefaultApp)
     class << mod
       attr_writer :default_app
-      def default_app
-        @default_app ||= RestCore::Dry
-      end
     end
   end
 
+  attr_reader :init, :middles, :wrapped
   attr_writer :default_app
   def default_app
     @default_app ||= self.class.default_app
@@ -22,6 +27,7 @@ module RestCore::Wrapper
     @middles ||= []
     instance_eval(&block) if block_given?
     @wrapped ||= to_app
+    @init      = nil
   end
 
   def use middle, *args, &block
@@ -43,9 +49,9 @@ module RestCore::Wrapper
     }.flatten
   end
 
-  def to_app init=@init || default_app
+  def to_app app=init || default_app
     # === foldr m.new app middles
-    middles.reverse.inject(init.new){ |app_, (middle, args, block)|
+    middles.reverse.inject(app.new){ |app_, (middle, args, block)|
       begin
         middle.new(app_, *partial_deep_copy(args), &block)
       rescue ArgumentError => e

data/rest-core.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [
   "Cardinal Blue",
   "Lin Jen-Shin (godfat)"]
-  s.date = "2012-05-14"
+  s.date = "2012-06-05"
   s.description = "Modular Ruby clients interface for REST APIs\n\nThere has been an explosion in the number of REST APIs available today.\nTo address the need for a way to access these APIs easily and elegantly,\nwe have developed [rest-core][], which consists of composable middleware\nthat allows you to build a REST client for any REST API. Or in the case of\ncommon APIs such as Facebook, Github, and Twitter, you can simply use the\ndedicated clients provided by [rest-more][].\n\n[rest-core]: https://github.com/cardinalblue/rest-core\n[rest-more]: https://github.com/cardinalblue/rest-more"
   s.email = ["dev (XD) cardinalblue.com"]
   s.files = [
@@ -78,10 +78,9 @@ Gem::Specification.new do |s|
   "pending/test_multi.rb",
   "pending/test_test_util.rb",
   "rest-core.gemspec",
-  "task/.gitignore",
-  "task/gemgem.rb",
   "test/test_auth_basic.rb",
   "test/test_builder.rb",
+  "test/test_cache.rb",
   "test/test_client.rb",
   "test/test_client_oauth1.rb",
   "test/test_default_query.rb",
@@ -101,6 +100,7 @@ Gem::Specification.new do |s|
   s.test_files = [
   "test/test_auth_basic.rb",
   "test/test_builder.rb",
+  "test/test_cache.rb",
   "test/test_client.rb",
   "test/test_client_oauth1.rb",
   "test/test_default_query.rb",

data/test/test_cache.rb

@@ -0,0 +1,69 @@
+
+require 'rest-core/test'
+
+describe RC::Cache do
+  after do
+    WebMock.reset!
+    RR.verify
+  end
+
+  should 'basic' do
+    c = RC::Builder.client do
+      use RC::Cache, {}, 3600
+      run Class.new{
+        attr_accessor :tick
+        def initialize
+          self.tick = 0
+        end
+        def call env
+          self.tick +=1
+          env.merge(RC::RESPONSE_BODY => 'response')
+        end
+      }
+    end.new
+    c.get('/')
+    c.cache.should.eq({Digest::MD5.hexdigest('/') => 'response'})
+    c.app.app.tick.should.eq 1
+    c.get('/')
+    c.app.app.tick.should.eq 1
+    c.cache.clear
+    c.get('/')
+    c.app.app.tick.should.eq 2
+  end
+
+  should 'cancel timeout for fiber' do
+    any_instance_of(RC::Timeout::EventMachineTimer) do |timer|
+      proxy.mock(timer).cancel.times(2)
+    end
+    path = 'http://example.com/'
+    stub_request(:get, path).to_return(:body => 'response')
+    c = RC::Builder.client do
+      use RC::Timeout, 10
+      use RC::Cache, {}, 3600
+      run RC::EmHttpRequestFiber
+    end.new
+    EM.run{ Fiber.new{
+      c.request_full(RC::REQUEST_PATH => path)
+      c.request_full(RC::REQUEST_PATH => path)
+      EM.stop }.resume }
+    c.cache.size.should.eq 1
+  end if defined?(Fiber)
+
+  should 'cancel timeout for async' do
+    path = 'http://example.com/'
+    any_instance_of(RC::Timeout::EventMachineTimer) do |timer|
+      mock(timer).cancel.times(2)
+    end
+    stub_request(:get, path).to_return(:body => 'response')
+    c = RC::Builder.client do
+      use RC::Timeout, 10
+      use RC::Cache, {}, 3600
+      run RC::EmHttpRequestAsync
+    end.new
+    EM.run{
+      c.request_full(RC::REQUEST_PATH => path){
+        c.request_full(RC::REQUEST_PATH => path){
+          EM.stop }}}
+    c.cache.size.should.eq 1
+  end
+end

data/test/test_timeout.rb

@@ -6,6 +6,10 @@ describe RC::Timeout do
     @app = RC::Timeout.new(RC::Dry.new, 0)
   end
 
+  after do
+    WebMock.reset!
+  end
+
   should 'bypass timeout if timeout is 0' do
     mock(@app).monitor.times(0)
     @app.call({}).should.eq({})
@@ -16,4 +20,15 @@ describe RC::Timeout do
     mock.proxy(@app).monitor(env).times(1)
     @app.call(env).should.eq(env)
   end
+
+  should 'return correct result under fibers' do
+    path = 'http://example.com/'
+    stub_request(:get, path).to_return(:body => 'response')
+
+    c = RC::Builder.client do
+      use RC::Timeout, 10
+      run RC::EmHttpRequestFiber
+    end.new
+    EM.run{Fiber.new{c.get(path).should.eq('response');EM.stop}.resume}
+  end if defined?(Fiber)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest-core
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-14 00:00:00.000000000 Z
+date: 2012-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -119,10 +119,9 @@ files:
 - pending/test_multi.rb
 - pending/test_test_util.rb
 - rest-core.gemspec
-- task/.gitignore
-- task/gemgem.rb
 - test/test_auth_basic.rb
 - test/test_builder.rb
+- test/test_cache.rb
 - test/test_client.rb
 - test/test_client_oauth1.rb
 - test/test_default_query.rb
@@ -162,6 +161,7 @@ summary: Modular Ruby clients interface for REST APIs
 test_files:
 - test/test_auth_basic.rb
 - test/test_builder.rb
+- test/test_cache.rb
 - test/test_client.rb
 - test/test_client_oauth1.rb
 - test/test_default_query.rb

data/task/.gitignore

@@ -1 +0,0 @@
-*.rbc

data/task/gemgem.rb

@@ -1,257 +0,0 @@
-
-require 'pathname'
-
-module Gemgem
-  class << self
-    attr_accessor :dir, :spec
-  end
-
-  module_function
-  def create
-    yield(spec = Gem::Specification.new{ |s|
-      s.authors     = ['Lin Jen-Shin (godfat)']
-      s.email       = ['godfat (XD) godfat.org']
-
-      s.description = description.join
-      s.summary     = description.first
-
-      s.rubygems_version = Gem::VERSION
-      s.date             = Time.now.strftime('%Y-%m-%d')
-      s.files            = gem_files
-      s.test_files       = gem_files.grep(%r{^test/(.+?/)*test_.+?\.rb$})
-      s.executables      = Dir['bin/*'].map{ |f| File.basename(f) }
-      s.require_paths    = %w[lib]
-    })
-    spec.homepage ||= "https://github.com/godfat/#{spec.name}"
-    spec
-  end
-
-  def readme
-    path = %w[README.md README].find{ |name|
-      File.exist?("#{Gemgem.dir}/#{name}")
-    }
-    @readme ||=
-      if path
-        ps = File.read(path).scan(/#+[^\n]+\n\n.+?(?=\n\n#+[^\n]+\n)/m)
-        ps.inject({'HEADER' => ps.first}){ |r, s, i|
-          r[s[/\w+/]] = s
-          r
-        }
-      else
-        {}
-      end
-  end
-
-  def description
-    @description ||= (readme['DESCRIPTION']||'').sub(/.+\n\n/, '').lines.to_a
-  end
-
-  def changes
-    path = %w[CHANGES.md CHANGES].find{ |name|
-      File.exist?("#{Gemgem.dir}/#{name}")
-    }
-    @changes ||=
-      if path
-        date = '\d+{4}\-\d+{2}\-\d{2}'
-        File.read(path).match(
-          /([^\n]+#{date}\n\n(.+?))(?=\n\n[^\n]+#{date}\n)/m)[1]
-      else
-        ''
-      end
-  end
-
-  def ann_md
-    "##{readme['HEADER'].sub(/([\w\-]+)/, "[\\1](#{spec.homepage})")}\n\n" \
-    "##{readme['DESCRIPTION'][/[^\n]+\n\n[^\n]+/]}\n\n"                    \
-    "### CHANGES:\n\n"                                                     \
-    "###{changes}\n\n"                                                     \
-    "##{readme['INSTALLATION']}\n\n"                                       +
-    if readme['SYNOPSIS'] then "##{readme['SYNOPSIS']}" else '' end
-  end
-
-  def ann_html
-    gem 'nokogiri'
-    gem 'kramdown'
-
-    IO.popen('kramdown', 'r+') do |md|
-      md.puts Gemgem.ann_md
-      md.close_write
-      require 'nokogiri'
-      html = Nokogiri::XML.parse("<gemgem>#{md.read}</gemgem>")
-      html.css('*').each{ |n| n.delete('id') }
-      html.root.children.to_html
-    end
-  end
-
-  def ann_email
-    "#{readme['HEADER'].sub(/([\w\-]+)/, "\\1 <#{spec.homepage}>")}\n\n" \
-    "#{readme['DESCRIPTION']}\n\n"                                       \
-    "#{readme['INSTALLATION']}\n\n"                                      +
-    if readme['SYNOPSIS'] then "##{readme['SYNOPSIS']}\n\n" else '' end  +
-    "## CHANGES:\n\n"                                                    \
-    "##{changes}\n\n"
-  end
-
-  def gem_tag
-    "#{spec.name}-#{spec.version}"
-  end
-
-  def write
-    File.open("#{dir}/#{spec.name}.gemspec", 'w'){ |f|
-      f << split_lines(spec.to_ruby) }
-  end
-
-  def split_lines ruby
-    ruby.gsub(/(.+?)\[(.+?)\]/){ |s|
-      if $2.index(',')
-        "#{$1}[\n  #{$2.split(',').map(&:strip).join(",\n  ")}]"
-      else
-        s
-      end
-    }
-  end
-
-  def all_files
-    @all_files ||= find_files(Pathname.new(dir)).map{ |file|
-      if file.to_s =~ %r{\.git/}
-        nil
-      else
-        file.to_s
-      end
-    }.compact.sort
-  end
-
-  def gem_files
-    @gem_files ||= all_files - ignored_files
-  end
-
-  def ignored_files
-    @ignored_file ||= all_files.select{ |path| ignore_patterns.find{ |ignore|
-      path =~ ignore && !git_files.include?(path)}}
-  end
-
-  def git_files
-    @git_files ||= if File.exist?("#{dir}/.git")
-                     `git ls-files`.split("\n")
-                   else
-                     []
-                   end
-  end
-
-  # protected
-  def find_files path
-    path.children.select(&:file?).map{|file| file.to_s[(dir.size+1)..-1]} +
-    path.children.select(&:directory?).map{|dir| find_files(dir)}.flatten
-  end
-
-  def ignore_patterns
-    @ignore_files ||= expand_patterns(
-      File.read("#{dir}/.gitignore").split("\n").reject{ |pattern|
-        pattern.strip == ''
-      }).map{ |pattern| %r{^([^/]+/)*?#{Regexp.escape(pattern)}(/[^/]+)*?$} }
-  end
-
-  def expand_patterns pathes
-    pathes.map{ |path|
-      if path !~ /\*/
-        path
-      else
-        expand_patterns(
-          Dir[path] +
-          Pathname.new(File.dirname(path)).children.select(&:directory?).
-            map{ |prefix| "#{prefix}/#{File.basename(path)}" })
-      end
-    }.flatten
-  end
-end
-
-namespace :gem do
-
-desc 'Install gem'
-task :install => [:build] do
-  sh("#{Gem.ruby} -S gem install pkg/#{Gemgem.gem_tag}")
-end
-
-desc 'Build gem'
-task :build => [:spec] do
-  sh("#{Gem.ruby} -S gem build #{Gemgem.spec.name}.gemspec")
-  sh("mkdir -p pkg")
-  sh("mv #{Gemgem.gem_tag}.gem pkg/")
-end
-
-desc 'Release gem'
-task :release => [:spec, :check, :build] do
-  sh("git tag #{Gemgem.gem_tag}")
-  sh("git push")
-  sh("git push --tags")
-  sh("#{Gem.ruby} -S gem push pkg/#{Gemgem.gem_tag}.gem")
-end
-
-task :check do
-  ver = Gemgem.spec.version.to_s
-
-  if ENV['VERSION'].nil?
-    puts("\x1b[35mExpected "                                        \
-         "\x1b[33mVERSION\x1b[35m=\x1b[33m#{ver}\x1b[m")
-    exit(1)
-
-  elsif ENV['VERSION'] != ver
-    puts("\x1b[35mExpected \x1b[33mVERSION\x1b[35m=\x1b[33m#{ver} " \
-         "\x1b[35mbut got\n         "                               \
-         "\x1b[33mVERSION\x1b[35m=\x1b[33m#{ENV['VERSION']}\x1b[m")
-    exit(2)
-  end
-end
-
-end # of gem namespace
-
-desc 'Run tests in memory'
-task :test do
-  require 'bacon'
-  Bacon.extend(Bacon::TestUnitOutput)
-  Bacon.summary_on_exit
-  $LOAD_PATH.unshift('lib')
-  Dir['./test/**/test_*.rb'].each{ |file| require file[0..-4] }
-end
-
-desc 'Run tests with shell'
-task 'test:shell', :RUBY_OPTS do |t, args|
-  files = Dir['test/**/test_*.rb'].join(' ')
-
-  cmd = [Gem.ruby, args[:RUBY_OPTS],
-         '-I', 'lib', '-S', 'bacon', '--quiet', files]
-
-  sh(cmd.compact.join(' '))
-end
-
-desc 'Generate ann markdown'
-task 'ann:md' => ['gem:spec'] do
-  puts Gemgem.ann_md
-end
-
-desc 'Generate ann html'
-task 'ann:html' => ['gem:spec'] do
-  puts Gemgem.ann_html
-end
-
-desc 'Generate ann email'
-task 'ann:email' => ['gem:spec'] do
-  puts Gemgem.ann_email
-end
-
-desc 'Generate rdoc'
-task :doc => ['gem:spec'] do
-  sh("yardoc -o rdoc --main README.md" \
-     " --files #{Gemgem.spec.extra_rdoc_files.join(',')}")
-end
-
-desc 'Remove ignored files'
-task :clean => ['gem:spec'] do
-  trash = "~/.Trash/#{Gemgem.spec.name}/"
-  sh "mkdir -p #{trash}" unless File.exist?(File.expand_path(trash))
-  Gemgem.ignored_files.each{ |file| sh "mv #{file} #{trash}" }
-end
-
-task :default do
-  puts `#{Gem.ruby} -S #{$PROGRAM_NAME} -T`
-end