rest-core 0.4.0.pre.1 → 0.4.0.pre.2

data/.travis.yml

@@ -1,7 +1,7 @@
 script: 'git submodule update --init; bundle exec rake test:travis'
 
 env:
-  - 'RESTCORE=rest-graph'
+  - 'RESTCORE=rest-core'
   - 'RESTCORE=rails2'
   - 'RESTCORE=rails3'
 

data/CHANGES.md

@@ -10,6 +10,16 @@
 * [client] Now `request` method takes an env and an app to make requests,
   instead of a weird requests array.
 
+* [client] Now if you really want to disable something, for example,
+  disabling cache when the default cache is `Rails.cache`, you'll need to
+  pass `false` instead of `nil`. This is because `nil` stands for using
+  defaults in rest-core.
+
+* [client] Defaults priorities are changed to:
+  per-request > instance variable > class defaults > middleware defaults
+  See *test_client.rb* for more detailed definition. If you don't understand
+  this, don't worry, since then this won't affect you.
+
 ### Compatible changes:
 
 * [client] Introduced a new method `request_full` which is exactly the same
@@ -36,6 +46,7 @@
 * [wrapped] Fixed a bug that force middlewares to implement `members` method,
   which should be optional. Thanks miaout17
 
+* [facebook][rails_util] Now default cache is `Rails.cache` instead of nil
 * [simple]   Added a Simple client, which only wraps RestClient
 * [univeral] Added an Universal client, which could be used for anything
 * [flurry]   Added a Flurry client, along with its `Flurry::RailsUtil`
@@ -46,6 +57,7 @@
   in header instead of in query string.
 * [common_logger] nil object would no longer be logged
 * [json_decode] Do nothing if we are being asked for env (dry mode)
+* [cache] Now default `:expires_in` is 600 down from 3600
 * [middleware] Now not only query values would be escaped, but also keys.
 
 * [rib-rest-core] Introduced an interactive shell. You'll need [rib][] to

data/TODO.md

@@ -3,7 +3,6 @@
 ## high
 
 * middleware revisit (how to initialize?)
-* what does false and nil mean in env?
 
 ## medium
 

data/example/rails2/app/controllers/application_controller.rb

@@ -50,10 +50,8 @@ class ApplicationController < ActionController::Base
   end
 
   def reinitialize
-    cache_nil = rc_facebook.cache
     rc_facebook_setup(:cache => {'a' => 'b'})
-    cache     = rc_facebook.cache
-    render :text => YAML.dump([cache_nil, cache])
+    render :text => YAML.dump(rc_facebook.cache)
   end
 
   def helper; end
@@ -62,6 +60,12 @@ class ApplicationController < ActionController::Base
     render :text => Timeout::Error.name
   end
 
+  def defaults
+    rc_facebook_setup
+    render :text => (rc_facebook.cache               == Rails.cache &&
+                     rc_facebook.log_method.receiver == Rails.logger)
+  end
+
   private
   def filter_common
     rc_facebook_setup(:auto_authorize => true, :canvas => '')

data/example/rails2/test/functional/application_controller_test.rb

@@ -172,7 +172,7 @@ class ApplicationControllerTest < ActionController::TestCase
   def test_reinitailize
     get(:reinitialize)
     assert_response :success
-    assert_equal [nil, {'a' => 'b'}], YAML.load(@response.body)
+    assert_equal({'a' => 'b'}, YAML.load(@response.body))
   end
 
   def test_helper
@@ -188,4 +188,10 @@ class ApplicationControllerTest < ActionController::TestCase
     assert_response :success
     assert_equal 'Timeout::Error', @response.body.strip
   end
+
+  def test_defaults
+    get(:defaults)
+    assert_response :success
+    assert_equal 'true', @response.body.strip
+  end
 end

data/example/rails3/app/controllers/application_controller.rb

@@ -50,10 +50,8 @@ class ApplicationController < ActionController::Base
   end
 
   def reinitialize
-    cache_nil = rc_facebook.cache
     rc_facebook_setup(:cache => {'a' => 'b'})
-    cache     = rc_facebook.cache
-    render :text => YAML.dump([cache_nil, cache])
+    render :text => YAML.dump(rc_facebook.cache)
   end
 
   def helper; end
@@ -62,6 +60,12 @@ class ApplicationController < ActionController::Base
     render :text => Timeout::Error.name
   end
 
+  def defaults
+    rc_facebook_setup
+    render :text => (rc_facebook.cache               == Rails.cache &&
+                     rc_facebook.log_method.receiver == Rails.logger)
+  end
+
   private
   def filter_common
     rc_facebook_setup(:auto_authorize => true, :canvas => '')

data/example/rails3/test/functional/application_controller_test.rb

@@ -172,7 +172,7 @@ class ApplicationControllerTest < ActionController::TestCase
   def test_reinitailize
     get(:reinitialize)
     assert_response :success
-    assert_equal [nil, {'a' => 'b'}], YAML.load(@response.body)
+    assert_equal({'a' => 'b'}, YAML.load(@response.body))
   end
 
   def test_helper
@@ -188,4 +188,10 @@ class ApplicationControllerTest < ActionController::TestCase
     assert_response :success
     assert_equal 'Timeout::Error', @response.body.strip
   end
+
+  def test_defaults
+    get(:defaults)
+    assert_response :success
+    assert_equal 'true', @response.body.strip
+  end
 end

data/lib/rest-core/client/facebook/rails_util.rb

@@ -5,16 +5,18 @@ require 'cgi'
 require 'uri'
 
 module RestCore::Facebook::DefaultAttributes
-  def default_canvas                ; ''   ; end
-  def default_iframe                ; false; end
-  def default_auto_authorize        ; false; end
-  def default_auto_authorize_options; {}   ; end
-  def default_auto_authorize_scope  ; ''   ; end
-  def default_ensure_authorized     ; false; end
-  def default_write_session         ; false; end
-  def default_write_cookies         ; false; end
-  def default_write_handler         ;   nil; end
-  def default_check_handler         ;   nil; end
+  def default_log_method            ; Rails.logger.method(:debug); end
+  def default_cache                 ; Rails.cache                ; end
+  def default_canvas                ; ''                         ; end
+  def default_iframe                ; false                      ; end
+  def default_auto_authorize        ; false                      ; end
+  def default_auto_authorize_options; {}                         ; end
+  def default_auto_authorize_scope  ; ''                         ; end
+  def default_ensure_authorized     ; false                      ; end
+  def default_write_session         ; false                      ; end
+  def default_write_cookies         ; false                      ; end
+  def default_write_handler         ;   nil                      ; end
+  def default_check_handler         ;   nil                      ; end
 end
 
 module RestCore::Facebook::RailsUtil
@@ -160,7 +162,7 @@ module RestCore::Facebook::RailsUtil
   end
 
   def rc_facebook_options_new
-    @rc_facebook_options_new ||= {:log_method => logger.method(:debug)}
+    @rc_facebook_options_new ||= {}
   end
   # ==================== end options utility =======================
 

data/lib/rest-core/client/facebook.rb

@@ -14,7 +14,7 @@ RestCore::Facebook = RestCore::Builder.client(
   use s::Oauth2Query   , nil
 
   use s::CommonLogger  , nil
-  use s::Cache         , nil, 3600 do
+  use s::Cache         , nil, 600 do
     use s::ErrorHandler,  lambda{ |env|
                             raise ::RestCore::Facebook::Error.call(env) }
     use s::ErrorDetector, lambda{ |env|

data/lib/rest-core/client/flurry/rails_util.rb

@@ -2,8 +2,10 @@
 require 'rest-core/util/rails_util_util'
 
 module RestCore::Flurry::DefaultAttributes
-  def default_api_key    ; nil; end
-  def default_access_code; nil; end
+  def default_log_method ; Rails.logger.method(:debug); end
+  def default_cache      ; Rails.cache                ; end
+  def default_api_key    ; nil                        ; end
+  def default_access_code; nil                        ; end
 end
 
 module RestCore::Flurry::RailsUtil
@@ -64,7 +66,7 @@ module RestCore::Flurry::RailsUtil
   end
 
   def rc_flurry_options_new
-    @rc_flurry_options_new ||= {:log_method => logger.method(:debug)}
+    @rc_flurry_options_new ||= {}
   end
   # ==================== end options utility =======================
 end

data/lib/rest-core/client/flurry.rb

@@ -5,19 +5,18 @@ require 'time' # for Time.parse
 
 RestCore::Flurry = RestCore::Builder.client(:api_key, :access_code) do
   s = self.class # this is only for ruby 1.8!
+  use s::Timeout       , 10
 
   use s::DefaultSite   , 'http://api.flurry.com/'
   use s::DefaultHeaders, {'Accept' => 'application/json'}
   use s::DefaultQuery  , {}
 
   use s::CommonLogger  , nil
-  use s::Cache         , {}, 3600 do
+  use s::Cache         , nil, 600 do
     use s::ErrorHandler, lambda{|env| raise env[s::RESPONSE_BODY]['message']}
     use s::ErrorDetectorHttp
     use s::JsonDecode  , true
   end
-
-  run s::RestClient
 end
 
 module RestCore::Flurry::Client
@@ -68,9 +67,9 @@ module RestCore::Flurry::Client
   # >> f.weekly(f.metrics('ActiveUsers', {}, :weeks => 4))
   # => [244548, 270227, 248513, 257149]
   def weekly array
-    start = Time.parse(array.first.first).to_i
+    start = Time.parse(array.first.first, nil).to_i
     array.group_by{ |(date, value)|
-      current = Time.parse(date).to_i
+      current = Time.parse(date, nil).to_i
       - (current - start) / (86400*7)
     # calling .last to discard week numbers created by group_by
     }.sort.map(&:last).map{ |week|
@@ -81,7 +80,7 @@ module RestCore::Flurry::Client
   # => [1020437, 775889, 505662, 257149]
   def sum array
     reverse = array.reverse
-    reverse.map.with_index{ |_, index|
+    (0...reverse.size).map{ |index|
       reverse[1, index].inject(reverse.first, &:+)
     }.reverse
   end

data/lib/rest-core/client/github.rb

@@ -10,7 +10,7 @@ RestCore::Github = RestCore::Builder.client do
   use s::Oauth2Query   , 'access_token', nil
 
   use s::CommonLogger  , nil
-  use s::Cache         , nil, 3600 do
+  use s::Cache         , nil, 600 do
     use s::ErrorHandler, lambda{|env| raise env[s::RESPONSE_BODY]['message']}
     use s::ErrorDetectorHttp
     use s::JsonDecode  , true

data/lib/rest-core/client/linkedin.rb

@@ -14,7 +14,7 @@ RestCore::Linkedin = RestCore::Builder.client(:data) do
     'https://www.linkedin.com/uas/oauth/authorize'
 
   use s::CommonLogger  , nil
-  use s::Cache         , nil, 3600 do
+  use s::Cache         , nil, 600 do
     use s::ErrorHandler, lambda{|env|
       if (body = env[s::RESPONSE_BODY]).kind_of?(Hash)
         raise body['message']

data/lib/rest-core/client/mixi.rb

@@ -10,7 +10,7 @@ RestCore::Mixi = RestCore::Builder.client(
   use s::Oauth2Header  , nil
 
   use s::CommonLogger  , nil
-  use s::Cache         , nil, 3600 do
+  use s::Cache         , nil, 600 do
     use s::ErrorHandler  , lambda{ |env| p env }
     use s::ErrorDetectorHttp
     use s::JsonDecode    , true

data/lib/rest-core/client/twitter.rb

@@ -12,7 +12,7 @@ RestCore::Twitter = RestCore::Builder.client(:data) do
     'oauth/request_token', 'oauth/access_token', 'oauth/authorize'
 
   use s::CommonLogger  , nil
-  use s::Cache         , nil, 3600 do
+  use s::Cache         , nil, 600 do
     use s::ErrorHandler, lambda{ |env|
                            raise ::RestCore::Twitter::Error.call(env) }
     use s::ErrorDetectorHttp

data/lib/rest-core/client/universal.rb

@@ -8,7 +8,7 @@ RestCore::Universal = RestCore::Builder.client(:data) do
   use s::DefaultQuery  , {}
 
   use s::CommonLogger  , method(:puts)
-  use s::Cache         , {}, 3600 do
+  use s::Cache         , {}, 600 do
     use s::ErrorHandler, nil
     use s::ErrorDetectorHttp
     use s::JsonDecode  , false

data/lib/rest-core/client.rb

@@ -19,15 +19,15 @@ module RestCore::Client
         end
 
         def default_#{name} app=app
-          if app.respond_to?(:#{name})      # instance value
-            app.#{name}({})
-          elsif app.respond_to?(:wrapped)   # wrapper value
-            default_#{name}(app.wrapped) || # walk into it
-            default_#{name}(app.app)
-          elsif app.respond_to?(:app)       # walk into next app
-            default_#{name}(app.app)
-          elsif self.class.respond_to?("default_#{name}")
-            self.class.default_#{name}       # old class default style
+          if self.class.respond_to?("default_#{name}")
+            self.class.default_#{name}      # old class default style
+          elsif app.respond_to?(:#{name})
+            app.#{name}({})                 # middleware instance value
+          elsif app.respond_to?(:wrapped)
+            default_#{name}(app.wrapped) || # wrapper value
+            default_#{name}(app.app)        # walk into it
+          elsif app.respond_to?(:app)
+            default_#{name}(app.app)        # walk into next app
           else
             nil
           end
@@ -160,15 +160,15 @@ module RestCore::Client
       response
     end
   end
-  # ------------------------ instance ---------------------
-
 
-
-  protected
   def build_env env={}
     string_keys(attributes).merge(string_keys(env))
   end
+  # ------------------------ instance ---------------------
+
 
+
+  protected
   def string_keys hash
     hash.inject({}){ |r, (k, v)|
       if v.kind_of?(Hash)

data/lib/rest-core/version.rb

@@ -1,4 +1,4 @@
 
 module RestCore
-  VERSION = '0.4.0.pre.1'
+  VERSION = '0.4.0.pre.2'
 end

data/rest-core.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "0.4.0.pre.1"
+  s.version = "0.4.0.pre.2"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = [
   "Cardinal Blue",
   "Lin Jen-Shin (godfat)"]
-  s.date = "2011-09-19"
+  s.date = "2011-09-21"
   s.description = "A modular Ruby REST client collection/infrastructure\n\nIn this era of web services and mashups, we have seen a blooming of REST\nAPIs. One might wonder, how do we use these APIs easily and elegantly?\nSince REST is very simple compared to SOAP, it is not hard to build a\ndedicated client ourselves.\n\nWe have developed [rest-core][] with composable middlewares to build a\nREST client, based on the effort from [rest-graph][]. In the cases of\ncommon APIs such as Facebook, Github, and Twitter, developers can simply\nuse the built-in dedicated clients provided by rest-core, or do it yourself\nfor any other REST APIs.\n\n[rest-core]: http://github.com/cardinalblue/rest-core\n[rest-graph]: http://github.com/cardinalblue/rest-graph"
   s.email = ["dev (XD) cardinalblue.com"]
   s.executables = ["rib-rest-core"]

data/test/client/flurry/test_metrics.rb

@@ -13,7 +13,7 @@ describe RestCore::Flurry do
     startDate = '2011-08-23'
     endDate   = '2011-09-19'
     @flurry = RestCore::Flurry.new
-    stub(@flurry).Time.stub!.now{ Time.parse(endDate) }
+    stub(Time).now{ Time.parse(endDate, nil) }
     stub_request(:get,
       "http://api.flurry.com/appMetrics/ActiveUsers?" \
       "startDate=#{startDate}&endDate=#{endDate}").

data/test/test_client.rb

@@ -11,4 +11,36 @@ describe RestCore::Simple do
     stub_request(:get, 'http://localhost/').to_return(:body => '[]')
     RestCore::Simple.new.get('http://localhost/').should.eq '[]'
   end
+
+  should 'use defaults' do
+    client = RestCore::Builder.client do
+      s = self.class # this is only for ruby 1.8!
+      use s::Timeout, 4
+    end
+    c = client.new
+    c.timeout.should.eq 4 # default goes to middleware
+    client.extend(Module.new do
+      def default_timeout
+        3
+      end
+    end)
+    c.timeout.should.eq 4 # default is cached, so it stays the same
+    c.timeout = nil       # clear cache
+    c.timeout.should.eq 3 # now default goes to module default
+    class << client
+      def default_timeout # module defaults could be overriden
+        super - 1
+      end
+    end
+    c.timeout = nil
+    c.timeout.should.eq 2 # so it goes to class default
+    c.timeout = 1         # setup instance level value
+    c.build_env(                )['timeout'].should.eq 1 # pick instance var
+    c.build_env({'timeout' => 0})['timeout'].should.eq 0 # per-request var
+    c.timeout.should.eq 1 # won't affect underlying instance var
+    c.timeout = nil
+    c.timeout.should.eq 2 # goes back to class default
+    c.timeout = false
+    c.timeout.should.eq false # false would disable default
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest-core
 version: !ruby/object:Gem::Version
-  version: 0.4.0.pre.1
+  version: 0.4.0.pre.2
   prerelease: 6
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-19 00:00:00.000000000Z
+date: 2011-09-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2168955760 !ruby/object:Gem::Requirement
+  requirement: &2152743040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +22,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2168955760
+  version_requirements: *2152743040
 description: ! 'A modular Ruby REST client collection/infrastructure