simpl 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+API_KEY
+coverage
+spec/fixtures

data/.rvmrc

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+if ! rvm list | grep ruby-1.9.3-p194 ; then
+  rvm install 1.9.3-p194
+fi
+
+rvm use 1.9.3-p194@platformq_simpl

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright 2012 Platform Q Limited
+
+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,24 @@
+# Simpl is a Googl URL shortener
+
+The API is simple:
+
+    your_url = "http://example.com/"
+    your_api_key = "1234567890abcedf"    
+    Simpl::Url.new(your_url, api_key: your_api_key).shortened
+    # -> http://goo.gl/123
+    
+If you're using Rails, it's probably best to setup an initializer with your key in it:
+
+    # config/initializers/simpl.rb
+    Simpl.api_key = "1234567890abcedf"
+    
+    # then use the API like this:
+    Simpl::Url.new(your_url).shortened
+
+# Testing
+
+To test the project on your local machine, download it, run `bundle install`, then run `rake`.
+
+# License
+
+Please see [LICENSE](https://github.com/PlatformQ/simpl/blob/master/LICENSE)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Runs test suite"
+task default: ['spec']
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end

data/lib/simpl.rb

@@ -0,0 +1,24 @@
+require "simpl/version"
+require "simpl/url"
+
+class Simpl
+  class << self
+    # your API key to access Goo.gl
+    # get your's at: https://code.google.com/apis/console/
+    attr_writer :api_key
+    
+    def api_key
+      @api_key || (raise NoApiKeyError, %Q(
+        No Goo.gl API key is present, please set one using:
+        # if you're using Rails put this in config/initializers/googl.rb
+        Googl.api_key = 'YOUR_KEY_HERE'
+      ))
+    end
+    
+    # how long to wait for Goo.gl response
+    # default: 10
+    attr_accessor :timeout
+  end
+  
+  class NoApiKeyError < StandardError; end
+end

data/lib/simpl/url.rb

@@ -0,0 +1,55 @@
+require 'timeout'
+require 'httparty'
+
+class Simpl
+  class Url
+    include HTTParty
+    base_uri 'https://www.googleapis.com'
+  
+    attr_accessor :url
+
+    # required: url to be shortened
+    def initialize(url, options = {})
+      # sets the URL to be shortened
+      self.url = url
+      # allows an instance-level override for the api key
+      @api_key = options[:api_key]
+      # allows an instance-level override for the timeout
+      @timeout = options[:timeout]
+    end
+  
+    # returns: a string respresenting the shortened url
+    # note: may be still the full url should a problem occur
+    def shortened
+      @shortened ||= shorten
+    end
+  
+    private
+    # processes the shortening of the full url
+    def shorten
+      Timeout::timeout(timeout) do
+        # submit the url to Goo.gl
+        result = self.class.post("/urlshortener/v1/url?key=#{api_key}", {
+          body:    { longUrl: url }.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        })
+        # parse the JSON
+        response = JSON.parse(result.body)
+        # return the response id or the url
+        response['id'] || url
+      end
+    # if a problem occurs
+    rescue Timeout::Error, JSON::ParserError => e
+      # just return the original url
+      url
+    end
+    
+    def api_key
+      @api_key || Simpl.api_key
+    end
+
+    def timeout
+      @timeout || Simpl.timeout || 10
+    end
+  end
+end

data/lib/simpl/version.rb

@@ -0,0 +1,3 @@
+class Simpl
+  VERSION = "0.0.1"
+end

data/simpl.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simpl/version"
+
+Gem::Specification.new do |s|
+  s.name        = "simpl"
+  s.version     = Simpl::VERSION
+  s.authors     = ["Ryan Townsend"]
+  s.email       = ["ryan@ryantownsend.co.uk"]
+  s.homepage    = ""
+  s.summary     = %q{Shortens URLs using the Goo.gl service}
+  s.description = s.summary
+
+  s.rubyforge_project = "simpl"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "httparty"
+  s.add_development_dependency "webmock", "~> 1.8"
+  s.add_development_dependency "rake", "~> 0.9"
+  s.add_development_dependency "rspec", "~> 2.8"
+  s.add_development_dependency "vcr", "~> 2.1"
+  s.add_development_dependency "simplecov", "~> 0.6"
+  s.add_development_dependency "json", "~> 1.6"
+end

data/spec/simpl/url_spec.rb

@@ -0,0 +1,142 @@
+require "json"
+require "spec_helper"
+require_relative "../../lib/simpl"
+
+describe Simpl::Url do
+  let(:url) { "http://example.com/test-page" }
+  let(:actual_api_key) { "1234567890abcdef" }
+  
+  before do
+    Simpl.api_key = actual_api_key
+    Simpl.timeout = 30
+  end
+  
+  subject { Simpl::Url.new(url) }
+  
+  context "when no custom timeout is set" do
+    let(:timeout) { 123 }
+    
+    before(:each) { Simpl.timeout = timeout }
+    
+    it "should return the timeout set on the Simpl class" do
+      subject.send(:timeout).should == timeout
+    end
+  end
+  
+  context "when setting a custom timeout" do
+    let(:timeout) { 654 }
+    
+    subject { Simpl::Url.new(url, timeout: timeout) }
+    
+    it "should return the custom timeout" do
+      subject.send(:timeout).should == timeout
+    end
+  end
+  
+  context "when no timeout is set on the class or instance" do
+    before(:each) { Simpl.timeout = nil }
+    
+    it "should return 10 seconds as the default timeout" do
+      subject.send(:timeout).should == 10
+    end
+  end
+  
+  context "when no custom API key is set" do
+    let(:api_key) { "hello" }
+    
+    before(:each) do
+      Simpl.api_key = api_key
+    end
+    
+    it "should return the API key set on the Simpl class" do
+      subject.send(:api_key).should == api_key
+    end
+  end
+  
+  context "when setting a custom API key" do
+    let(:api_key) { "0987654321" }
+    
+    subject { Simpl::Url.new(url, api_key: api_key) }
+    
+    it "should return the custom API key" do
+      subject.send(:api_key).should == api_key
+    end
+  end
+  
+  context "when no API key is set on the class or instance" do
+    before(:each) { Simpl.api_key = nil }
+    
+    it "should raise an error" do
+      lambda { subject.send(:api_key) }.should raise_error(Simpl::NoApiKeyError)
+    end
+  end
+  
+  context "when invalid data is returned from the API" do
+    before(:each) do
+      response = mock("response", body: "<html><head></head><body></body></html>")
+      Simpl::Url.should_receive(:post).and_return(response)
+    end
+    
+    it "should return the original URL" do
+      subject.shortened.should == url
+    end
+  end
+  
+  context "when the API times out" do
+    before(:each) do
+      Simpl::Url.should_receive(:post).and_raise(Timeout::Error)
+    end
+    
+    it "should return the original URL" do
+      subject.shortened.should == url
+    end
+  end
+  
+  context "when the API returns valid JSON with an id" do
+    let(:shortened_url) { "http://goo.gl/123" }
+    
+    before(:each) do
+      response = mock("response", body: { id: shortened_url }.to_json)
+      Simpl::Url.should_receive(:post).and_return(response)
+    end
+
+    it "should return a valid shortened URL" do
+      subject.shortened.should == shortened_url
+    end
+  end
+  
+  context "when the API returns valid JSON without an ID" do
+    before(:each) do
+      response = mock("response", body: {}.to_json)
+      Simpl::Url.should_receive(:post).and_return(response)
+    end
+    
+    it "should return the original URL" do
+      subject.shortened.should == url
+    end
+  end
+  
+  context "against the real API" do
+    use_vcr_cassette "googl-valid-submission"
+    
+    let(:actual_api_key) do
+      api_key_file = File.join(File.dirname(__FILE__), "../../", "API_KEY")
+      unless File.exist?(api_key_file)
+        raise StandardError, %Q(
+          You haven't specified your Googl API key in ./API_KEY,
+          to obtain your's go here:
+          https://code.google.com/apis/console/
+        )
+      end
+      File.read(api_key_file)
+    end
+
+    it "should store a valid full URL" do
+      subject.url.should == url
+    end
+    
+    it "should shorten the url" do
+      subject.shortened.should =~ /^http\:\/\/goo.gl\/.*$/
+    end
+  end
+end

data/spec/simpl_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+require_relative "../lib/simpl"
+
+describe Simpl do
+  it "should allow specification of an API key" do
+    Simpl.api_key = "123"
+    Simpl.api_key.should == "123"
+  end
+  
+  it "should allow specification of a timeout" do
+    Simpl.timeout = 11
+    Simpl.timeout.should == 11
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+  add_filter "/features/"
+end
+
+Dir[File.join(File.dirname(__FILE__), "support", "**/*.rb")].each {|f| require f}

data/spec/support/vcr.rb

@@ -0,0 +1,10 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+end
+
+RSpec.configure do |c|
+  c.extend VCR::RSpec::Macros
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: simpl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Townsend
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Shortens URLs using the Goo.gl service
+email:
+- ryan@ryantownsend.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/simpl.rb
+- lib/simpl/url.rb
+- lib/simpl/version.rb
+- simpl.gemspec
+- spec/simpl/url_spec.rb
+- spec/simpl_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: simpl
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Shortens URLs using the Goo.gl service
+test_files:
+- spec/simpl/url_spec.rb
+- spec/simpl_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr.rb