rest-more 0.7.1 → 0.7.2

data/.travis.yml

@@ -9,5 +9,6 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - rbx
+  - rbx-18mode
+  - rbx-19mode
   - jruby

data/CHANGES.md

@@ -1,5 +1,25 @@
 # CHANGES
 
+## rest-more 0.7.2 -- 2011-11-05
+
+### Incompatible changes
+
+* [Flurry] renamed `api_key` to `apiKey` to better match the original name
+  from flurry. Also renamed `access_code` to `apiAccessCode`.
+* [Facebook::RailsUtil] Some `module_function`s are changed to controller's
+  private methods. You aren't using it if you don't know what does this mean.
+
+### Enhancement
+
+* Added `rib-rest-core` command line tool, extracted from rest-core.
+* [RailsUtilUtil] Introduced this to ease the pain writing RailsUtil for
+  various clients.
+* [Bing] Added Bing client and its RailsUtil.
+* [Github] Added RailsUtil for Github client.
+* [Linkedin] Added RailsUtil for Linkedin client.
+* [Mixi] Added RailsUtil for Mixi client.
+* [Twitter] Added RailsUtil for Twitter client.
+
 ## rest-more 0.7.1 -- 2011-10-31
 
 ### Bugs fixes

data/Gemfile

@@ -1,7 +1,11 @@
 
 source 'http://rubygems.org'
 
-gemspec
+# this is for travis-ci
+gem 'rest-core', :path => 'rest-core' if
+  File.exist?("#{File.dirname(File.expand_path(__FILE__))}/rest-core/Gemfile")
+gem 'rest-client'
+gem 'rest-more', :path => '.'
 
 gem 'rake'
 gem 'bacon'

data/README.md

@@ -48,6 +48,32 @@ See [example][] for more complex examples.
 
 [example]: https://github.com/cardinalblue/rest-more/tree/master/example
 
+## List of supported clients:
+
+* Bing
+* Facebook
+* Flurry
+* Github
+* Linkedin
+* Mixi
+* Twitter
+
+## A simple interactive shell with [rib][]:
+
+You need to install [rib][] in order to try this interactive shell:
+
+    gem install rib
+
+Then you can try this by running `rib rest-core`:
+
+    rest-core>> self.site = 'https://api.github.com/users/'
+    rest-core>> self.json_decode = true
+    rest-core>> get 'cardinalblue'
+
+Which is using `RestCore::Universal` for accessing arbitrary websites.
+
+[rib]: https://github.com/godfat/rib
+
 ## rest-more users:
 
 * [s2sync](https://github.com/brucehsu/s2sync)

data/bin/rib-rest-core

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'rib/runner'
+  # create the shell before app to prvent your bundler (if any) kicks in
+  Rib.shell
+  # we need to require anything before loading the app,
+  # and both `rib auto` (true) and `rib-auto` (nil) should work
+  require 'rib/core' if Rib.config.delete(:mimic_irb) != false
+  require 'rib/app/rest-core'
+  # load the app
+  Rib::RestCore.load
+  Rib::Runner.run(ARGV)
+rescue LoadError => e
+  abort("Error: #{e}\n"                                        \
+        "Please install rib to use interactive rest-core:\n\n" \
+        "    gem install rib\n\n"                              \
+        "Or add rib or rest-core to Gemfile if that's the case")
+end
+
+__END__
+Run as interactive rest-core client

data/example/rails2/Gemfile

@@ -4,6 +4,7 @@ source 'http://rubygems.org'
 gem 'rails', '2.3.14'
 
 gem 'rest-client' # for rest-core
+gem 'rest-core', :path => '../../rest-core'
 gem 'rest-more', :path => '../../'
 
 group 'test' do

data/example/rails2/app/views/application/helper.html.erb

@@ -1,2 +1,2 @@
 <%= rc_facebook.app_id  %>
-<%= rc_flurry  .api_key %>
+<%= rc_flurry  .apiKey %>

data/example/rails2/config/environment.rb

@@ -3,6 +3,16 @@
 # Specifies gem version of Rails to use when vendor/rails is not present
 RAILS_GEM_VERSION = '2.3.14' unless defined? RAILS_GEM_VERSION
 
+# monkey patch from https://github.com/rails/rails/pull/3473
+class MissingSourceFile < LoadError #:nodoc:
+  REGEXPS = [
+    [/^no such file to load -- (.+)$/i, 1],
+    [/^Missing \w+ (file\s*)?([^\s]+.rb)$/i, 2],
+    [/^Missing API definition file in (.+)$/i, 1],
+    [/^cannot load such file -- (.+)$/i, 1]
+  ]
+end
+
 # Bootstrap the Rails environment, frameworks, and default configuration
 require File.join(File.dirname(__FILE__), 'boot')
 

data/example/rails2/config/rest-core.yaml

@@ -6,8 +6,8 @@ development: &default
     canvas: 'can'
 
   flurry:
-    api_key: 'key'
-    access_code: 'code'
+    apiKey: 'key'
+    apiAccessCode: 'code'
 
 production:
   *default

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

@@ -145,7 +145,7 @@ class ApplicationControllerTest < ActionController::TestCase
     stub_request(:get, 'https://graph.facebook.com/me?access_token=wozilla').
       to_return(:body => '["fireball"]')
 
-    @request.session[RestCore::Facebook::RailsUtil.rc_facebook_storage_key] =
+    @request.session[@controller.send(:rc_facebook_storage_key)] =
       RestCore::Facebook.new(:access_token => 'wozilla').fbs
 
     get(:session_)
@@ -158,7 +158,7 @@ class ApplicationControllerTest < ActionController::TestCase
     stub_request(:get, 'https://graph.facebook.com/me?access_token=blizzard').
       to_return(:body => '["yeti"]')
 
-    @request.cookies[RestCore::Facebook::RailsUtil.rc_facebook_storage_key] =
+    @request.cookies[@controller.send(:rc_facebook_storage_key)] =
       RestCore::Facebook.new(:access_token => 'blizzard').fbs
 
     get(:cookies_)
@@ -182,7 +182,7 @@ class ApplicationControllerTest < ActionController::TestCase
     get(:helper)
     assert_response :success
     assert_equal "#{RestCore::Facebook.default_app_id}\n" \
-                 "#{RestCore::Flurry  .default_api_key}",
+                 "#{RestCore::Flurry  .default_apiKey}",
       @response.body.strip
   end
 

data/example/rails2/test/unit/rails_util_test.rb

@@ -6,8 +6,13 @@ class RailsUtilTest < ActiveSupport::TestCase
   include RR::Adapters::TestUnit
 
   def setup_mock url
-    mock(RestCore::Facebook::RailsUtil).rc_facebook_in_canvas?{ false }
-    mock(RestCore::Facebook::RailsUtil).request{
+    @controller = Class.new do
+      def self.helper      dummy   ; end
+      def self.rescue_from dummy, _; end
+      include RestCore::Facebook::RailsUtil
+    end.new
+    mock(@controller).rc_facebook_in_canvas?{ false }
+    mock(@controller).request{
       mock(Object.new).url{ url }
     }
   end
@@ -15,30 +20,30 @@ class RailsUtilTest < ActiveSupport::TestCase
   def test_rest_graph_normalized_request_uri_0
     setup_mock(  'http://test.com/?code=123&lang=en')
     assert_equal('http://test.com/?lang=en',
-      RestCore::Facebook::RailsUtil.rc_facebook_normalized_request_uri)
+      @controller.send(:rc_facebook_normalized_request_uri))
   end
 
   def test_rest_graph_normalized_request_uri_1
     setup_mock(  'http://test.com/?lang=en&code=123')
     assert_equal('http://test.com/?lang=en',
-      RestCore::Facebook::RailsUtil.rc_facebook_normalized_request_uri)
+      @controller.send(:rc_facebook_normalized_request_uri))
   end
 
   def test_rest_graph_normalized_request_uri_2
     setup_mock(  'http://test.com/?session=abc&lang=en&code=123')
     assert_equal('http://test.com/?lang=en',
-      RestCore::Facebook::RailsUtil.rc_facebook_normalized_request_uri)
+      @controller.send(:rc_facebook_normalized_request_uri))
   end
 
   def test_rest_graph_normalized_request_uri_3
     setup_mock(  'http://test.com/?code=123')
     assert_equal('http://test.com/',
-      RestCore::Facebook::RailsUtil.rc_facebook_normalized_request_uri)
+      @controller.send(:rc_facebook_normalized_request_uri))
   end
 
   def test_rest_graph_normalized_request_uri_4
     setup_mock(  'http://test.com/?signed_request=abc&code=123')
     assert_equal('http://test.com/',
-      RestCore::Facebook::RailsUtil.rc_facebook_normalized_request_uri)
+      @controller.send(:rc_facebook_normalized_request_uri))
   end
 end

data/example/rails3/Gemfile

@@ -4,6 +4,7 @@ source 'http://rubygems.org'
 gem 'rails', '3.0.9'
 
 gem 'rest-client' # for rest-core
+gem 'rest-core', :path => '../../rest-core'
 gem 'rest-more', :path => '../../'
 
 group 'test' do

data/example/rails3/app/views/application/helper.html.erb

@@ -1,2 +1,2 @@
 <%= rc_facebook.app_id  %>
-<%= rc_flurry  .api_key %>
+<%= rc_flurry  .apiKey %>

data/example/rails3/config/rest-core.yaml

@@ -6,8 +6,8 @@ development: &default
     canvas: 'can'
 
   flurry:
-    api_key: 'key'
-    access_code: 'code'
+    apiKey: 'key'
+    apiAccessCode: 'code'
 
 production:
   *default

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

@@ -145,7 +145,7 @@ class ApplicationControllerTest < ActionController::TestCase
     stub_request(:get, 'https://graph.facebook.com/me?access_token=wozilla').
       to_return(:body => '["fireball"]')
 
-    @request.session[RestCore::Facebook::RailsUtil.rc_facebook_storage_key] =
+    @request.session[@controller.send(:rc_facebook_storage_key)] =
       RestCore::Facebook.new(:access_token => 'wozilla').fbs
 
     get(:session_)
@@ -158,7 +158,7 @@ class ApplicationControllerTest < ActionController::TestCase
     stub_request(:get, 'https://graph.facebook.com/me?access_token=blizzard').
       to_return(:body => '["yeti"]')
 
-    @request.cookies[RestCore::Facebook::RailsUtil.rc_facebook_storage_key] =
+    @request.cookies[@controller.send(:rc_facebook_storage_key)] =
       RestCore::Facebook.new(:access_token => 'blizzard').fbs
 
     get(:cookies_)
@@ -182,7 +182,7 @@ class ApplicationControllerTest < ActionController::TestCase
     get(:helper)
     assert_response :success
     assert_equal "#{RestCore::Facebook.default_app_id}\n" \
-                 "#{RestCore::Flurry  .default_api_key}",
+                 "#{RestCore::Flurry  .default_apiKey}",
       @response.body.strip
   end
 

data/example/rails3/test/unit/rails_util_test.rb

@@ -6,8 +6,13 @@ class RailsUtilTest < ActiveSupport::TestCase
   include RR::Adapters::TestUnit
 
   def setup_mock url
-    mock(RestCore::Facebook::RailsUtil).rc_facebook_in_canvas?{ false }
-    mock(RestCore::Facebook::RailsUtil).request{
+    @controller = Class.new do
+      def self.helper      dummy   ; end
+      def self.rescue_from dummy, _; end
+      include RestCore::Facebook::RailsUtil
+    end.new
+    mock(@controller).rc_facebook_in_canvas?{ false }
+    mock(@controller).request{
       mock(Object.new).url{ url }
     }
   end
@@ -15,30 +20,30 @@ class RailsUtilTest < ActiveSupport::TestCase
   def test_rest_graph_normalized_request_uri_0
     setup_mock(  'http://test.com/?code=123&lang=en')
     assert_equal('http://test.com/?lang=en',
-      RestCore::Facebook::RailsUtil.rc_facebook_normalized_request_uri)
+      @controller.send(:rc_facebook_normalized_request_uri))
   end
 
   def test_rest_graph_normalized_request_uri_1
     setup_mock(  'http://test.com/?lang=en&code=123')
     assert_equal('http://test.com/?lang=en',
-      RestCore::Facebook::RailsUtil.rc_facebook_normalized_request_uri)
+      @controller.send(:rc_facebook_normalized_request_uri))
   end
 
   def test_rest_graph_normalized_request_uri_2
     setup_mock(  'http://test.com/?session=abc&lang=en&code=123')
     assert_equal('http://test.com/?lang=en',
-      RestCore::Facebook::RailsUtil.rc_facebook_normalized_request_uri)
+      @controller.send(:rc_facebook_normalized_request_uri))
   end
 
   def test_rest_graph_normalized_request_uri_3
     setup_mock(  'http://test.com/?code=123')
     assert_equal('http://test.com/',
-      RestCore::Facebook::RailsUtil.rc_facebook_normalized_request_uri)
+      @controller.send(:rc_facebook_normalized_request_uri))
   end
 
   def test_rest_graph_normalized_request_uri_4
     setup_mock(  'http://test.com/?signed_request=abc&code=123')
     assert_equal('http://test.com/',
-      RestCore::Facebook::RailsUtil.rc_facebook_normalized_request_uri)
+      @controller.send(:rc_facebook_normalized_request_uri))
   end
 end

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

@@ -0,0 +1,92 @@
+
+require 'rest-core'
+
+RestCore::Bing = RestCore::Builder.client(:AppId) do
+  s = self.class # this is only for ruby 1.8!
+  use s::Timeout       , 10
+
+  use s::DefaultSite   , 'http://api.bing.net/json.aspx'
+  use s::DefaultHeaders, {'Accept' => 'application/json'}
+  use s::DefaultQuery  , {}
+
+  use s::CommonLogger  , nil
+  use s::Cache         , nil, 600 do
+    use s::ErrorHandler,  lambda{ |env|
+                            raise ::RestCore::Bing::Error.call(env) }
+    use s::ErrorDetector, lambda{ |env|
+      if        env[s::RESPONSE_BODY].kind_of?(Hash) &&
+         (res = env[s::RESPONSE_BODY]['SearchResponse']).kind_of?(Hash)
+          res['Errors']
+      end}
+    use s::JsonDecode  , true
+  end
+end
+
+module RestCore::Bing::Client
+  def query
+    {'AppId'    => self.AppId,
+     'JsonType' => 'raw'     ,
+     'Version'  => '2.2'     }
+  end
+
+  def search_image term, query={}, opts={}
+    get('', {:Query => term, :Sources => 'Image'}.merge(query), opts)[
+      'SearchResponse']['Image']['Results'] || []
+  end
+
+  def search_image_urls term, query={}, opts={}
+    search_image(term, query, opts).map{ |i| i['MediaUrl'] }
+  end
+end
+
+class RestCore::Bing::Error < RestCore::Error
+  include RestCore
+  class MissingParameter              < Bing::Error; end
+  class InvalidParameter              < Bing::Error; end
+  class QueryTooLong                  < Bing::Error; end
+  class AppIdNotFunctioning           < Bing::Error; end
+  class ExceededLimit                 < Bing::Error; end
+  class NoAccess                      < Bing::Error; end
+  class ResultsTemporarilyUnavailable < Bing::Error; end
+  class ServiceTemporarilyUnavailable < Bing::Error; end
+  class SourceTypeError               < Bing::Error; end
+
+  attr_reader :error, :url
+  def initialize error, url=''
+    @error, @url = error, url
+    super("#{error.inspect} from #{url}")
+  end
+
+  def self.call env
+    error, url = env[RESPONSE_BODY], Middleware.request_uri(env)
+    code       = extract_error_code(error)
+
+    return new(env[FAIL], url) unless code
+
+    case code
+    when 1001; MissingParameter
+    when 1002; InvalidParameter
+    when 1005; QueryTooLong
+    when 2001; AppIdNotFunctioning
+    when 2002; ExceededLimit
+    when 2003; NoAccess
+    when 3001; ResultsTemporarilyUnavailable
+    when 3002; ServiceTemporarilyUnavailable
+    when 4001; SourceTypeError
+    end.new(error, url)
+  end
+
+  def self.extract_error_code error
+    code    = error.kind_of?(Hash)                     &&
+     (error = error['SearchResponse']).kind_of?(Hash)  &&
+     (error = error['Errors']        ).kind_of?(Array) &&
+     (error = error[0]               ).kind_of?(Hash)  &&
+     (error = error['Code']          )
+
+    code && code.to_i
+  end
+end
+
+RestCore::Bing.send(:include, RestCore::Bing::Client)
+require 'rest-core/client/bing/rails_util' if
+  Object.const_defined?(:Rails)

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

@@ -0,0 +1,13 @@
+
+require 'rest-core/util/rails_util_util'
+
+module RestCore::Bing::DefaultAttributes
+  def default_log_method; Rails.logger.method(:debug); end
+  def default_cache     ; Rails.cache                ; end
+end
+
+module RestCore::Bing::RailsUtil
+  include RestCore::RailsUtilUtil
+end
+
+RestCore::Bing::RailsUtil.init(Rails)

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

@@ -132,7 +132,7 @@ module RestCore::Facebook::Client
   def parse_fbs! fbs
     self.data = check_sig_and_return_data(
       # take out facebook sometimes there but sometimes not quotes in cookies
-      Vendor.parse_query(fbs.to_s.sub(/^"/, '').sub(/"$/, '')))
+      ParseQuery.parse_query(fbs.to_s.sub(/^"/, '').sub(/"$/, '')))
   end
 
   def parse_fbsr! fbsr
@@ -180,7 +180,7 @@ module RestCore::Facebook::Client
 
   def authorize! opts={}
     query = {:client_id => app_id, :client_secret => secret}.merge(opts)
-    self.data = Vendor.parse_query(
+    self.data = ParseQuery.parse_query(
                   get(url('oauth/access_token'), query,
                       {:json_decode => false}.merge(opts)))
   end