rubenfonseca-whitme 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,31 @@
+= whitme
+
+whitme is a Ruby library for the URL shortener service whit.me
+
+The whit.me URL service is available at http://whit.me and it's API at
+http://www.whit.me/api/docs
+
+== Features
+
+* shortens and expands (multiple) URLs
+* 100% API features implemented
+* json (json-pure for JRuby) as the only external dependency
+* Ruby 1.8, 1.9 and JRuby compatible
+
+== Install
+
+  $ gem sources -a http://gems.github.com
+  $ sudo gem install rubenfonseca-whitme
+
+== Example
+
+  require 'whitme'
+  url = Whitme.short(:url => 'http://www.google.com', :note => 'foo')
+  puts url.hash # the shortened URL
+  
+  url = Whitme.short(:url => ['http://google.com', 'http://sapo.pt'])
+  puts url.hash # the shortened URL for multiple URLs
+
+== 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/whitme.rb

@@ -0,0 +1,169 @@
+# -*- coding: utf-8 -*-
+# vim:tabstop=4:expandtab:sw=4:softtabstop=4
+
+require 'rubygems'
+require 'json'
+require 'net/http'
+require 'uri'
+require 'cgi'
+
+# == MalformedURLError
+#
+# Raised when the user submits a malformed URL to whit.me
+#
+class MalformedURLError < ArgumentError
+end
+
+# == MalformedAliasError
+#
+# Raised when the user submits a malformed alias/hash to whit.me
+#
+class MalformedAliasError < ArgumentError
+end
+
+# == WhitmeURL
+#
+# Object that holds the different results of a Whit.me response
+#
+class WhitmeURL
+  SHORT_URL = 'http://www.whit.me/api/short?'
+  EXPAND_URL = 'http://www.whit.me/api/expand?'
+  
+  # The list of urls
+  attr_accessor :url
+  
+  # The list of url notes. Should be the same size of urls
+  attr_accessor :urlnote
+  
+  # The note associated with this url
+  attr_accessor :note
+  
+  # Contains the shortened URL
+  attr_accessor :hash
+  
+  def initialize
+    self.url = []
+    self.urlnote = []
+  end
+  
+  def to_short_url
+    params = self.url.map { |u| "url=#{CGI.escape(u)}" }
+    params |= self.urlnote.map { |u| "urlnote=#{CGI.escape(u)}" }
+    params << "note=#{CGI.escape(self.note)}" if self.note
+    params << "hash=#{CGI.escape(self.hash)}" if self.hash
+    
+    SHORT_URL + params.join('&')
+  end
+  
+  def to_expand_url
+    EXPAND_URL + "hash=#{CGI.escape(self.hash)}"
+  end
+end
+
+# == Whitme
+#
+# Holds the methods available on the Whit.me API
+#
+# (see http://www.whit.me/api/docs)
+#
+class Whitme
+  # Shortens a URL
+  #
+  # Returns a Whitme instance with the shortened version under the
+  # <tt>hash</tt> property.
+  #
+  # === Parameters
+  #
+  # * <tt>:url</tt> - a single string or an array of strings containing urls to shorten
+  # * <tt>:urlnote</tt> - a single string or an array of strings containing notes associated with the urls
+  # * <tt>:note</tt> - a general note to be associated with all the urls shortened
+  # * <tt>:hash</tt> - a custom URL alias (for readable shortened URLs). whit.me will return a generated alias if the supplied parameter already exists or is invalid
+  #
+  # The only really required field is <tt>:url</tt>. If <tt>:urlnotes</tt> is
+  # supplied, it must have the same size of <tt>:url</tt>. Otherwise an
+  # ArgumentError is raised.
+  #
+  # === Example
+  #
+  #   require 'whitme'
+  #   url = Whitme.short(:url => 'http://www.google.com', :note => 'foo')
+  #   puts url.hash.inspect
+  #
+  #   url = Whitme.short(:url => ['http://google.com', 'http://sapo.pt'])
+  #   puts url.hash.inspect
+  #
+  def self.short(options = {})
+    # we must have at least on url to short
+    raise ArgumentError unless options[:url]
+    
+    # if we have multiple notes, we should have the same number of urls
+    if options[:urlnote]
+      raise ArgumentError unless options[:urlnote].class == options[:url].class
+      if(options[:url].class == Array)
+        raise ArgumentError unless options[:url].size == options[:urlnote].size
+      end
+    end
+    
+    url = WhitmeURL.new
+    url.url << options[:url] if options[:url].class == String
+    url.url |= options[:url] if options[:url].class == Array
+    
+    if options[:urlnote]
+      url.urlnote << options[:urlnote] if options[:urlnote].class == String
+      url.urlnote |= options[:urlnote] if options[:urlnote].class == Array
+    end
+    
+    url.note = options[:note]
+    url.hash = options[:hash]
+    
+    uri = URI.parse(url.to_short_url)
+    res = Net::HTTP.start(uri.host, uri.port) do |http|
+      http.get(uri.request_uri, { 'Accept' => 'application/json' })
+    end
+    
+    json = JSON.parse(res.body) rescue nil
+    if json
+      if json['error']
+        case json['error']
+        when 0
+          raise MalformedURLError
+        when 1
+          raise MalformedAliasError
+        else
+          raise ArgumentError
+        end
+      else
+        url.hash = json['url']
+        return url
+      end
+    end
+  end
+  
+  # Expands an URL
+  #
+  # Returns a Whitme instance with all the (possible) fields filled. Accepts
+  # a unique argument with either a hash (e.g. XP45xe3) or a full whit.me
+  # URL.
+  # 
+  # === Example
+  #  
+  #  require 'whitme'
+  #  url = Whitme.expand('HQX4P9')
+  #  puts url.url.inspect
+  #
+  def self.expand(hash)
+    url = WhitmeURL.new
+    
+    if(hash.include? 'http://')
+      hash =~ /hash=(.+)/
+      hash = $1
+    end
+    url.hash = hash
+    
+    json = JSON.parse(Net::HTTP.get(URI.parse(url.to_expand_url)))
+    url.url = json['urls']
+    url.urlnote = json['urlnotes']
+    url.note = json['note']
+    url
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'spec'
+require 'spec/expectations'
+require 'spec/matchers'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'whitme'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/whitme_spec.rb

@@ -0,0 +1,128 @@
+$:.unshift File.dirname(__FILE__)
+require 'spec_helper'
+
+describe Whitme do
+  describe "short operation" do
+    describe "with one url" do
+      before(:all) do
+        @url = 'http://www.google.com'
+        @res = Whitme.short(:url => @url)
+      end
+      
+      it "should short url" do
+        @res.should_not be_nil
+        @res.class.should == WhitmeURL
+        @res.url.first.should == @url
+        @res.urlnote.should == []
+        @res.note.should be_nil
+        @res.hash.should_not be_nil
+      end
+    end
+    
+    describe "with one url and a note and a urlnote" do
+      before(:all) do
+        @url = 'http://www.google.com'
+        @note = 'Shortening Google'
+        @urlnote = 'THE url to start the internet'
+        @res = Whitme.short(:url => @url, :urlnote => @urlnote, :note => @note)
+      end
+      
+      it "should short url" do
+        @res.should_not be_nil
+        @res.class.should == WhitmeURL
+        @res.url.first.should == @url
+        @res.urlnote.first.should == @urlnote
+        @res.note.should == @note
+        @res.hash.should_not be_nil
+      end
+    end
+    
+    describe "with multiple urls and multiple urlnotes" do
+      before(:all) do
+        @urls = ['http://www.google.com', 'http://www.yahoo.com']
+        @urlnotes = ['THE url to start', 'Search engine wannabe']
+        @res = Whitme.short(:url => @urls, :urlnote => @urlnotes)
+      end
+      
+      it "should short url" do
+        @res.should_not be_nil
+        @res.class.should == WhitmeURL
+        @res.url.should == @urls
+        @res.urlnote.should == @urlnotes
+        @res.note.should be_nil
+        @res.hash.should_not be_nil
+      end
+    end
+    
+    describe "with a hash/alias" do
+      before(:all) do
+        @urls = 'http://www.google.com'
+        @hash = 'google'
+        @res = Whitme.short(:url => @urls, :hash => @hash)
+      end
+      
+      it "should short with hash" do
+        @res.should_not be_nil
+        @res.class.should == WhitmeURL
+        @res.url.first.should == @urls
+        @res.urlnote.should == []
+        @res.note.should be_nil
+        @res.hash.should_not be_nil
+      end
+    end
+    
+    describe "without a url" do
+      it "should throw a ArgumentError" do
+        lambda { Whitme.short(:url => nil) }.should raise_error(ArgumentError)
+        lambda { Whitme.short().should raise_error(ArgumentError) } 
+      end
+    end
+    
+    describe "with different url and urlnotes sizes" do
+      it "should throw a ArgumentError" do
+        lambda { 
+          Whitme.short(:url => ['http://www.google.com'],
+                       :urlnote => ['yes', 'no'])
+        }.should raise_error(ArgumentError)
+      end
+    end
+    
+    describe "with a malformed url" do
+      it "should throw a MalformedURLError" do
+        lambda { 
+          Whitme.short(:url => '////////////') 
+        }.should raise_error(MalformedURLError)
+      end
+    end
+  end
+  
+  describe "expand operation" do
+    describe "expanding a hash" do
+      before(:all) do
+        @res = Whitme.expand('HQX4P9')
+      end
+      
+      it "should expand" do
+        @res.should_not be_nil
+        @res.class.should == WhitmeURL
+        @res.url.should == ['http://whit.me/', 'http://whit.me/api/docs']
+        @res.urlnote.should == ['main page', 'documentation']
+        @res.note.should == 'Some links about whit.me'
+      end
+    end
+    
+    describe "expading a url" do
+      before(:all) do
+        @res = Whitme.expand('http://www.whit.me/api/expand?hash=HQX4P9')
+      end
+      
+      it "should expand" do
+        @res.should_not be_nil
+        @res.class.should == WhitmeURL
+        @res.url.should == ['http://whit.me/', 'http://whit.me/api/docs']
+        @res.urlnote.should == ['main page', 'documentation']
+        @res.note.should == 'Some links about whit.me'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: rubenfonseca-whitme
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+platform: ruby
+authors: 
+- Ruben Fonseca
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-23 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json-pure
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: root@cpan.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/whitme.rb
+- spec/spec_helper.rb
+- spec/whitme_spec.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/rubenfonseca/whitme
+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.2.0
+signing_key: 
+specification_version: 2
+summary: whitme is a Ruby library for the URL shortener service whit.me
+test_files: []
+