rest-more 0.8.0 → 1.0.0

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

@@ -0,0 +1,104 @@
+
+require 'rest-core'
+
+# https://www.dropbox.com/developers/reference/api
+RestCore::Dropbox = RestCore::Builder.client(:root) do
+  s = self.class # this is only for ruby 1.8!
+  use s::Timeout       , 10
+
+  use s::DefaultSite   , 'https://api.dropbox.com/'
+  use s::DefaultHeaders, {'Accept'       => 'application/json',
+                          'Content-Type' => 'application/octet-stream'}
+
+  use s::Oauth1Header  ,
+    '1/oauth/request_token', '1/oauth/access_token',
+    'https://www.dropbox.com/1/oauth/authorize'
+
+  use s::CommonLogger  , nil
+  use s::Cache         , nil, 600 do
+    use s::ErrorHandler, lambda{ |env|
+      if env[s::ASYNC]
+        if env[s::RESPONSE_BODY].kind_of?(::Exception)
+          env
+        else
+          env.merge(s::RESPONSE_BODY => ::RestCore::Dropbox::Error.call(env))
+        end
+      else
+        raise ::RestCore::Dropbox::Error.call(env)
+      end}
+    use s::ErrorDetectorHttp
+    use s::JsonDecode  , true
+  end
+end
+
+class RestCore::Dropbox::Error < RestCore::Error
+  include RestCore
+  class ServerError         < Dropbox::Error; end
+
+  class BadRequest          < Dropbox::Error; end
+  class Unauthorized        < Dropbox::Error; end
+  class Forbidden           < Dropbox::Error; end
+  class NotFound            < Dropbox::Error; end
+  class MethodNotAllowed    < Dropbox::Error; end
+
+  # a 5xx error which is not a server error
+  class OverStorageQuota    < Dropbox::Error; end
+
+  class ServiceUnavailable  < Dropbox::Error::ServerError; end
+
+  attr_reader :error, :code, :url
+  def initialize error, code, url=''
+    @error, @code, @url = error, code, url
+    super("[#{code}] #{error.inspect} from #{url}")
+  end
+
+  def self.call env
+    error, code, url = env[RESPONSE_BODY], env[RESPONSE_STATUS],
+                       Middleware.request_uri(env)
+    return new(error, code, url) unless error.kind_of?(Hash)
+    case code
+      when 400; BadRequest
+      when 401; Unauthorized
+      when 403; Forbidden
+      when 404; NotFound
+      when 405; MethodNotAllowed
+      when 503; ServiceUnavailable
+      when 507; OverStorageQuota
+      else    ; if code / 100 == 5
+                  Dropbox::Error::ServerError
+                else
+                  Dropbox::Error
+                end
+    end.new(error, code, url)
+  end
+end
+
+module RestCore::Dropbox::Client
+  include RestCore
+
+  def me query={}, opts={}
+    get('1/account/info', query, opts)
+  end
+
+  def default_root
+    'sandbox'
+  end
+
+  def download path, query={}, opts={}
+    get("https://api-content.dropbox.com/1/files/#{root}/#{path}",
+        query, {:json_decode => false}.merge(opts))
+  end
+
+  def upload path, file, query={}, opts={}
+    put("https://api-content.dropbox.com/1/files_put/#{root}/#{path}",
+        file, query, opts)
+  end
+
+  def ls path='', query={}, opts={}
+    get("1/metadata/#{root}/#{path}", query, opts)['contents'].
+      map{ |c| c['path'] }
+  end
+end
+
+RestCore::Dropbox.send(:include, RestCore::ClientOauth1)
+RestCore::Dropbox.send(:include, RestCore::Dropbox::Client)

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

@@ -18,7 +18,15 @@ RestCore::Facebook = RestCore::Builder.client(
   use s::CommonLogger  , nil
   use s::Cache         , nil, 600 do
     use s::ErrorHandler,  lambda{ |env|
-                            raise ::RestCore::Facebook::Error.call(env) }
+      if env[s::ASYNC]
+        if env[s::RESPONSE_BODY].kind_of?(::Exception)
+          env
+        else
+          env.merge(s::RESPONSE_BODY => ::RestCore::Facebook::Error.call(env))
+        end
+      else
+        raise ::RestCore::Facebook::Error.call(env)
+      end}
     use s::ErrorDetector, lambda{ |env|
       if env[s::RESPONSE_BODY].kind_of?(Hash)
         env[s::RESPONSE_BODY]['error'] ||
@@ -45,7 +53,7 @@ class RestCore::Facebook::Error < RestCore::Error
 
   def self.call env
     error, url = env[RESPONSE_BODY], Middleware.request_uri(env)
-    return new(env[FAIL], url) unless error.kind_of?(Hash)
+    return new(error, url) unless error.kind_of?(Hash)
     if    invalid_token?(error)
       InvalidAccessToken.new(error, url)
     elsif missing_token?(error)
@@ -91,31 +99,67 @@ module RestCore::Facebook::Client
   def authorized?        ; !!access_token                  ; end
 
   def next_page hash, opts={}, &cb
-    if hash['paging'].kind_of?(Hash) && hash['paging']['next']
-      get(hash['paging']['next'], {}, opts, &cb)
+    if hash.nil?
+      nil
+    elsif hash['paging'].kind_of?(Hash) && hash['paging']['next']
+      # FIXME: facebook is returning broken URI....
+      get(URI.encode(hash['paging']['next']), {}, opts, &cb)
+    elsif block_given?
+      yield(nil)
+      self
     else
-      yield(nil) if block_given?
+      nil
     end
   end
 
   def prev_page hash, opts={}, &cb
-    if hash['paging'].kind_of?(Hash) && hash['paging']['previous']
-      get(hash['paging']['previous'], {}, opts, &cb)
+    if hash.nil?
+      nil
+    elsif hash['paging'].kind_of?(Hash) && hash['paging']['previous']
+      # FIXME: facebook is returning broken URI....
+      get(URI.encode(hash['paging']['previous']), {}, opts, &cb)
+    elsif block_given?
+      yield(nil)
+      self
     else
-      yield(nil) if block_given?
+      nil
     end
   end
   alias_method :previous_page, :prev_page
 
   def for_pages hash, pages=1, opts={}, kind=:next_page, &cb
-    if pages > 1
-      merge_data(send(kind, hash, opts){ |result|
-        yield(result.freeze) if block_given?
-        for_pages(result, pages - 1, opts, kind, &cb) if result
-      }, hash)
+    if hash.nil?
+      nil
+    elsif pages <= 0
+      if block_given?
+        yield(nil)
+        self
+      else
+        nil
+      end
+    elsif pages == 1
+      if block_given?
+        yield(hash)
+        yield(nil)
+        self
+      else
+        hash
+      end
     else
-      yield(nil) if block_given?
-      hash
+      if block_given?
+        yield(hash)
+        send(kind, hash, opts){ |result|
+          if result.nil?
+            yield(nil)
+          else
+            for_pages(result, pages - 1, opts, kind, &cb)
+          end
+        }
+      else
+        merge_data(
+          for_pages(send(kind, hash, opts), pages - 1, opts, kind),
+          hash)
+      end
     end
   end
 

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

@@ -14,7 +14,17 @@ RestCore::Flurry = RestCore::Builder.client(:apiKey, :apiAccessCode) do
 
   use s::CommonLogger  , nil
   use s::Cache         , nil, 600 do
-    use s::ErrorHandler, lambda{|env| raise env[s::RESPONSE_BODY]['message']}
+    use s::ErrorHandler, lambda{ |env|
+      if env[s::ASYNC]
+        if env[s::RESPONSE_BODY].kind_of?(::Exception)
+          env
+        else
+          env.merge(s::RESPONSE_BODY =>
+                      RuntimeError.new(env[s::RESPONSE_BODY]['message']))
+        end
+      else
+        raise env[s::RESPONSE_BODY]['message']
+      end}
     use s::ErrorDetectorHttp
     use s::JsonDecode  , true
   end

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

@@ -12,7 +12,17 @@ RestCore::Github = RestCore::Builder.client do
 
   use s::CommonLogger  , nil
   use s::Cache         , nil, 600 do
-    use s::ErrorHandler, lambda{|env| raise env[s::RESPONSE_BODY]['message']}
+    use s::ErrorHandler, lambda{ |env|
+      if env[s::ASYNC]
+        if env[s::RESPONSE_BODY].kind_of?(::Exception)
+          env
+        else
+          env.merge(s::RESPONSE_BODY =>
+                      RuntimeError.new(env[s::RESPONSE_BODY]['message']))
+        end
+      else
+        raise env[s::RESPONSE_BODY]['message']
+      end}
     use s::ErrorDetectorHttp
     use s::JsonDecode  , true
   end

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

@@ -16,13 +16,17 @@ RestCore::Linkedin = RestCore::Builder.client do
 
   use s::CommonLogger  , nil
   use s::Cache         , nil, 600 do
-    use s::ErrorHandler, lambda{|env|
-      if (body = env[s::RESPONSE_BODY]).kind_of?(Hash)
-        raise body['message']
+    use s::ErrorHandler, lambda{ |env|
+      if env[s::ASYNC]
+        if env[s::RESPONSE_BODY].kind_of?(::Exception)
+          env
+        else
+          env.merge(s::RESPONSE_BODY =>
+                      RuntimeError.new(env[s::RESPONSE_BODY]['message']))
+        end
       else
-        raise body
-      end
-    }
+        raise env[s::RESPONSE_BODY]['message']
+      end}
     use s::ErrorDetectorHttp
     use s::JsonDecode  , true
   end

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

@@ -15,7 +15,15 @@ RestCore::Twitter = RestCore::Builder.client do
   use s::CommonLogger  , nil
   use s::Cache         , nil, 600 do
     use s::ErrorHandler, lambda{ |env|
-                           raise ::RestCore::Twitter::Error.call(env) }
+      if env[s::ASYNC]
+        if env[s::RESPONSE_BODY].kind_of?(::Exception)
+          env
+        else
+          env.merge(s::RESPONSE_BODY => ::RestCore::Twitter::Error.call(env))
+        end
+      else
+        raise ::RestCore::Twitter::Error.call(env)
+      end}
     use s::ErrorDetectorHttp
     use s::JsonDecode  , true
   end
@@ -37,16 +45,17 @@ class RestCore::Twitter::Error < RestCore::Error
   class BadGateway          < Twitter::Error::ServerError; end
   class ServiceUnavailable  < Twitter::Error::ServerError; end
 
-  attr_reader :error, :url
-  def initialize error, url=''
-    @error, @url = error, url
-    super("#{error.inspect} from #{url}")
+  attr_reader :error, :code, :url
+  def initialize error, code, url=''
+    @error, @code, @url = error, code, url
+    super("[#{code}] #{error.inspect} from #{url}")
   end
 
   def self.call env
-    error, url = env[RESPONSE_BODY], Middleware.request_uri(env)
-    return new(env[FAIL], url) unless error.kind_of?(Hash)
-    case env[RESPONSE_STATUS]
+    error, code, url = env[RESPONSE_BODY], env[RESPONSE_STATUS],
+                       Middleware.request_uri(env)
+    return new(error, code, url) unless error.kind_of?(Hash)
+    case code
       when 400; BadRequest
       when 401; Unauthorized
       when 403; Forbidden
@@ -57,7 +66,7 @@ class RestCore::Twitter::Error < RestCore::Error
       when 502; BadGateway
       when 503; ServiceUnavailable
       else    ; self
-    end.new(error, url)
+    end.new(error, code, url)
   end
 end
 

data/lib/rest-core/util/config.rb

@@ -9,6 +9,8 @@ module RestCore::Config
   DefaultModuleName = 'DefaultAttributes'
 
   def load_for_rails klass, namespace=nil, app=Rails
+    default_attributes_module(klass) # make sure the default is there
+                                     # even if there's no config file
     root = File.expand_path(app.root)
     path = ["#{root}/config/rest-core.yaml", # YAML should use .yaml
             "#{root}/config/rest-core.yml" ].find{|p| File.exist?(p)}
@@ -29,6 +31,18 @@ module RestCore::Config
     raise ArgumentError.new("#{data} is not a hash") unless
       data.kind_of?(Hash)
 
+    default_attributes_module(klass).module_eval(
+      data.inject(["extend self\n"]){ |r, (k, v)|
+        # quote strings, leave others free (e.g. false, numbers, etc)
+        r << <<-RUBY
+          def default_#{k}
+            #{v.inspect}
+          end
+        RUBY
+      }.join, __FILE__, __LINE__)
+  end
+
+  def default_attributes_module klass
     mod = if klass.const_defined?(DefaultModuleName)
             klass.const_get(DefaultModuleName)
           else
@@ -42,14 +56,6 @@ module RestCore::Config
                       end
 
     klass.send(:extend, mod) unless singleton_class < mod
-
-    mod.module_eval(data.inject(["extend self\n"]){ |r, (k, v)|
-      # quote strings, leave others free (e.g. false, numbers, etc)
-      r << <<-RUBY
-        def default_#{k}
-          #{v.kind_of?(String) ? "'#{v}'" : v}
-        end
-      RUBY
-    }.join, __FILE__, __LINE__)
+    mod
   end
 end

data/lib/rest-more.rb

@@ -5,6 +5,7 @@ module RestCore
   autoload :Config  , 'rest-core/util/config'
 
   autoload :Bing    , 'rest-core/client/bing'
+  autoload :Dropbox , 'rest-core/client/dropbox'
   autoload :Facebook, 'rest-core/client/facebook'
   autoload :Flurry  , 'rest-core/client/flurry'
   autoload :Github  , 'rest-core/client/github'

data/lib/rest-more/version.rb

@@ -1,4 +1,4 @@
 
 module RestMore
-  VERSION = '0.8.0'
+  VERSION = '1.0.0'
 end

data/rest-more.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |s|
   s.name = "rest-more"
-  s.version = "0.8.0"
+  s.version = "1.0.0"
 
   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 = "2011-11-29"
+  s.date = "2012-03-17"
   s.description = "Various REST clients such as Facebook and Twitter built with [rest-core][]\n\n[rest-core]: https://github.com/cardinalblue/rest-core"
   s.email = ["dev (XD) cardinalblue.com"]
   s.executables = ["rib-rest-core"]
@@ -23,6 +23,14 @@ Gem::Specification.new do |s|
   "Rakefile",
   "TODO.md",
   "bin/rib-rest-core",
+  "doc/ToC.md",
+  "doc/dependency.md",
+  "doc/design.md",
+  "doc/rest-graph.md",
+  "doc/tutorial/facebook.md",
+  "example/async.rb",
+  "example/facebook.rb",
+  "example/multi.rb",
   "example/rails2/Gemfile",
   "example/rails2/README",
   "example/rails2/Rakefile",
@@ -62,9 +70,12 @@ Gem::Specification.new do |s|
   "example/rails3/test/functional/application_controller_test.rb",
   "example/rails3/test/test_helper.rb",
   "example/rails3/test/unit/rails_util_test.rb",
+  "example/rainbows.rb",
+  "example/simple.rb",
   "example/sinatra/config.ru",
   "lib/rest-core/client/bing.rb",
   "lib/rest-core/client/bing/rails_util.rb",
+  "lib/rest-core/client/dropbox.rb",
   "lib/rest-core/client/facebook.rb",
   "lib/rest-core/client/facebook/rails_util.rb",
   "lib/rest-core/client/flurry.rb",
@@ -86,56 +97,58 @@ Gem::Specification.new do |s|
   "rest-more.gemspec",
   "task/.gitignore",
   "task/gemgem.rb",
-  "test/client/bing/test_api.rb",
-  "test/client/facebook/config/rest-core.yaml",
-  "test/client/facebook/test_api.rb",
-  "test/client/facebook/test_cache.rb",
-  "test/client/facebook/test_default.rb",
-  "test/client/facebook/test_error.rb",
-  "test/client/facebook/test_handler.rb",
-  "test/client/facebook/test_load_config.rb",
-  "test/client/facebook/test_misc.rb",
-  "test/client/facebook/test_oauth.rb",
-  "test/client/facebook/test_old.rb",
-  "test/client/facebook/test_page.rb",
-  "test/client/facebook/test_parse.rb",
-  "test/client/facebook/test_serialize.rb",
-  "test/client/facebook/test_timeout.rb",
-  "test/client/flurry/test_metrics.rb",
-  "test/client/mixi/test_api.rb",
-  "test/client/twitter/test_api.rb"]
+  "test/bing/test_api.rb",
+  "test/dropbox/test_api.rb",
+  "test/facebook/config/rest-core.yaml",
+  "test/facebook/test_api.rb",
+  "test/facebook/test_cache.rb",
+  "test/facebook/test_default.rb",
+  "test/facebook/test_error.rb",
+  "test/facebook/test_handler.rb",
+  "test/facebook/test_load_config.rb",
+  "test/facebook/test_misc.rb",
+  "test/facebook/test_oauth.rb",
+  "test/facebook/test_old.rb",
+  "test/facebook/test_page.rb",
+  "test/facebook/test_parse.rb",
+  "test/facebook/test_serialize.rb",
+  "test/facebook/test_timeout.rb",
+  "test/flurry/test_metrics.rb",
+  "test/mixi/test_api.rb",
+  "test/twitter/test_api.rb"]
   s.homepage = "https://github.com/cardinalblue/rest-more"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.11"
+  s.rubygems_version = "1.8.19"
   s.summary = "Various REST clients such as Facebook and Twitter built with [rest-core][]"
   s.test_files = [
-  "test/client/bing/test_api.rb",
-  "test/client/facebook/test_api.rb",
-  "test/client/facebook/test_cache.rb",
-  "test/client/facebook/test_default.rb",
-  "test/client/facebook/test_error.rb",
-  "test/client/facebook/test_handler.rb",
-  "test/client/facebook/test_load_config.rb",
-  "test/client/facebook/test_misc.rb",
-  "test/client/facebook/test_oauth.rb",
-  "test/client/facebook/test_old.rb",
-  "test/client/facebook/test_page.rb",
-  "test/client/facebook/test_parse.rb",
-  "test/client/facebook/test_serialize.rb",
-  "test/client/facebook/test_timeout.rb",
-  "test/client/flurry/test_metrics.rb",
-  "test/client/mixi/test_api.rb",
-  "test/client/twitter/test_api.rb"]
+  "test/bing/test_api.rb",
+  "test/dropbox/test_api.rb",
+  "test/facebook/test_api.rb",
+  "test/facebook/test_cache.rb",
+  "test/facebook/test_default.rb",
+  "test/facebook/test_error.rb",
+  "test/facebook/test_handler.rb",
+  "test/facebook/test_load_config.rb",
+  "test/facebook/test_misc.rb",
+  "test/facebook/test_oauth.rb",
+  "test/facebook/test_old.rb",
+  "test/facebook/test_page.rb",
+  "test/facebook/test_parse.rb",
+  "test/facebook/test_serialize.rb",
+  "test/facebook/test_timeout.rb",
+  "test/flurry/test_metrics.rb",
+  "test/mixi/test_api.rb",
+  "test/twitter/test_api.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rest-core>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-core>, [">= 1.0.0"])
     else
-      s.add_dependency(%q<rest-core>, [">= 0"])
+      s.add_dependency(%q<rest-core>, [">= 1.0.0"])
     end
   else
-    s.add_dependency(%q<rest-core>, [">= 0"])
+    s.add_dependency(%q<rest-core>, [">= 1.0.0"])
   end
 end