em-shorturl 0.0.1 → 0.1.0.pre

data/lib/em-shorturl/bitly.rb

@@ -0,0 +1,95 @@
+require 'em-http-request'
+require 'uri'
+
+module EventMachine
+    module ShortURL
+
+        ##
+        # Driver for bitly.com URL Shortening service.
+
+        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'
+
+            def initialize(account={})
+                @client_id = account[:client_id]
+                @client_secret = account[:client_secret]
+                @username = account[:username]
+                @password = account[:password]
+                @access_token = account[:token]
+                @deferrable_args = [self]
+            end
+
+            def shorten(url)
+                if @access_token.nil?
+                    login { shorten(url) } 
+                    return self
+                end
+
+                params = get_request_parameters(url)
+                request = EM::HttpRequest.new(API_SHORTEN_URL).get(params)
+                request.callback(&method(:on_success))
+                request.errback(&method(:on_error))
+                self
+            end
+
+            def login
+                params = {
+                    :head => { 'authorization' => [@username, @password] },
+                    :body => {}
+                }
+                params[:body]['client_id'] = @client_id if @client_id
+                params[:body]['client_secret'] = @client_secret if @client_secret
+                http = EM::HttpRequest.new(API_OAUTH_URL).post(params)
+
+                http.errback do |http|
+                    fail(http.error, *@deferrable_args)
+                end
+
+                http.callback do |http|
+                    if http.response_header.status != 200
+                        fail(http.response, *@deferrable_args)
+                        next
+                    end
+
+                    @access_token = http.response
+                    if @access_token.nil?
+                        fail('OAuth request did not return an access token', *@deferrable_args)
+                        next
+                    else
+                        yield if block_given?
+                    end
+                end
+            end
+
+            private
+
+            def get_request_parameters(url)
+                url = URI(url)
+                url.path = '/' if url.path.empty?
+
+                return {
+                    :query => {
+                        'access_token' => @access_token,
+                        'longUrl' => url.to_s,
+                        'format' => 'txt'
+                    }
+                }
+            end
+
+            def on_success(http)
+                if http.response_header.status != 200
+                    fail(http.response, *@deferrable_args)
+                    return
+                end
+
+                succeed(http.response, *@deferrable_args)
+            end
+
+            def on_error(http)
+                fail(http.response, *@deferrable_args)
+            end
+        end
+    end
+end

data/lib/em-shorturl/google.rb

@@ -7,6 +7,11 @@ module EventMachine
         ##
         # The Google class is the driver for URLShortener to use Google's API
         # for URL shortening.
+        #
+        # As a deferrable, instances accept callback procs in calls to
+        # callback() and errback(). Callbacks are provided arguments
+        # +shorturl+ and +self+, while errbacks are provided +err_string+
+        # and +self+.
 
         class Google
             include EventMachine::Deferrable
@@ -16,8 +21,9 @@ module EventMachine
 
 
             ##
-            # Takes the URL to shorten and optionally two callbacks for success
-            # and error. Does not immediately shorten the URL.
+            # Initializes the driver instance, optionally with account information
+            # for making requests on behalf of an account. Benefits of using an api key
+            # include higher request limits and stat tracking.
             #
             # The +account+ argument may take the following options:
             #   :apikey     Defines an apikey to use for the request
@@ -27,9 +33,14 @@ module EventMachine
                 @account_apikey = account[:apikey]
             end
 
-            
+
             ##
-            # Performs the request of shortening a URL asynchronously.
+            # Performs the request of shortening a URL asynchronously. Returns self,
+            # which is a deferrable. This allows a usage like the following:
+            #
+            #   EM::ShortURL::Google.new.shorten('http://google.com').callback do |u,d|
+            #       puts "Shorturl: #{u}"
+            #   end
 
             def shorten(url)
                 params = get_request_parameters(url)
@@ -45,7 +56,7 @@ module EventMachine
 
             ##
             # Creates the parameter hash for the HTTP Request to Google
-            
+
             def get_request_parameters(url)
                 options = {
                     :head => { "Content-Type" => "application/json" },
@@ -58,7 +69,8 @@ module EventMachine
 
                 options
             end
-            
+
+
             ##
             # Callback for HttpRequest object upon success. Parses the response
             # as JSON, checks for a Google API error, and finally saves the

data/lib/em-shorturl/tinyurl.rb

@@ -0,0 +1,52 @@
+require 'em-http-request'
+
+module EventMachine
+    module ShortURL
+        class TinyURL
+            include EventMachine::Deferrable
+
+            # TinyURL API
+            API_URL = 'http://tinyurl.com/api-create.php'
+
+            
+            ##
+            # TinyURL has no accounts or users, so while the class accepts an
+            # +account+ parameter, it is unused.
+
+            def initialize(account={})
+                @deferrable_args = [self]
+            end
+
+
+            def shorten(url)
+                params = { :query => { :url => url } }
+                request = EM::HttpRequest.new(API_URL).post(params)
+                request.callback(&method(:on_success))
+                request.errback(&method(:on_error))
+                self
+            end
+            private
+
+
+            ##
+            # Callback for HttpRequest object upon success. The response should
+            # just be the plaintest link.
+
+            def on_success(http)
+                short_url = http.response
+                succeed(short_url, *@deferrable_args)
+            end
+
+
+            ##
+            # Callback for an error from HttpRequest (caused by a server
+            # outage of lack of connectivity). Simply forwards the error
+            # value and sets the deferrable status to fail.
+
+            def on_error(http)
+                error = http.error
+                fail(error, *@deferrable_args)
+            end
+        end
+    end
+end

data/lib/em-shorturl/version.rb

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

data/lib/em-shorturl.rb

@@ -1,14 +1,34 @@
 require 'eventmachine'
 require 'em-shorturl/version'
 require 'em-shorturl/google'
+require 'em-shorturl/tinyurl'
+require 'em-shorturl/bitly'
 
 module EventMachine
+
+    ##
+    # The ShortURL module for EventMachine adds an asynchronous interface to
+    # shortening urls using several publically available URL shortening
+    # services. Several drivers may be provided, and the top level module
+    # provides a uniform and easy interface to using any of these services.
+
     module ShortURL
         DEFAULT_DRIVER = :google
         DRIVERS = {
-            :google => ShortURL::Google
+            :google => ShortURL::Google,
+            :tinyurl => ShortURL::TinyURL,
+            :bitly => ShortURL::Bitly
         }
 
+
+        ##
+        # Takes a URL and returns the driver instance, which should then have
+        # its callback and errback attributes set. Optionally accepts +driver+
+        # and +account+. +driver+ is a symbol which maps to a driver class and
+        # +account+ is a driver-specific hash of account information.
+        #
+        # Raises +KeyError+ if the driver is not mapped.
+
         def self.shorten(url, driver=DEFAULT_DRIVER, account={})
             raise KeyError, "Driver does not exist" unless DRIVERS[driver]
 

data/test/test_bitly.rb

@@ -0,0 +1,49 @@
+require "test/unit"
+require "em-shorturl/bitly"
+
+class TestBitly < Test::Unit::TestCase
+    TEST_URL = 'http://google.com'
+    SHORT_REGEX = /^http:\/\/bit.ly\/\S+$/
+    USER_ENV_VAR = 'bitly_user'
+    PASS_ENV_VAR = 'bitly_pass'
+    TOKEN_ENV_VAR = 'bitly_token'
+
+    def test_no_auth
+        EM.run do
+            bitly = EM::ShortURL::Bitly.new
+            bitly.errback { |e| assert(true, e); EM.stop }
+            bitly.callback { |s| assert(false, s); EM.stop }
+            bitly.shorten(TEST_URL)
+        end
+    end
+
+    if ENV[USER_ENV_VAR] and ENV[PASS_ENV_VAR]
+        def test_with_oauth_basic
+            EM.run do
+                bitly = EM::ShortURL::Bitly.new(:username => ENV[USER_ENV_VAR], :password => ENV[PASS_ENV_VAR])
+                set_asserts(bitly)
+                bitly.shorten(TEST_URL)
+            end
+        end
+    else
+        warn "Skipping test_with_oauth_basic: '#{USER_ENV_VAR}' and '#{PASS_ENV_VAR}' environment variable must be set"
+    end
+
+    if ENV[TOKEN_ENV_VAR]
+        def test_with_oauth_token
+            EM.run do
+                bitly = EM::ShortURL::Bitly.new(:token => ENV[TOKEN_ENV_VAR])
+                set_asserts(bitly)
+                bitly.shorten(TEST_URL)
+            end
+        end
+    else
+        warn "Skipping test_with_oauth_token: '#{TOKEN_ENV_VAR}' environment variable must be set"
+    end
+
+    private
+    def set_asserts(deferrable)
+        deferrable.callback { |s| assert_match(SHORT_REGEX, s); EM.stop }
+        deferrable.errback { |e| assert(false, e); EM.stop}
+    end
+end

data/test/test_tinyurl.rb

@@ -0,0 +1,21 @@
+require "test/unit"
+require "em-shorturl/tinyurl"
+
+class TestTinyURL < Test::Unit::TestCase
+    TEST_URL = 'http://google.com'
+    SHORT_REGEX = /^http:\/\/tinyurl\.com\/\S+$/
+
+    def test_tinyurl
+        EM.run do
+            tinyurl = EM::ShortURL::TinyURL.new
+            set_asserts(tinyurl)
+            tinyurl.shorten(TEST_URL)
+        end
+    end
+
+    private
+    def set_asserts(deferrable)
+        deferrable.callback { |s| assert_match(SHORT_REGEX, s); EM.stop }
+        deferrable.errback { |e| assert(false, e); EM.stop}
+    end
+end

metadata

@@ -1,29 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: em-shorturl
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0.pre
+  prerelease: 6
 platform: ruby
 authors:
 - Nik Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-24 00:00:00.000000000 Z
+date: 2013-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: An EventMachine module for shortening urls
 email:
 - nikjohnson08@gmail.com
@@ -31,35 +34,42 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/em-shorturl/version.rb
-- lib/em-shorturl/google.rb
 - lib/em-shorturl.rb
+- lib/em-shorturl/tinyurl.rb
+- lib/em-shorturl/google.rb
+- lib/em-shorturl/bitly.rb
+- lib/em-shorturl/version.rb
 - test/test_google.rb
 - test/test_shorturl.rb
+- test/test_bitly.rb
+- test/test_tinyurl.rb
 homepage: https://github.com/jumpandspintowin/em-shorturl
 licenses:
 - Simplified BSD
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.24
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: An EventMachine module for shortening urls
 test_files:
 - test/test_google.rb
 - test/test_shorturl.rb
+- test/test_bitly.rb
+- test/test_tinyurl.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 67a5cd1bf46ff96a3c6a00d651b954229f11e7b2
-  data.tar.gz: 778cb1c98b3a1aad091abc7a5eae7db018c6c387
-SHA512:
-  metadata.gz: 86bc8edf6aa87d139397e3c0f1369d44590e63f958a525f147f59afde00e858cedb2eda16e59e8b3eb492156a16fed2046c47c6d93e53139288ee922785a1856
-  data.tar.gz: 4a9d75b5909ae617b607afdadc5390c9ccc2765777f4ed3c91315be05431aabf5cff944e2ebac6c85abc45497ff7d179ff11ca3ca93abc24383b59f4ca5a3c3b