goshortener 1.1 → 1.2

data/README.rdoc

@@ -10,8 +10,14 @@ Uses Google URL shortener API service to shorten/expand given URLs.
 of if you are using bundler, add the following line to your Gemfile.
   gem "goshortener"
 
-=== Initialize and shorten urls
+=== Initialize
+  go = GoShortener.new(YOUR_API_KEY)
+or
   go = GoShortener.new
+
+Using Google API keys will increase the usage quota.
+
+=== Shorten urls
   short_url = go.shorten "http://github.com/luckydev"
 
 === To expand short urls
@@ -20,8 +26,8 @@ of if you are using bundler, add the following line to your Gemfile.
 === Example usage in irb
   ruby-1.9.2-p136 :001 > require "goshortener"
    => true 
-  ruby-1.9.2-p136 :002 > go = GoShortener.new
-   => #<GoShortener:0x93b35e0 @base_url="https://www.googleapis.com/urlshortener/v1/url"> 
+  ruby-1.9.2-p136 :002 > go = GoShortener.new("yourapikeyfromgoogle")
+   => #<GoShortener:0x93b35e0 @base_url="https://www.googleapis.com/urlshortener/v1/url", @api_key="yourapikeyfromgoogle"> 
   ruby-1.9.2-p136 :003 > go.shorten "http://github.com/luckydev"
    => "http://goo.gl/TCZHi" 
   ruby-1.9.2-p136 :004 > go.lengthen "http://goo.gl/TCZHi"

data/lib/goshortener.rb

@@ -1,5 +1,4 @@
 require "rubygems"
-require "bundler/setup"
 
 require "rest_client"
 require "json"
@@ -7,16 +6,24 @@ require "json"
 
 class GoShortener
 
-  def initialize
+  #initialize with/without api key
+  def initialize(api_key="")
+    unless api_key == ""
+      @api_key = api_key
+    else
+      puts "[GoShortener] Use Google API key to increase your usage quota."
+    end
     @base_url = "https://www.googleapis.com/urlshortener/v1/url"
   end
 
+  #Given a long URL, Returns the true short url using http://goo.gl service
   def shorten(long_url)
     if long_url.is_a?(String)
       request_json = {'longUrl' => long_url}.to_json
+      request_url = @api_key ? (@base_url + "?key=#{@api_key}") : @base_url
 
       begin
-        response = RestClient.post @base_url, request_json, :accept => :json, :content_type => :json
+        response = RestClient.post request_url, request_json, :accept => :json, :content_type => :json
       rescue
         raise "Please provide a valid url string"
       end
@@ -29,25 +36,11 @@ class GoShortener
     return short_url
   end
 
+  #Given a short URL, Returns the true long url using http://goo.gl service
   def lengthen(short_url)
-    ##
-    # Accepts a short url shortened by http://goo.gl and returns original
-    # long url.
-    # 
-    # Examples:
-    # go = GoShortener.new
-    #
-    # go.lengthen("http://goo.gl/TCZHi")      #=> "http://github.com/luckydev"
-    #
-    # go.lengthen("http://www.goo.gl/TCZHi")  #=> Error
-    # go.lengthen("goo.gl/TCZHi")             #=> Error
-    # go.lengthen("http://goo.gl/")           #=> Error
-    # go.lengthen("http://goo.gl/T")          #=> Error
-    # go.lengthen("http://bit.ly/TCZHi")      #=> Error
-    #
-    ##
     if short_url.is_a?(String)
       request_params = {:shortUrl => short_url}
+      request_params.merge!(:key => @api_key) if @api_key
 
       begin
         response = RestClient.get @base_url, :params => request_params

metadata

@@ -1,8 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: goshortener
 version: !ruby/object:Gem::Version 
+  hash: 11
   prerelease: 
-  version: "1.1"
+  segments: 
+  - 1
+  - 2
+  version: "1.2"
 platform: ruby
 authors: 
 - lakshmanan
@@ -10,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-06 00:00:00 +05:30
+date: 2011-02-22 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,6 +25,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -32,6 +39,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -61,17 +71,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: GoShortener uses Google URL shortener service to shorten/expand urls.