google-short-links 0.0.1 → 0.1.0

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree

data/Gemfile

@@ -1,8 +1,12 @@
 source :rubygems
 
+gem 'httparty'
+gem 'multi_json'
+
 group :development do
   gem 'jeweler'
   gem 'rcov'
   gem 'rdoc'
   gem 'rspec'
+  gem 'timecop'
 end

data/Gemfile.lock

@@ -3,11 +3,16 @@ GEM
   specs:
     diff-lcs (1.1.3)
     git (1.2.5)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
     json (1.6.1)
+    multi_json (1.0.3)
+    multi_xml (0.4.1)
     rake (0.9.2.2)
     rcov (0.9.11)
     rdoc (3.11)
@@ -20,12 +25,16 @@ GEM
     rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.7.0)
+    timecop (0.3.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  httparty
   jeweler
+  multi_json
   rcov
   rdoc
   rspec
+  timecop

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/google-short-links.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{google-short-links}
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Benjamin Manns"]
-  s.date = %q{2011-11-17}
+  s.date = %q{2011-11-18}
   s.description = %q{Ruby wrapper for Google Short Links.}
   s.email = %q{benmanns@gmail.com}
   s.extra_rdoc_files = [
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
     ".document",
     ".rspec",
     ".rvmrc",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -28,6 +29,10 @@ Gem::Specification.new do |s|
     "VERSION",
     "google-short-links.gemspec",
     "lib/google_short_links.rb",
+    "lib/google_short_links/client.rb",
+    "lib/google_short_links/parser.rb",
+    "spec/google_short_links/client_spec.rb",
+    "spec/google_short_links/parser_spec.rb",
     "spec/google_short_links_spec.rb",
     "spec/spec_helper.rb"
   ]
@@ -41,21 +46,30 @@ 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"])
+      s.add_runtime_dependency(%q<multi_json>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<timecop>, [">= 0"])
     else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<multi_json>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<rcov>, [">= 0"])
       s.add_dependency(%q<rdoc>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<timecop>, [">= 0"])
     end
   else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<multi_json>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<rdoc>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<timecop>, [">= 0"])
   end
 end
 

data/lib/google_short_links.rb

@@ -1,2 +1,4 @@
 module GoogleShortLinks
+  autoload :Client, 'google_short_links/client'
+  autoload :Parser, 'google_short_links/parser'
 end

data/lib/google_short_links/client.rb

@@ -0,0 +1,89 @@
+require 'cgi'
+require 'base64'
+require 'digest/sha1'
+require 'openssl'
+require 'uri'
+
+require 'httparty'
+
+class GoogleShortLinks::Client
+  include HTTParty
+
+  attr_accessor :server, :secret, :email
+
+  parser GoogleShortLinks::Parser
+
+  def initialize options={}
+    self.server = options[:server]
+    self.secret = options[:secret]
+    self.email = options[:email]
+  end
+
+  def get_or_create_hash_url url, params={}
+    request_path = request_path(:get_or_create_hash)
+
+    query = params_to_query(base_params.merge(:url => url).merge(params))
+
+    digest_url(request_path, query)
+  end
+
+  def get_or_create_shortlink_url url, shortcut, params={}
+    request_path = request_path(:get_or_create_shortlink)
+
+    query = params_to_query(base_params.merge(:url => url, :shortcut => shortcut).merge(params))
+
+    digest_url(request_path, query)
+  end
+
+  def get_details_url shortcut, params={}
+    request_path = request_path(:get_details)
+
+    query = params_to_query(base_params.merge(:shortcut => shortcut).merge(params))
+
+    digest_url(request_path, query)
+  end
+
+  def get_or_create_hash url, params={}
+    self.class.get(get_or_create_hash_url(url, params)).parsed_response
+  end
+
+  def get_or_create_shortlink url, shortcut, params={}
+    self.class.get(get_or_create_shortlink_url(url, shortcut, params)).parsed_response
+  end
+
+  def get_details shortcut, params={}
+    self.class.get(get_details_url(shortcut, params)).parsed_response
+  end
+
+  protected
+
+  def request_path action
+    "http://#{server}/js/#{action}"
+  end
+
+  def base_params
+    {
+      :oauth_signature_method => 'HMAC-SHA1',
+      :timestamp => Time.now.to_i.to_f,
+      :user => email,
+    }
+  end
+
+  def params_to_query params
+    params.to_a.sort_by { |param| param.to_s }.map { |(key, value)| "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}" }.join('&')
+  end
+
+  def digest request_path, query
+    content = "GET&#{CGI.escape(request_path)}&#{CGI.escape(query)}"
+
+    digest = OpenSSL::Digest::Digest.new('sha1')
+    digest_raw = OpenSSL::HMAC.digest(digest, secret, content)
+    CGI.escape(Base64.encode64(digest_raw).chomp)
+  end
+
+  def digest_url request_path, query
+    request_uri = URI.parse(request_path)
+    request_uri.query = "#{query}&oauth_signature=#{digest(request_path, query)}"
+    request_uri.to_s
+  end
+end

data/lib/google_short_links/parser.rb

@@ -0,0 +1,10 @@
+require 'httparty'
+require 'multi_json'
+
+class GoogleShortLinks::Parser < HTTParty::Parser
+  SupportedFormats = { 'text/html' => :json }
+
+  def json
+    MultiJson.decode(body)
+  end
+end

data/spec/google_short_links/client_spec.rb

@@ -0,0 +1,287 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe GoogleShortLinks::Client do
+  subject { GoogleShortLinks::Client }
+
+  it { should <= HTTParty }
+
+  describe '#initialize' do
+    subject { GoogleShortLinks::Client.new @params }
+
+    context 'with options { :server => "a", :secret => "b", :email => "c" }' do
+      before :each do
+        @params = { :server => 'a', :secret => 'b', :email => 'c' }
+      end
+
+      it 'sets server to a' do
+        subject.server.should == 'a'
+      end
+
+      it 'sets secret to b' do
+        subject.secret.should == 'b'
+      end
+
+      it 'sets email to c' do
+        subject.email.should == 'c'
+      end
+    end
+
+    context 'with options { :email => "c" }' do
+      before :each do
+        @params = { :email => 'c' }
+      end
+
+      it 'leaves server nil' do
+        subject.server.should be_nil
+      end
+
+      it 'leaves secret nil' do
+        subject.secret.should be_nil
+      end
+
+      it 'sets email to c' do
+        subject.email.should == 'c'
+      end
+    end
+
+    context 'with options {}' do
+      before :each do
+        @params = {}
+      end
+
+      it 'leaves server nil' do
+        subject.server.should be_nil
+      end
+
+      it 'leaves secret nil' do
+        subject.secret.should be_nil
+      end
+
+      it 'leaves email nil' do
+        subject.email.should be_nil
+      end
+    end
+  end
+
+  describe '#get_or_create_hash_url' do
+    subject { GoogleShortLinks::Client.new(@options).get_or_create_hash_url(@url, @params) }
+
+    context 'at 2011-11-17 13:04:15 -0500' do
+      before :each do
+        @now = Time.at(1321553055)
+        Timecop.freeze(@now)
+      end
+
+      after :each do
+        Timecop.return
+      end
+
+      context 'with server a, secret b, and email c' do
+        before :each do
+          @options = { :server => 'a', :secret => 'b', :email => 'c' }
+        end
+
+        context 'with url d' do
+          before :each do
+            @url = 'd'
+          end
+
+          context 'with empty params' do
+            before :each do
+              @params = {}
+            end
+
+            it 'should return a url with host a, path get_or_create_hash, signature method HMAC-SHA1, a current timestamp, url d, and user c, that is signed' do
+              subject.should == "http://a/js/get_or_create_hash?oauth_signature_method=HMAC-SHA1&timestamp=#{Time.now.to_f}&url=d&user=c&oauth_signature=H8ugo%2B8%2FHLIORPo9LjntVSClZXY%3D"
+            end
+          end
+
+          context 'with params oauth_signature_method HMAC-MD5, blah 123' do
+            before :each do
+              @params = { :oauth_signature_method => 'HMAC-MD5', :blah => 123 }
+            end
+
+            it 'should return a url with host a, path get_or_create_hash, signature method HMAC-MD5, a current timestamp, url d, user c, and extra parameter blah 123, that is signed' do
+              subject.should == "http://a/js/get_or_create_hash?blah=123&oauth_signature_method=HMAC-MD5&timestamp=#{Time.now.to_f}&url=d&user=c&oauth_signature=SHidraLOaaGtSP08qTXITZRk4nk%3D"
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe '#get_or_create_shortlink_url' do
+    subject { GoogleShortLinks::Client.new(@options).get_or_create_shortlink_url(@url, @shortcut, @params) }
+
+    context 'at 2011-11-17 13:04:15 -0500' do
+      before :each do
+        @now = Time.at(1321553055)
+        Timecop.freeze(@now)
+      end
+
+      after :each do
+        Timecop.return
+      end
+
+      context 'with server a, secret b, and email c' do
+        before :each do
+          @options = { :server => 'a', :secret => 'b', :email => 'c' }
+        end
+
+        context 'with url d' do
+          before :each do
+            @url = 'd'
+          end
+
+          context 'with a shortcut e' do
+            before :each do
+              @shortcut = 'e'
+            end
+
+            context 'with empty params' do
+              before :each do
+                @params = {}
+              end
+
+              it 'should return a url with host a, path get_or_create_shortlink, signature method HMAC-SHA1, shortcut e, a current timestamp, url d, and user c, that is signed' do
+                subject.should == "http://a/js/get_or_create_shortlink?oauth_signature_method=HMAC-SHA1&shortcut=e&timestamp=#{Time.now.to_f}&url=d&user=c&oauth_signature=Hf23Wj%2FoHARH4oyqy7FCgzUQrSk%3D"
+              end
+            end
+
+            context 'with params oauth_signature_method HMAC-MD5, blah 123' do
+              before :each do
+                @params = { :oauth_signature_method => 'HMAC-MD5', :blah => 123 }
+              end
+
+              it 'should return a url with host a, path get_or_create_shortlink, signature method HMAC-MD5, shortcut e, a current timestamp, url d, user c, and extra parameter blah 123, that is signed' do
+                subject.should == "http://a/js/get_or_create_shortlink?blah=123&oauth_signature_method=HMAC-MD5&shortcut=e&timestamp=#{Time.now.to_f}&url=d&user=c&oauth_signature=bdfkqZPbuqsKqalwou08oImutV0%3D"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe '#get_details_url' do
+    subject { GoogleShortLinks::Client.new(@options).get_details_url(@shortcut, @params) }
+
+    context 'at 2011-11-17 13:04:15 -0500' do
+      before :each do
+        @now = Time.at(1321553055)
+        Timecop.freeze(@now)
+      end
+
+      after :each do
+        Timecop.return
+      end
+
+      context 'with server a, secret b, and email c' do
+        before :each do
+          @options = { :server => 'a', :secret => 'b', :email => 'c' }
+        end
+
+        context 'with a shortcut e' do
+          before :each do
+            @shortcut = 'e'
+          end
+
+          context 'with empty params' do
+            before :each do
+              @params = {}
+            end
+
+            it 'should return a url with host a, path get_details, signature method HMAC-SHA1, shortcut e, a current timestamp, and user c, that is signed' do
+              subject.should == "http://a/js/get_details?oauth_signature_method=HMAC-SHA1&shortcut=e&timestamp=#{Time.now.to_f}&user=c&oauth_signature=4uyxm8VBpvqEjoorn9Z60OhNsr8%3D"
+            end
+          end
+
+          context 'with params oauth_signature_method HMAC-MD5, blah 123' do
+            before :each do
+              @params = { :oauth_signature_method => 'HMAC-MD5', :blah => 123 }
+            end
+
+            it 'should return a url with host a, path get_details, signature method HMAC-MD5, shortcut e, a current timestamp, user c, and extra parameter blah 123, that is signed' do
+              subject.should == "http://a/js/get_details?blah=123&oauth_signature_method=HMAC-MD5&shortcut=e&timestamp=#{Time.now.to_f}&user=c&oauth_signature=iXvjBSxA87X45ShYk4JRb7W%2BcOw%3D"
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe '#get_or_create_hash' do
+    let(:client) { GoogleShortLinks::Client.new }
+
+    subject { client.get_or_create_hash(nil) }
+
+    context 'with get_or_create_hash_url returning http://www.example.org/' do
+      before :each do
+        client.stub!(:get_or_create_hash_url).and_return('http://www.example.org/')
+      end
+
+      it 'should call get with http://www.example.org/' do
+        GoogleShortLinks::Client.should_receive(:get).with('http://www.example.org/').and_return(mock(:parsed_response => nil))
+        subject
+      end
+
+      context 'when get returns a parsed response { "a" => "b" }' do
+        before :each do
+          GoogleShortLinks::Client.stub!(:get).with('http://www.example.org/').and_return(mock(:parsed_response => { 'a' => 'b'}))
+        end
+
+        it { should == { 'a' => 'b' } }
+      end
+    end
+  end
+
+  describe '#get_or_create_shortlink' do
+    let(:client) { GoogleShortLinks::Client.new }
+
+    subject { client.get_or_create_shortlink(nil, nil) }
+
+    context 'with get_or_create_shortlink_url returning http://www.example.org/' do
+      before :each do
+        client.stub!(:get_or_create_shortlink_url).and_return('http://www.example.org/')
+      end
+
+      it 'should call get with http://www.example.org/' do
+        GoogleShortLinks::Client.should_receive(:get).with('http://www.example.org/').and_return(mock(:parsed_response => nil))
+        subject
+      end
+
+      context 'when get returns a parsed response { "a" => "b" }' do
+        before :each do
+          GoogleShortLinks::Client.stub!(:get).with('http://www.example.org/').and_return(mock(:parsed_response => { 'a' => 'b'}))
+        end
+
+        it { should == { 'a' => 'b' } }
+      end
+    end
+  end
+
+  describe '#get_details' do
+    let(:client) { GoogleShortLinks::Client.new }
+
+    subject { client.get_details(nil) }
+
+    context 'with get_details_url returning http://www.example.org/' do
+      before :each do
+        client.stub!(:get_details_url).and_return('http://www.example.org/')
+      end
+
+      it 'should call get with http://www.example.org/' do
+        GoogleShortLinks::Client.should_receive(:get).with('http://www.example.org/').and_return(mock(:parsed_response => nil))
+        subject
+      end
+
+      context 'when get returns a parsed response { "a" => "b" }' do
+        before :each do
+          GoogleShortLinks::Client.stub!(:get).with('http://www.example.org/').and_return(mock(:parsed_response => { 'a' => 'b'}))
+        end
+
+        it { should == { 'a' => 'b' } }
+      end
+    end
+  end
+end

data/spec/google_short_links/parser_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe GoogleShortLinks::Parser do
+  subject { GoogleShortLinks::Parser }
+
+  it { should <= HTTParty::Parser }
+
+  it('should support format :json') { should be_supports_format :json }
+
+  describe '#call' do
+    subject { GoogleShortLinks::Parser.call @body, @format }
+
+    context 'with a format of :json' do
+      before :each do
+        @format = :json
+      end
+
+      context 'with an body of {"a":"b"}' do
+        before :each do
+          @body = '{"a":"b"}'
+        end
+
+        it { should == {'a' => 'b'} }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,6 +3,8 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'google_short_links'
 
+require 'timecop'
+
 Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].each { |f| require f }
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-short-links
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-17 00:00:00.000000000 -05:00
+date: 2011-11-18 00:00:00.000000000 -05:00
 default_executable: 
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &22456740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *22456740
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &22456100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *22456100
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &21125900 !ruby/object:Gem::Requirement
+  requirement: &22455460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21125900
+  version_requirements: *22455460
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &21122960 !ruby/object:Gem::Requirement
+  requirement: &22454860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21122960
+  version_requirements: *22454860
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &21122400 !ruby/object:Gem::Requirement
+  requirement: &22454260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +66,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21122400
+  version_requirements: *22454260
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &21121880 !ruby/object:Gem::Requirement
+  requirement: &22453640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22453640
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &22453020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +88,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21121880
+  version_requirements: *22453020
 description: Ruby wrapper for Google Short Links.
 email: benmanns@gmail.com
 executables: []
@@ -67,6 +100,7 @@ files:
 - .document
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -75,6 +109,10 @@ files:
 - VERSION
 - google-short-links.gemspec
 - lib/google_short_links.rb
+- lib/google_short_links/client.rb
+- lib/google_short_links/parser.rb
+- spec/google_short_links/client_spec.rb
+- spec/google_short_links/parser_spec.rb
 - spec/google_short_links_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -93,7 +131,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2495021109624385223
+      hash: 2703034883636259662
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: