restfulie 1.0.0 → 1.0.3

data/tests/spec/requests/http/errors_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+
+describe Restfulie::Client::HTTP do
+
+  context "error conditions" do
+  
+    before do
+      @host = "http://localhost:4567"
+      @client = Restfulie.at(@host)
+    end
+  
+    it "receives error when 300..399  code is returned" do
+      @client.at("/test/302").get.should respond_with_status(200)
+    end
+    it "raise Error::Redirection error when 300..399  code is returned" do
+      lambda { @client.at("/test/302").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::Redirection
+    end
+  
+    it "raise Error::BadRequest error when 400 code is returned" do
+      @client.at("/test/400").get.should respond_with_status(400)
+    end
+    it "receives error when 400 code is returned" do
+      lambda { @client.at("/test/400").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::BadRequest
+    end
+  
+    it "raise Error::Unauthorized error when 401 code is returned" do
+      @client.at("/test/401").get.should respond_with_status(401)
+    end
+    it "receives error when 401 code is returned" do
+      lambda { @client.at("/test/401").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::Unauthorized
+    end
+  
+    it "raise Error::Forbidden error when 403 code is returned" do
+      @client.at("/test/403").get.should respond_with_status(403)
+    end
+    
+    it "receives error when 403 code is returned" do
+      lambda { Restfulie.at("http://localhost:4567/test/403").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::Forbidden
+    end
+  
+    it "raise Error::NotFound error when 404 code is returned" do
+      @client.at("/test/404").get.should respond_with_status(404)
+    end
+    it "receives error when 404 code is returned" do
+      lambda { @client.at("/test/404").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::NotFound
+    end
+  
+    it "raise Error::MethodNotAllowed error when 405 code is returned" do
+      @client.at("/test/405").get.should respond_with_status(405)
+    end
+    it "receives error when 405 code is returned" do
+      lambda { @client.at("/test/405").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::MethodNotAllowed
+    end
+  
+    it "raise Error::ProxyAuthenticationRequired error when 407 code is returned" do
+      @client.at("/test/407").get.should respond_with_status(407)
+    end
+    it "receives error when 407 code is returned" do
+      lambda { @client.at("/test/407").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::ProxyAuthenticationRequired
+    end
+  
+    it "receives error when 409 code is returned" do
+      @client.at("/test/409").get.should respond_with_status(409)
+    end
+    
+    it "raise Error::Conflict error when 409 code is returned" do
+     lambda { @client.at("/test/409").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::Conflict
+    end
+  
+    it "raise Error::Gone error when 410 code is returned" do
+      @client.at("/test/410").get.should respond_with_status(410)
+    end
+    it "receives error when 410 code is returned" do
+     lambda { @client.at("/test/410").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::Gone
+    end
+  
+    it "raise Error::PreconditionFailed error when 412 code is returned" do
+      @client.at("/test/412").get.should respond_with_status(412)
+    end
+    it "receives error when 412 code is returned" do
+      lambda { @client.at("/test/412").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::PreconditionFailed
+    end
+  
+   it "receives error when 413 code is returned" do
+      @client.at("/test/413").get.should respond_with_status(413)
+    end
+    it "raise Error::ClientError error when 413 code is returned" do
+      lambda { @client.at("/test/413").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::ClientError
+    end
+  
+   it "receives error when 501 code is returned" do
+      @client.at("/test/501").get.should respond_with_status(501)
+    end
+    it "raise Error::NotImplemented error when 501 code is returned" do
+      lambda { @client.at("/test/501").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::NotImplemented
+    end
+  
+   it "receives error when 500 code is returned" do
+      @client.at("/test/500").get.should respond_with_status(500)
+    end
+    it "raise Error::ServerError error when 500 code is returned" do
+      lambda { @client.at("/test/500").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::ServerError
+    end
+  
+   it "receives error when 503 code is returned" do
+     pending "should treat it well when the server is not there..."
+      Restfulie.at("http://localhost:2222/").get.should respond_with_status(503)
+    end
+    
+    it "raise Error::ServerNotAvailableError error when 503 code is returned" do
+      lambda { Restfulie.at("http://localhost:2222/").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::ServerNotAvailableError
+    end
+  
+   it "receives error when 502..599 code is returned" do
+     @client.at("/test/502").get.should respond_with_status(502)
+   end
+   it "raise Error::ServerError error when 502..599 code is returned" do
+      lambda { @client.at("/test/502").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::ServerError
+    end
+  
+   it "receives error when 600 or bigger code is returned" do
+     @client.at("/test/600").get.should respond_with_status(600)
+   end
+   it "raise Error::UnknownError error when 600 or bigger code is returned" do
+      lambda { @client.at("/test/600").get! }.should raise_exception ::Restfulie::Client::HTTP::Error::UnknownError
+    end
+  
+  end
+end
+

data/tests/spec/requests/http/history_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Restfulie::Client::HTTP do
+
+  context 'RequestHistory' do
+  
+    before do
+      @host = "http://localhost:4567"
+    end
+  
+    it "should remember last requests" do
+      r1 = Restfulie.at(@host).history.at('/test').accepts('application/atom+xml').with('Accept-Language' => 'en').get
+      r1.should respond_with_status(200)
+      r2 = r1.debug.at('/test').accepts('text/html').with('Accept-Language' => 'pt-BR').head
+      r2.should respond_with_status(200)
+      r3 = r2.at('/test').as('application/xml').with('Accept-Language' => 'en').delete!
+      r3.should respond_with_status(200)
+      r4 = r3.at('/test/500').accepts('application/xml').with('Accept-Language' => 'en').get
+      r4.should respond_with_status(500)
+  
+      req = r4.debug.history(-4)
+      req.get.should respond_with_status(200)
+      req.path.should == '/test'
+      req.host.to_s.should == @host + "/test"
+      req.headers['Accept'].should == 'application/atom+xml'
+      req.headers['Accept-Language'].should == 'en'
+  
+      req = req.history(-4)
+      req.head.should respond_with_status(200)
+      req.path.should == '/test'
+      req.host.to_s.should == @host + "/test"
+      req.headers['Accept'].should == 'text/html'
+      req.headers['Accept-Language'].should == 'pt-BR'
+  
+      req = req.history(-4)
+      req.post!.should respond_with_status(200)
+      req.path.should == '/test'
+      req.host.to_s.should == @host + "/test"
+      req.headers['Accept'].should == 'application/xml'
+      req.headers['Accept-Language'].should == 'en'
+      req.headers['Content-Type'].should == 'application/xml'
+  
+      req = req.history(-4)
+      req.get.should respond_with_status(500)
+      req.path.should == '/test/500'
+      req.host.to_s.should == @host + "/test/500"
+      req.headers['Accept'].should == 'application/xml'
+      req.headers['Accept-Language'].should == 'en'
+  
+      lambda { req.history(10).request }.should raise_error RuntimeError
+    end 
+  
+  end
+    
+end
+

data/tests/spec/requests/http/marshal_spec.rb2

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe Restfulie::Client::HTTP::RequestMarshaller do
+
+  before(:all) do
+    @marshaller = Restfulie::Client::HTTP::RequestMarshallerExecutor.new('http://localhost:4567')
+  end
+
+  context 'raw' do
+
+    context 'shouldnt unmarshal if forcing raw' do
+      
+      let(:raw_response) { @marshaller.at('/songs').accepts('application/atom+xml').raw.get! }
+
+      it "should respond to 200 code" do
+        raw_response.code.should equal 200
+      end
+      
+      it "response class should Restfulie response" do
+        raw_response.class.should equal Restfulie::Client::HTTP::Response
+      end
+      
+      it "body should equal to response data" do
+        raw_response.body.should == response_data( 'atoms', 'songs' )
+      end
+      
+    end
+    
+    context "follow 201 responses and shouldnt unmarshal if forcing raw" do
+      let(:raw_response) { @marshaller.at('/test/redirect/songs').accepts('application/atom+xml').as("application/atom+xml").raw.post!('<?xml version="1.0" encoding="UTF-8" ?><feed xmlns="http://www.w3.org/2005/Atom"><id>http://example.com/albums/1</id><title>Albums feed</title><updated>2010-05-03T16:29:26-03:00</updated></feed>') }
+
+      it "should respond to 200 code" do
+        raw_response.response.code.should == 200        
+      end
+
+      it "body should equal to response data" do
+        raw_response.response.body.should == response_data( 'atoms', 'songs' )        
+      end
+
+    end
+
+  end
+
+  context 'marshal' do
+
+    # before(:all) do
+    #   Restfulie.recipe(:atom, :name => :custom_song) do |representation, song|
+    #     representation.values do |value|
+    #       value.id      "ID/#{song.id}"
+    #       value.title   "Title #{song.title}"
+    #       value.updated song.updated
+    #     end        
+    #   end
+    # end
+
+    it 'should unmarshal' do
+      pending
+      songs = @marshaller.at('/songs').accepts('application/atom+xml').get!
+      
+      songs.response.code.should == 200
+      songs.title.should == 'Songs feed'
+      songs.id.should == 'http://localhost:4567/songs'
+      songs.updated.year.should == 2010
+      songs.entries.size.should == 4
+
+      a_song = songs.entries.first
+      a_song.title.should == 'Song 1'
+      a_song.id.should == 'http://localhost:4567/songs_1'
+
+      top_ten_songs = songs.links.top_ten.get!
+      top_ten_songs.response.code.should == 200
+      top_ten_songs.title.should == 'Top Ten Songs feed'
+      top_ten_songs.id.should == 'http://localhost:4567/songs_top_ten'
+      top_ten_songs.updated.year.should == 2010
+      a_song = top_ten_songs.entries.first
+      a_song.title.should == 'Song 3'
+      a_song.id.should == 'http://localhost:4567/song_3'
+
+      top_ten_songs = songs.links.top_ten.get!
+      a_song = top_ten_songs.entries.first
+      related_songs = a_song.links.related_songs.get!
+      similar_song = related_songs.entries.first.links.similar_song
+      similar_song.get!.title.should == 'Song 4 feed' 
+    end
+
+    it 'should marshal' do
+      pending
+      songs = @marshaller.at('/songs').accepts('application/atom+xml').get!
+
+      a_song = songs.entries.first
+      a_song.title = "Update song #{a_song.title}"
+
+      songs = @marshaller.at('/test/redirect/songs').as("application/atom+xml").post!(a_song)
+      songs.response.code.should == 200
+
+      songs = @marshaller.at('/test/redirect/songs').as("application/atom+xml").post!(a_song, :recipe => :custom_song)
+      songs.response.code.should == 200
+    end
+
+  end
+  
+  it 'should understand a different response content type from its request' do
+    result = Restfulie.at('http://localhost:4567/with_content').as("application/xml").post!('<order></order>')
+    result.response.headers['content-type'].should == "application/atom+xml"
+  end
+end
+
+describe Restfulie::Client::HTTP::RequestMarshaller do
+  it "should retrieve any content type if no accepts is specified" do
+    result = Restfulie.at('http://localhost:4567/html_result').get!
+    result.response.headers['content-type'].should == "text/html"
+  end
+end

data/tests/spec/requests/http/parameters_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Restfulie do
+  
+  it "should accept parameters in get requests" do
+    result = Restfulie.at('http://localhost:4567/request_with_querystring').get(:foo => "bar", :bar => "foo")
+    params  = JSON.parse(result.body)
+    params["foo"].should == "bar"
+    params["bar"].should == "foo"
+  end
+  
+end

data/tests/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format html:doc/rspec_results.html
+--format specdoc
+--loadby mtime
+--reverse

data/tests/spec/spec_helper.rb

@@ -0,0 +1,61 @@
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../../config/environment", __FILE__)
+require 'rspec/rails'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+module ResponseMatchers
+
+  class ResponseStatus
+
+    def initialize(response_code)
+      @expected_code = response_code.to_s
+    end
+
+    def matches?(response_header)
+      @actual_code = response_header.code
+      @expected_code.to_i == @actual_code.to_i
+    end
+
+    def failure_message
+        "expected response status to be #{@expected_code} but it's #{@actual_code}"
+    end
+
+    def negative_failure_message
+        "didn't expect #{@expected_code} to be #{@actual_code}"
+    end
+
+  end
+
+  def respond_with_status(response_code)
+    ResponseStatus.new(response_code)
+  end
+
+end
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, comment the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  config.include(ResponseMatchers)
+end
+
+# Change output logger
+Restfulie::Common::Logger.logger = ActiveSupport::BufferedLogger.new(File.join(File.dirname(__FILE__), "logs", "spec.log"))

data/tests/spec/support/atoms/full.rb.txt

@@ -0,0 +1,63 @@
+# Revision: 4                                                                            #
+collection(@materias) do |collection, materias|                                          # <feed xmlns="http://www.w3.org/2005/Atom" xmlns:materias="http://example.com.br">
+                                                                                         #
+  collection.values("xmlns:materias" => "http://example.com.br") do |values|             #
+    values.id      "uri:materia:1"                                                       #   <id>uri:materia:1</id>
+    values.title   "Materias"                                                            #   <title>Materias</title>
+    values.updated Time.now                                                              #   <updated>2010-05-03T16:29:26-03:00</updated>
+                                                                                         #
+    values.author {                                                                      #   <author>
+      values.name  "Éverton Ribeiro"                                                     #     <name>Éverton Antônio Ribeiro</name>
+      values.email "nuxlli@gmail.com"                                                    #     <email>nuxlli@gmail.com</email>
+    }                                                                                    #   </author>
+                                                                                         #
+    values.author {                                                                      #   <author>                              
+      values.name  "Luis Felipe Cipriani"                                                #     <name>Luis Felipe Cipriani</name>
+      values.email "lfcipriani@gmail.com"                                                #     <email>lfcipriani@gmail.com</email>      
+    }                                                                                    #   </author>
+                                                                                         #
+    values["materias"].dominio "editorial"                                               #   <materias:dominio>editorial</materias:dominio>
+    values.count("xmlns" => "http://example.com.br") do                                  #   <count xmlns="http://example.com.br">
+      values.materias  1                                                                 #     <materias>1</materias>
+      values.albums    1                                                                 #     <albums>1</albums>
+    end                                                                                  #   </count>
+  end                                                                                    #
+                                                                                         #
+  collection.members do |member, materia|                                                #   <entry xmlns:materias="http://example.com.br">
+                                                                                         #
+    member.values("xmlns:materias" => "http://example.com.br") do |values|               #
+      values.id      "uri:1"                                                             #     <id>uri:1</id>
+      values.title   "Materias 1"                                                        #     <title>Materia 1</title>
+      values.updated materia.updated_at                                                  #     <updated>2010-05-03T16:29:26-03:00</updated>
+                                                                                         #
+      values["materias"].criacao {                                                       #     <materias:criacao>
+        values["materias"].autor           "Luis Felipe Cipriani"                        #       <materias:autor>Luis Felipe Cipriani</materias:autor>
+        values["materias"].data_de_criacao Time.now                                      #       <materias:data_de_criacao>2010-05-03T16:29:26-03:00</materias:data_de_criacao>
+      }                                                                                  #     </materias:criacao>
+                                                                                         #
+      values["materias"].editorial(:editoria => "veja") do                               #     <materias:editorial editoria="veja">
+        values["materias"].categoria "categoria 1, categoria 2"                          #       <materias:categoria>categoria 1, categoria 2</materias:categoria>
+      end                                                                                #     </materias:editorial>
+                                                                                         #
+      values["materias"].albums("xmlns:albums" => "http://example.com.br") do            #     <materias:albums xmlns:albums="http://example.com.br">
+        values["albums"].id    "uri:albums:1"                                            #       <albums:id>uri:albums:1</albums:id>
+        values["albums"].title "Album 1"                                                 #       <albums:title>Album 1</albums:title>
+      end                                                                                #     </albums:albums>
+                                                                                         #
+      values.albums("xmlns" => "http://example.com.br",                                  #     <albums xmlns="http://example.com.br" xmlns:song="http://example.com.br">
+                   "xmlns:song" => "http://example.com.br")  do                          #       
+       values.id = 1                                                                     #       <id>1</id>
+       values["song"].song "a song"                                                      #       <song:title>a song</song:title>
+      end                                                                                #     </albums>
+    end                                                                                  #
+                                                                                         #
+    member.link("image", "http://example.com/image/1")                                   #     <link href="http://example.com/image/1" rel="image" />
+    member.link("image", "http://example.com/image/2",                                   #     <link href="http://example.com/image/2" rel="image" type="application/atom+xml" />
+         :type => "application/atom+xml")                                                #
+  end                                                                                    #   </entry>
+                                                                                         #
+  collection.link("next", "http://example.com/next")                                     #   <link href="http://example.com/next" rel="next" />
+  collection.link("previous", "http://example.com/previous",                             #   <link href="http://example.com/previus" rel="previous" />
+       :type => "application/atom+xml")                                                  #
+end                                                                                      # </feed>
+