RubyGems - shorturl - Versions diffs - 0.3.0 → 0.4.0 - Mend

shorturl 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

data/ChangeLog +6 -0
data/README +1 -0
data/TODO +0 -1
data/doc/classes/InvalidService.html +111 -0
data/doc/classes/Service.html +26 -26
data/doc/classes/ShortURL.html +15 -12
data/doc/created.rid +1 -1
data/doc/files/ChangeLog.html +11 -1
data/doc/files/README.html +4 -1
data/doc/files/TODO.html +1 -5
data/doc/files/lib/shorturl_rb.html +1 -1
data/doc/fr_class_index.html +1 -0
data/examples/shorten.rb +27 -0
data/lib/shorturl.rb +16 -5
data/test/tc_service.rb +10 -1
data/test/tc_shorturl.rb +2 -1
metadata +4 -2

data/ChangeLog CHANGED Viewed

@@ -1,3 +1,9 @@
+0.4.0:
+	- Added minilink.org
+	- More tests for the Service class
+	- Changed the ArgumentError exception for an InvalidService exception in ShortURL.shorten
+	- Created examples/shorten.rb
+	- Added a stats task to the Rakefile.  Requires code_statistics, provided by Rails.
 0.3.0:
 	- Added linktrim.com and shorterlink.com
 	- Replaced get_short_url and all the private class methods in favor of a Service class, which makes things clearer

data/README CHANGED Viewed

@@ -27,6 +27,7 @@ The second parameter represents the service you want to use.  These are:
 - <tt>:skinnylink</tt>
 - <tt>:linktrim</tt>
 - <tt>:shorterlink</tt>
+- <tt>:minilink</tt>
 Note that you can use <tt>ShortURL.valid_services</tt> to obtain a
 list of the valid services (in case I forget to update the

data/TODO CHANGED Viewed

@@ -1,4 +1,3 @@
 = Todo
-* Make services an instance of a Service class
 * Check out WWW::Mecanize

data/doc/classes/InvalidService.html ADDED Viewed

@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: InvalidService</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">InvalidService</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/shorturl_rb.html">
+                lib/shorturl.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Exception
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/classes/Service.html CHANGED Viewed

@@ -167,20 +167,20 @@ long URL and the block of what to do with the HTML code you get.
             onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000003-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/shorturl.rb, line 18</span>
-18:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">hostname</span>) <span class="ruby-comment cmt"># :yield: service</span>
-19:     <span class="ruby-ivar">@hostname</span> = <span class="ruby-identifier">hostname</span>
-20:     <span class="ruby-ivar">@port</span> = <span class="ruby-value">80</span>
-21:     <span class="ruby-ivar">@code</span> = <span class="ruby-value">200</span>
-22:     <span class="ruby-ivar">@method</span> = <span class="ruby-identifier">:post</span>
-23:     <span class="ruby-ivar">@action</span> = <span class="ruby-value str">&quot;/&quot;</span>
-24:     <span class="ruby-ivar">@field</span> = <span class="ruby-value str">&quot;url&quot;</span>
-25:     <span class="ruby-ivar">@block</span> = <span class="ruby-identifier">lambda</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">body</span><span class="ruby-operator">|</span> }
-26:
-27:     <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
-28:       <span class="ruby-keyword kw">yield</span> <span class="ruby-keyword kw">self</span>
-29:     <span class="ruby-keyword kw">end</span>
-30:   <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/shorturl.rb, line 21</span>
+21:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">hostname</span>) <span class="ruby-comment cmt"># :yield: service</span>
+22:     <span class="ruby-ivar">@hostname</span> = <span class="ruby-identifier">hostname</span>
+23:     <span class="ruby-ivar">@port</span> = <span class="ruby-value">80</span>
+24:     <span class="ruby-ivar">@code</span> = <span class="ruby-value">200</span>
+25:     <span class="ruby-ivar">@method</span> = <span class="ruby-identifier">:post</span>
+26:     <span class="ruby-ivar">@action</span> = <span class="ruby-value str">&quot;/&quot;</span>
+27:     <span class="ruby-ivar">@field</span> = <span class="ruby-value str">&quot;url&quot;</span>
+28:     <span class="ruby-ivar">@block</span> = <span class="ruby-identifier">lambda</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">body</span><span class="ruby-operator">|</span> }
+29:
+30:     <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
+31:       <span class="ruby-keyword kw">yield</span> <span class="ruby-keyword kw">self</span>
+32:     <span class="ruby-keyword kw">end</span>
+33:   <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
@@ -206,18 +206,18 @@ Now that our service is set up, call it with all the parameters to
             onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000004-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/shorturl.rb, line 34</span>
-34:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">call</span>(<span class="ruby-identifier">url</span>)
-35:     <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">start</span>(<span class="ruby-ivar">@hostname</span>, <span class="ruby-ivar">@port</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">http</span><span class="ruby-operator">|</span>
-36:       <span class="ruby-identifier">response</span> = <span class="ruby-keyword kw">case</span> <span class="ruby-ivar">@method</span>
-37:                  <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:post</span><span class="ruby-operator">:</span> <span class="ruby-identifier">http</span>.<span class="ruby-identifier">send</span>(<span class="ruby-ivar">@method</span>, <span class="ruby-ivar">@action</span>, <span class="ruby-node">&quot;#@field=#{url}&quot;</span>)
-38:                  <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:get</span><span class="ruby-operator">:</span> <span class="ruby-identifier">http</span>.<span class="ruby-identifier">send</span>(<span class="ruby-ivar">@method</span>, <span class="ruby-node">&quot;#@action?#@field=#{CGI.escape(url)}&quot;</span>)
-39:                  <span class="ruby-keyword kw">end</span>
-40:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span> <span class="ruby-operator">==</span> <span class="ruby-ivar">@code</span>.<span class="ruby-identifier">to_s</span>
-41:         <span class="ruby-ivar">@block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">response</span>.<span class="ruby-identifier">read_body</span>)
-42:       <span class="ruby-keyword kw">end</span>
-43:     }
-44:   <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/shorturl.rb, line 37</span>
+37:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">call</span>(<span class="ruby-identifier">url</span>)
+38:     <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">start</span>(<span class="ruby-ivar">@hostname</span>, <span class="ruby-ivar">@port</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">http</span><span class="ruby-operator">|</span>
+39:       <span class="ruby-identifier">response</span> = <span class="ruby-keyword kw">case</span> <span class="ruby-ivar">@method</span>
+40:                  <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:post</span><span class="ruby-operator">:</span> <span class="ruby-identifier">http</span>.<span class="ruby-identifier">send</span>(<span class="ruby-ivar">@method</span>, <span class="ruby-ivar">@action</span>, <span class="ruby-node">&quot;#@field=#{url}&quot;</span>)
+41:                  <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:get</span><span class="ruby-operator">:</span> <span class="ruby-identifier">http</span>.<span class="ruby-identifier">send</span>(<span class="ruby-ivar">@method</span>, <span class="ruby-node">&quot;#@action?#@field=#{CGI.escape(url)}&quot;</span>)
+42:                  <span class="ruby-keyword kw">end</span>
+43:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span> <span class="ruby-operator">==</span> <span class="ruby-ivar">@code</span>.<span class="ruby-identifier">to_s</span>
+44:         <span class="ruby-ivar">@block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">response</span>.<span class="ruby-identifier">read_body</span>)
+45:       <span class="ruby-keyword kw">end</span>
+46:     }
+47:   <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>

data/doc/classes/ShortURL.html CHANGED Viewed

@@ -155,6 +155,9 @@ Valid <tt>service</tt> values:
 </li>
 <li><tt>:shorterlink</tt>
+</li>
+<li><tt>:minlink</tt>
 </li>
 </ul>
 <p>
@@ -168,14 +171,14 @@ call-seq:
             onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000002-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/shorturl.rb, line 137</span>
-137:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">shorten</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">service</span> = <span class="ruby-identifier">:rubyurl</span>)
-138:     <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@@valid_services</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">service</span>
-139:       <span class="ruby-ivar">@@services</span>[<span class="ruby-identifier">service</span>].<span class="ruby-identifier">call</span>(<span class="ruby-identifier">url</span>)
-140:     <span class="ruby-keyword kw">else</span>
-141:       <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;Invalid service&quot;</span>
-142:     <span class="ruby-keyword kw">end</span>
-143:   <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/shorturl.rb, line 148</span>
+148:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">shorten</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">service</span> = <span class="ruby-identifier">:rubyurl</span>)
+149:     <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@@valid_services</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">service</span>
+150:       <span class="ruby-ivar">@@services</span>[<span class="ruby-identifier">service</span>].<span class="ruby-identifier">call</span>(<span class="ruby-identifier">url</span>)
+151:     <span class="ruby-keyword kw">else</span>
+152:       <span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidService</span>
+153:     <span class="ruby-keyword kw">end</span>
+154:   <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
@@ -198,10 +201,10 @@ Returns @@<a href="ShortURL.html#M000001">valid_services</a>
             onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000001-source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/shorturl.rb, line 113</span>
-113:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">valid_services</span>
-114:     <span class="ruby-ivar">@@valid_services</span>
-115:   <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/shorturl.rb, line 123</span>
+123:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">valid_services</span>
+124:     <span class="ruby-ivar">@@valid_services</span>
+125:   <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>

data/doc/created.rid CHANGED Viewed

	@@ -1 +1 @@
1	- ~~Sun~~ Jun 05 15:37:07 EDT 2005
1	+ Tue Jun 07 15:30:52 EDT 2005

data/doc/files/ChangeLog.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Sun Jun 05 15:31:15 EDT 2005</td>
+      <td>Tue Jun 07 15:30:33 EDT 2005</td>
     </tr>
     </table>
   </div>
@@ -70,6 +70,16 @@
     <div id="description">
       <p>
+0.4.0:
+</p>
+<pre>
+        - Added minilink.org
+        - More tests for the Service class
+        - Changed the ArgumentError exception for an InvalidService exception in ShortURL.shorten
+        - Created examples/shorten.rb
+        - Added a stats task to the Rakefile.  Requires code_statistics, provided by Rails.
+</pre>
+<p>
 0.3.0:
 </p>
 <pre>

data/doc/files/README.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Sun Jun 05 15:37:02 EDT 2005</td>
+      <td>Tue Jun 07 01:17:24 EDT 2005</td>
     </tr>
     </table>
   </div>
@@ -124,6 +124,9 @@ The second parameter represents the service you want to use. These are:
 </li>
 <li><tt>:shorterlink</tt>
+</li>
+<li><tt>:minilink</tt>
 </li>
 </ul>
 <p>

data/doc/files/TODO.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Sat Jun 04 23:12:24 EDT 2005</td>
+      <td>Sun Jun 05 23:59:51 EDT 2005</td>
     </tr>
     </table>
   </div>
@@ -71,10 +71,6 @@
     <div id="description">
       <h1>Todo</h1>
 <ul>
-<li>Make services an instance of a <a
-href="../classes/Service.html">Service</a> class
-</li>
 <li>Check out WWW::Mecanize
 </li>

data/doc/files/lib/shorturl_rb.html CHANGED Viewed

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Sun Jun 05 15:32:04 EDT 2005</td>
+      <td>Tue Jun 07 15:20:28 EDT 2005</td>
     </tr>
     </table>
   </div>

data/doc/fr_class_index.html CHANGED Viewed

@@ -20,6 +20,7 @@
 <div id="index">
   <h1 class="section-bar">Classes</h1>
   <div id="index-entries">
+    <a href="classes/InvalidService.html">InvalidService</a><br />
     <a href="classes/Service.html">Service</a><br />
     <a href="classes/ShortURL.html">ShortURL</a><br />
   </div>

data/examples/shorten.rb ADDED Viewed

@@ -0,0 +1,27 @@
+require "rubygems"
+require "shorturl"
+def usage
+  puts "Usage: #$0 <url> [<service>]"
+  puts "Valid services:"
+  ShortURL.valid_services.map { |s| s.to_s }.sort.each { |s| puts "\t#{s}" }
+end
+def main
+  begin
+    case ARGV.length
+    when 0: usage
+    when 1: puts ShortURL.shorten(ARGV[0])
+    else puts ShortURL.shorten(ARGV[0], ARGV[1].to_sym)
+    end
+  rescue InvalidService
+    puts "Invalid service"
+    usage
+  end
+end
+if $0 == __FILE__
+  main
+end

data/lib/shorturl.rb CHANGED Viewed

@@ -7,6 +7,9 @@ require "net/http"
 require "cgi"
 require "uri"
+class InvalidService < Exception
+end
 class Service
   attr_accessor :port, :code, :method, :action, :field, :block
@@ -45,7 +48,11 @@ class Service
 end
 class ShortURL
+  # Hash table of all the supported services.  The key is a symbol
+  # representing the service (usually the hostname minus the .com,
+  # .net, etc.)  The value is an instance of Service with all the
+  # parameters set so that when +instance+.call is invoked, the
+  # shortened URL is returned.
   @@services = {
     :rubyurl => Service.new("rubyurl.com") { |s|
       s.code = 302
@@ -79,9 +86,7 @@ class ShortURL
     :metamark => Service.new("metamark.net") { |s|
       s.action = "/add"
       s.field = "long_url"
-      s.block = lambda { |body|
-        URI.extract(body).grep(/xrl.us/)[0]
-      }
+      s.block = lambda { |body| URI.extract(body).grep(/xrl.us/)[0] }
     },
     :makeashorterlink => Service.new("makeashorterlink.com") { |s|
@@ -103,6 +108,11 @@ class ShortURL
       s.method = :get
       s.action = "/add_url.html"
       s.block = lambda { |body| URI.extract(body).grep(/shorterlink/)[0] }
+    },
+    :minilink => Service.new("minilink.org") { |s|
+      s.method = :get
+      s.block = lambda { |body| URI.extract(body)[-1] }
     }
   }
   # Array containing symbols representing all the implemented URL
@@ -130,6 +140,7 @@ class ShortURL
   # * <tt>:skinnylink</tt>
   # * <tt>:linktrim</tt>
   # * <tt>:shorterlink</tt>
+  # * <tt>:minlink</tt>
   #
   # call-seq:
   #   ShortURL.shorten("http://mypage.com") => Uses RubyURL
@@ -138,7 +149,7 @@ class ShortURL
     if @@valid_services.include? service
       @@services[service].call(url)
     else
-      raise ArgumentError, "Invalid service"
+      raise InvalidService
     end
   end
 end

data/test/tc_service.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-# tc_ervicerb
+# tc_service.rb
 #
 #   Created by Vincent Foley on 2005-06-01
@@ -14,6 +14,15 @@ class TestService < Test::Unit::TestCase
   def test_call
     service = Service.new("oasdasobf")
     assert_raise(SocketError) { service.call(nil) }
+    service = Service.new("tinyurl.com") { |s|
+      s.code = 404
+      s.action = "/create.php"
+      s.block = lambda { |body|
+        URI.extract(body).grep(/tinyurl/)[-1]
+      }
+    }
+    assert_nil service.call("http://www.google.com")
   end
   def test_initialize

data/test/tc_shorturl.rb CHANGED Viewed

@@ -25,7 +25,8 @@ class TestShortURL < Test::Unit::TestCase
     assert ShortURL.shorten(@url, :skinnylink) == "http://skinnylink.com?nqvcce"
     assert ShortURL.shorten(@url, :linktrim) =~ /http:\/\/linktrim/ # Never the same URL
     assert ShortURL.shorten(@url, :shorterlink) == "http://shorterlink.com/?PQD096"
+    assert ShortURL.shorten(@url, :minilink) == "http://lnk.nu/darkhost.mine.nu:81/2zr.html"
-    assert_raise(ArgumentError) { ShortURL.shorten(@url, :foobar) }
+    assert_raise(InvalidService) { ShortURL.shorten(@url, :foobar) }
   end
 end

metadata CHANGED Viewed

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: shorturl
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-date: 2005-06-05
+  version: 0.4.0
+date: 2005-06-07
 summary: Shortens URLs using services such as TinyURL and RubyURL
 require_paths:
   - lib
@@ -36,6 +36,7 @@ files:
   - doc/fr_method_index.html
   - doc/index.html
   - doc/rdoc-style.css
+  - doc/classes/InvalidService.html
   - doc/classes/Service.html
   - doc/classes/ShortURL.html
   - doc/files/ChangeLog.html
@@ -47,6 +48,7 @@ files:
   - test/tc_service.rb
   - test/tc_shorturl.rb
   - test/ts_all.rb
+  - examples/shorten.rb
   - README
   - TODO
   - MIT-LICENSE