googl-api 0.2.4 → 0.3.0

data/Gemfile

@@ -1,5 +1,4 @@
 source "http://rubygems.org"
-# gem 'httparty'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
@@ -8,4 +7,6 @@ group :development do
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"
+  gem 'httparty'
+  gem "google_client_login"
 end

data/Gemfile.lock

@@ -1,7 +1,11 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    crack (0.1.8)
     git (1.2.5)
+    google_client_login (0.3.1)
+    httparty (0.6.1)
+      crack (= 0.1.8)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
@@ -15,6 +19,8 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.0.0)
+  google_client_login
+  httparty
   jeweler (~> 1.5.2)
   rcov
   shoulda

data/README.rdoc

@@ -2,7 +2,7 @@
 
 A very simple Ruby wrapper for the Google Url Shortener.
 
-* service - http://goo.gl/
+* service - http://goo.gl
 * api docs - http://code.google.com/apis/urlshortener/index.html
 
 == INSTALLATION:
@@ -11,11 +11,12 @@ A very simple Ruby wrapper for the Google Url Shortener.
 
 == USAGE:
 
-Create a googl client using your API key:
+Create a googl client using your API key and/or with ClientLogin auth information.  (note:  you will need to "Activate" the "URL Shortener API" on this page to retrieve and user your api_key: https://code.google.com/apis/console/b/0/#project:1090911256926:overview )
 
-  googl = GooglApi.new('your api key')
+  googl = GooglApi.new(:api_key => 'your_api_key', :email => 'google_email', :password => 'valid_password')
+  
 
-Then use the client to shorten, extend or review the analytics for a URL.
+Then use the client to shorten, extend or review the analytics for a URL.  If authentication is provided the short_url provided will be specific to the given user and will show up in the users history.
 
   googl.shorten('http://www.google.com')
   googl.expand('http://goo.gl/fbsS')
@@ -23,9 +24,15 @@ Then use the client to shorten, extend or review the analytics for a URL.
 
 These methods will return a response object containing the short/long url and other values provide by the API
 
-* TODO: fix api key usage (broken in goo.gl api?)
-* TODO: implement analytics object
-* TODO: implement usage method
+To access a users history you must provide authentication information
+
+  googl = GooglApi.new(:email => 'google_email', :password => 'valid_password')
+  googl.history
+  
+This method returns a hash containing the authenticated users history
+
+* TODO: implement analytics and history response objects
+* TODO: implement oauth
 
 == ACKNOWLEDGEMENTS 
 

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.3.0

data/googl-api.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{googl-api}
-  s.version = "0.2.4"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Allen"]
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
     "init.rb",
     "lib/googl-api.rb",
     "lib/googl-api/client.rb",
+    "lib/googl-api/client_login.rb",
     "lib/googl-api/response.rb",
     "test/helper.rb",
     "test/test_googl.rb"
@@ -51,12 +52,16 @@ Gem::Specification.new do |s|
       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<httparty>, [">= 0"])
+      s.add_development_dependency(%q<google_client_login>, [">= 0"])
       s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
     else
       s.add_dependency(%q<shoulda>, [">= 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<httparty>, [">= 0"])
+      s.add_dependency(%q<google_client_login>, [">= 0"])
       s.add_dependency(%q<httparty>, [">= 0.6.1"])
     end
   else
@@ -64,6 +69,8 @@ Gem::Specification.new do |s|
     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<httparty>, [">= 0"])
+    s.add_dependency(%q<google_client_login>, [">= 0"])
     s.add_dependency(%q<httparty>, [">= 0.6.1"])
   end
 end

data/lib/googl-api.rb

@@ -1,2 +1,3 @@
 require 'googl-api/client'
+require 'googl-api/client_login'
 require 'googl-api/response'

data/lib/googl-api/client.rb

@@ -4,8 +4,8 @@ module GooglApi
   API_URL     = 'https://www.googleapis.com/urlshortener/'
   API_VERSION = 'v1'
 
-  def self.new(api_key = nil)
-    Client.new(api_key)
+  def self.new(options = {})
+    Client.new(options)
   end
 
   class Client
@@ -14,8 +14,14 @@ module GooglApi
     base_uri "#{API_URL}#{API_VERSION}"
     headers 'Content-Type' => 'application/json; charset=utf-8'
       
-    def initialize(api_key = nil)
-      @api_key = { :key => api_key } unless api_key.blank?
+    def initialize(options = {})
+      # set api key if provided
+      @api_key = { :key => options[:api_key] } if options.has_key?(:api_key)
+
+      # set auth token for client login if provided
+      if options[:email] && options[:password] && @token = ClientLogin.authenticate(options[:email], options[:password])
+        self.class.headers.merge!("Authorization" => "GoogleLogin auth=#{@token}")
+      end
     end
     
     def shorten(url)
@@ -32,6 +38,11 @@ module GooglApi
       raise ArgumentError.new("A URL to check analytics on is required") if url.blank?
       load_respose(self.class.get('/url', :query => @api_key.merge({ :shortUrl => url, :projection => projection })))
     end
+
+    def history
+      raise ArgumentError.new("Doing a history search requires a Client Login (or eventually OAuth to be set)") unless @token
+      self.class.get('/url/history')
+    end
   private
     def load_respose(resp)
       raise GooglError.new(resp.message, resp.code) if resp.code != 200

data/lib/googl-api/client_login.rb

@@ -0,0 +1,16 @@
+require 'google_client_login'
+
+module GooglApi
+  class ClientLogin
+    class << self
+      def authenticate(email, password)
+        login_service = GoogleClientLogin::GoogleAuth.new(:accountType => 'HOSTED_OR_GOOGLE', 
+          :service => 'urlshortener', 
+          :source => 'companyName-applicationName-versionID'
+        )
+        login_service.authenticate(email, password)
+        auth_token = login_service.auth
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -17,7 +17,14 @@ require 'googl-api'
 
 class Test::Unit::TestCase
   def api_key
-    # 'test_key'
-    'AIzaSyDIENPX6ZJoRFIS4Ix-ev5fOjRh8pNME9Y'
+    'test_key'
+  end
+  
+  def email
+    "email"
+  end
+  
+  def password
+    "password"
   end
 end

data/test/test_googl.rb

@@ -3,13 +3,13 @@ require 'helper'
 class TestGoogl < Test::Unit::TestCase
   context "googl-api module" do
       should "create a new googl-api client" do
-        c = GooglApi.new(api_key)
+        c = GooglApi.new(:api_key => api_key)
         assert_equal GooglApi::Client, c.class
       end
     end
     context "using the googl-api client" do
       setup do
-        @client = GooglApi.new(api_key)
+        @client = GooglApi.new(:api_key => api_key)
       end
 
       context "shortening" do
@@ -21,13 +21,13 @@ class TestGoogl < Test::Unit::TestCase
             assert_kind_of GooglApi::Response, @url
           end
           should "return a short goo.gl url" do
-            assert_equal "http://goo.gl/p2Jpa", @url.short_url
+            assert @url.short_url.match(/^http:\/\/goo.gl\//)
           end
           should "save the long url" do
             assert_equal "http://ruby-lang.org/", @url.long_url
           end
           should "provide a qr code url" do
-            assert_equal "http://goo.gl/p2Jpa.qr", @url.qr_code
+            assert_equal @url.short_url, @url.qr_code[0..(@url.short_url.size - 1)]
           end
         end
         context "no links" do
@@ -97,5 +97,33 @@ class TestGoogl < Test::Unit::TestCase
           end
         end
       end
+      context "history" do
+        should "raise an ArgumentError because auth is not set" do
+          assert_raise ArgumentError do
+            @client.history
+          end
+        end
+      end
+    end
+    context "using google client login" do
+      setup do
+        @client_auth = GooglApi.new(:email => email, :password => password)
+      end
+      
+      context "shortening" do
+        context "a single link" do
+          setup do
+            @url = @client_auth.shorten('http://ruby-lang.org/')
+          end
+          should "return a GooglApi::Response" do
+            assert_kind_of GooglApi::Response, @url
+          end
+        end
+      end
+      context "history" do
+        should "have history" do 
+          assert_not_nil @client_auth.history
+        end
+      end
     end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 4
-  version: 0.2.4
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - John Allen
@@ -76,6 +76,32 @@ dependencies:
 - !ruby/object:Gem::Dependency 
   name: httparty
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: google_client_login
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -87,7 +113,7 @@ dependencies:
         version: 0.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *id007
 description: A very simple ruby wrapper for the goo.gl URL Shortening service
 email: john@threedogconsulting.com
 executables: []
@@ -109,6 +135,7 @@ files:
 - init.rb
 - lib/googl-api.rb
 - lib/googl-api/client.rb
+- lib/googl-api/client_login.rb
 - lib/googl-api/response.rb
 - test/helper.rb
 - test/test_googl.rb
@@ -126,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2555399239044821738
+      hash: 3605682061074164118
       segments: 
       - 0
       version: "0"