weary 0.5.1 → 0.6.0

data/spec/weary/request_spec.rb

@@ -17,6 +17,7 @@ describe Weary::Request do
     test.class.should == Net::HTTP
   end
   
+  # replace with FakeWeb
   it "should perform the request and retrieve a response" do
     test = Weary::Request.new("http://foo.bar")
     method = test.method
@@ -26,6 +27,7 @@ describe Weary::Request do
     test.perform.redirected?.should == true
   end
   
+  # replace with FakeWeb
   it "should follow redirects" do
     test = Weary::Request.new("http://foo.bar")
     method = test.method   

data/spec/weary/resource_spec.rb

@@ -5,96 +5,252 @@ describe Weary::Resource do
     @test = Weary::Resource.new("test")
   end
   
-  it 'defaults to a GET request' do
-    @test.via.should == :get
+  describe 'Name' do
+    it 'has a name' do
+      @test.name.should == "test"
+    end
+    
+    it 'replaces the whitespace in the name' do
+      @test.name = " test number two"
+      @test.name.should == "test_number_two"
+      @test.name = "test\nthree"
+      @test.name.should == "test_three"
+    end
+    
+    it 'downcases everything' do
+      @test.name = "TEST"
+      @test.name.should == "test"
+    end
+    
+    it 'is a string' do
+      @test.name = :test
+      @test.name.should == "test"
+    end
   end
   
-  it 'should add requirements to the "with" array' do
-    @test.requires = [:foo, :bar]
-    @test.with.should == [:foo, :bar]
-  end
-  
-  it 'with paramaters could be comma delimited strings' do
-    @test.with = "foo", "bar"
-    @test.with.should == [:foo, :bar]
-  end
-  
-  it 'with params could be a hash' do
-    @test.with = {:foo => "Foo", :bar => "Bar"}
-    @test.with.should == {:foo => "Foo", :bar => "Bar"}
-    @test.requires = [:id, :user]
-    @test.with.should == {:bar=>"Bar", :user => nil, :foo => "Foo", :id => nil}
-    @test.with = [:foo, :bar]
-    @test.with.should == [:foo, :bar, :id, :user]
-  end
-  
-  it 'authenticates? should be boolean' do
-    @test.authenticates = "foobar"
-    @test.authenticates?.should == true
-    @test.authenticates = false
-    @test.authenticates?.should == false
-  end
-  
-  it "oauth should be boolean" do
-    @test.oauth = "foobar"
-    @test.oauth?.should == true
-    @test.oauth = false
-    @test.oauth?.should == false    
+  describe 'Via' do
+    it 'defaults as a GET request' do
+      @test.via.should == :get
+    end
+
+    it 'normalizes HTTP request verbs' do
+      @test.via = "POST"
+      @test.via.should == :post
+    end
+
+    it 'remains a GET if the input verb is not understood' do
+      @test.via = "foobar"
+      @test.via.should == :get
+    end
   end
   
-  it "oauth should override basic authentication" do
-    @test.authenticates = true
-    @test.oauth = true
-    @test.authenticates?.should == false
-    @test.oauth?.should == true
+  describe 'Parameters' do
+    it 'is an array of params' do
+      @test.with = [:uid, :date]
+      @test.with.should == [:uid, :date]
+      @test.with = :user, :message
+      @test.with.should == [:user, :message]
+    end
+    
+    it 'stores the params as symbols' do
+      @test.with = "user", "message"
+      @test.with.should == [:user, :message]
+    end
+    
+    it 'defines required params' do
+      @test.requires = [:uid, :date]
+      @test.requires.should == [:uid, :date]
+      @test.requires = :user, :message
+      @test.requires.should == [:user, :message]
+    end
+    
+    it 'stores the required params as symbols' do
+      @test.requires = "user", "message"
+      @test.requires.should == [:user, :message]
+    end
+    
+    it 'required params inherently become passed params' do
+      @test.requires = [:user, :message]
+      @test.requires.should == [:user, :message]
+      @test.with.should == [:user, :message]
+    end
+    
+    it 'merges required params with optional params' do
+      @test.with = [:user, :message]
+      @test.requires = [:id, :time]
+      @test.with.should == [:user, :message, :id, :time]
+      @test.requires.should == [:id, :time]
+    end
+    
+    it 'optional params should merge with required params' do
+      @test.requires = [:id, :time]
+      @test.with.should == [:id, :time]
+      @test.with = [:user, :message]
+      @test.requires.should == [:id, :time]
+      @test.with.should == [:id, :time, :user, :message]
+    end
   end
   
-  it "providing an access token should set oauth to true" do
-    consumer = OAuth::Consumer.new("consumer_token","consumer_secret",{:site => 'http://foo.bar'})
-    token = OAuth::AccessToken.new(consumer, "token", "secret")
-    @test.oauth = false
-    @test.access_token = token
-    @test.oauth?.should == true
-    @test.access_token.should == token
+  describe 'Authenticates' do
+    it 'defaults to false' do
+      @test.authenticates?.should == false
+    end
+    
+    it 'is always set to a boolean' do
+      @test.authenticates = "foobar"
+      @test.authenticates?.should == true
+      @test.authenticates = "false"
+      @test.authenticates?.should == true
+    end
   end
   
-  it "an access token must contain an OAuth::AccessToken" do
-    lambda { @test.access_token = "foobar" }.should raise_error
+  describe 'Redirection' do
+    it 'defaults to true' do
+      @test.follows?.should == true
+    end
+    
+    it 'is always set to a boolean' do
+      @test.follows = "foobar"
+      @test.follows?.should == true
+      @test.follows = "false"
+      @test.follows?.should == true
+      @test.follows = false
+      @test.follows?.should == false
+    end
   end
   
-  it 'follows_redirects? should be boolean' do
-    @test.follows = "false"
-    @test.follows_redirects?.should == true
-    @test.follows = false
-    @test.follows_redirects?.should == false
+  describe 'URL' do
+    it 'is a valid URI' do
+      @test.url = 'http://foo.bar/foobar'
+      @test.url.scheme.should == 'http'
+      @test.url.host.should == 'foo.bar'
+      @test.url.path.should == '/foobar'
+      @test.url.normalize.to_s.should == 'http://foo.bar/foobar'
+    end
+    
+    it "rejects fake url's" do
+      lambda { @test.url = "this is not really a url" }.should raise_error
+    end
   end
   
-  it 'should be intelligent about crafting names' do
-    @test.name = "foo bar \n"
-    @test.name.should == "foo_bar"
+  describe 'Request Builder' do
+    before do
+      @test.url = 'http://foo.bar'
+      @test.with = :user, :message
+      @test.headers = {"User-Agent" => Weary::UserAgents["Safari 4.0.2 - Mac"]}
+    end
+    
+    it "merges defaults in with passed params" do
+      params = {:message => "Hello"}
+      defaults = {:user => "me"}
+      @test.setup_parameters(params, defaults).should == {:message => "Hello", :user => "me"}
+      @test.setup_parameters(params).should == {:message => "Hello"}
+    end
+    
+    it 'alerts if a required param is missing' do
+      @test.requires = [:id]
+      params = {:user => "me", :message => "Hello"}
+      lambda { @test.find_missing_requirements(params) }.should raise_error
+    end
+    
+    it 'removes unnecessary parameters' do
+      params = {:message => "Hello", :user => "me", :foo => "bar"}
+      @test.remove_unnecessary_params(params).should == {:message => "Hello", :user => "me"}
+    end
+    
+    it 'prepares param options for the request' do
+      params = {:user => "me", :message => "Hello"}
+      @test.prepare_request_body(params)[:query].should == {:user => "me", :message => "Hello"}
+      @test.prepare_request_body(params).has_key?(:body).should == false
+      @test.via = :post
+      @test.prepare_request_body(params)[:body].should == {:user => "me", :message => "Hello"}
+      @test.prepare_request_body(params).has_key?(:query).should == false
+    end
+    
+    it 'alerts if credentials are missing but authorization is required' do
+      @test.authenticates = true
+      lambda { @test.setup_authentication({}) }.should raise_error
+    end
+    
+    it 'negotiates what form of authentication is used (basic or oauth)' do
+      @test.authenticates = true
+      basic_auth = {:username => "mwunsch", :password => "secret123"}
+      oauth_consumer = OAuth::Consumer.new("consumer_token","consumer_secret",{:site => 'http://foo.bar'})
+      oauth_token = OAuth::AccessToken.new(oauth_consumer, "token", "secret")
+      
+      basic_authentication = @test.setup_authentication({},basic_auth)
+      oauth_authentication = @test.setup_authentication({},oauth_token)
+      
+      basic_authentication.has_key?(:basic_auth).should == true
+      basic_authentication.has_key?(:oauth).should == false
+      basic_authentication[:basic_auth].should == basic_auth
+      
+      oauth_authentication.has_key?(:oauth).should == true
+      oauth_authentication.has_key?(:basic_auth).should == false
+      oauth_authentication[:oauth].should == oauth_token
+    end
+    
+    it 'sets request options' do
+      setup = @test.setup_options({})
+      
+      setup.has_key?(:headers).should == true
+      setup.has_key?(:no_follow).should == false
+      setup[:headers].should == @test.headers
+    end
+    
+    it 'sets redirection following options' do
+      @test.follows = false
+      setup = @test.setup_options({})
+      
+      setup[:no_follow].should == true
+    end
+    
+    it 'sets parameter body options' do
+      params = {:user => "me", :message => "Hello"}
+      setup_get = @test.setup_options(params)
+      
+      setup_get.has_key?(:query).should == true
+      setup_get[:query] == params
+      
+      @test.via = :post
+      setup_post = @test.setup_options(params)
+      
+      setup_post.has_key?(:query).should == false
+      setup_post.has_key?(:body).should == true
+      setup_post[:body].should == params      
+    end
+    
+    it 'sets up authentication options' do
+      @test.authenticates = true
+      basic_auth = {:username => "mwunsch", :password => "secret123"}
+      oauth_consumer = OAuth::Consumer.new("consumer_token","consumer_secret",{:site => 'http://foo.bar'})
+      oauth_token = OAuth::AccessToken.new(oauth_consumer, "token", "secret")
+      setup_basic = @test.setup_options({}, basic_auth)
+      setup_oauth = @test.setup_options({}, oauth_token)
+      
+      setup_basic[:basic_auth].should == basic_auth
+      setup_oauth[:oauth].should == oauth_token
+    end
+    
+    it 'builds a Request' do
+      @test.authenticates = true
+      @test.requires = [:id]
+      params = {:user => "me", :message => "Hello", :bar => "foo"}
+      defaults = {:id => 1234, :foo => "bar"}
+      basic_auth = {:username => "mwunsch", :password => "secret123"}
+      
+      request = @test.build!(params, defaults, basic_auth)
+      
+      request.class.should == Weary::Request
+      request.method.should == :get
+      request.options[:basic_auth].should == basic_auth
+    end
   end
   
-  it 'should only allow specified http methods' do
-    @test.via = "Post"
-    @test.via.should == :post
-    @test.via = :foobar
-    @test.via.should == :get
-  end
-
-  it 'format should be a symbol' do
-    @test.format = "xml"
-    @test.format.class.should == Symbol
+  it 'can convert to a hash' do
+    @test.to_hash.has_key?(:test).should == true
   end
   
-  it 'format should be an allowed format' do
-    @test.format = 'text/json'
-    @test.format.should == :json
-    lambda { @test.format = :foobar }.should raise_error
-  end
   
-  it 'should be able to set Headers' do
-    @test.headers = {'Content-Type' => 'text/html'}
-    @test.headers.should == {'Content-Type' => 'text/html'}
-  end
   
 end

data/spec/weary/response_spec.rb

@@ -25,49 +25,45 @@ describe Weary::Response do
     @test.success?.should == true
   end
   
+  # replace with better mocking method
   it 'should parse JSON' do
     test = Weary::Response.new(mock_response(:get, 200, {'content-type' => 'text/json'}, get_fixture("vimeo.json")), :get)
     test.parse[0]["title"].should == "\"The Noises Rest\""
   end
   
+  # replace with better mocking method
   it 'should parse XML' do
     test = Weary::Response.new(mock_response(:get, 200, {'content-type' => 'text/xml'}, get_fixture("twitter.xml")), :get)
     test.parse.class.should == Hash
     test.parse['statuses'][0]['id'].should == "2186350626"
   end
   
+  # replace with better mocking method
   it 'should parse YAML' do
     test = Weary::Response.new(mock_response(:get, 200, {'content-type' => 'text/yaml'}, get_fixture("github.yml")), :get)
     test.parse.class.should == Hash
     test.parse["repository"][:name].should == "rails"
   end
   
-  it 'should be able to search XML or HTML with Nokogiri' do
-    test = Weary::Response.new(mock_response(:get, 200, {'content-type' => 'text/xml'}, get_fixture("twitter.xml")), :get)
-    test.search("status:first > id").text.should == "2186350626"
-  end
-  
+  # replace with better mocking method
   it 'should use [] to parse the document' do
     test = Weary::Response.new(mock_response(:get, 200, {'content-type' => 'text/xml'}, get_fixture("twitter.xml")), :get).parse
     test['statuses'][0]['id'].should == "2186350626"
   end
   
-  it 'should parse the document to a hash if we try to search a non-XMLish document' do
-    test = Weary::Response.new(mock_response(:get, 200, {'content-type' => 'text/yaml'}, get_fixture("github.yml")), :get)
-    test.search("foo bar").class.should == Hash
-    test.search("foo bar")["repository"][:name].should == "rails"
-  end
-  
+  # replace with better mocking method
   it 'should raise an exception if there was a Server Error' do
     test = Weary::Response.new(mock_response(:get, 500), :get)
     lambda { test.parse }.should raise_error
   end
   
+  # replace with better mocking method
   it 'should raise an exception if there was a Client Error'  do
     test = Weary::Response.new(mock_response(:get, 404), :get)
     lambda { test.parse }.should raise_error
   end
   
+  # replace with better mocking method
   it 'should follow HTTP redirects' do
     test = Weary::Response.new(mock_response(:get, 301), :get)
     test.redirected?.should == true

data/spec/weary_spec.rb

@@ -1,161 +1,4 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe Weary do
-  before do
-    @test = Class.new
-    @test.instance_eval { extend Weary }
-  end
-  
-  describe 'Default Domain' do
-    it 'should be set with a url' do
-      @test.on_domain 'http://twitter.com/'
-      @test.domain.should == 'http://twitter.com/'
-    end
-    
-    it 'should raise an exception when a url is not present' do
-      lambda { @test.on_domain("foobar") }.should raise_error
-    end
-
-    it 'should only take the first url given' do
-      @test.on_domain("with http://google.com/ and http://yahoo.com/")
-      @test.domain.should == "http://google.com/"
-    end
-  end
-  
-  describe 'Default Format' do
-    it 'can be set' do
-      @test.as_format(:xml)
-      @test.instance_variable_get(:@default_format).should == :xml
-    end
-    
-    it 'should be a recognized format' do
-      @test.as_format('text/yaml')
-      @test.on_domain('http://foobar.com/')
-      @test.get('foobar').format.should == :yaml
-    end
-  end
-  
-  describe 'Default URL Pattern' do
-    it 'can be set' do
-      @test.construct_url("<domain><resource>.<format>")
-      @test.instance_variable_defined?(:@url_pattern).should == true
-    end
-
-    it 'should be a string' do
-      @test.construct_url(123)
-      @test.instance_variable_get(:@url_pattern).class.should == String
-    end
-  end
-  
-  describe "Basic Authentication Credentials" do
-    # i want to change this to be more specific about it being
-    # basic authentication
-    it "should accept a username and password" do
-      @test.authenticates_with("foo","bar")
-      @test.instance_variable_get(:@username).should == "foo"
-      @test.instance_variable_get(:@password).should == "bar"
-    end
-  end
-  
-  describe "OAuth" do
-    before do
-      consumer = OAuth::Consumer.new("consumer_token","consumer_secret",{:site => 'http://foo.bar'})
-      @token = OAuth::AccessToken.new(consumer, "token", "secret")
-      @test.oauth @token
-    end
-    
-    it "should accept an OAuth Access Token" do
-      @test.instance_variable_get(:@oauth).should == @token
-      lambda { @test.oauth "foobar" }.should raise_error
-    end
-    it "should notify the Resource that this is using OAuth" do
-      @test.domain "http://foo.bar"
-      r = @test.declare("show")
-      r.oauth?.should == true
-      r.access_token.should == @token
-    end
-    it "should be able to handle tokens set within the resource intelligently" do
-      test = Class.new
-      test.instance_eval { extend Weary }
-      test.domain "http://foo.bar"
-      r = test.declare("show")
-      r.oauth?.should == false
-      r.access_token.should == nil
-      r.oauth = true
-      lambda { test.send(:form_resource, r) }.should raise_error
-      r.access_token = @token
-      r.access_token.should == @token
-      test.send(:form_resource, r)[:show][:oauth].should == true
-      test.send(:form_resource, r)[:show][:access_token].should == @token
-    end
-  end
-  
-  describe "Set Headers" do
-    it "should be a hash of values to pass in the Request head" do
-      @test.on_domain "http://foo.bar"
-      @test.set_headers "Content-Type" => "text/html"
-      r = @test.get "resource"
-      r.headers.should == {"Content-Type"=>'text/html'}
-    end
-  end
-  
-  describe "Common Request Paramaters" do
-    it "should define with params that every resource inherits" do
-      @test.on_domain "http://foo.bar"
-      @test.always_with [:login, :token]
-      r = @test.get "resource"
-      r.with.should == [:login, :token]
-      r.requires = [:foobar]
-      r.with.should == [:login, :token, :foobar]
-    end
-    
-    it "should be able to be a hash" do
-      @test.on_domain "http://foo.bar"
-      @test.always_with :foo => "Foo", :bar => "Bar"
-      r = @test.get "resource"
-      r.with.should == {:foo => "Foo", :bar => "Bar"}
-      r.requires = [:foobar]
-      r.with.should == {:foo => "Foo", :bar => "Bar", :foobar => nil}
-    end
-  end
-  
-  describe 'Resource Declaration' do
-    before do
-      @test.on_domain "http://foobar.com/"
-    end
-    
-    it 'should have a common method for building requests' do
-      block = Proc.new { |r| r.via = :post; r.url = "http://bar.foo/name.json"}
-      test = @test.build_resource('name',:get,block)
-      test.class.should == Weary::Resource
-      test.url.should == "http://bar.foo/name.json"
-      test.via.should == :post
-    end
-    
-    it 'should add a new resource' do
-      @test.get "resource"
-      @test.resources[0].has_key?(:resource).should == true
-    end
-    
-    it 'should instantiate a Resource object' do
-      @test.get("resource").class.should == Weary::Resource
-    end
-    
-    it 'should craft code to be evaluated' do
-      r = @test.get("resource")
-      @test.send(:craft_methods, r).class.should == String
-    end
-    
-    it 'should define new instance methods' do
-      @test.get("resource")
-      @test.public_method_defined?(:resource).should == true
-    end
-    
-    it 'should use sensible default formats' do
-      @test.get("resource").format.should == :json
-      @test.as_format(:xml)
-      @test.post("foo").format.should == :xml
-    end
-  end
-  
 end