gcoder 0.11.0 → 0.12.0

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    gcoder (0.12.0)
+      hashie
+      ruby-hmac
+      yajl-ruby
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    hashie (1.0.0)
+    ruby-hmac (0.4.0)
+    yajl-ruby (0.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gcoder!

data/README.md

@@ -52,6 +52,11 @@ More info [here](http://code.google.com/apis/maps/documentation/geocoding/#Viewp
 To access the special features of Google Maps API Premier, you must provide a
 client ID. All client IDs begin with a gme- prefix.
 
+### `:key`
+
+To access the special features of Google Maps API Premier, you must provide a
+signing key in addition to the client ID.
+
 ### `:storage`
 
 Defines the storage adapter to use for caching results from the geocoder to

data/Rakefile

@@ -1,5 +1,5 @@
 require 'rubygems/specification' unless defined?(Gem::Specification)
-require 'rake/gempackagetask'
+require 'rubygems/package_task'
 require 'rake/testtask'
 
 def gemspec
@@ -35,7 +35,7 @@ task :release => :package do
   sh "gem push pkg/#{gemspec.name}-#{gemspec.version}.gem"
 end
 
-Rake::GemPackageTask.new(gemspec) do |pkg|
+Gem::PackageTask.new(gemspec) do |pkg|
   pkg.gem_spec = gemspec
 end
 task :gem => :gemspec

data/gcoder.gemspec

@@ -11,11 +11,12 @@ Gem::Specification.new do |s|
   s.summary     = %q{A nice library for geocoding stuff with Google Maps API V3}
   s.description = %q{Uses Google Maps Geocoding API (V3) to geocode stuff and optionally caches the results somewhere.}
 
-  s.required_rubygems_version = '>= 1.3.6'
+  s.required_rubygems_version = '>= 1.8.5'
   s.rubyforge_project = 'gcoder'
 
   s.add_dependency 'hashie'
   s.add_dependency 'yajl-ruby'
+  s.add_dependency 'ruby-hmac'
 
   s.files         = `git ls-files`.split(?\n)
   s.test_files    = `git ls-files -- {test,spec}/*`.split(?\n)

data/lib/gcoder.rb

@@ -1,8 +1,12 @@
 require 'yajl'
 require 'hashie'
 require 'net/http'
+require 'uri'
+require 'base64'
 require 'timeout'
 require 'digest/sha1'
+require 'hmac'
+require 'hmac-sha1'
 
 $:.unshift(File.dirname(__FILE__))
 
@@ -24,6 +28,8 @@ module GCoder
     :append         => nil,
     :region         => nil,
     :bounds         => nil,
+    :client         => nil,
+    :key            => nil,
     :storage        => nil,
     :storage_config => nil
   }.freeze

data/lib/gcoder/geocoder.rb

@@ -5,14 +5,9 @@ module GCoder
     PATH = '/maps/api/geocode/json'
 
     class Request
-      def self.u(string)
-        string.to_s.gsub(/([^ a-zA-Z0-9_.-]+)/n) {
-          '%' + $1.unpack('H2' * $1.size).join('%').upcase
-        }.tr(' ', '+')
-      end
 
       def self.to_query(params)
-        params.map { |key, val| "#{u key}=#{u val}" }.join('&')
+        URI.escape(params.map { |key, val| "#{key}=#{val}" }.join('&'))
       end
 
       def self.stubs
@@ -30,17 +25,17 @@ module GCoder
 
       def params
         p = { :sensor => 'false' }
-        p[:address]  = address            if @address
-        p[:latlng]   = latlng             if @latlng
-        p[:language] = @config[:language] if @config[:language]
-        p[:region]   = @config[:region]   if @config[:region]
-        p[:bounds]   = bounds             if @config[:bounds]
-        p[:client]   = @config[:client]   if @config[:client]
+        p[:address]   = address             if @address
+        p[:latlng]    = latlng              if @latlng
+        p[:language]  = @config[:language]  if @config[:language]
+        p[:region]    = @config[:region]    if @config[:region]
+        p[:bounds]    = bounds              if @config[:bounds]
+        p[:client]    = @config[:client]    if @config[:client]
         p
       end
 
       def path
-        "#{PATH}?#{self.class.to_query(params)}"
+        "#{PATH}?#{self.class.to_query(params)}#{"&signature=#{sign_key(@config[:key])}" if @config[:key]}"
       end
 
       def uri
@@ -97,8 +92,23 @@ module GCoder
       def address
         @config[:append] ? "#{@address} #{@config[:append]}" : @address
       end
-    end
+      
+      def url_safe_base64_decode(string)
+        return Base64.decode64(string.tr('-_','+/')).gsub(/\n/,'')
+      end
 
+      def url_safe_base64_encode(raw)
+        return Base64.encode64(raw).tr('+/','-_').gsub(/\n/,'')
+      end
+      
+      def sign_key(key)
+        sha1 = HMAC::SHA1.new(url_safe_base64_decode(key))
+        sha1 << "#{PATH}?#{self.class.to_query(params)}"
+        raw_signature = sha1.digest()
+        
+        url_safe_base64_encode(raw_signature)  
+      end
+    end
 
     class Response
       attr_reader :uri, :data

data/lib/gcoder/version.rb

@@ -1,3 +1,3 @@
 module GCoder
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
 end

data/spec/gcoder/geocoder_spec.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require 'spec_helper'
 
 describe GCoder::Geocoder::Request do
@@ -23,12 +24,18 @@ describe GCoder::Geocoder::Request do
   end
 
   it 'should URI encode a string' do
-    GCoder::Geocoder::Request.u('hello world').must_equal 'hello+world'
+    q = GCoder::Geocoder::Request.to_query(:q => 'hello world', :a => 'test')
+    q.must_equal 'q=hello%20world&a=test'
+  end
+
+  it 'should URI encode a UTF-8 string' do
+    q = GCoder::Geocoder::Request.to_query(:q => 'मुंबई', :a => 'test')
+    q.must_equal 'q=%E0%A4%AE%E0%A5%81%E0%A4%82%E0%A4%AC%E0%A4%88&a=test'
   end
 
   it 'should create a query string' do
     q = GCoder::Geocoder::Request.to_query(:q => 'hello world', :a => 'test')
-    q.must_equal 'q=hello+world&a=test'
+    q.must_equal 'q=hello%20world&a=test'
   end
 
   it '(when passed a bounds option) should generate correct query params' do
@@ -50,4 +57,10 @@ describe GCoder::Geocoder::Request do
       req.params[:address].must_equal 'queen and spadina'
     end
   end
+  
+  it "(when passed a premier client and key) should generate correct query params" do
+    q = GCoder::Geocoder::Request.new('los angeles', :client => "gme-test", :key => "zNf23lb-YIoD4kEFN34C6324cww=").path
+    q.must_equal '/maps/api/geocode/json?sensor=false&address=los%20angeles&client=gme-test&signature=p0EiRD298eLhlGTqlBA5RKxv448='
+  end
+  
 end

data/spec/support/requests.yml

@@ -15,4 +15,4 @@
   :uri: http://maps.googleapis.com/maps/api/geocode/json?sensor=false&address=overlimit
 
 - :file: 6.json
-  :uri: http://maps.googleapis.com/maps/api/geocode/json?sensor=false&address=invalid
+  :uri: http://maps.googleapis.com/maps/api/geocode/json?sensor=false&address=invalid

metadata

@@ -1,61 +1,61 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: gcoder
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 11
-  - 0
-  version: 0.11.0
+version: !ruby/object:Gem::Version
+  version: 0.12.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Carsten Nielsen
 - Christos Pappas
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-17 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-07-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: hashie
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2160555480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *2160555480
+- !ruby/object:Gem::Dependency
   name: yajl-ruby
+  requirement: &2160554660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2160554660
+- !ruby/object:Gem::Dependency
+  name: ruby-hmac
+  requirement: &2160553960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-description: Uses Google Maps Geocoding API (V3) to geocode stuff and optionally caches the results somewhere.
-email: 
+  prerelease: false
+  version_requirements: *2160553960
+description: Uses Google Maps Geocoding API (V3) to geocode stuff and optionally caches
+  the results somewhere.
+email:
 - heycarsten@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -77,41 +77,31 @@ files:
 - spec/support/requests/4.json
 - spec/support/requests/5.json
 - spec/support/requests/6.json
-has_rdoc: true
 homepage: http://github.com/heycarsten/gcoder
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
-      version: 1.3.6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.5
 requirements: []
-
 rubyforge_project: gcoder
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: A nice library for geocoding stuff with Google Maps API V3
-test_files: 
+test_files:
 - spec/gcoder/geocoder_spec.rb
 - spec/gcoder/resolver_spec.rb
 - spec/gcoder/storage_spec.rb