rest-core 0.2.3 → 0.3.0.pre.0

data/.travis.yml

@@ -1,9 +1,13 @@
-script: 'git submodule update --init; bundle exec rake test'
+script: 'git submodule update --init; bundle exec rake test:travis'
+
+env:
+  - 'RESTCORE=rest-graph'
+  - 'RESTCORE=rails2'
+  - 'RESTCORE=rails3'
+
 rvm:
   - 1.8.7
   - 1.9.2
-  - ruby-head
-  - rbx
+  - 1.9.3
   - rbx-2.0
   - jruby
-  - ree

data/CHANGES.md

@@ -1,5 +1,25 @@
 # rest-core CHANGES
 
+## rest-core 0.3.0 -- ?
+
+* [facebook] RestGraph is Facebook now.
+* [facebook] Facebook::RailsUtil is imported from [rest-graph][]
+* [facebook] Use json_decode instead of auto_decode as rest-graph
+* [twitter] Fixed opts in Twitter#tweet
+* [rest-core] We no longer explicitly depends on Rack
+* [rest-core] Added a shorthand RC to access RestCore
+* [cache] All clients no longer have default hash cache
+* [oauth2_query] Now we always use the term "access_token"
+* [config] Now Config#load and Config#load_for_rails take namespace
+  e.g. rest-core.yaml:
+      development:
+        facebook:
+          app_id: 123
+        twitter:
+          consumer_key: abc
+
+[rest-graph]: https://github.com/cardinalblue/rest-graph
+
 ## rest-core 0.2.3 -- 2011-08-27
 
 * Adding rack as a runtime dependency for now.

data/Gemfile

@@ -3,6 +3,7 @@ source 'http://rubygems.org'
 
 gemspec
 
-if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
-  gem 'jruby-openssl'
-end
+gem 'rails', '2.3.14' if ENV['RESTCORE'] == 'rails2'
+gem 'rails', '3.0.9'  if ENV['RESTCORE'] == 'rails3'
+
+gem 'jruby-openssl', :platforms => [:jruby]

data/README.md

@@ -28,9 +28,8 @@ for any other REST APIs.
 
 ## REQUIREMENTS:
 
-* Tested with MRI (official ruby) 1.9.2, 1.8.7, and trunk
-* Tested with Rubinius (rbx) 1.2
-* Tested with JRuby 1.6
+* Tested with MRI (official CRuby) 1.8.7, 1.9.2, 1.9.3, Rubinius and JRuby
+* gem rest-client (for now)
 
 ## INSTALLATION:
 
@@ -67,11 +66,12 @@ See [example][] for more complex examples.
     require 'rest-core'
 
     YourClient = RestCore::Builder.client do
-      use DefaultSite , 'https://api.github.com/users/'
-      use JsonDecode  , true
-      use CommonLogger, method(:puts)
-      use Cache       , {}, 3600
-      run RestClient
+      s = self.class # this is only for ruby 1.8!
+      use s::DefaultSite , 'https://api.github.com/users/'
+      use s::JsonDecode  , true
+      use s::CommonLogger, method(:puts)
+      use s::Cache       , {}, 3600
+      run s::RestClient
     end
 
     client = YourClient.new

data/Rakefile

@@ -14,8 +14,8 @@ task 'gem:spec' do
     s.homepage    = 'https://github.com/cardinalblue/rest-core'
     # s.executables = [s.name]
 
-    %w[rest-client rack].each{ |g| s.add_runtime_dependency(g) }
-    %w[yajl-ruby json json_pure ruby-hmac
+    %w[rest-client].each{ |g| s.add_runtime_dependency(g) }
+    %w[yajl-ruby rack json json_pure ruby-hmac
        webmock bacon rr rake].each{ |g| s.add_development_dependency(g) }
 
     s.authors     = ['Cardinal Blue', 'Lin Jen-Shin (godfat)']
@@ -24,3 +24,43 @@ task 'gem:spec' do
 
   Gemgem.write
 end
+
+module Gemgem
+  module_function
+  def test_rails *rails
+    rails.each{ |framework|
+      opts = Rake.application.options
+      args = (opts.singleton_methods - [:rakelib, 'rakelib']).map{ |arg|
+               if arg.to_s !~ /=$/ && opts.send(arg)
+                 "--#{arg}"
+               else
+                 ''
+               end
+             }.join(' ')
+      Rake.sh "cd example/#{framework}; #{Gem.ruby} -S rake test #{args}"
+    }
+  end
+end
+
+desc 'Run example tests'
+task 'test:example' do
+  Gemgem.test_rails('rails3', 'rails2')
+end
+
+desc 'Run all tests'
+task 'test:all' => ['test', 'test:example']
+
+desc 'Run different json test'
+task 'test:json' do
+  %w[yajl json].each{ |json|
+    Rake.sh "#{Gem.ruby} -S rake -r #{json} test"
+  }
+end
+
+task 'test:travis' do
+  case ENV['RESTCORE']
+  when 'rails3'; Gemgem.test_rails('rails3')
+  when 'rails2'; Gemgem.test_rails('rails2')
+  else         ; Rake::Task['test'].invoke
+  end
+end

data/example/rails2/Gemfile

@@ -0,0 +1,13 @@
+
+source 'http://rubygems.org'
+
+gem 'rails', '2.3.14'
+
+gem 'rest-client' # for rest-core
+gem 'yajl-ruby'   # for rest-core
+gem 'rest-core', :path => '../../'
+
+group 'test' do
+  gem 'rr'
+  gem 'webmock'
+end

data/example/rails2/README

@@ -0,0 +1,4 @@
+
+Please fill config/rest-core.yaml with your app_id, secret, etc., to
+see if this example is working or not. The default setup is designed for
+standalone site with Facebook JavaScript SDK.

data/example/rails2/Rakefile

@@ -0,0 +1,11 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake/dsl_definition'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

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

@@ -0,0 +1,119 @@
+
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  include RestCore::Facebook::RailsUtil
+
+  before_filter :filter_common       , :only => [:index]
+  before_filter :filter_canvas       , :only => [:canvas]
+  before_filter :filter_options      , :only => [:options]
+  before_filter :filter_no_auto      , :only => [:no_auto]
+  before_filter :filter_diff_app_id  , :only => [:diff_app_id]
+  before_filter :filter_diff_canvas  , :only => [:diff_canvas]
+  before_filter :filter_iframe_canvas, :only => [:iframe_canvas]
+  before_filter :filter_cache        , :only => [:cache]
+  before_filter :filter_hanlder      , :only => [:handler_]
+  before_filter :filter_session      , :only => [:session_]
+  before_filter :filter_cookies      , :only => [:cookies_]
+
+  def index
+    render :text => rc_facebook.get('me').to_json
+  end
+  alias_method :canvas       , :index
+  alias_method :options      , :index
+  alias_method :diff_canvas  , :index
+  alias_method :iframe_canvas, :index
+  alias_method :handler_     , :index
+  alias_method :session_     , :index
+  alias_method :cookies_     , :index
+
+  def no_auto
+    rc_facebook.get('me')
+  rescue RestCore::Facebook::Error
+    render :text => 'XD'
+  end
+
+  def diff_app_id
+    render :text => rc_facebook.app_id
+  end
+
+  def cache
+    url = rc_facebook.url('cache')
+    rc_facebook.get('cache')
+    rc_facebook.get('cache')
+    render :text => Rails.cache.read(Digest::MD5.hexdigest(url))
+  end
+
+  def error
+    raise RestCore::Facebook::Error.new("don't rescue me")
+  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])
+  end
+
+  def helper; end
+
+  private
+  def filter_common
+    rc_facebook_setup(:auto_authorize => true, :canvas => '')
+  end
+
+  def filter_canvas
+    rc_facebook_setup(:canvas               => RestCore::Facebook.
+                                                 default_canvas,
+                      :auto_authorize_scope => 'publish_stream')
+  end
+
+  def filter_diff_canvas
+    rc_facebook_setup(:canvas               => 'ToT',
+                      :auto_authorize_scope => 'email')
+  end
+
+  def filter_iframe_canvas
+    rc_facebook_setup(:canvas               => 'zzz',
+                      :auto_authorize       => true)
+  end
+
+  def filter_no_auto
+    rc_facebook_setup(:auto_authorize => false)
+  end
+
+  def filter_diff_app_id
+    rc_facebook_setup(:app_id => 'zzz',
+                      :auto_authorize => true)
+  end
+
+  def filter_options
+    rc_facebook_setup(:auto_authorize_options => {:scope => 'bogus'},
+                      :canvas => nil)
+  end
+
+  def filter_cache
+    rc_facebook_setup(:cache => Rails.cache)
+  end
+
+  def filter_hanlder
+    rc_facebook_setup(:write_handler => method(:write_handler),
+                      :check_handler => method(:check_handler))
+  end
+
+  def write_handler fbs
+    Rails.cache[:fbs] = fbs
+  end
+
+  def check_handler
+    Rails.cache[:fbs]
+  end
+
+  def filter_session
+    rc_facebook_setup(:write_session => true)
+  end
+
+  def filter_cookies
+    rc_facebook_setup(:write_cookies => true)
+  end
+end

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

@@ -0,0 +1 @@
+<%= rc_facebook.app_id %>

data/example/rails2/config/boot.rb

@@ -0,0 +1,130 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      if load_error.message =~ /Could not find RubyGem rails/
+        STDERR.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+        exit 1
+      else
+        raise
+      end
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        min_version = '1.3.2'
+        require 'rubygems'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# begin copied from http://gembundler.com/rails23.html
+class Rails::Boot
+  def run
+    load_initializer
+
+    Rails::Initializer.class_eval do
+      def load_gems
+        @bundler_loaded ||= Bundler.require(:default, Rails.env.to_sym)
+      end
+    end
+
+    Rails::Initializer.run(:set_load_path)
+  end
+end
+# end copied from http://gembundler.com/rails23.html
+
+# All that for this:
+Rails.boot!

data/example/rails2/config/environment.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '2.3.14' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  # we use bundler now, so don't do this at this example
+  # config.gem 'rest-graph'
+
+  config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
+  config.time_zone = 'UTC'
+end

data/example/rails2/config/environments/development.rb

@@ -0,0 +1,17 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+config.cache_classes = false
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false

data/example/rails2/config/environments/production.rb

@@ -0,0 +1,28 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The production environment is meant for finished, "live" apps.
+# Code is not reloaded between requests
+config.cache_classes = true
+
+# Full error reports are disabled and caching is turned on
+config.action_controller.consider_all_requests_local = false
+config.action_controller.perform_caching             = true
+config.action_view.cache_template_loading            = true
+
+# See everything in the log (default is :info)
+# config.log_level = :debug
+
+# Use a different logger for distributed setups
+# config.logger = SyslogLogger.new
+
+# Use a different cache store in production
+# config.cache_store = :mem_cache_store
+
+# Enable serving of images, stylesheets, and javascripts from an asset server
+# config.action_controller.asset_host = "http://assets.example.com"
+
+# Disable delivery errors, bad email addresses will be ignored
+# config.action_mailer.raise_delivery_errors = false
+
+# Enable threaded mode
+# config.threadsafe!

data/example/rails2/config/environments/test.rb

@@ -0,0 +1,30 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+config.action_view.cache_template_loading            = true
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+# Use SQL instead of Active Record's schema dumper when creating the test database.
+# This is necessary if your schema can't be completely dumped by the schema dumper,
+# like if you have constraints or database-specific column types
+# config.active_record.schema_format = :sql
+
+config.logger = Logger.new($stdout, :debug)

data/example/rails2/config/initializers/cookie_verification_secret.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+ActionController::Base.cookie_verifier_secret = '095e8e5c0b6b901901efb23fab50005b68d9d6a9d41f4ec780946cff34b26603762bc0ea1baf204613b252e5ae499d38b232d5b75edac513a723e450e76548a3';

data/example/rails2/config/initializers/new_rails_defaults.rb

@@ -0,0 +1,21 @@
+# Be sure to restart your server when you modify this file.
+
+# These settings change the behavior of Rails 2 apps and will be defaults
+# for Rails 3. You can remove this initializer when Rails 3 is released.
+
+if defined?(ActiveRecord)
+  # Include Active Record class name as root for JSON serialized output.
+  ActiveRecord::Base.include_root_in_json = true
+
+  # Store the full class name (including module namespace) in STI type column.
+  ActiveRecord::Base.store_full_sti_class = true
+end
+
+ActionController::Routing.generate_best_match = false
+
+# Use ISO 8601 format for JSON serialized times and dates.
+ActiveSupport.use_standard_json_time_format = true
+
+# Don't escape HTML entities in JSON, leave that for the #json_escape helper.
+# if you're including raw json in an HTML page.
+ActiveSupport.escape_html_entities_in_json = false

data/example/rails2/config/initializers/session_store.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying cookie session data integrity.
+# If you change this key, all old sessions will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+ActionController::Base.session = {
+  :key         => '_rails2_session',
+  :secret      => 'c99a19ce0dc4ed1809e32b6b43bd9229c3a504c456230119dd445fdcb63c0ce06b436f1bf1eace27ebbe0da6041ff2b65cbb4ae4beadc3077e3e6ae07ea75118'
+}
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rake db:sessions:create")
+# ActionController::Base.session_store = :active_record_store

data/example/rails2/config/preinitializer.rb

@@ -0,0 +1,23 @@
+
+# copied from http://gembundler.com/rails23.html
+
+begin
+  require "rubygems"
+  require "bundler"
+rescue LoadError
+  raise "Could not load the bundler gem. Install it with `gem install bundler`."
+end
+
+if Gem::Version.new(Bundler::VERSION) <= Gem::Version.new("0.9.24")
+  raise RuntimeError, "Your bundler version is too old for Rails 2.3." +
+   "Run `gem install bundler` to upgrade."
+end
+
+begin
+  # Set up load paths for all bundled gems
+  ENV["BUNDLE_GEMFILE"] = File.expand_path("../../Gemfile", __FILE__)
+  Bundler.setup
+rescue Bundler::GemNotFound
+  raise RuntimeError, "Bundler couldn't find some gems." +
+    "Did you run `bundle install`?"
+end

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

@@ -0,0 +1,12 @@
+
+development: &default
+  facebook:
+    app_id: '123'
+    secret: '456'
+    canvas: 'can'
+
+production:
+  *default
+
+test:
+  *default

data/example/rails2/config/routes.rb

@@ -0,0 +1,43 @@
+ActionController::Routing::Routes.draw do |map|
+  # The priority is based upon order of creation: first created -> highest priority.
+
+  # Sample of regular route:
+  #   map.connect 'products/:id', :controller => 'catalog', :action => 'view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   map.purchase 'products/:id/purchase', :controller => 'catalog', :action => 'purchase'
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   map.resources :products
+
+  # Sample resource route with options:
+  #   map.resources :products, :member => { :short => :get, :toggle => :post }, :collection => { :sold => :get }
+
+  # Sample resource route with sub-resources:
+  #   map.resources :products, :has_many => [ :comments, :sales ], :has_one => :seller
+
+  # Sample resource route with more complex sub-resources
+  #   map.resources :products do |products|
+  #     products.resources :comments
+  #     products.resources :sales, :collection => { :recent => :get }
+  #   end
+
+  # Sample resource route within a namespace:
+  #   map.namespace :admin do |admin|
+  #     # Directs /admin/products/* to Admin::ProductsController (app/controllers/admin/products_controller.rb)
+  #     admin.resources :products
+  #   end
+
+  # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
+  map.connect ':action', :controller => 'application'
+
+  # See how all your routes lay out with "rake routes"
+
+  # Install the default routes as the lowest priority.
+  # Note: These default routes make all actions in every controller accessible via GET requests. You should
+  # consider removing or commenting them out if you're using named routes and resources.
+  # map.connect ':controller/:action/:id'
+  # map.connect ':controller/:action/:id.:format'
+end