shorty 0.1.1 → 0.1.2

data/.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 doc/
 features/
+pkg/

data/README.rdoc

@@ -11,7 +11,7 @@ shorty makes interfacing with url shortening services easy, so far the following
 
 == Install
 
-  sudo gem install drcapulet-shorty
+  sudo gem install shorty
 
 == Usage
 
@@ -21,7 +21,7 @@ Yeah just read the rdocs. But to get started, make sure the gem is installed. Re
 
 or with Rails:
 
-  config.gem 'drcapulet-shorty', :lib => 'shorty'
+  config.gem 'shorty'
 
 == Possible Additions
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/shorty.rb

@@ -1,11 +1,20 @@
 require 'httparty'
 require 'crack'
+require 'ostruct'
 
 module Shorty
-  class API
-    include HTTParty
+  class SimpleAPI
+    
+    def shorten(url)
+      self.class.get(self.class::API_URL, :query => self.class.prep_query(url))
+    end
+    
+    def self.shorten(url)
+      get(self::API_URL, :query => self.prep_query(url))
+    end
   end
   
+  require File.dirname(__FILE__) + '/shorty/to_openstruct'
   require File.dirname(__FILE__) + '/shorty/trim'
   require File.dirname(__FILE__) + '/shorty/bitly'
   require File.dirname(__FILE__) + '/shorty/tinyurl'

data/lib/shorty/bitly.rb

@@ -32,21 +32,19 @@ module Shorty
     def shorten( longurl )
       query = {:longUrl => longurl}
       query.merge!(@options)
-      short = self.class.get('/shorten', :query => query)
-      short = Crack::JSON.parse(short)
-      short["errorCode"].zero? ? short["results"][longurl]["shortUrl"] : raise_error(short["errorCode"], short["errorMessage"])
+      short = Crack::JSON.parse(self.class.get('/shorten', :query => query))
+      short["errorCode"].zero? ? short["results"][longurl]["shortUrl"] : raise_error(short)
     end
     
     # expand- given a bit.ly url, returns long source url, takes:
     #
     # - shorturl: the bit.ly url, can either be the full url or missing http://bit.ly
     def expand(shorturl)
-      shorturl = gsub_url(shorturl)
-      query = {:hash => shorturl}
+      hash = gsub_url(shorturl)
+      query = {:hash => hash}
       query.merge!(@options)
-      expand = self.class.get('/expand', :query => query)
-      expand = Crack::JSON.parse(expand)
-      expand["errorCode"].zero? ? expand["results"][shorturl]["longUrl"] : raise_error(expand["errorCode"], expand["errorMessage"])
+      expand = Crack::JSON.parse(self.class.get('/expand', :query => query))
+      expand["errorCode"].zero? ? expand["results"][hash]["longUrl"] : raise_error(expand)
     end
     
     # info - Given a bit.ly url or hash, return information about that page, such as the long source url, ...
@@ -58,9 +56,8 @@ module Shorty
         query = {:hash => urlhash}
       end
       query.merge!(@options)
-      stats = self.class.get('/info', :query => query)
-      stats = Crack::JSON.parse(stats)
-      stats["errorCode"].zero? ? stats["results"][urlhash] : raise_error(stats["errorCode"], stats["errorMessage"])
+      stats = Crack::JSON.parse(self.class.get('/info', :query => query))
+      stats["errorCode"].zero? ? stats["results"][urlhash] : raise_error(stats)
     end
     
     # stats - get stats on clicks and reffers, pass either:
@@ -70,17 +67,16 @@ module Shorty
     #
     # Example:
     #   bitly = Shorty::Bitly.new('login', 'apikey')
-    #   bitly.expand('1RmnUT')
+    #   bitly.stats('1RmnUT')
     # Or:
     #   bitly = Shorty::Bitly.new('login', 'apikey')
-    #   bitly.expand('http://bit.ly/1RmnUT')
+    #   bitly.stats('http://bit.ly/1RmnUT')
     def stats(urlorhash)
       urlhash = gsub_url(urlorhash)
       query = {:hash => urlhash}
       query.merge!(@options)
-      stats = self.class.get('/stats', :query => query)
-      stats = Crack::JSON.parse(stats)
-      stats["errorCode"].zero? ? stats["results"] : raise_error(stats["errorCode"], stats["errorMessage"])
+      stats = Crack::JSON.parse(self.class.get('/stats', :query => query))
+      stats["errorCode"].zero? ? stats["results"] : raise_error(stats)
     end
     
     
@@ -88,14 +84,26 @@ module Shorty
     
     def gsub_url(shorturl) 
       shorturl.split('/').last
-      # shorturl = shorturl.gsub(/http:\/\//, '') if shorturl.include?('http://')
-      # shorturl = shorturl.gsub(/bit.ly\//, '') if shorturl.include?('bit.ly/')
     end  
     
-    def raise_error(code, message = '(no error message)')
+    def raise_error(hash)
+      code = hash["errorCode"]
+      message = hash["errorMessage"] || '(no error message)'
       error = message + " (error code: #{code})"
       raise Shorty::Bitly::Error, error
     end
     
+    # We need to work on how to handle this and working with openstruct
+    # def handle_response(resp, url)
+    #   r = {
+    #     "error" => {
+    #       "code" => resp["errorCode"],
+    #       "message" => resp["errorMessage"]
+    #       },
+    #     "hash" => resp["results"][url]["hash"]
+    #   }
+    #   resp.to_openstruct
+    # end
+    
   end
 end

data/lib/shorty/cligs.rb

@@ -49,7 +49,7 @@ module Shorty
     
     def raise_error(code, message = '(no error message)')
       error = message + " (error code: #{code})"
-      raise Shorty::Bitly::Error, error
+      raise Shorty::Cligs::Error, error
     end
     
   end

data/lib/shorty/isgd.rb

@@ -1,14 +1,12 @@
 module Shorty
   # is.gd API as defined http://is.gd/api_info.php
-  class Isgd
+  class Isgd < SimpleAPI
     include HTTParty
     
-    def shorten(url)
-      self.class.get('http://is.gd/api.php', :query => {:longurl => url})
-    end
-    
-    def self.shorten(url)
-      get('http://is.gd/api.php', :query => {:longurl => url})
+    API_URL = 'http://is.gd/api.php'
+        
+    def self.prep_query(url)
+      {:longurl => url}
     end
   end
 end

data/lib/shorty/supr.rb

@@ -29,71 +29,66 @@ module Shorty
     # - url: The long URL you wish to shorten
     # Will return the full url unless you pass false for the second parameter, then it only returns the hash
     def shorten(url, full = true)
-      query = {:longUrl => url}
-      query.merge!(@options)
-      short = self.class.get('/shorten', :query => query)
-      short = Crack::JSON.parse(short)
-      if full
-        short["errorCode"].zero? ? short["results"][url]["shortUrl"] : raise_error(short["errorCode"], short["errorMessage"])
-      else
-        short["errorCode"].zero? ? short["results"][url]["hash"] : raise_error(short["errorCode"], short["errorMessage"])
-      end
+      self.class.get_and_parse_shorten(url, full)
     end
     
     # self.shorten. see shorten
     def self.shorten(url, full = true)
-      query = {:longUrl => url}
-      query.merge!(@options) if @options
-      short = get('/shorten', :query => query)
-      short = Crack::JSON.parse(short)
-      if full
-        short["errorCode"].zero? ? short["results"][url]["shortUrl"] : raise_error(short["errorCode"], short["errorMessage"])
-      else
-        short["errorCode"].zero? ? short["results"][url]["hash"] : raise_error(short["errorCode"], short["errorMessage"])
-      end
+      get_and_parse_shorten(url, full)
     end
     
     # expand. pass either:
     # - shortUrl: he Su.pr URL you wish to expand
     # - hash: The six character hash you wish to expand
     def expand(urlorhash)
-      hash = gsub_url(urlorhash)
-      query = {:hash => hash}
-      query.merge!(@options)
-      expand = self.class.get('/expand', :query => query)
-      expand = Crack::JSON.parse(expand)
-      expand["errorCode"].zero? ? expand["results"][hash]["longUrl"] : raise_error(expand["errorCode"], expand["errorMessage"])
+      self.class.get_and_parse_expand(urlorhash)
     end
     
     # self.expand. see expand
     def self.expand(urlorhash)
-      hash = gsub_url(urlorhash)
-      query = {:hash => hash}
-      query.merge!(@options) if @options
-      expand = get('/expand', :query => query)
-      expand = Crack::JSON.parse(expand)
-      expand["errorCode"].zero? ? expand["results"][hash]["longUrl"] : raise_error(expand["errorCode"], expand["errorMessage"])
+      get_and_parse_expand(urlorhash)
     end
 
         
     protected
     
-    def gsub_url(shorturl) 
-      shorturl.split('/').last
-    end
-    
     def self.gsub_url(shorturl) 
       shorturl.split('/').last
     end
     
-    def raise_error(code, message = '(no error message)')
+    def self.raise_error(hash)
+      code = hash["errorCode"]
+      message = hash["errorMessage"] || '(no error message)'
       error = message + " (error code: #{code})"
       raise Shorty::Supr::Error, error
     end
     
-    def self.raise_error(code, message = '(no error message)')
-      error = message + " (error code: #{code})"
-      raise Shorty::Supr::Error, error
+    def self.handle_full_or_hash_option(short, url, full)
+        short["errorCode"].zero? ? (full ? short["results"][url]["shortUrl"] : short["results"][url]["hash"]) : self.raise_error(short)
+    end
+    
+    def self.prep_shorten_request(url)
+      query = {:longUrl => url}
+      query.merge!(@options) if @options
+      query
+    end
+    
+    def self.prep_expand_request(urlorhash)
+      hash = self.gsub_url(urlorhash)
+      query = {:hash => hash}
+      query.merge!(@options) if @options
+      [query, hash]
+    end
+
+    def self.get_and_parse_shorten(url, full)
+      short = Crack::JSON.parse(get('/shorten', :query => prep_shorten_request(url)))
+      handle_full_or_hash_option(short, url, full)
+    end
+    
+    def self.get_and_parse_expand(urlorhash)
+      query, hash = prep_expand_request(urlorhash)
+      expand = Crack::JSON.parse(get('/expand', :query => query))
+      expand["errorCode"].zero? ? expand["results"][hash]["longUrl"] : raise_error(expand)
     end
 
   end

data/lib/shorty/tinyurl.rb

@@ -1,14 +1,12 @@
 module Shorty
   # The tinyurl.com API. Not much here, undocumented API
-  class Tinyurl
+  class Tinyurl < SimpleAPI
     include HTTParty
     
-    def shorten(url)
-      self.class.get('http://tinyurl.com/api-create.php', :query => {:url => url})
-    end
+    API_URL = 'http://tinyurl.com/api-create.php'
     
-    def self.shorten(url)
-      get('http://tinyurl.com/api-create.php', :query => {:url => url})
+    def self.prep_query(url)
+      {:url => url}
     end
   end
 end

data/lib/shorty/to_openstruct.rb

@@ -0,0 +1,19 @@
+class Object
+ def to_openstruct
+   self
+ end
+end
+
+class Array
+ def to_openstruct
+   map{ |el| el.to_openstruct }
+ end
+end
+
+class Hash
+ def to_openstruct
+   mapped = {}
+   each{ |key,value| mapped[key] = value.to_openstruct }
+   OpenStruct.new(mapped)
+ end
+end

data/lib/shorty/trim.rb

@@ -67,9 +67,8 @@ module Shorty
     def trim_url( options = {} )
       options.merge!(@options)
       response = self.class.get( '/trim_url.xml', :query => options )
-      response = Crack::XML.parse(response)
-      raise_error(response['trim']['status']['code'], response['trim']['status']['message']) if response['trim']['status']['code'] >= '205'
-      return response['trim']['url']
+      response = handle_response(Crack::XML.parse(response))
+      return response.url
     end
     
     TRIM_ERRORS = {
@@ -104,6 +103,14 @@ module Shorty
       # raise Shorty::Trim::APIError.new(TRIM_ERRORS[code])
       raise TRIM_ERRORS[code], message
     end
+    
+    # Process the response
+    def handle_response(resp)
+      response = resp['trim'].to_openstruct
+      raise_error(response.status.code, response.status.message) if response.status.code >= '205'
+      response
+    end
+    
   end
 end
 

data/shorty.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# 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{shorty}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Coomans"]
-  s.date = %q{2009-10-10}
+  s.date = %q{2009-11-23}
   s.description = %q{Makes it easy to shorten URLs}
   s.email = %q{alex@alexcoomans.com}
   s.extra_rdoc_files = [
@@ -35,6 +35,7 @@ Gem::Specification.new do |s|
      "lib/shorty/isgd.rb",
      "lib/shorty/supr.rb",
      "lib/shorty/tinyurl.rb",
+     "lib/shorty/to_openstruct.rb",
      "lib/shorty/trim.rb",
      "lib/shorty/twurl.rb",
      "shorty.gemspec",
@@ -93,3 +94,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<crack>, [">= 0.1.4"])
   end
 end
+

data/test/supr_test.rb

@@ -49,6 +49,10 @@ class SuprTest < Test::Unit::TestCase
       should "return a shortened url" do
         assert_equal 'http://su.pr/2yw2PP', Shorty::Supr.shorten('http://cnn.com')
       end
+      
+      should "return a shortened hash" do
+        assert_equal '2yw2PP', Shorty::Supr.shorten('http://cnn.com', false)
+      end
 
       should "return an expanded url when passed a hash" do
         assert_equal 'http://cnn.com/', Shorty::Supr.expand('2yw2PP')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shorty
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Alex Coomans
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-10 00:00:00 -07:00
+date: 2009-11-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,6 +60,7 @@ files:
 - lib/shorty/isgd.rb
 - lib/shorty/supr.rb
 - lib/shorty/tinyurl.rb
+- lib/shorty/to_openstruct.rb
 - lib/shorty/trim.rb
 - lib/shorty/twurl.rb
 - shorty.gemspec