em-shorturl 0.0.1

checksums.yaml

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

data/lib/em-shorturl/google.rb

@@ -0,0 +1,111 @@
+require 'em-http-request'
+require 'json'
+
+module EventMachine
+    module ShortURL
+
+        ##
+        # The Google class is the driver for URLShortener to use Google's API
+        # for URL shortening.
+
+        class Google
+            include EventMachine::Deferrable
+
+            # Specifies the API URL for shortening URLs
+            API_URL = "https://www.googleapis.com/urlshortener/v1/url"
+
+
+            ##
+            # Takes the URL to shorten and optionally two callbacks for success
+            # and error. Does not immediately shorten the URL.
+            #
+            # The +account+ argument may take the following options:
+            #   :apikey     Defines an apikey to use for the request
+
+            def initialize(account={})
+                @deferrable_args = [self]
+                @account_apikey = account[:apikey]
+            end
+
+            
+            ##
+            # Performs the request of shortening a URL asynchronously.
+
+            def shorten(url)
+                params = get_request_parameters(url)
+                request = EventMachine::HttpRequest.new(API_URL).post(params)
+                request.callback(&method(:on_success))
+                request.errback(&method(:on_error))
+                self
+            end
+
+
+            private
+
+
+            ##
+            # Creates the parameter hash for the HTTP Request to Google
+            
+            def get_request_parameters(url)
+                options = {
+                    :head => { "Content-Type" => "application/json" },
+                    :body => { "longUrl" => url }.to_json
+                }
+
+                if @account_apikey
+                    options[:query] = { "key" => @account_apikey }
+                end
+
+                options
+            end
+            
+            ##
+            # Callback for HttpRequest object upon success. Parses the response
+            # as JSON, checks for a Google API error, and finally saves the
+            # short URL as an instance variable. If any of the above fail,
+            # sets the error message and sets the deferrable status to failure.
+
+            def on_success(http)
+                response = nil
+
+                # Handle JSON Failure
+                begin
+                    response = JSON.parse(http.response)
+                rescue JSON::ParseError => e
+                    error = e.message
+                    fail(error, *@deferrable_args)
+                    return
+                end
+
+                # Handle google API Error
+                if response['error']
+                    error = response['error']['message']
+                    fail(error, *@deferrable_args)
+                    return
+                end
+
+                # Odd case if response['id'] doesn't exist (Should't happen)
+                if response['id'].nil?
+                    error = "No short URL was returned (Google API Change?)"
+                    fail(error, *@deferrable_args)
+                end
+
+                # Return the short URL
+                short_url = response['id']
+                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

@@ -0,0 +1,5 @@
+module EventMachine
+    module ShortURL
+        VERSION = '0.0.1'
+    end
+end

data/lib/em-shorturl.rb

@@ -0,0 +1,19 @@
+require 'eventmachine'
+require 'em-shorturl/version'
+require 'em-shorturl/google'
+
+module EventMachine
+    module ShortURL
+        DEFAULT_DRIVER = :google
+        DRIVERS = {
+            :google => ShortURL::Google
+        }
+
+        def self.shorten(url, driver=DEFAULT_DRIVER, account={})
+            raise KeyError, "Driver does not exist" unless DRIVERS[driver]
+
+            r = DRIVERS[driver].new(account)
+            r.shorten(url)
+        end
+    end
+end

data/test/test_google.rb

@@ -0,0 +1,35 @@
+require "test/unit"
+require "em-shorturl/google"
+
+class TestGoogle < Test::Unit::TestCase
+    TEST_URL = 'http://google.com'
+    API_ENV_VAR = 'google_apikey'
+
+    def test_no_auth
+        EM.run do
+            google = EM::ShortURL::Google.new
+            set_asserts(google)
+            google.shorten(TEST_URL)
+        end
+    end
+
+    if ENV[API_ENV_VAR]
+        def test_with_apikey
+
+            EM.run do
+
+                google = EM::ShortURL::Google.new(:apikey => ENV[API_ENV_VAR])
+                set_asserts(google)
+                google.shorten(TEST_URL)
+            end
+        end
+    else
+        warn "Skipping test_with_apikey: No '#{API_ENV_VAR}' environment variable set"
+    end
+
+    private
+    def set_asserts(deferrable)
+        deferrable.callback { |s| assert_match(/^http:\/\/goo.gl\/\S+$/, s); EM.stop }
+        deferrable.errback { |e| assert(false, e); EM.stop}
+    end
+end

data/test/test_shorturl.rb

@@ -0,0 +1,14 @@
+require 'eventmachine'
+require "test/unit"
+require "em-shorturl"
+
+class TestURLShortener < Test::Unit::TestCase
+    def test_bad_driver_should_raise_KeyError
+        assert_raise(KeyError) do
+            EM.run do
+                r = EM::ShortURL.shorten('http://google.com', :nonexistent_driver)
+                EM.stop
+            end
+        end
+    end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: em-shorturl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nik Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An EventMachine module for shortening urls
+email:
+- nikjohnson08@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/em-shorturl/version.rb
+- lib/em-shorturl/google.rb
+- lib/em-shorturl.rb
+- test/test_google.rb
+- test/test_shorturl.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
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: An EventMachine module for shortening urls
+test_files:
+- test/test_google.rb
+- test/test_shorturl.rb