googl 0.1.2 → 0.2.0

data/Gemfile

@@ -1,9 +1,11 @@
 source "http://rubygems.org"
 
+gem "httparty", "0.6.1"
+
 group :development do
   gem "rspec", "~> 2.3.0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"
-  gem "fakeweb", "~> 1.3.0"
+  gem "webmock", "~> 1.6.2"
 end

data/Gemfile.lock

@@ -1,9 +1,12 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    addressable (2.2.2)
+    crack (0.1.8)
     diff-lcs (1.1.2)
-    fakeweb (1.3.0)
     git (1.2.5)
+    httparty (0.6.1)
+      crack (= 0.1.8)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
@@ -18,13 +21,17 @@ GEM
     rspec-expectations (2.3.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.3.0)
+    webmock (1.6.2)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0.0)
-  fakeweb (~> 1.3.0)
+  httparty (= 0.6.1)
   jeweler (~> 1.5.2)
   rcov
   rspec (~> 2.3.0)
+  webmock (~> 1.6.2)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2010 Zigotto®. http://www.zigotto.com.br
+Copyright 2011 Zigotto®. http://www.zigotto.com.br
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -14,6 +14,9 @@ Google URL Shortener API in Ruby
   url.long_url
   => "http://www.zigotto.com/"
 
+  url.qr_code
+  => "http://goo.gl/ump4S.qr"
+
 === Expand a short URL
 
   url = Googl.expand('http://goo.gl/ump4S')
@@ -21,10 +24,30 @@ Google URL Shortener API in Ruby
   url.long_url
   => "http://www.zigotto.com/"
 
+== Authentication
+
+The Google URL Shortener API supports the OAuth and ClientLogin mechanisms for authenticating.
+
+For shorten requests, each short URL for an authenticated user is unique, and thus will gather unique click statistics. In addition, it shows up on the user's dashboard at http://goo.gl.
+
+=== ClientLogin
+
+  client = Googl.client('user@gmail.com', 'my_valid_password')
+
+  url = client.shorten('https://github.com/zigotto/googl')
+  url.short_url
+  => http://goo.gl/DWDfi
+
+Go to http://goo.gl to see URL statistics.
+
+=== OAuth
+
+  TODO
+
 == Installation
 
   gem install googl
 
 == License
 
-MIT License. Copyright 2010 Zigotto®. http://www.zigotto.com.br
+MIT License. Copyright 2011 Zigotto®. http://www.zigotto.com.br

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/googl.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{googl}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jesus Lopes"]
-  s.date = %q{2011-01-11}
+  s.date = %q{2011-01-13}
   s.description = %q{Small library for Google URL Shortener API}
   s.email = %q{jlopes@zigotto.com.br}
   s.extra_rdoc_files = [
@@ -24,12 +24,18 @@ Gem::Specification.new do |s|
     "VERSION",
     "googl.gemspec",
     "lib/googl.rb",
+    "lib/googl/base.rb",
+    "lib/googl/client_login.rb",
     "lib/googl/expand.rb",
     "lib/googl/request.rb",
     "lib/googl/shorten.rb",
+    "spec/client_spec.rb",
     "spec/expand_spec.rb",
+    "spec/fixtures/client_login_invalid.json",
+    "spec/fixtures/client_login_valid.json",
     "spec/fixtures/expand.json",
     "spec/fixtures/shorten.json",
+    "spec/fixtures/shorten_authenticated.json",
     "spec/shorten_spec.rb",
     "spec/spec_helper.rb"
   ]
@@ -39,6 +45,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.4.2}
   s.summary = %q{Wrapper for Google URL Shortener API}
   s.test_files = [
+    "spec/client_spec.rb",
     "spec/expand_spec.rb",
     "spec/shorten_spec.rb",
     "spec/spec_helper.rb"
@@ -48,26 +55,29 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, ["= 0.6.1"])
       s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<fakeweb>, ["~> 1.3.0"])
+      s.add_development_dependency(%q<webmock>, ["~> 1.6.2"])
       s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
     else
+      s.add_dependency(%q<httparty>, ["= 0.6.1"])
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<fakeweb>, ["~> 1.3.0"])
+      s.add_dependency(%q<webmock>, ["~> 1.6.2"])
       s.add_dependency(%q<httparty>, [">= 0.6.1"])
     end
   else
+    s.add_dependency(%q<httparty>, ["= 0.6.1"])
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
     s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<fakeweb>, ["~> 1.3.0"])
+    s.add_dependency(%q<webmock>, ["~> 1.6.2"])
     s.add_dependency(%q<httparty>, [">= 0.6.1"])
   end
 end

data/lib/googl.rb

@@ -1,9 +1,10 @@
-require 'rubygems'
 require 'httparty'
 
+require 'googl/base'
 require 'googl/request'
 require 'googl/shorten'
 require 'googl/expand'
+require 'googl/client_login'
 
 module Googl
 
@@ -15,4 +16,8 @@ module Googl
     Googl::Expand.new(url)
   end
 
+  def self.client(email, passwd)
+    Googl::ClientLogin.new(email, passwd)
+  end
+
 end

data/lib/googl/base.rb

@@ -0,0 +1,13 @@
+module Googl
+
+  class Base
+
+    private
+
+    def modify_headers(item)
+      Request.headers.merge!(item)
+    end
+
+  end
+
+end

data/lib/googl/client_login.rb

@@ -0,0 +1,29 @@
+module Googl
+
+  class ClientLogin < Base
+
+    API_URL = "https://www.google.com/accounts/ClientLogin"
+
+    PARAMS = {'accountType' => 'HOSTED_OR_GOOGLE', 'service' => 'urlshortener', 'source' => 'gem-googl-ruby'}
+
+    attr_accessor :code
+
+    def initialize(email, passwd)
+      modify_headers('Content-Type' => 'application/x-www-form-urlencoded')
+      resp = Request.post(API_URL, :body => PARAMS.merge!('Email' => email, 'Passwd' => passwd))
+      @code = resp.code
+      if resp.code == 200
+        token = resp.split('=').last.gsub(/\n/, '')
+        modify_headers("Authorization" => "GoogleLogin auth=#{token}")
+      else
+        resp.response
+      end
+    end
+
+    def shorten(url)
+      Googl::Shorten.new(url)
+    end
+
+  end
+
+end

data/lib/googl/expand.rb

@@ -2,12 +2,14 @@ module Googl
 
   class Expand
 
+    API_URL = "https://www.googleapis.com/urlshortener/v1/url?shortUrl="
+
     attr_accessor :long_url
 
     def initialize(short_url)
-      resp = Request.get("/urlshortener/v1/url?shortUrl=#{short_url}")
+      resp = Request.get(API_URL + short_url)
       if resp.code == 200
-        self.long_url   = resp['longUrl']
+        @long_url   = resp['longUrl']
       else
         resp.response
       end

data/lib/googl/request.rb

@@ -1,6 +1,3 @@
 class Request
   include HTTParty
-  base_uri 'https://www.googleapis.com'
-  headers 'Content-Type' => 'application/json'
-  headers "Content-length" => "0"
 end

data/lib/googl/shorten.rb

@@ -1,20 +1,27 @@
 module Googl
 
-  class Shorten
+  class Shorten < Base
+
+    API_URL = 'https://www.googleapis.com/urlshortener/v1/url'
 
     attr_accessor :short_url, :long_url
 
     def initialize(long_url)
+      modify_headers('Content-Type' => 'application/json')
       options = {"longUrl" => long_url}.inspect
-      resp = Request.post('/urlshortener/v1/url', :body => options)
+      resp = Request.post(API_URL, :body => options)
       if resp.code == 200
-        self.short_url  = resp['id']
-        self.long_url   = resp['longUrl']
+        @short_url  = resp['id']
+        @long_url   = resp['longUrl']
       else
         resp.response
       end
     end
 
+    def qr_code
+      short_url + ".qr" if !short_url.blank?
+    end
+
   end
 
 end

data/spec/client_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Googl::ClientLogin do
+
+  before :each do
+    fake_urls
+  end
+
+  context "request a new client login" do
+
+    it { Googl.should respond_to(:client) }
+
+    context "when valid" do
+
+      subject { Googl.client('my_user@gmail.com', 'my_valid_password') }
+
+      describe "#code" do
+        it "should return 200" do
+          subject.code.should == 200
+        end
+      end
+
+    end
+
+    context "when invalid" do
+
+      subject { Googl.client('my_invalid_gmail', 'my_invalid_passwod') }
+
+      describe "#code" do
+        it "should return 403" do
+          subject.code.should == 403
+        end
+      end
+      
+    end
+
+  end
+
+  context "request new shor url" do
+
+    before :each do
+      @client = Googl.client('my_user@gmail.com', 'my_valid_password') 
+    end
+
+    it { @client.should respond_to(:shorten) }
+
+    subject { @client.shorten('http://www.zigotto.net') }
+
+    describe "#short_url" do
+      it "should return a short URL" do
+        subject.short_url.start_with?("http://goo.gl/").should be_true
+      end
+    end
+    
+  end
+
+end

data/spec/fixtures/client_login_invalid.json

@@ -0,0 +1,12 @@
+HTTP/1.1 403 Forbidden
+Content-Type: text/plain
+Cache-control: no-cache, no-store
+Pragma: no-cache
+Expires: Mon, 01-Jan-1990 00:00:00 GMT
+Date: Thu, 13 Jan 2011 12:59:18 GMT
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 1; mode=block
+Content-Length: 24
+Server: GSE
+
+Error=BadAuthentication

data/spec/fixtures/client_login_valid.json

@@ -0,0 +1,14 @@
+HTTP/1.1 200 OK
+Content-Type: text/plain
+Cache-control: no-cache, no-store
+Pragma: no-cache
+Expires: Mon, 01-Jan-1990 00:00:00 GMT
+Date: Thu, 13 Jan 2011 11:47:47 GMT
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 1; mode=block
+Content-Length: 755
+Server: GSE
+
+SID=DQAAAKwAAABcU9-c9pgL8tAf6T6oEBT4wFgOskDQE7t_f_ehTKhrlKULwNhUXOlaZgeG8e8dZwfV6Odpzb15CzCSQ
+LSID=DQAAAK4AAAC9oNnhvkDo8-jbQQbWzyvi_sAlt9ZkcmFoKsed7zfbmBs0rurcEL5vuN0DR_0s60v2j9kVf0_2yUVu
+Auth=DQAAAK8AAAC9ahL-o7g

data/spec/fixtures/shorten_authenticated.json

@@ -0,0 +1,18 @@
+HTTP/1.1 200 OK
+ETag: "EEZ1AD443JkEgW3KJFaymzTd26A/41aG_KwuemZSq8rrtXp-EsY0Iuk"
+Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+Pragma: no-cache
+Expires: Fri, 01 Jan 1990 00:00:00 GMT
+Date: Thu, 13 Jan 2011 13:07:26 GMT
+Content-Type: application/json; charset=UTF-8
+X-Content-Type-Options: nosniff
+X-Frame-Options: SAMEORIGIN
+X-XSS-Protection: 1; mode=block
+Server: GSE
+Transfer-Encoding: chunked
+
+{
+ "kind": "urlshortener#url",
+ "id": "http://goo.gl/R3mYj",
+ "longUrl": "http://www.zigotto.net/"
+}

data/spec/shorten_spec.rb

@@ -24,6 +24,12 @@ describe Googl::Shorten do
       end
     end
 
+    describe "#qr_code" do
+      it "should return a url for generate a qr code" do
+        subject.qr_code.should == 'http://goo.gl/ump4S.qr'
+      end
+    end
+
   end
 
 end

data/spec/spec_helper.rb

@@ -1,27 +1,48 @@
-require "rubygems"
-require "rspec"
-require 'fakeweb'
-
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
+require "rubygems"
+require "rspec"
+require 'webmock/rspec'
 require 'googl'
 
 def load_fixture(name)
-  File.join(File.expand_path(File.dirname(__FILE__)), '/fixtures', name)
+  File.new(File.join(File.expand_path(File.dirname(__FILE__)), '/fixtures', name))
 end
 
 def fake_urls
 
-  FakeWeb.allow_net_connect = false
-
   # Shorten
-  url = "https://www.googleapis.com/urlshortener/v1/url"
-  options = {"longUrl" => "http://www.zigotto.com"}.inspect
-  FakeWeb.register_uri(:post, url, :response => load_fixture('shorten.json'), :body => options)
+  url_shorten = "https://www.googleapis.com/urlshortener/v1/url"
+  params = {"longUrl" => "http://www.zigotto.com"}.inspect
+  stub_request(:post, url_shorten).
+    with(:body => params,
+         :headers => {'Content-Type'=>'application/json'}).
+         to_return(load_fixture('shorten.json'))
 
   # Expand
-  url = "https://www.googleapis.com/urlshortener/v1/url?shortUrl=http://goo.gl/7lob"
-  FakeWeb.register_uri(:get, url, :response => load_fixture('expand.json'))
+  url_expand = "https://www.googleapis.com/urlshortener/v1/url?shortUrl=http://goo.gl/7lob"
+  stub_request(:get, url_expand).to_return(load_fixture('expand.json'))
+
+  # Authentication
+  url_login = "https://www.google.com/accounts/ClientLogin"
+
+  # ClientLogin valid
+  params = "Passwd=my_valid_password&service=urlshortener&accountType=HOSTED_OR_GOOGLE&Email=my_user%40gmail.com&source=gem-googl-ruby"
+  stub_request(:post, url_login).
+    with(:body => params,
+         :headers => {'Content-Type'=>'application/x-www-form-urlencoded'}).
+         to_return(load_fixture('client_login_valid.json'))
+
+  # ClientLogin invalid
+  params = "Passwd=my_invalid_passwod&service=urlshortener&accountType=HOSTED_OR_GOOGLE&Email=my_invalid_gmail&source=gem-googl-ruby"
+  stub_request(:post, url_login).with(:body => params).to_return(load_fixture('client_login_invalid.json'))
+
+  # Shorten authenticated
+  params = {"longUrl" => "http://www.zigotto.net"}.inspect
+  stub_request(:post, url_shorten).
+    with(:body => params, 
+         :headers => {'Authorization'=>'GoogleLogin auth=DQAAAK8AAAC9ahL-o7g', 'Content-Type'=>'application/json'}).
+         to_return(load_fixture('shorten_authenticated.json'))
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: googl
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jesus Lopes
@@ -15,14 +15,30 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-11 00:00:00 -02:00
+date: 2011-01-13 00:00:00 -02:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: httparty
+  type: :runtime
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
   prerelease: false
   name: rspec
   type: :development
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -33,12 +49,12 @@ dependencies:
         - 3
         - 0
         version: 2.3.0
-  requirement: *id001
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
   prerelease: false
   name: bundler
   type: :development
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -49,12 +65,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  requirement: *id002
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
   prerelease: false
   name: jeweler
   type: :development
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -65,12 +81,12 @@ dependencies:
         - 5
         - 2
         version: 1.5.2
-  requirement: *id003
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
   prerelease: false
   name: rcov
   type: :development
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -79,28 +95,28 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id004
+  requirement: *id005
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  name: fakeweb
+  name: webmock
   type: :development
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 11
         segments: 
         - 1
-        - 3
-        - 0
-        version: 1.3.0
-  requirement: *id005
+        - 6
+        - 2
+        version: 1.6.2
+  requirement: *id006
 - !ruby/object:Gem::Dependency 
   prerelease: false
   name: httparty
   type: :runtime
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -111,7 +127,7 @@ dependencies:
         - 6
         - 1
         version: 0.6.1
-  requirement: *id006
+  requirement: *id007
 description: Small library for Google URL Shortener API
 email: jlopes@zigotto.com.br
 executables: []
@@ -129,12 +145,18 @@ files:
 - VERSION
 - googl.gemspec
 - lib/googl.rb
+- lib/googl/base.rb
+- lib/googl/client_login.rb
 - lib/googl/expand.rb
 - lib/googl/request.rb
 - lib/googl/shorten.rb
+- spec/client_spec.rb
 - spec/expand_spec.rb
+- spec/fixtures/client_login_invalid.json
+- spec/fixtures/client_login_valid.json
 - spec/fixtures/expand.json
 - spec/fixtures/shorten.json
+- spec/fixtures/shorten_authenticated.json
 - spec/shorten_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -172,6 +194,7 @@ signing_key:
 specification_version: 3
 summary: Wrapper for Google URL Shortener API
 test_files: 
+- spec/client_spec.rb
 - spec/expand_spec.rb
 - spec/shorten_spec.rb
 - spec/spec_helper.rb