svenaas-trim 0.1.2 → 0.1.3

data/README.rdoc

@@ -6,11 +6,24 @@ The trim gem is a wrapper for the tr.im URL shortening service,
 which can be found at http://tr.im/
 
 This software is not affiliated with tr.im in any way. tr.im is 
-a product of The Nambu Network (http://www.nambu.com/).
+a product of The Nambu Network: http://www.nambu.com/.
 
 == Installation
 
-    sudo gem install trim
+First, if you do not already have GitHub in your gem sources, 
+execute the following command to add it:
+
+    sudo gem sources -a http://gems.github.com
+
+Then you can install this gem with:
+  
+    sudo gem install svenaas-trim
+    
+If you prefer not to add GitHub to your gem sources, install via:
+
+    sudo gem install svenaas-trim -s http://gems.github.com 
+    
+Windows users should omit the sudo, of course.
 
 == Usage
 
@@ -18,9 +31,29 @@ a product of The Nambu Network (http://www.nambu.com/).
     
     Trim.trim('http://www.google.com') # Returns trimmed URL, or nil if any error occurs
 
+== Testing
+
+The standard tests run via
+    
+    rake test
+    
+use mock code to verify functionality instead of depending on 
+online interaction with tr.im's servers. This is done for several
+reasons, primarily because the service provider deserves this basic 
+consideration, but also because tr.im limits the number of URLs
+which can be shortened during a particular amount of time. 
+
+If you need to verify online functionality you can run 
+
+    rake test:online
+    
+for simple-case testing that the servers are reachable via the
+expected address and API. Please note that this test consumes
+online resources, and use it sparingly. 
+
 == License
 
-Copyright (c) 2009 Sven Aas (mailto:sven.aas@gmail.com)
+Copyright (c) 2009 Sven Aas
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/Rakefile

@@ -29,7 +29,13 @@ end
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList.new("test/**/*_test.rb") { |fl| fl.exclude /online/ }
+  t.verbose = true
+end
+
+Rake::TestTask.new("test:online") do |t|
+  t.libs << 'test'
+  t.test_files = FileList.new("test/**/online_*_test.rb") 
   t.verbose = true
 end
 

data/lib/trim/version.rb

@@ -3,7 +3,7 @@ module Trim
     
     MAJOR = 0
     MINOR = 1
-    TINY  = 2
+    TINY  = 3
     
     def self.to_s # :nodoc:
       [MAJOR, MINOR, TINY].join('.')

data/test/unit/online_trim_test.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require 'net/http'
+require 'uri'
+
+
+class TrimTest < Test::Unit::TestCase
+
+	context "A valid URL" do
+		
+		setup do
+			@long_url = 'http://www.google.com/'
+		end
+		
+		context "An online trim_simple request" do  	
+			should "provide a working shortened URL" do 
+				trimmed_url = Trim.trim_simple @long_url
+				response = Net::HTTP.get_response(URI.parse(trimmed_url))
+				assert response.kind_of?(Net::HTTPRedirection)
+				assert_equal @long_url, response['location']
+			end
+		end
+		
+		context "An online trim_url request" do  	
+			should "provide a working shortened URL" do 
+				trimmed_url = Trim.trim_url @long_url
+				response = Net::HTTP.get_response(URI.parse(trimmed_url))
+				assert response.kind_of?(Net::HTTPRedirection)
+				assert_equal @long_url, response['location']
+			end
+		end
+		
+  end
+
+end

data/test/unit/trim_test.rb

@@ -1,10 +1,10 @@
 require File.dirname(__FILE__) + '/../test_helper'
-require 'net/http'
-require 'uri'
-
+require 'mocha'
 
 class TrimTest < Test::Unit::TestCase
 
+	VALID_SHORTENED_URL = "http://tr.im/OK"
+	
 	context "A valid URL" do
 		
 		setup do
@@ -13,88 +13,90 @@ class TrimTest < Test::Unit::TestCase
 		
 		context "A trim_simple request" do  	
 			should "provide a working shortened URL" do 
+			  Trim.expects(:trim_simple).with(@long_url).returns(VALID_SHORTENED_URL)
 				trimmed_url = Trim.trim_simple @long_url
-				response = Net::HTTP.get_response(URI.parse(trimmed_url))
-				assert response.kind_of?(Net::HTTPRedirection)
-				assert_equal @long_url, response['location']
-			end
-		end
-		
-		context "A trim_url request" do  	
-			should "provide a working shortened URL" do 
-				trimmed_url = Trim.trim_url @long_url
-				response = Net::HTTP.get_response(URI.parse(trimmed_url))
-				assert response.kind_of?(Net::HTTPRedirection)
-				assert_equal @long_url, response['location']
+				assert_equal VALID_SHORTENED_URL, trimmed_url 
 			end
 		end
 		
+    context "A trim_url request" do    
+      should "provide a working shortened URL" do 
+			  Trim.expects(:trim_url).with(@long_url).returns(VALID_SHORTENED_URL)
+        trimmed_url = Trim.trim_url @long_url
+        assert_equal VALID_SHORTENED_URL, trimmed_url 
+      end
+    end
+    
   end
-
-	context "An invalid URL" do
-		
-		setup do
-  		@long_url = 'www'
-  	end
-	
-	  context "A trim_simple request" do	  	
-			should "return nil" do 
-				trimmed_url = Trim.trim @long_url
-				assert_nil trimmed_url
-			end
-		end
-
-	  context "A trim_url request" do	  	
-			should "return nil" do 
-				trimmed_url = Trim.trim @long_url
-				assert_nil trimmed_url
-			end
-		end
-
-  end
-
-	context "An empty URL" do
-		
-		setup do
-  		@long_url = ''
-  	end
-	
-	  context "A trim_simple request" do	  	
-			should "return nil" do 
-				trimmed_url = Trim.trim @long_url
-				assert_nil trimmed_url
-			end
-		end
-
-	  context "A trim_url request" do	  	
-			should "return nil" do 
-				trimmed_url = Trim.trim @long_url
-				assert_nil trimmed_url
-			end
-		end
-
-  end
-
-	context "A nil URL" do
-		
-		setup do
-  		@long_url = nil
-  	end
-	
-	  context "A trim_simple request" do	  	
-			should "return nil" do 
-				trimmed_url = Trim.trim @long_url
-				assert_nil trimmed_url
-			end
-		end
-
-	  context "A trim_url request" do	  	
-			should "return nil" do 
-				trimmed_url = Trim.trim @long_url
-				assert_nil trimmed_url
-			end
-		end
-
+   
+  context "An invalid URL" do
+     
+    setup do
+      @long_url = 'www'
+    end
+  
+    context "A trim_simple request" do      
+      should "return nil" do 
+        Trim.expects(:trim_simple).with(@long_url).returns(nil)
+        trimmed_url = Trim.trim_simple @long_url
+        assert_nil trimmed_url
+      end
+    end
+  
+    context "A trim_url request" do      
+      should "return nil" do 
+        Trim.expects(:trim_url).with(@long_url).returns(nil)
+        trimmed_url = Trim.trim_url @long_url
+        assert_nil trimmed_url
+      end
+    end
+  
+    end
+  
+  context "An empty URL" do
+    
+    setup do
+        @long_url = ''
+      end
+  
+    context "A trim_simple request" do      
+      should "return nil" do 
+        Trim.expects(:trim_simple).with('').returns(nil)
+        trimmed_url = Trim.trim_simple @long_url
+        assert_nil trimmed_url
+      end
+    end
+  
+    context "A trim_url request" do      
+      should "return nil" do 
+        Trim.expects(:trim_url).with('').returns(nil)
+        trimmed_url = Trim.trim_url @long_url
+        assert_nil trimmed_url
+      end
+    end
+  
+    end
+  
+  context "A nil URL" do
+    
+    setup do
+        @long_url = nil
+      end
+  
+    context "A trim_simple request" do      
+      should "return nil" do 
+        trimmed_url = Trim.trim @long_url
+        assert_nil trimmed_url
+      end
+    end
+  
+    context "A trim_url request" do      
+      should "return nil" do 
+        trimmed_url = Trim.trim @long_url
+        assert_nil trimmed_url
+      end
+    end
+  
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: svenaas-trim
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Sven Aas
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-02 00:00:00 -08:00
+date: 2009-03-03 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -38,6 +38,7 @@ files:
 - lib/trim.rb
 - test/test_helper.rb
 - test/unit
+- test/unit/online_trim_test.rb
 - test/unit/trim_test.rb
 has_rdoc: true
 homepage: http://github.com/svenaas/trim/