em-shorturl 0.1.0.pre → 0.1.0

data/lib/em-shorturl/bitly.rb

@@ -5,13 +5,32 @@ module EventMachine
     module ShortURL
 
         ##
-        # Driver for bitly.com URL Shortening service.
+        # Driver for bitly.com URL Shortening service. Bitly requires API users
+        # to have an account. This can be provided to the driver as either a
+        # pre-obtained access token or as a username and password pair
+        # (optionally with a client id and secret). If a username and password
+        # are provided instead of an access token, login is differed until
+        # needed (first call to +shorten+) or can be explicitly called via the
+        # +login+ function.
 
         class Bitly
             include EventMachine::Deferrable
             API_OAUTH_URL = 'https://api-ssl.bitly.com/oauth/access_token'
             API_SHORTEN_URL = 'https://api-ssl.bitly.com/v3/shorten'
 
+
+            ##
+            # Initialize the driver with account details. Despite being
+            # required by bitly, the driver does not currently verify that
+            # proper account details are given.
+            #
+            # +account+ takes the following options:
+            #   :client_id  The client ID of the registered application
+            #   :client_secret  The secret for the client id
+            #   :username   A username to use for basic authentication
+            #   :password   The password to use for basic authentication
+            #   :token  A previously obtained access token to use
+
             def initialize(account={})
                 @client_id = account[:client_id]
                 @client_secret = account[:client_secret]
@@ -21,6 +40,11 @@ module EventMachine
                 @deferrable_args = [self]
             end
 
+
+            ##
+            # Shortens the given URL. If no access token is known, will call
+            # the login function and upon success will call shorten again.
+
             def shorten(url)
                 if @access_token.nil?
                     login { shorten(url) } 
@@ -34,6 +58,12 @@ module EventMachine
                 self
             end
 
+
+            ##
+            # Uses the given username and password to obtain an access token
+            # from bitly. If authentication fails, sets the driver's deferrable
+            # status to failed.
+
             def login
                 params = {
                     :head => { 'authorization' => [@username, @password] },

data/lib/em-shorturl/google.rb

@@ -80,6 +80,14 @@ module EventMachine
             def on_success(http)
                 response = nil
 
+                # Handle HTTP Status other than 200
+                if http.response_header.status != 200
+                    error = http.response_header.http_reason
+                    fail(error, *@deferrable_args)
+                    return
+                end
+
+
                 # Handle JSON Failure
                 begin
                     response = JSON.parse(http.response)

data/lib/em-shorturl/tinyurl.rb

@@ -5,7 +5,7 @@ module EventMachine
         class TinyURL
             include EventMachine::Deferrable
 
-            # TinyURL API
+            # TinyURL API URL
             API_URL = 'http://tinyurl.com/api-create.php'
 
             
@@ -18,6 +18,10 @@ module EventMachine
             end
 
 
+            ##
+            # Shortens the given URL, returning self. The shortened URL is
+            # passed to the success callback as the first parameter.
+
             def shorten(url)
                 params = { :query => { :url => url } }
                 request = EM::HttpRequest.new(API_URL).post(params)
@@ -25,6 +29,7 @@ module EventMachine
                 request.errback(&method(:on_error))
                 self
             end
+
             private
 
 
@@ -33,8 +38,12 @@ module EventMachine
             # just be the plaintest link.
 
             def on_success(http)
-                short_url = http.response
-                succeed(short_url, *@deferrable_args)
+                if http.response_header.status != 200
+                    fail(http.response_header.http_reason, *@deferrable_args)
+                else
+                    short_url = http.response
+                    succeed(short_url, *@deferrable_args)
+                end
             end
 
 

data/lib/em-shorturl/version.rb

@@ -1,5 +1,5 @@
 module EventMachine
     module ShortURL
-        VERSION = '0.1.0.pre'
+        VERSION = '0.1.0'
     end
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: em-shorturl
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
-  prerelease: 6
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Nik Johnson
@@ -59,9 +59,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24