puny 1.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ruben Fonseca
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,32 @@
+= puny
+
+puny is a Ruby library for the URL shortener service created by SAPO
+
+The puny URL service is available at http://puny.sapo.pt and
+it's API at http://services.sapo.pt/Metadata/Service/PunyURL?culture=EN
+
+The code is a translation of the Python library wrote by Celso Pinto 
+and available at http://github.com/cpinto/punypie/tree/master
+
+== Features
+
+* shortens and expands URLs
+* no external dependencies
+* Ruby 1.8, 1.9 and JRuby compatible
+
+== Install
+
+$ gem sources -a http://gems.github.com
+$ sudo gem install rubenfonseca-puny
+
+== Example
+
+  require 'puny'
+  puny = Puny.shorten('http://developers.sapo.pt')
+  puts puny.puny # see PunyURL for aditional properties
+  
+  puts Puny.expand(puny.puny) # returns the original URL
+
+== Copyright
+
+Copyright (c) 2009 Ruben Fonseca. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 1
+:minor: 1
+:patch: 0

data/lib/puny.rb

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+# vim:tabstop=4:expandtab:sw=4:softtabstop=4
+
+require 'rexml/document'
+require 'open-uri'
+require 'cgi'
+
+# == PunyURL
+# 
+# Object that holds the different URLs available on a Puny response
+# 
+class PunyURL
+  attr_accessor :puny, :ascii, :preview, :url
+end
+
+# == Puny
+#
+# Holds the methods available on the Puny API
+#
+# (see http://services.sapo.pt/Metadata/Service/PunyURL?culture=EN)
+#
+class Puny
+  TO_PUNY   = 'http://services.sapo.pt/PunyURL/GetCompressedURLByURL'
+  FROM_PUNY = 'http://services.sapo.pt/PunyURL/GetURLByCompressedURL'
+  
+  # Shortens a URL
+  #
+  # Returns a PunyURL instance with the shortened version of the URL,
+  # or <tt>nil</tt> if there was an error
+  #
+  # Example:
+  #   
+  #   require 'puny'
+  #   puny = Puny.shorten('http://developers.sapo.pt')
+  #   puts puny.puny
+  #   puts puny.url
+  #
+  def self.shorten(url)
+    url = TO_PUNY + '?url=' + CGI.escape(url)
+    _process_response(open(url))
+  end
+  
+  # Expands a puny URL to the original URL
+  #
+  # Returns a String instance with the original URL or <tt>nil</tt>
+  # if there was an error
+  #
+  # Example:
+  #   
+  #   require 'puny'
+  #   puts Puny.expand('http://b.ot.sl.pt')
+  #
+  def self.expand(url)
+    url = FROM_PUNY + '?url=' + CGI.escape(url)
+    p = _process_response(open(url))
+    p.url
+  end
+  
+  private
+
+  # Private method to parse SAPO's WS responses
+  def self._process_response(body)
+    doc = REXML::Document.new(body).root
+    
+    begin
+      puny_url = PunyURL.new
+      puny_url.url     = doc.elements['url'].text
+      puny_url.ascii   = doc.elements['ascii'].text
+      puny_url.preview = doc.elements['preview'].text
+      puny_url.puny    = doc.elements['puny'].text
+    
+      return puny_url
+    rescue
+      nil
+    end
+  end
+end

data/test/puny_test.rb

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+# vim:tabstop=4:expandtab:sw=4:softtabstop=4
+
+require 'test_helper'
+
+class PunyTest < Test::Unit::TestCase
+  def test_to_puny_response_handling
+    puny = Puny._process_response('<?xml version="1.0" encoding="utf-8"?>
+    <punyURL xmlns="http://services.sapo.pt/Metadata/PunyURL">
+        <puny>http://漭.sl.pt</puny>
+        <ascii>http://b.ot.sl.pt</ascii>
+        <preview>http://b.ot.sl.pt/-</preview>
+        <url><![CDATA[http://developers.sapo.pt/]]></url>
+    </punyURL>')
+    
+    assert_equal puny.puny, 'http://漭.sl.pt'
+    assert_equal puny.ascii, 'http://b.ot.sl.pt'
+    assert_equal puny.preview, 'http://b.ot.sl.pt/-'
+    assert_equal puny.url, 'http://developers.sapo.pt/'
+  end
+  
+  def test_from_puny_response_handling
+    puny = Puny._process_response('<?xml version="1.0" encoding="utf-8"?>
+    <punyURL xmlns="http://services.sapo.pt/Metadata/PunyURL">
+        <puny>http://漭.sl.pt</puny>
+        <ascii>http://b.ot.sl.pt</ascii>
+        <preview>http://b.ot.sl.pt/-</preview>
+        <url><![CDATA[http://developers.sapo.pt/]]></url>
+    </punyURL>')
+    
+    assert_equal puny.url, 'http://developers.sapo.pt/'
+  end
+  
+  def test_remote_puny_shorten
+    puny = Puny.shorten('http://developers.sapo.pt/')
+    
+    assert_equal puny.puny, 'http://漭.sl.pt'
+    assert_equal puny.ascii, 'http://b.ot.sl.pt'
+    assert_equal puny.preview, 'http://b.ot.sl.pt/-'
+    assert_equal puny.url, 'http://developers.sapo.pt/'
+  end
+  
+  def test_remote_puny_expand
+    assert_equal Puny.expand('http://漭.sl.pt'), 'http://developers.sapo.pt/'
+    assert_equal Puny.expand('http://b.ot.sl.pt'), 'http://developers.sapo.pt/'
+  end
+  
+  def test_smoke
+    assert_equal 100.times { Puny.shorten('http://developers.sapo.pt') }, 100
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'puny'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: puny
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+platform: ruby
+authors: 
+- Ruben Fonseca
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-16 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: root@cpan.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/puny.rb
+- test/puny_test.rb
+- test/test_helper.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/rubenfonseca/puny
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Ruby library for the URL shortener service created by SAPO
+test_files: []
+