google_url_shortener 0.0.3 → 0.0.4

data/Gemfile

@@ -1,5 +1,6 @@
 source :gemcutter
 gemspec
 
+gem "fakeweb"
 gem "json", "1.4.6"
 gem "rest-client", "1.6.1", :require => "restclient"

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    google_url_shortener (0.0.2)
+    google_url_shortener (0.0.3)
       json (= 1.4.6)
       rest-client (= 1.6.1)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    fakeweb (1.3.0)
     json (1.4.6)
     mime-types (1.16)
     rest-client (1.6.1)
@@ -18,6 +19,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (>= 1.0.0)
+  fakeweb
   google_url_shortener!
   json (= 1.4.6)
   rest-client (= 1.6.1)

data/google_url_shortener.gemspec

@@ -9,11 +9,10 @@ Gem::Specification.new do |s|
   s.email       = ["josh@josh-nesbitt.net"]
   s.homepage    = "http://rubygems.org/gems/google_url_shortener"
   s.summary     = "A simple library to shorten and expand goo.gl URL's."
-  s.description = "Google URL Shortener is a library to compress and expand goo.gl URL's. It also provides an interface to view analytics of any given URL."
+  s.description = "Google URL Shortener is a library to compress and expand goo.gl URL's. It also provides an interface to review the analytics of a short URL."
   
   s.required_rubygems_version = ">= 1.3.6"
-  s.rubyforge_project         = "google_url_shortener"
-  
+  s.rubyforge_project = "google_url_shortener"
   s.add_dependency "json", "1.4.6"
   s.add_dependency "rest-client", "1.6.1"
   s.add_development_dependency "bundler", ">= 1.0.0"

data/lib/google/url_shortener.rb

@@ -1,21 +1,20 @@
 require 'restclient'
 require 'json'
+require 'date'
 
-%w{ version request base url }.each do |f|
+%w{ version request base url analytics analytics_group errors }.each do |f|
   require("#{GEM_ROOT}/lib/google/url_shortener/#{f}")
 end
 
 module Google
   module UrlShortener
-    class << self
-      
-      def shorten!(url)
-        Url.new(:long_url => url).shorten!
-      end
-      
-      def expand!(url)
-        Url.new(:short_url => url).expand!
-      end
+    
+    def self.shorten!(url)
+      Url.new(:long_url => url).shorten!
+    end
+    
+    def self.expand!(url)
+      Url.new(:short_url => url).expand!
     end
   end
 end

data/lib/google/url_shortener/analytics.rb

@@ -0,0 +1,28 @@
+module Google
+  module UrlShortener
+    class Analytics
+      PROJECTION_LEVEL = "FULL"
+      attr_reader :raw, :all, :month, :week, :day, :two_hours
+      
+      class << self
+        def from_hash(hash)
+          a = new(hash)
+          a.parse_all!
+          a
+        end
+      end
+      
+      def initialize(raw={})
+        @raw = raw.dup
+      end
+      
+      def parse_all!
+        @all   = AnalyticsGroup.from_hash(self.raw["allTime"])
+        @month = AnalyticsGroup.from_hash(self.raw["month"])
+        @week  = AnalyticsGroup.from_hash(self.raw["week"])
+        @day   = AnalyticsGroup.from_hash(self.raw["day"])
+        @two_hours = AnalyticsGroup.from_hash(self.raw["twoHours"])
+      end
+    end
+  end
+end

data/lib/google/url_shortener/analytics_group.rb

@@ -0,0 +1,46 @@
+module Google
+  module UrlShortener
+    class AnalyticsGroup
+      attr_reader :raw,
+                  :short_url_clicks,
+                  :long_url_clicks,
+                  :referrers,
+                  :countries,
+                  :browsers,
+                  :platforms
+      
+      class << self
+        def from_hash(hash)
+          a = new(hash)
+          a.parse_all!
+          a
+        end
+      end
+      
+      def initialize(raw={})
+        @raw = raw.dup
+        @short_url_clicks = self.raw["shortUrlClicks"].to_i
+        @long_url_clicks  = self.raw["longUrlClicks"].to_i
+      end
+      
+      def parse_all!
+        %w{ referrers countries browsers platforms }.each do |g|
+          self.instance_variable_set(:"@#{g}", reverse_array(self.raw[g]))
+        end
+      end
+      
+      private
+      def reverse_array(array=[])
+        hash = {}
+        
+        return hash if array.nil?
+        
+        array.each do |entry|
+          hash[entry["id"]] = entry["count"].to_i
+        end
+        
+        hash
+      end
+    end
+  end
+end

data/lib/google/url_shortener/base.rb

@@ -12,7 +12,11 @@ module Google
         end
         
         def api_key
-          @@api_key
+          begin
+            @@api_key
+          rescue NameError
+            raise MissingApiKey, "No API key has been set!"
+          end
         end
       end
     end

data/lib/google/url_shortener/errors.rb

@@ -0,0 +1,14 @@
+module Google
+  module UrlShortener
+    class UrlShortenerError < StandardError
+      attr_accessor :data
+      
+      def initialize(data)
+        self.data = data
+        super
+      end
+    end
+    
+    class MissingApiKey < UrlShortenerError;end
+  end
+end

data/lib/google/url_shortener/url.rb

@@ -2,7 +2,7 @@ module Google
   module UrlShortener
     class Url < Base
       include Request
-      attr_reader :long_url, :short_url, :status
+      attr_reader :long_url, :short_url, :status, :created_at, :analytics
       
       def initialize(opts={})
         opts.each_pair do |k, v|
@@ -11,11 +11,12 @@ module Google
       end
       
       def decode!
-        params   = validate_and_prepare_params(:shortUrl => self.short_url, :projection => "FULL")
+        params   = validate_and_prepare_params(:shortUrl => self.short_url, :projection => Analytics::PROJECTION_LEVEL)
         response = get(params)
         
-        # TODO: get more info from response
-        @long_url = response["longUrl"]
+        @created_at = Date.parse(response["created"])
+        @analytics  = Analytics.from_hash(response["analytics"])
+        @long_url   = response["longUrl"]
       end
       alias_method :expand!, :decode!
       

data/lib/google/url_shortener/version.rb

@@ -1,6 +1,6 @@
 module Google
   module UrlShortener
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
     
   end
 end

data/readme.textile

@@ -9,6 +9,8 @@ h1. Google Url Shortener.
 
 h2. Overview
 
+Google URL Shortener is a library to compress and expand goo.gl URL's. It also provides an interface to review the analytics of a short URL.
+
 
 
 h2. Installation
@@ -24,7 +26,7 @@ h2. Usage
 
 h3. Setup
 
-You need to provide an API to use the URL shortener service. To do this set the @api_key@ class variable:
+You need to provide an API key to use the URL shortener service. To do this set the @api_key@ class variable:
 
 pre. Google::UrlShortener::Base.api_key = "KEY"
 
@@ -54,6 +56,32 @@ Or the shorthand form:
 pre. Google::UrlShortener.expand!("http://goo.gl/r5akx") # => http://blog.josh-nesbitt.net
 
 
+h3. Getting more data from an expanded URL
+
+More data is available from a URL once it's been expanded:
+
+pre. url = Google::UrlShortener::Url.new(:short_url => "http://goo.gl/r5akx")
+url.expand! # => http://blog.josh-nesbitt.net
+url.created_at # => 2011-01-11
+url.created_at.year # => 2011
+url.analytics # => Google::UrlShortener::Analytics
+url.analytics.all # => Google::UrlShortener::AnalyticsGroup
+url.analytics.all.browsers # => { "Chrome" => 1 }
+url.analytics.all.countries # => { "GB" => 1 }
+url.analytics.all.platforms # => { "Macintosh" => 1 }
+url.analytics.all.referrers # => { "Unknown/empty" => 1 }
+url.analytics.all.long_url_clicks # => 23
+url.analytics.all.short_url_clicks # => 3
+
+Available scopes are:
+
+pre. all
+month
+week
+day
+two_hours
+
+E.g: @url.analytics.month@.
 
 h2. Bugs
 

data/spec/fixtures/expand.json

@@ -0,0 +1,101 @@
+{
+ "kind": "urlshortener#url",
+ "id": "http://goo.gl/r5akx",
+ "longUrl": "http://blog.josh-nesbitt.net/",
+ "status": "OK",
+ "created": "2011-01-11T20:53:38.778+00:00",
+ "analytics": {
+  "allTime": {
+   "shortUrlClicks": "1",
+   "longUrlClicks": "1",
+   "referrers": [
+    {
+     "count": "1",
+     "id": "Unknown/empty"
+    }
+   ],
+   "countries": [
+    {
+     "count": "1",
+     "id": "GB"
+    }
+   ],
+   "browsers": [
+    {
+     "count": "1",
+     "id": "Chrome"
+    }
+   ],
+   "platforms": [
+    {
+     "count": "1",
+     "id": "Macintosh"
+    }
+   ]
+  },
+  "month": {
+   "shortUrlClicks": "1",
+   "longUrlClicks": "1",
+   "referrers": [
+    {
+     "count": "1",
+     "id": "Unknown/empty"
+    }
+   ],
+   "countries": [
+    {
+     "count": "1",
+     "id": "GB"
+    }
+   ],
+   "browsers": [
+    {
+     "count": "1",
+     "id": "Chrome"
+    }
+   ],
+   "platforms": [
+    {
+     "count": "1",
+     "id": "Macintosh"
+    }
+   ]
+  },
+  "week": {
+   "shortUrlClicks": "1",
+   "longUrlClicks": "1",
+   "referrers": [
+    {
+     "count": "1",
+     "id": "Unknown/empty"
+    }
+   ],
+   "countries": [
+    {
+     "count": "1",
+     "id": "GB"
+    }
+   ],
+   "browsers": [
+    {
+     "count": "1",
+     "id": "Chrome"
+    }
+   ],
+   "platforms": [
+    {
+     "count": "1",
+     "id": "Macintosh"
+    }
+   ]
+  },
+  "day": {
+   "shortUrlClicks": "0",
+   "longUrlClicks": "0"
+  },
+  "twoHours": {
+   "shortUrlClicks": "0",
+   "longUrlClicks": "0"
+  }
+ }
+}

data/spec/fixtures/shorten.json

@@ -0,0 +1,5 @@
+{
+ "kind": "urlshorFAKEtener#url",
+ "id": "http://goo.gl/r5akx",
+ "longUrl": "http://blog.josh-nesbitt.net/"
+}

data/spec/helpers/fakeweb.rb

@@ -0,0 +1,14 @@
+module FakewebHelper
+  
+  def stub_request(url, opts={})
+    method  = opts[:method] || :get
+    fixture = opts[:fixture] || "Fakeweb request body"
+    body    = begin
+      File.read(File.expand_path(File.dirname(__FILE__)) + "/../fixtures/#{fixture}.json")
+    rescue Errno::ENOENT
+      raise "Could not find fixture file named '#{fixture}'!"
+    end
+    
+    FakeWeb.register_uri(method, url, :body => body)
+  end
+end

data/spec/lib/google/analytics_spec.rb

@@ -0,0 +1,29 @@
+module Google
+  module UrlShortener
+    describe Analytics do
+      
+      before(:all) do
+        stub_request(Google::UrlShortener::Request::BASE_URL + "?shortUrl=#{@short_url}&projection=FULL&key=#{@key}", :fixture => "expand")
+        url = Google::UrlShortener::Url.new(:short_url => @short_url)
+        url.expand!
+        
+        @analytics = url.analytics
+      end
+      
+      it "should parse the analytics data correctly." do
+        @analytics.all.browsers.class.should  == Hash
+        @analytics.all.referrers.class.should == Hash
+        @analytics.all.countries.class.should == Hash
+        @analytics.all.platforms.class.should == Hash
+        
+        @analytics.all.browsers.should  include("Chrome")
+        @analytics.all.referrers.should include("Unknown/empty")
+        @analytics.all.countries.should include("GB")
+        @analytics.all.platforms.should include("Macintosh")
+        
+        @analytics.all.short_url_clicks.should == 1
+        @analytics.all.long_url_clicks.should  == 1
+      end
+    end
+  end
+end

data/spec/lib/google/base_spec.rb

@@ -0,0 +1,22 @@
+module Google
+  module UrlShortener
+    describe Base do
+      
+      it "should allow an API key to be set" do
+        key = "apikey"
+        Base.api_key = key
+        Base.api_key.should == key
+      end
+      
+      it "should allow a logger to be set" do
+        RestClient.log = nil
+        RestClient.log.should == nil
+        
+        Base.log = $stdout
+        RestClient.log.should == $stdout
+        
+        Base.log = nil
+      end
+    end
+  end
+end

data/spec/lib/google/url_spec.rb

@@ -0,0 +1,29 @@
+module Google
+  module UrlShortener
+    describe Url do
+      
+      it "should have the correct attributes after shortening a URL" do
+        stub_request(Google::UrlShortener::Request::BASE_URL, :method => :post, :fixture => "shorten")
+        
+        url = Google::UrlShortener::Url.new(:long_url => @long_url)
+        url.shorten!
+        
+        url.long_url.should  == @long_url
+        url.short_url.should == @short_url
+      end
+      
+      it "should have the correct attributes after expanding a URL" do
+        stub_request(Google::UrlShortener::Request::BASE_URL + "?shortUrl=#{@short_url}&projection=FULL&key=#{@key}", :fixture => "expand")
+        
+        url = Google::UrlShortener::Url.new(:short_url => @short_url)
+        url.expand!
+        
+        url.long_url.should  == @long_url
+        url.short_url.should == @short_url
+        url.created_at.year.should  == 2011
+        url.created_at.month.should == 01
+        url.created_at.day.should   == 11
+      end
+    end
+  end
+end

data/spec/lib/url_shortener_spec.rb

@@ -0,0 +1,18 @@
+module Google
+  describe UrlShortener do
+    
+    it "should shorten a URL" do
+      stub_request(Google::UrlShortener::Request::BASE_URL, :method => :post, :fixture => "shorten")
+      
+      url = UrlShortener.shorten!(@long_url)
+      url.should == @short_url
+    end
+    
+    it "should expand a URL" do
+      stub_request(Google::UrlShortener::Request::BASE_URL + "?shortUrl=#{@short_url}&projection=FULL&key=#{@key}", :fixture => "expand")
+      
+      url = UrlShortener.expand!(@short_url)
+      url.should == @long_url
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+Dir[File.dirname(__FILE__) + "/helpers/*"].each { |f| require(f) }
+require 'google_url_shortener'
+require 'fakeweb'
+require 'spec'
+include FakewebHelper
+
+Spec::Runner.configure do |config|
+  
+  config.before(:all) do
+    Google::UrlShortener::Base.api_key = "TESTKEY"
+    @key       = Google::UrlShortener::Base.api_key
+    @short_url = "http://goo.gl/r5akx"
+    @long_url  = "http://blog.josh-nesbitt.net/"
+  end
+  
+end

data/spec/watch.rb

@@ -0,0 +1,28 @@
+# A simple alternative to autotest that isnt painful
+
+options = {
+  :options => "--require '#{File.expand_path(File.dirname(__FILE__)) + "/spec_helper"}' --format nested --color",
+  :binary => "spec"
+}
+
+watch("(lib|spec)/(.*)\.rb") do |match|
+  puts %x[ clear ]
+  
+  file   = match[match.size - 1]
+  opts   = options[:options]
+  binary = options[:binary]
+  
+  files = []
+  
+  ["spec/lib/*.rb", "spec/lib/*/*.rb"].each do |glob|
+    Dir.glob(glob).each { |f| files << f }
+  end
+  
+  puts "Found:"
+  files.each { |f| puts "+ #{f}" }
+  puts ""
+  command = "#{binary} #{files.collect! { |f| File.expand_path(f) }.join(" ")} #{opts}"
+  
+  system(command)
+  
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: google_url_shortener
 version: !ruby/object:Gem::Version 
-  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Josh Nesbitt
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 11
         segments: 
         - 1
         - 4
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 13
         segments: 
         - 1
         - 6
@@ -58,7 +55,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 1
         - 0
@@ -66,7 +62,7 @@ dependencies:
         version: 1.0.0
   type: :development
   version_requirements: *id003
-description: Google URL Shortener is a library to compress and expand goo.gl URL's. It also provides an interface to view analytics of any given URL.
+description: Google URL Shortener is a library to compress and expand goo.gl URL's. It also provides an interface to review the analytics of a short URL.
 email: 
 - josh@josh-nesbitt.net
 executables: []
@@ -84,12 +80,23 @@ files:
 - google_url_shortener.gemspec
 - lib/google/url_shortener.rb
 - lib/google/url_shortener/analytics.rb
+- lib/google/url_shortener/analytics_group.rb
 - lib/google/url_shortener/base.rb
+- lib/google/url_shortener/errors.rb
 - lib/google/url_shortener/request.rb
 - lib/google/url_shortener/url.rb
 - lib/google/url_shortener/version.rb
 - lib/google_url_shortener.rb
 - readme.textile
+- spec/fixtures/expand.json
+- spec/fixtures/shorten.json
+- spec/helpers/fakeweb.rb
+- spec/lib/google/analytics_spec.rb
+- spec/lib/google/base_spec.rb
+- spec/lib/google/url_spec.rb
+- spec/lib/url_shortener_spec.rb
+- spec/spec_helper.rb
+- spec/watch.rb
 has_rdoc: true
 homepage: http://rubygems.org/gems/google_url_shortener
 licenses: []
@@ -104,7 +111,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -113,7 +119,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
       segments: 
       - 1
       - 3