recortas 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+doc/**
+pkg/**

data/README.markdown

@@ -0,0 +1,39 @@
+# recortas A ruby wrapper for the [cort.as](http://cort.as) service
+
+recortas is a basic ruby wrapper for the [soitu.es](http://soitu.es/) [cort.as](http://cort.as/) service.
+
+Currently only have two methods: one for decoding and one for encoding an URI. Support for statistics is planned
+
+## Usage
+
+To use recortas you only have to require it in your script
+
+    require 'rubygems'
+    require 'recortas'
+
+**Encoding an URI**
+
+    Recortas.encode(uri)
+
+Returns a string with the shortened URI. Raises CortasError if the +uri+ cannot be shortened
+
+    begin
+      short = Recortas.encode('blalal')
+    rescue CortasError => e
+      puts e  # Error returned from cort.as service
+    end
+
+**Decoding an existing URI**
+    
+    Recortas.decode(uri)
+
+Returns a string with the original URI. The uri parameter must be a valid cort.as uri (i.e. must start with 'http://cort.as')
+
+If an error occurs, an exception of class CortasError is raised.
+
+    begin
+      Recortas.decode('http://www.google.com')
+    rescue CortasError => e
+      puts e # Not a valid cort.as URI
+    end
+

data/Rakefile

@@ -0,0 +1,15 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "recortas"
+    gemspec.version = "0.1.0"
+    gemspec.summary = "A ruby wrapper for the http://cort.as service"
+    gemspec.description = "A ruby wrapper for the http://cort.as service"
+    gemspec.email = "antarticonorte@gmail.com"
+    gemspec.homepage = "http://github.com/afgomez/recortas"
+    gemspec.authors = ["Alejandro Fernández"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/lib/recortas.rb

@@ -0,0 +1,111 @@
+# = recortas A ruby wrapper for the http://cort.as service
+#
+# recortas is a basic ruby wrapper for the http://soitu.es http://cort.as service.
+#
+# Currently only have two methods: one for decoding and one for encoding an URI.
+# Support for statistics is planned
+#
+# == Encoding an URI
+# 
+#     Recortas.encode(uri)
+# 
+# Returns a string with the shortened URI
+# 
+# == Decoding an cort.as URI
+#     
+#     Recortas.decode(uri)
+# 
+# Returns a string with the original URI. The uri parameter must be a valid cort.as uri (i.e. must start with 'http://cort.as')
+# 
+# If an error occurs, an exception of class CortasError is raised.
+# 
+#     begin
+#       Recortas.decode('http://www.google.com')
+#     rescue CortasError => e
+#       puts e # Not a valid cort.as URI
+#     end
+# 
+# Author:: Alejandro Fernández Gómez,  antarticonorte@gmail.com
+# Version::  0.1
+# License::  BSD
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# * Redistributions of source code must retain the above copyright
+#   notice, this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+# * Neither the name of the <organization> nor the
+#   names of its contributors may be used to endorse or promote products
+#   derived from this software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY Alejandro Fernández Gómez ''AS IS'' AND ANY
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL Alejandro Fernández Gómez BE LIABLE FOR ANY
+# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require 'net/http'
+require 'rexml/document'
+
+# = CortasError
+# Exception raised when:
+# * A URI cannot be encoded with Recortas.encode
+# * An invalid URI is passed to Recortas.decode
+class CortasError < ArgumentError; end
+
+
+class Recortas
+  
+  # Get the original URI shortened with cort.as as a string
+  #
+  # Usage example
+  #   original = Recortas.decode('http://cort.as/1')   # Returns 'http://www.yahoo.com/'
+  # 
+  # Raises CortasError when +uri+ is not a cort.as URI
+  
+  def self.decode(uri)
+    
+    raise CortasError, "Not a valid cort.as URI" unless uri =~ /^http:\/\/cort\.as/i
+    
+    xml_data = Net::HTTP.get_response(URI.parse("#{uri}.xml")).body
+    xml_doc = REXML::Document.new(xml_data)
+
+    if xml_doc.root.children[0].text == 'ok'
+      xml_doc.root.children[1].text
+    else
+      raise URIError, REXML::XPath.first(xml_doc, '//errorLong').text
+    end
+  end
+  
+  # Sends an URI to http://cort.as to be shortened
+  #
+  # Usage example
+  #   short = Recortas.encode('http://www.yahoo.com')  # Returns 'http://cort.as/1'
+  #
+  # Raises CortasError if the +uri+ cannot be shortened
+  #
+  #   begin
+  #     short = Recortas.encode('blalal')
+  #   rescue CortasError => e
+  #     puts e  # Error returned from cort.as service
+  #   end
+
+  def self.encode(uri)
+    
+    xml_data = Net::HTTP.get_response(URI.parse("http://www.soitu.es/cortas/encode.pl?r=xml&u=#{uri}")).body
+    xml_doc = REXML::Document.new(xml_data)
+    
+    if xml_doc.root.children[0].text == 'ok'
+      REXML::XPath.first(xml_doc, '//urlCortas').text
+    else
+      raise CortasError, REXML::XPath.first(xml_doc, '//errorLong').text
+    end
+  end
+end

data/recortas.gemspec

@@ -0,0 +1,41 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{recortas}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alejandro Fern\303\241ndez"]
+  s.date = %q{2010-01-09}
+  s.description = %q{A ruby wrapper for the http://cort.as service}
+  s.email = %q{antarticonorte@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.markdown",
+     "Rakefile",
+     "lib/recortas.rb",
+     "recortas.gemspec"
+  ]
+  s.homepage = %q{http://github.com/afgomez/recortas}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A ruby wrapper for the http://cort.as service}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: recortas
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Alejandro Fern\xC3\xA1ndez"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-09 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A ruby wrapper for the http://cort.as service
+email: antarticonorte@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- README.markdown
+- Rakefile
+- lib/recortas.rb
+- recortas.gemspec
+has_rdoc: true
+homepage: http://github.com/afgomez/recortas
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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: 3
+summary: A ruby wrapper for the http://cort.as service
+test_files: []
+