restfully 0.4.0 → 0.4.1

data/CHANGELOG

@@ -1,3 +1,10 @@
+0.4.1
+* added a require 'yaml' in restfully.rb (priteau);
+* added an introductory message when suing the command-line tool;
+* removed [root_path] from the list of options in command-line client 'Usage' banner (priteau);
+* added test for :configuration_file option;
+* tests are no longer failing on ruby1.9;
+
 0.4.0
 * removed 'root_path' option: 'base_uri' must point to the starting resource;
 * objects can now be pretty printed using 'pp object';

data/README.rdoc

@@ -19,19 +19,19 @@ If the connection was successful, you should get a prompt. You may enter
   irb(main):001:0> pp root
 
 to get back a pretty-printed output of the root resource:
-#<Restfully::Resource:0x91f08c
-  @uri=#<URI::HTTP:0x123e30c URL:http://api.local/sid/grid5000>
-  LINKS
-    @environments=#<Restfully::Collection:0x917666>,
-    @sites=#<Restfully::Collection:0x9170d0>,
-    @version=#<Restfully::Resource:0x91852a>,
-    @versions=#<Restfully::Collection:0x917e68>
-  PROPERTIES
-    "uid"=>"grid5000",
-    "type"=>"grid",
-    "version"=>"4fe96b25d2cbfee16abe5a4fb999c82dbafc2ee8">
-
-You can see the LINKS and PROPERTIES headers that respectively indicate what links you can follow from there (by calling +root.link_name+) and what properties are available (by calling +root[property_name]+).
+  #<Restfully::Resource:0x91f08c
+    @uri=#<URI::HTTP:0x123e30c URL:http://api.local/sid/grid5000>
+    LINKS
+      @environments=#<Restfully::Collection:0x917666>,
+      @sites=#<Restfully::Collection:0x9170d0>,
+      @version=#<Restfully::Resource:0x91852a>,
+      @versions=#<Restfully::Collection:0x917e68>
+    PROPERTIES
+      "uid"=>"grid5000",
+      "type"=>"grid",
+      "version"=>"4fe96b25d2cbfee16abe5a4fb999c82dbafc2ee8">
+
+You can see the LINKS and PROPERTIES headers that respectively indicate what links you can follow from there (by calling <tt>root.link_name</tt>) and what properties are available (by calling <tt>root[property_name]</tt>).
 
 Let's say you want to access the collection of +sites+, you would enter:
   irb(main):002:0> pp root.sites

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/bin/restfully

@@ -1,12 +1,12 @@
 #!/usr/bin/env ruby
 # The command line Restfully client
 
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib' unless $LOAD_PATH.include? File.dirname(__FILE__) + '/../lib'
+lib_dir = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift lib_dir unless $LOAD_PATH.include? lib_dir
 
 require 'restfully'
 require 'optparse'
 require 'logger'
-require 'yaml'
 require 'pp'
 
 
@@ -18,7 +18,7 @@ option_parser = OptionParser.new do |opts|
 * Description
   Restfully #{Restfully::VERSION} - Access REST APIs effortlessly
 * Usage
-  restfully [base_uri] [root_path] [options]
+  restfully [base_uri] [options]
 * Options
 BANNER
 
@@ -59,6 +59,8 @@ def root
   @root ||= session.root.load
 end
 
+puts "Restfully/#{Restfully::VERSION} - The root resource is available in the 'root' variable."
+
 require 'irb'
 require 'irb/completion'
 ARGV.clear

data/lib/restfully.rb

@@ -1,4 +1,5 @@
 require 'backports'
+require 'yaml'
 require 'restfully/error'
 require 'restfully/parsing'
 require 'restfully/http'
@@ -13,7 +14,7 @@ require 'restfully/collection'
 
 
 module Restfully
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
   class << self
     attr_accessor :adapter
   end

data/lib/restfully/http/error.rb

@@ -1,13 +1,21 @@
 module Restfully
   module HTTP
     class Error < Restfully::Error
+      STATUS_CODES = {
+        400 => "Bad Request",
+        401 => "Authorization Required",
+        403 => "Forbiden",
+        406 => "Not Acceptable"        
+      }
+      
       attr_reader :response
       def initialize(response)
         @response = response
-        if response.body.kind_of?(Hash)
-          message = "#{response.status} #{response.body['title']}. #{response.body['message']}"
+        response_body = response.body rescue response.raw_body
+        if response_body.kind_of?(Hash)
+          message = "#{response.status} #{response_body['title']}. #{response_body['message']}"
         else
-          message = response.body
+          message = "#{response.status} #{STATUS_CODES[response.status] || (response_body[0..100]+"...")}"
         end
         super(message)
       end

data/restfully.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{restfully}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril Rohr"]
@@ -49,6 +49,7 @@ Gem::Specification.new do |s|
      "lib/restfully/special_hash.rb",
      "restfully.gemspec",
      "spec/collection_spec.rb",
+     "spec/fixtures/configuration_file.yml",
      "spec/fixtures/grid5000-sites.json",
      "spec/http/error_spec.rb",
      "spec/http/headers_spec.rb",

data/spec/collection_spec.rb

@@ -32,7 +32,7 @@ describe Collection do
     it "should not load if already loaded and no :reload" do
       collection = Collection.new(@uri, mock("session"))
       options = {:headers => {'key' => 'value'}}
-      collection.should_receive(:executed_requests).and_return({'GET' => {'options' => options, 'body' => {"key", "value"}}})
+      collection.should_receive(:executed_requests).and_return({'GET' => {'options' => options, 'body' => {"key" => "value"}}})
       collection.load(options.merge(:reload => false)).should == collection
     end
     it "should load when :reload param is true [already loaded]" do

data/spec/fixtures/configuration_file.yml

@@ -0,0 +1,4 @@
+base_uri: http://somewhere.net/x/y/z
+username: u
+password: p
+verbose: false

data/spec/session_spec.rb

@@ -4,7 +4,7 @@ restfully_version = File.read(File.dirname(__FILE__)+'/../VERSION').strip
 include Restfully
 describe Session do
   before do
-    @session = Session.new(:base_uri => 'https://api.grid5000.fr/sid/', :root_path => '/grid5000', :user => 'crohr', :password => 'password', :default_headers => {})
+    @session = Session.new(:base_uri => 'https://api.grid5000.fr/sid/', :user => 'crohr', :password => 'password', :default_headers => {})
     @request = mock("restfully http request", :uri => mock("uri"), :headers => mock("headers"), :body => nil)
     @response = mock("restfully http response", :status => 200, :headers => mock("headers"))
   end
@@ -66,15 +66,23 @@ describe Session do
     it "should yield the loaded root resource and the session object" do
       Restfully::Resource.stub!(:new).and_return(root_resource = mock(Restfully::Resource))
       root_resource.should_receive(:load).and_return(root_resource)
-      Session.new(:base_uri => 'https://api.grid5000.fr', :root_path => '/grid5000', :user => 'crohr', :password => 'password') do |root, session|
+      Session.new(:base_uri => 'https://api.grid5000.fr', :user => 'crohr', :password => 'password') do |root, session|
         session.root.should == root
         root.should == root_resource
       end
     end
+    
+    it "should use the options defined in the given configuration file" do
+      config_file = 
+      session = Session.new(:base_uri => 'https://api.grid5000.fr', :username => 'x', :password => 'y', :verbose => true, :configuration_file => (File.dirname(__FILE__)+'/fixtures/configuration_file.yml'))
+      session.base_uri.should == URI.parse('http://somewhere.net/x/y/z')
+      session.logger.should_not == Logger::DEBUG
+    end
   end
   
   describe "Transmitting requests" do
     before do
+      Session.send(:public, :transmit)  
       @request.should_receive(:add_headers).with("User-Agent"=>"Restfully/#{restfully_version}", "Accept"=>"application/json")
     end
     it "should send a head" do
@@ -106,7 +114,10 @@ describe Session do
     end
   end
   
-  describe "Dealing with errors" do    
+  describe "Dealing with errors" do   
+    before do      
+      Session.send(:public, :deal_with_eventual_errors)
+    end 
     it "should raise a Restfully::HTTP::ClientError error on 4xx errors" do
       response = mock("404 response", :status => 404, :body => {'code' => 404, 'message' => 'The requested resource cannot be found.', 'title' => 'Not Found'}, :headers => mock("headers"))
       lambda{ @session.send(:deal_with_eventual_errors, response, @request) }.should raise_error(Restfully::HTTP::ClientError, "404 Not Found. The requested resource cannot be found.")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: restfully
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - Cyril Rohr
@@ -72,6 +72,7 @@ files:
 - lib/restfully/special_hash.rb
 - restfully.gemspec
 - spec/collection_spec.rb
+- spec/fixtures/configuration_file.yml
 - spec/fixtures/grid5000-sites.json
 - spec/http/error_spec.rb
 - spec/http/headers_spec.rb