restfully 1.0.0.rc1 → 1.0.0.rc2

data/README.md

@@ -90,6 +90,10 @@ add the `--record` flag, and at the end of your session the commands you
 entered will have been written into `SESSION_FILE` (by default:
 `restfully-tape`).
 
+Note: depending on your Readline installation, you might see the following
+message: "Bond has detected EditLine and may not work with it. See the
+README's Limitations section". You can safely ignore it.
+
 ### Replay
 
 Restfully can replay a sequence of ruby expressions. Just pass the FILE (local

data/bin/restfully

@@ -7,6 +7,7 @@ require 'logger'
 require 'pp'
 require 'ripl'
 require 'ripl/multi_line'
+require 'ripl/short_errors'
 
 # Behaviour of pp in IRB is different on ruby1.9:
 # * pp(object) returns object#inspect.
@@ -67,7 +68,6 @@ BANNER
   end
   opts.on("--color", "Color output") do |v|
     require 'ripl/color_streams'
-    require 'ripl/color_result'
   end
   opts.on("--record [SESSION_FILE]", "Record interactive session into SESSION_FILE (default=#{Restfully::DEFAULT_TAPE}), to be replayed later. This option is ignored if FILE is given.") do |v|
     OPTIONS["record"] = v || Restfully::DEFAULT_TAPE
@@ -104,11 +104,9 @@ BANNER
   end
 end.parse!
 
-# Declare original Restfully::Session
-@session = Restfully::Session.new(OPTIONS)
-
 if $stdin.tty? && !ARGV[0]
   # Interactive session
+  OPTIONS["shell"] = true
   puts "Restfully/#{Restfully::VERSION} - The root resource is available in the 'root' variable."
   if OPTIONS["record"]
     # Recording requested
@@ -117,7 +115,7 @@ if $stdin.tty? && !ARGV[0]
   end
 else
   # Replayed session
-  @session.logger.warn "--record option valid only with interactive session. Ignoring." if OPTIONS["record"]
+  logger.warn "--record option valid only with interactive session. Ignoring." if OPTIONS["record"]
   require 'ripl/play'
 
   module Ripl::Play
@@ -153,6 +151,9 @@ else
   Ripl.config[:play] = ARGV[0].dup if ARGV[0]
 end
 
+# Declare original Restfully::Session
+SESSION = Restfully::Session.new(OPTIONS)
+
 module Restfully
   class Session
     alias :old_initialize :initialize
@@ -160,9 +161,10 @@ module Restfully
     # scripts, so that they preferably take the configuration given with the
     # restfully command-line tool.
     def initialize(options = {}, &block)
+      options[:overridden] = true
       old_opts = Configuration.new(options).expand
-      new_opts = Configuration.new(OPTIONS).expand
-      old_initialize(old_opts.merge(new_opts).to_hash, &block)
+      new_opts = old_opts.merge(SESSION.config)
+      old_initialize(new_opts, &block)
     end
   end
 end
@@ -171,4 +173,4 @@ end
 at_exit{ @log_file && @log_file.close }
 
 ARGV.clear
-Ripl.start :binding => @session.instance_eval{ binding }
+Ripl.start :binding => SESSION.sandbox.instance_eval{ binding }

data/lib/restfully/configuration.rb

@@ -6,6 +6,17 @@ module Restfully
     
     def initialize(opts = {})
       @options = opts.symbolize_keys
+      
+      @options[:retry_on_error] ||= 5
+      @options[:wait_before_retry] ||= 5
+    end
+
+    def logger
+      @options[:logger] ||= begin
+        l = Logger.new(STDERR)
+        l.level = Logger::WARN
+        l
+      end
     end
 
     def merge(config = {})
@@ -35,6 +46,7 @@ module Restfully
       if file
         file = File.expand_path(file)
         if File.file?(file) && File.readable?(file)
+          logger.info "Loading configuration from #{file}..."
           @options = self.class.load(file).merge(self).options
         end
       end

data/lib/restfully/sandbox.rb

@@ -0,0 +1,16 @@
+require 'forwardable'
+
+module Restfully
+  class Sandbox
+    extend Forwardable
+
+    def_delegators :@session, :head, :get, :post, :put, :delete, :root, :logger
+
+    attr_reader :session
+
+    def initialize(session)
+      @session = session
+    end
+
+  end
+end

data/lib/restfully/session.rb

@@ -7,21 +7,17 @@ require 'restclient/components'
 require 'rack/cache'
 require 'addressable/uri'
 
+require 'restfully/sandbox'
+
 module Restfully
   class Session
 
-
-    attr_writer :logger
     attr_accessor :uri
     attr_reader :config
     attr_writer :default_headers
     
     def logger
-      @logger ||= begin
-        l = Logger.new(STDERR)
-        l.level = Logger::INFO
-        l
-      end
+      @config.logger
     end
 
     # Builds a new client session.
@@ -46,28 +42,40 @@ module Restfully
     #   ) {|root, session| p root}
     #
     def initialize(options = {})
-      @config = Configuration.new(options).expand
-      @logger = @config.delete(:logger)
+      @config = if options.kind_of?(Configuration)
+        options
+      else
+        Configuration.new(options).expand
+      end
 
-      @config[:retry_on_error] ||= 5
-      @config[:wait_before_retry] ||= 5
+      setup
 
+      yield root, self if block_given?
+    end
+    
+    def setup
       # Compatibility with :base_uri parameter of Restfully <= 0.6
-      @uri = @config.delete(:uri) || @config.delete(:base_uri)
-      if @uri.nil? || @uri.empty?
-        raise ArgumentError, "You must pass a :uri option."
+      @uri = config[:uri] || config[:base_uri]
+      msg = if @uri.nil? || @uri.empty?
+        @uri = Restfully::DEFAULT_URI
+        "No URI given. Using #{@uri}"
       else
-        @uri = Addressable::URI.parse(@uri)
+        "Base URI changed to: #{@uri}" 
+      end
+      if config[:overridden] || @uri == Restfully::DEFAULT_URI
+        config[:shell] ? puts(msg) : logger.warn(msg)
       end
 
-      default_headers.merge!(@config.delete(:default_headers) || {})
+      @uri = Addressable::URI.parse(@uri)
+
+      default_headers.merge!(config[:default_headers] || {})
 
       disable RestClient::Rack::Compatibility
-      authenticate(@config)
-      setup_cache(@config.delete(:cache))
+      authenticate(config)
+      setup_cache(config[:cache])
 
       # Require additional types (e.g.: media-types):
-      (@config[:require] || []).each do |r|
+      (config[:require] || []).each do |r|
         logger.info "Requiring #{r}..."
         if ::File.exist?(file=File.expand_path(r))
           require file
@@ -86,8 +94,6 @@ module Restfully
           require "restfully/media_type/#{r.underscore}"
         end
       end
-
-      yield root, self if block_given?
     end
 
     # Enable a RestClient Rack component.
@@ -136,10 +142,11 @@ module Restfully
     def root
       get(uri.path).load
     end
-
-    # Returns self.
-    def session
-      self
+    
+    # Return a sandbox object, useful to execute code within the current
+    # session context witout polluting the Session object.
+    def sandbox
+      Sandbox.new(self)
     end
 
     # Returns an HTTP::Response object or raise a Restfully::HTTP::Error

data/lib/restfully/version.rb

@@ -1,3 +1,3 @@
 module Restfully
-  VERSION = "1.0.0.rc1"
+  VERSION = "1.0.0.rc2"
 end

data/lib/restfully.rb

@@ -14,6 +14,7 @@ require 'restfully/media_type'
 
 module Restfully
   DEFAULT_TAPE = "restfully-tape"
+  DEFAULT_URI = "http://localhost:4567"
   # Include the default media-types
   MediaType.reset
 end

data/spec/restfully/configuration_spec.rb

@@ -4,37 +4,38 @@ describe Restfully::Configuration do
 
   before do
     @config_file = File.expand_path("../../fixtures/config.yml", __FILE__)
-    @expected_merge = {
-      :require=>["ApplicationVndBonfireXml", "something"], 
-      :username=>"crohr", 
-      :gateway=>"ssh.bonfire.grid5000.fr", 
+    @defaults = {
+      :retry_on_error=>5, :wait_before_retry=>5
+    }
+    @expected_config_from_file = {
+      :require=>["ApplicationVndBonfireXml"], 
+      :username=>"someone", 
       :uri=>"https://api.bonfire-project.eu/", 
-      :password=>"p4ssw0rd"
+      :password=>"p4ssw0rd", 
+      :gateway=>"ssh.bonfire.grid5000.fr"
     }
+    @expected_merge = @expected_config_from_file.merge(@defaults).merge({
+      :username=>"crohr", 
+      :require=>["ApplicationVndBonfireXml", "something"], 
+    })
   end
 
   it "should take a hash and store it with symbolized keys" do
     config = Restfully::Configuration.new("a" => 1, :b => "hello", "c" => [1,2,3])
-    config.options.should == {:a=>1, :b=>"hello", :c=>[1, 2, 3]}
+    config.options.should == {:a=>1, :b=>"hello", :c=>[1, 2, 3]}.merge(@defaults)
   end
 
   it "should correctly load a configuration file" do
     config = Restfully::Configuration.load(@config_file)
-    config.options.should == {
-      :require=>["ApplicationVndBonfireXml"], 
-      :username=>"someone", 
-      :uri=>"https://api.bonfire-project.eu/", 
-      :password=>"p4ssw0rd", 
-      :gateway=>"ssh.bonfire.grid5000.fr"
-    }
+    config.options.should == @expected_config_from_file.merge(@defaults)
   end
   
   it "should correctly overwrite the options defined in the configuration file with other options given on initialization" do
     config = Restfully::Configuration.new(:username => "crohr", :require => ['something'], :configuration_file => @config_file)
     config.expand
-    config.options.should == @expected_merge.merge(
+    config.options.should include(@expected_merge.merge(
       :configuration_file=>@config_file
-    )
+    ))
   end
   
   it "should correctly merge two configs" do

data/spec/restfully/session_spec.rb

@@ -16,13 +16,12 @@ describe Restfully::Session do
       session = Restfully::Session.new(@config.merge("key" => "value"))
       session.logger.should == @logger
       session.uri.should == Addressable::URI.parse(@uri)
-      session.config.to_hash.should == {:wait_before_retry=>5, :key=>"value", :retry_on_error=>5}
+      session.config.to_hash.values_at(:wait_before_retry, :key, :retry_on_error).should == [5, "value", 5]
     end
 
-    it "should raise an error if no URI given" do
-      lambda{
-        Restfully::Session.new(@config.merge(:uri => ""))
-      }.should raise_error(ArgumentError)
+    it "should set a default URI if no URI given" do
+      session = Restfully::Session.new(@config.merge(:uri => ""))
+      session.uri.to_s.should == Restfully::DEFAULT_URI
     end
     
     it "should add or replace additional headers to the default set" do
@@ -69,9 +68,11 @@ describe Restfully::Session do
     session.root.should == res
   end
   
-  it "should return itself when calling #session" do
+  it "should return a sanbox" do
     session = Restfully::Session.new(@config)
-    session.session.should == session
+    sandbox = session.sandbox
+    sandbox.session.should == session
+    sandbox.logger.should == session.logger
   end
 
   it "should fetch the root path [URI path present]" do

metadata

@@ -1,202 +1,279 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: restfully
-version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+version: !ruby/object:Gem::Version 
+  hash: 15424049
   prerelease: 6
+  segments: 
+  - 1
+  - 0
+  - 0
+  - rc
+  - 2
+  version: 1.0.0.rc2
 platform: ruby
-authors:
+authors: 
 - Cyril Rohr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-04 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-11-04 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: &2152514160 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
   type: :runtime
-  prerelease: false
-  version_requirements: *2152514160
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: rest-client
-  requirement: &2152511640 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.6'
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
   type: :runtime
-  prerelease: false
-  version_requirements: *2152511640
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: rest-client-components
-  requirement: &2152510880 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2152510880
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rack-cache
-  requirement: &2152509540 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2152509540
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: backports
-  requirement: &2152508000 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2152508000
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: addressable
-  requirement: &2152506760 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2152506760
-- !ruby/object:Gem::Dependency
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: ripl
-  requirement: &2152505220 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2152505220
-- !ruby/object:Gem::Dependency
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   name: ripl-multi_line
-  requirement: &2152504360 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2152504360
-- !ruby/object:Gem::Dependency
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
   name: ripl-color_streams
-  requirement: &2152503480 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: ripl-short_errors
   prerelease: false
-  version_requirements: *2152503480
-- !ruby/object:Gem::Dependency
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
   name: ripl-play
-  requirement: &2152502240 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 0
+        - 2
+        - 1
         version: 0.2.1
   type: :runtime
-  prerelease: false
-  version_requirements: *2152502240
-- !ruby/object:Gem::Dependency
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
   name: rb-readline
-  requirement: &2152501420 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2152501420
-- !ruby/object:Gem::Dependency
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &2152500480 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.8'
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
   type: :development
-  prerelease: false
-  version_requirements: *2152500480
-- !ruby/object:Gem::Dependency
+  version_requirements: *id013
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &2152499460 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id014 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2'
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
   type: :development
-  prerelease: false
-  version_requirements: *2152499460
-- !ruby/object:Gem::Dependency
+  version_requirements: *id014
+- !ruby/object:Gem::Dependency 
   name: webmock
-  requirement: &2152498720 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id015 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2152498720
-- !ruby/object:Gem::Dependency
+  version_requirements: *id015
+- !ruby/object:Gem::Dependency 
   name: autotest
-  requirement: &2152497620 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id016 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2152497620
-- !ruby/object:Gem::Dependency
+  version_requirements: *id016
+- !ruby/object:Gem::Dependency 
   name: autotest-growl
-  requirement: &2152495520 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id017 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2152495520
+  version_requirements: *id017
 description: Consume RESTful APIs effortlessly
-email:
+email: 
 - cyril.rohr@gmail.com
-executables:
+executables: 
 - restfully
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE
 - README.md
-files:
+files: 
 - bin/restfully
 - lib/restfully/collection.rb
 - lib/restfully/configuration.rb
@@ -217,6 +294,7 @@ files:
 - lib/restfully/rack/basic_auth.rb
 - lib/restfully/rack.rb
 - lib/restfully/resource.rb
+- lib/restfully/sandbox.rb
 - lib/restfully/session.rb
 - lib/restfully/version.rb
 - lib/restfully.rb
@@ -247,32 +325,43 @@ files:
 - Rakefile
 - LICENSE
 - README.md
+has_rdoc: true
 homepage: http://github.com/crohr/restfully
 licenses: []
+
 post_install_message: 
-rdoc_options:
+rdoc_options: 
 - --charset=UTF-8
-require_paths:
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '1.8'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 31
+      segments: 
+      - 1
+      - 8
+      version: "1.8"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '1.3'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 9
+      segments: 
+      - 1
+      - 3
+      version: "1.3"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Consume RESTful APIs effortlessly
-test_files:
+test_files: 
 - spec/fixtures/bonfire-collection-with-fragments.xml
 - spec/fixtures/bonfire-compute-existing.xml
 - spec/fixtures/bonfire-empty-collection.xml