google_business_api_url_signer 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in google_business_api_url_signer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Thorbjørn Hermansen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Google Business Api Url Signer
+
+Signs URLs used to call Google's business APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'google_business_api_url_signer', git: 'git://github.com/Skalar/google_business_api_url_signer.git'
+
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+    private_key = "my-private-key-here"
+    url = "http://maps.googleapis.com/maps/api/geocode/json?address=New+York&sensor=false&client=clientID"
+    GoogleBusinessApiUrlSigner.add_signature(url, private_key)
+    => "http://maps.googleapis.com/maps/api/geocode/json?address=New+York&sensor=false&client=clientID&signature=KrU1TzVQM7Ur0i8i7K3huiw3MsA="
+
+
+The private key may also be set as a default value on the Signer class,
+in which case you don't have to give it when calling `add_signature`.
+
+    GoogleBusinessApiUrlSigner::Signer.default_private_key = 'my-default-private-key-here'
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/google_business_api_url_signer.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/google_business_api_url_signer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Thorbjørn Hermansen"]
+  gem.email         = ["thhermansen@gmail.com"]
+  gem.description   = %q{Signs URLs used to call Google's business APIs}
+  gem.summary       = %q{Signs URLs used to call Google's business APIs}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "google_business_api_url_signer"
+  gem.require_paths = ["lib"]
+  gem.version       = GoogleBusinessApiUrlSigner::VERSION
+
+  gem.add_dependency "activesupport", "~> 3.2.0"
+  gem.add_development_dependency "rspec", "2.11.0"
+end

data/lib/google_business_api_url_signer.rb

@@ -0,0 +1,27 @@
+require 'active_support/all'
+require "google_business_api_url_signer/version"
+require "google_business_api_url_signer/errors"
+require "google_business_api_url_signer/signer"
+
+module GoogleBusinessApiUrlSigner
+  # Public: Adds a signature to given URL
+  #
+  # url           - The Google API URL you want to sign.
+  #                 The URL should contain your Google client ID set as get parameter 'client'
+  # private_key   - Your private key which you got from Google when signing up for the business APIs
+  #                 This can be left blank if you set GoogleBusinessApiUrlSigner::Signer.default_private_key
+  #
+  #
+  # Example
+  #
+  #   private_key = "my-private-key-here"
+  #   url = "http://maps.googleapis.com/maps/api/geocode/json?address=New+York&sensor=false&client=clientID"
+  #   GoogleBusinessApiUrlSigner.add_signature(url, private_key)
+  #   # => "http://maps.googleapis.com/maps/api/geocode/json?address=New+York&sensor=false&client=clientID&signature=KrU1TzVQM7Ur0i8i7K3huiw3MsA="
+  #
+  def add_signature(url, private_key = nil)
+    Signer.new(url: url, private_key: private_key).signed_url
+  end
+
+  extend self
+end

data/lib/google_business_api_url_signer/errors.rb

@@ -0,0 +1,7 @@
+module GoogleBusinessApiUrlSigner
+  class Error < StandardError; end
+
+  class MissingPrivateKeyError < Error; end
+  class MissingClientIdError < Error; end
+  class UrlAlreadySignedError < Error; end
+end

data/lib/google_business_api_url_signer/signer.rb

@@ -0,0 +1,103 @@
+require 'base64'
+require 'openssl'
+
+module GoogleBusinessApiUrlSigner
+  # Public: Takes care of signing URLs
+  #
+  # Google's documentation for this can be found here:
+  # https://developers.google.com/maps/documentation/business/webservices#generating_valid_signatures
+  #
+  class Signer
+    BASE_64_DECODE_ENCODE_REPLACEMENTS = ['-_', '+/']
+
+    cattr_accessor :default_private_key
+    self.default_private_key = ''
+
+    attr_reader :url
+
+    # Public: Initializes the signer
+    #
+    # options   - url must be given within the options,
+    #             private_key can be given, or you can set default value with:
+    #             GoogleBusinessApiUrlSigner::Signer.default_private_key = 'key'
+    #
+    def initialize(options = {})
+      @url = options.fetch :url
+      @private_key = options.fetch :private_key, default_private_key
+      @private_key = default_private_key if @private_key.blank?
+    end
+
+    def private_key
+      return @private_key if @private_key.present?
+      fail MissingPrivateKeyError
+    end
+
+    # Public: Calculates the signature from the given URL and private key
+    def signature
+      Base64.encode64(signature_digest).tr(*BASE_64_DECODE_ENCODE_REPLACEMENTS.reverse).chomp
+    end
+
+    # Public: Calculates the signature and returns a signed version of the URL
+    def signed_url
+      [
+        parsed_url.scheme,
+        '://',
+        parsed_url.host,
+        parsed_url.path,
+        '?',
+        query_params_as_string_with_signature
+      ].join.html_safe
+    end
+
+
+
+    private
+
+    def signature_digest
+      OpenSSL::HMAC.digest(
+        OpenSSL::Digest.new('sha1'),
+        private_key_decoded, 
+        path_and_query
+      )
+    end
+
+
+
+    def parsed_url
+      @parsed_url ||= URI(url)
+    end
+
+    def path_and_query
+      [parsed_url.path, query_params_as_string].join '?'
+    end
+
+
+
+    def query_params
+      return @query_params if @query_params
+
+      @query_params = Hash[(parsed_url.query || '').split('&').collect { |key_value| key_value.split('=')}]
+
+      fail MissingClientIdError if @query_params['client'].blank?
+      fail UrlAlreadySignedError if @query_params['signature'].present?
+
+      @query_params
+    end
+
+    def query_params_as_string(params = nil)
+      (params || query_params).to_a.collect { |pair| pair.join('=') }.join('&')
+    end
+
+    def query_params_as_string_with_signature
+      query_params_as_string(
+        query_params.update(signature: signature)
+      )
+    end
+
+
+
+    def private_key_decoded
+      Base64.decode64 private_key.tr(*BASE_64_DECODE_ENCODE_REPLACEMENTS)
+    end
+  end
+end

data/lib/google_business_api_url_signer/version.rb

@@ -0,0 +1,3 @@
+module GoogleBusinessApiUrlSigner
+  VERSION = "0.0.1"
+end

data/spec/google_business_api_url_signer/signer_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe GoogleBusinessApiUrlSigner::Signer do
+  let(:url) { "http://maps.googleapis.com/maps/api/geocode/json?address=New+York&sensor=false&client=clientID" }
+  let(:private_key) { "vNIXE0xscrmjlyV-12Nj_BvUPaw=" }
+  let(:signature) { "KrU1TzVQM7Ur0i8i7K3huiw3MsA=" }
+  let(:signed_url) { "http://maps.googleapis.com/maps/api/geocode/json?address=New+York&sensor=false&client=clientID&signature=#{signature}" }
+
+  subject do
+    described_class.new(
+      url: url,
+      private_key: private_key
+    )
+  end
+
+  its(:url) { should eq url }
+  its(:private_key) { should eq private_key }
+  its(:signature) { should eq signature }
+  its(:signed_url) { should eq signed_url }
+  its(:signed_url) { should be_html_safe }
+
+  it "ensures that the URL contains a client id" do
+    expect {
+      described_class.new(url: '', private_key: private_key).signature
+    }.to raise_error GoogleBusinessApiUrlSigner::MissingClientIdError
+  end
+
+  it "ensures that no signature exists within the URL" do
+    expect {
+      described_class.new(url: signed_url, private_key: private_key).signature
+    }.to raise_error GoogleBusinessApiUrlSigner::UrlAlreadySignedError
+  end
+
+  it "ensures that private key is set" do
+    expect {
+      described_class.new(url: signed_url, private_key: '').signature
+    }.to raise_error GoogleBusinessApiUrlSigner::MissingPrivateKeyError
+  end
+
+
+  describe "default private key" do
+    after { described_class.default_private_key = nil }
+
+    it "uses default private key when set" do
+      described_class.default_private_key = 'default'
+
+      Base64.should_receive(:decode64).with('default').and_return 'decoded'
+      described_class.new(url: url).signature
+    end
+
+    it "uses the private key when options are filled with a blank private key" do
+      described_class.default_private_key = 'default'
+
+      Base64.should_receive(:decode64).with('default').and_return 'decoded'
+      described_class.new(url: url, private_key: nil).signature
+    end
+  end
+end

data/spec/google_business_api_url_signer_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe GoogleBusinessApiUrlSigner do
+  describe ".add_signature" do
+    let(:signer) { mock }
+    let(:private_key) { "vNIXE0xscrmjlyV-12Nj_BvUPaw=" }
+    let(:url) { "http://maps.googleapis.com/maps/api/geocode/json?address=New+York&sensor=false&client=clientID" }
+    let(:signed_url) { "http://maps.googleapis.com/maps/api/geocode/json?address=New+York&sensor=false&client=clientID&signature=KrU1TzVQM7Ur0i8i7K3huiw3MsA=" }
+
+    it "delegates to signer" do
+      GoogleBusinessApiUrlSigner::Signer.should_receive(:new).with(hash_including(
+        url: url,
+        private_key: private_key
+      )).and_return signer
+      signer.should_receive(:signed_url).and_return signed_url
+
+      described_class.add_signature(url, private_key).should eq signed_url
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler'
+
+Bundler.require :default, :development
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: google_business_api_url_signer
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Thorbjørn Hermansen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: activesupport
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: rspec
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+    none: false
+description: Signs URLs used to call Google's business APIs
+email:
+- thhermansen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- google_business_api_url_signer.gemspec
+- lib/google_business_api_url_signer.rb
+- lib/google_business_api_url_signer/errors.rb
+- lib/google_business_api_url_signer/signer.rb
+- lib/google_business_api_url_signer/version.rb
+- spec/google_business_api_url_signer/signer_spec.rb
+- spec/google_business_api_url_signer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -119753422113709265
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -119753422113709265
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Signs URLs used to call Google's business APIs
+test_files:
+- spec/google_business_api_url_signer/signer_spec.rb
+- spec/google_business_api_url_signer_spec.rb
+- spec/spec_helper.rb