svenaas-trim 0.1.3 → 0.2.0

data/README.rdoc

@@ -30,6 +30,14 @@ Windows users should omit the sudo, of course.
     require 'trim'
     
     Trim.trim('http://www.google.com') # Returns trimmed URL, or nil if any error occurs
+    
+If you want to use an account that tr.im knows about you can provide 
+your valid username and password:
+    
+    Trim.trim('http://www.google.com', 'username', 'password')
+
+NOTE: as of this writing (3 Mar 2009) tr.im does not support SSL so 
+this username and password will be sent over unencrypted HTTP.
 
 == Testing
 

data/lib/trim.rb

@@ -7,12 +7,10 @@ require 'libxml'
 module Trim
 
 	# 
-	# Alias for Trim::trim_simple
+	# Alias for #Trim::trim_simple
 	#
-	def Trim::trim(url)
-		response = nil
-	  open("http://api.tr.im/api/trim_simple?url=#{url}") {|http| response = http.read }
-	  response.strip!.size > 0 ? response : nil
+	def Trim::trim(url, username = nil, password = nil)		
+	  trim_simple(url, username, password)	  
   end
 
   #  
@@ -20,11 +18,22 @@ module Trim
 	#
 	#   trimmed_url = Trim.trim_simple('http://sample.com/some/long/url')
 	#
-	# Utilizes the tr.im API method trim_simple
+	# If a +username+ and +password+ are provided they will be passed to tr.im
+	# for authentication. NOTE: as of this writing (3 Mar 2009) tr.im does 
+	# not support SSL so this username and password will be sent over
+	# unencrypted HTTP.
+	# 
+	# If the username and password provided are not valid, tr.tim will still
+	# generate a shortened URL, but will do so as if no username and password
+	# were provided. The account credentials can be verified with #Trim::valid_account?
+	#
+	# This method utilizes the tr.im API method trim_simple
 	#	
-	def Trim::trim_simple(url)
+	def Trim::trim_simple(url, username = nil, password = nil)
 		response = nil
-	  open("http://api.tr.im/api/trim_simple?url=#{url}") {|http| response = http.read }
+		request_url = "http://api.tr.im/api/trim_simple?url=#{url}"
+		request_url += "&username=#{username}&password=#{password}" if (username and password)
+	  open(request_url) {|http| response = http.read }
 	  response.strip!.size > 0 ? response : nil
   end
 
@@ -32,14 +41,44 @@ module Trim
 	# Returns a trimmed URL based on +url+, or nil if any error occurs.
 	#
 	#   trimmed_url = Trim.trim_url('http://sample.com/some/long/url')
+	#
+	# If a +username+ and +password+ are provided they will be passed to tr.im
+	# for authentication. NOTE: as of this writing (3 Mar 2009) tr.im does 
+	# not support SSL so this username and password will be sent over
+	# unencrypted HTTP.
+	# 
+	# If the username and password provided are not valid, tr.tim will still
+	# generate a shortened URL, but will do so as if no username and password
+	# were provided. The account credentials can be verified with #Trim::valid_account?
 	#	
 	# Utilizes the tr.im API method trim_url.xml
 	#
-	def Trim::trim_url(url)
+	def Trim::trim_url(url, username = nil, password = nil)
 		xml_response = nil
-	  open("http://api.tr.im/api/trim_url.xml?url=#{url}") {|http| xml_response = http.read }
+		request_url = "http://api.tr.im/api/trim_url.xml?url=#{url}"
+		request_url += "&username=#{username}&password=#{password}" if (username and password)
+	  open(request_url) {|http| xml_response = http.read }
 		get_url_from_xml_response(xml_response)
   end
+  
+  #  
+	# Verifies that the provided +username+ and +password+ successfully 
+	# validate as an account known to tr.im
+	#
+	#   is_valid_account = Trim.valid_account?('good_username', 'good_password')
+	#
+	# NOTE: as of this writing (3 Mar 2009) tr.im does not support SSL so this 
+	# username and password will be sent over unencrypted HTTP.
+	# 
+	# Utilizes the tr.im API method verify.xml
+	#  
+  def Trim::valid_account?(username, password)
+		xml_response = nil
+		request_url = "http://api.tr.im/api/verify.xml?username=#{username}&password=#{password}"
+	  open(request_url) {|http| xml_response = http.read }
+    status_code = get_status_code_from_xml_response(xml_response)
+    "200" == status_code
+  end
 
 private  
 	def Trim::get_url_from_xml_response(xml_response)
@@ -47,4 +86,9 @@ private
     urls = parser.parse.find('url')
     urls.size > 0 ? urls.first.content : nil
 	end  
+	
+	def Trim::get_status_code_from_xml_response(xml_response)	
+    parser = LibXML::XML::Parser.string xml_response
+    status = parser.parse.root.attributes['code']      
+	end 
 end

data/lib/trim/version.rb

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

data/test/unit/trim_test.rb

@@ -4,99 +4,142 @@ require 'mocha'
 class TrimTest < Test::Unit::TestCase
 
 	VALID_SHORTENED_URL = "http://tr.im/OK"
-	
-	context "A valid URL" do
-		
-		setup do
-			@long_url = 'http://www.google.com/'
-		end
-		
-		context "A trim_simple request" do  	
+
+  context "With a valid account" do    
+    setup do
+      @username = 'user'
+      @password = 'pass'
+      @long_url = 'http://www.google.com/'
+    end
+
+    context "account verification" do
+      should "succeed" do 
+        Trim.expects(:valid_account?).with(@username, @password).returns(true)
+        assert Trim.valid_account?(@username, @password)
+      end
+    end        
+    
+    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
+			  Trim.expects(:trim_simple).with(@long_url, @username, @password).returns(VALID_SHORTENED_URL)
+				trimmed_url = Trim.trim_simple @long_url, @username, @password
 				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
-     
+    context "a trim_url request" do 
+			should "provide a working shortened URL" do 
+			  Trim.expects(:trim_url).with(@long_url, @username, @password).returns(VALID_SHORTENED_URL)
+				trimmed_url = Trim.trim_url @long_url, @username, @password
+				assert_equal VALID_SHORTENED_URL, trimmed_url 
+			end
+		end		
+  end      
+
+  context "With an invalid account" do    
     setup do
-      @long_url = 'www'
+      @username = 'baduser'
+      @password = 'badpass'
     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
+
+    context "account verification" do
+      should "fail" do 
+        Trim.expects(:valid_account?).with(@username, @password).returns(false)
+        assert ! Trim.valid_account?(@username, @password)
       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
+	
+	context "Anonymously" do	  	  
+  	context "using a valid URL" do  		
+  		setup do
+  			@long_url = 'http://www.google.com/'
+  		end
+  		
+  		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
+  				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 "using 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
+    context "using 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
+    
+      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
-    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
+    
+      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
-  
-    end
-  
-  context "A nil URL" do
     
-    setup do
+    context "using 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
+    
+      context "a trim_simple request" do      
+        should "return nil" do 
+          Trim.expects(:trim_simple).with(nil).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(nil).returns(nil)
+          trimmed_url = Trim.trim_url @long_url
+          assert_nil trimmed_url
+        end
+      end    
     end
-  
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: svenaas-trim
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors: 
 - Sven Aas