google_shortener 0.0.2 → 0.0.3

data/README.markdown

@@ -29,6 +29,38 @@ Usage:
     irb(main):005:0> google_shortener.api_key='your own API key'
     => "your own API key"
 
+    Analytics can be obtained for the short URL, to obtain detail
+    information set projection to 'FULL'. Other values for projection are
+    'ANALYTICS_CLICKS', 'ANALYTICS_TOP_STRINGS'
+
+    irb(main):006:0> google_shortener.analytics(google_shortener.shorten('http://www.twitter.com'), 'ANALYTICS_CLICKS')
+    => {
+    "kind"=>"urlshortener#url",
+    "id"=>"http://goo.gl/CbHS",
+    "longUrl"=>"http://www.twitter.com/",
+    "status"=>"OK",
+    "analytics"=>{
+    "allTime"=>{
+    "shortUrlClicks"=>"655",
+    "longUrlClicks"=>"4515"
+    },
+    "month"=>{
+    "shortUrlClicks"=>"17",
+    "longUrlClicks"=>"50"
+    },
+    "week"=>{
+    "shortUrlClicks"=>"2",
+    "longUrlClicks"=>"12"
+    },
+    "day"=>{
+    "shortUrlClicks"=>"0",
+    "longUrlClicks"=>"5"},
+    "twoHours"=>{
+    "shortUrlClicks"=>"0",
+    "longUrlClicks"=>"0"
+    }}}
+
+
 ## Contributing
 
 1. Fork it

data/google_shortener.gemspec

@@ -16,6 +16,6 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  gem.add_development_dependency "shoulda-context"
+  gem.add_development_dependency "rake"
   gem.add_runtime_dependency "json"
 end

data/lib/google_shortener.rb

@@ -4,12 +4,16 @@ require 'json'
 class GoogleShortener
   attr_accessor :api_key
 
+  PROJECTIONS = ['FULL', 'ANALYTICS_CLICKS', 'ANALYTICS_TOP_STRINGS']
+
   def initialize
     @api_key = 'AIzaSyDOY31us5qGR_MdMQKaTfGlhpOi8w3Ur7U'
   end
 
   def shorten(long_url)
-    if long_url.nil?
+    raise ArgumentError, "Long URL should be a String" unless long_url.is_a?(String)
+
+    if long_url.empty?
       raise ArgumentError, 'Long URL is required'
     end
 
@@ -24,7 +28,9 @@ class GoogleShortener
   end
 
   def expand(short_url)
-    if short_url.nil?
+    raise ArgumentError, "Short URL should be a String" unless short_url.is_a?(String)
+
+    if short_url.empty?
       raise ArgumentError, 'Short URL is required'
     end
     res = get_from_google_url_shortener_api(short_url)
@@ -37,6 +43,20 @@ class GoogleShortener
     end
   end
 
+  def analytics(short_url, projection='FULL')
+    raise ArgumentError, "Short URL should be a String" unless short_url.is_a?(String)
+
+    if short_url.empty?
+      raise ArgumentError, 'Short URL is required'
+    end
+
+    raise ArgumentError, "Projection should be a String" unless projection.is_a?(String)
+    raise ArgumentError, "Projection can only be #{PROJECTIONS.join(',')}" unless PROJECTIONS.include?(projection)
+
+    res = get_from_google_url_shortener_api(short_url, {'projection' => projection})
+    res_body = JSON.load(res.body)
+  end
+
   def valid_api_key?
     res = post_to_google_url_shortener_api('http://www.google.com')
 
@@ -53,9 +73,10 @@ class GoogleShortener
     'https://www.googleapis.com/urlshortener/v1/url'
   end
 
-  def get_from_google_url_shortener_api(short_url)
+  def get_from_google_url_shortener_api(short_url, options = {})
     uri = URI(google_url_shortener_location)
     params = {'shortUrl' => short_url, 'key' => @api_key}
+    params = params.merge(options) unless options.empty?
     uri.query = URI.encode_www_form(params)
     req = Net::HTTP::Get.new(uri.request_uri)
     req.content_type = 'application/json'

data/lib/google_shortener/version.rb

@@ -1 +1 @@
-VERSION = "0.0.2"
+VERSION = "0.0.3"

data/test/google_shortener_test.rb

@@ -42,6 +42,28 @@ class GoogleShortenerTest < MiniTest::Unit::TestCase
     assert_raises ArgumentError do
       google_shortener.expand
     end
+  end
+
+  def test_analytics_with_short_url_and_projection
+    google_shortener = GoogleShortener.new
+    analytics_hash = google_shortener.analytics('http://goo.gl/fbsS')
+    assert_equal ['kind', 'id', 'longUrl', 'status', 'created', 'analytics'], analytics_hash.keys
+
+    analytics_hash = google_shortener.analytics('http://goo.gl/fbsS', 'ANALYTICS_CLICKS')
+    assert_equal ['kind', 'id', 'longUrl', 'status', 'analytics'], analytics_hash.keys
+
+    analytics_hash = google_shortener.analytics('http://goo.gl/fbsS', 'ANALYTICS_TOP_STRINGS')
+    assert_equal ['kind', 'id', 'longUrl', 'status', 'analytics'], analytics_hash.keys
+
+    assert_raises ArgumentError do
+      google_shortener.analytics('http://goo.gl/fbsS', 'foo')
+    end
+  end
 
+  def test_analytics_without_short_url
+    google_shortener = GoogleShortener.new
+    assert_raises ArgumentError do
+      google_shortener.analytics(nil)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_shortener
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-05 00:00:00.000000000 Z
+date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: shoulda-context
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -73,7 +73,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2250692420382275581
+      hash: -3080101778216265152
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2250692420382275581
+      hash: -3080101778216265152
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25