postcode_anywhere 0.2 → 0.3

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Rakefile

@@ -1,29 +1,4 @@
-require 'rake/gempackagetask'
-PKG_FILES = FileList[
-  '[a-zA-Z]*',
-  'generators/**/*',
-  'lib/**/*',
-  'rails/**/*',
-  'tasks/**/*',
-  'test/**/*'
-]
- 
-spec = Gem::Specification.new do |s|
-  s.name = "postcode_anywhere"
-  s.version = "0.2"
-  s.author = "Matthew Crouch"
-  s.email = "mcrouch@mobilezil.la"
-  s.homepage = "http://github.com/mobzilla/postcode_anywhere"
-  s.platform = Gem::Platform::RUBY
-  s.summary = "Find addresses by postcode and building number via Postcode Anywhere API"
-  s.files = PKG_FILES.to_a
-  s.require_path = "lib"
-  s.has_rdoc = false
-  s.extra_rdoc_files = ["README.markdown"]
-  s.add_dependency("httparty", "~> 0.7.7")
-end
- 
-desc 'Turn this plugin into a gem.'
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-end
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/postcode_anywhere.rb

@@ -1,11 +1,10 @@
 require "httparty"
+require "postcode_anywhere/validator"
+require "postcode_anywhere/lookup"
+require "postcode_anywhere/address"
+
 module PostcodeAnywhere
   
-  SERVICE_ADDRESS = "http://services.postcodeanywhere.co.uk/PostcodeAnywhere/Interactive/RetrieveByPostcodeAndBuilding/v1.00/xmle.ws"
-  
-  include HTTParty
-  format :xml
-  
   class << self
     
     attr_accessor :key
@@ -15,11 +14,14 @@ module PostcodeAnywhere
     end
   end
   
+  def self.lookup(options = {})
+    validate_key
+    validate_postcode(options[:postcode])
+    return find_postcode(options)
+  end
+  
   def self.find_by_number_and_postcode(number, postcode)
-    PostcodeAnywhere.validate_key
-    sanitised_postcode = postcode.gsub(/\s/, "")
-    data = PostcodeAnywhere.lookup(number, sanitised_postcode)
-    data["Table"]["Row"]
+    lookup(:number => number, :postcode => postcode)
   end
   
   protected
@@ -29,11 +31,18 @@ module PostcodeAnywhere
       raise PostcodeAnywhereException, "Please provide a valid Postcode Anywhere License Key"
     end
   end
-
-  def self.lookup(number, postcode)
-    PostcodeAnywhere.get SERVICE_ADDRESS+"?Key=#{PostcodeAnywhere.key}&Postcode=#{postcode}&Building=#{number}"
+  
+  def self.validate_postcode(postcode = "")
+    unless PostcodeAnywhere::Validator.valid_postcode?(postcode)
+      raise PostcodeAnywhereException::InvalidPostCode
+    end
+  end
+  
+  def self.find_postcode(options)
+    PostcodeAnywhere::Lookup.lookup(:number => options[:number], :postcode => options[:postcode])
   end
   
   class PostcodeAnywhereException < StandardError;end
+  class PostcodeAnywhereException::InvalidPostCode < StandardError;end
   
 end

data/lib/postcode_anywhere/address.rb

@@ -0,0 +1,5 @@
+module PostcodeAnywhere
+  class Address
+    attr_accessor :udprn, :company, :department, :line1, :line2, :line3, :line4, :line5, :town, :county, :postcode, :mailsort, :barcode, :address_type, :name, :number, :primary_street, :secondary_street, :double_dependent_locality, :dependent_locality, :po_box
+  end
+end

data/lib/postcode_anywhere/error_handler.rb

@@ -0,0 +1,5 @@
+module PostcodeAnywhere
+  class ErrorHandler
+    
+  end
+end

data/lib/postcode_anywhere/lookup.rb

@@ -0,0 +1,18 @@
+require "cgi"
+module PostcodeAnywhere
+  
+  SERVICE_ADDRESS = "http://services.postcodeanywhere.co.uk/PostcodeAnywhere/Interactive/RetrieveByPostcodeAndBuilding/v1.00/xmle.ws"
+  
+  include HTTParty
+  format :xml
+  
+  class Lookup
+    def self.lookup(options)
+      results = PostcodeAnywhere.get(SERVICE_ADDRESS+"?Key=#{PostcodeAnywhere.key}&Postcode=#{CGI::escape(options[:postcode])}&Building=#{options[:number]}")
+      address = Address.new
+      address.line1 = results["Table"]["Row"]["Line1"]
+      address.company = results["Table"]["Row"]["Company"]
+      address
+    end
+  end
+end

data/lib/postcode_anywhere/validator.rb

@@ -0,0 +1,10 @@
+module PostcodeAnywhere
+  class Validator
+    
+    POSTCODE_REGEX = /(GIR 0AA)|(((A[BL]|B[ABDHLNRSTX]?|C[ABFHMORTVW]|D[ADEGHLNTY]|E[HNX]?|F[KY]|G[LUY]?|H[ADGPRSUX]|I[GMPV]|JE|K[ATWY]|L[ADELNSU]?|M[EKL]?|N[EGNPRW]?|O[LX]|P[AEHLOR]|R[GHM]|S[AEGKLMNOPRSTY]?|T[ADFNQRSW]|UB|W[ADFNRSV]|YO|ZE)[1-9]?[0-9]|((E|N|NW|SE|SW|W)1|EC[1-4]|WC[12])[A-HJKMNPR-Y]|(SW|W)([2-9]|[1-9][0-9])|EC[1-9][0-9]) [0-9][ABD-HJLNP-UW-Z]{2})/
+    
+    def self.valid_postcode?(postcode)
+      true if postcode =~ POSTCODE_REGEX
+    end
+  end
+end

data/postcode_anywhere.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "postcode_anywhere"
+  s.version     = "0.3"
+  s.authors     = ["Matthew Crouch"]
+  s.email       = ["matthew@springydevelopment.co.uk"]
+  s.homepage    = ""
+  s.summary     = %q{Postcode Anywhere - Wrapper for postcode lookups}
+  s.description = %q{Find addresses by postcode and building number via Postcode Anywhere API}
+
+  s.rubyforge_project = "postcode_anywhere"
+
+  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_dependency("httparty", "~> 0.7.7")
+  
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "fakeweb"
+  
+end

data/spec/fixtures/no-results.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<Table/>

data/spec/fixtures/postcode-error.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<Table>
+  <Row>
+    <Error>1002</Error>
+    <Description>Postcode Invalid</Description>
+    <Cause>Postcode Invalid</Cause>
+    <Resolution>The Postcode parameter should be valid UK postcode.</Resolution>
+  </Row>
+</Table>

data/spec/fixtures/success.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<Table>
+  <Row>
+    <Udprn>51585066</Udprn>
+    <Company>Harrods</Company>
+    <Department />
+    <Line1>87-135 Brompton Road</Line1>
+    <Line2 />
+    <Line3 />
+    <Line4 />
+    <Line5 />
+    <PostTown>London</PostTown>
+    <County />
+    <Postcode>SW1X 7XL</Postcode>
+    <Mailsort>72114</Mailsort>
+    <Barcode>(SW1X7XL1AC)</Barcode>
+    <Type>SmallBusiness</Type>
+    <DeliveryPointSuffix>1A</DeliveryPointSuffix>
+    <SubBuilding />
+    <BuildingName />
+    <BuildingNumber>87-135</BuildingNumber>
+    <PrimaryStreet>Brompton Road</PrimaryStreet>
+    <SecondaryStreet />
+    <DoubleDependentLocality />
+    <DependentLocality />
+    <PoBox />
+  </Row>
+</Table>

data/spec/fixtures/system_errors/unknown_error.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<Table>
+  <Row>
+    <Error>-1</Error>
+    <Description>Unknown error</Description>
+    <Cause>The cause of the error is unknown but details have been passed to our support staff who will investigate.</Cause>
+    <Resolution>These problems are typically short lived and often resolved by trying again in a few minutes.</Resolution>
+  </Row>
+</Table>

data/spec/postcode_anywhere/lookup_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe PostcodeAnywhere::Lookup do
+  context "found valid postcode" do
+    
+    before(:each) do
+      success_file = File.open(File.expand_path("../../fixtures/success.xml", __FILE__)).read
+      FakeWeb.register_uri(:get, "http://services.postcodeanywhere.co.uk/PostcodeAnywhere/Interactive/RetrieveByPostcodeAndBuilding/v1.00/xmle.ws?Key=AAAA-BBBB-CCCC-DDDD&Postcode=SW1X+7XL&Building=87", :body => success_file, :content_type => "application/xml")
+    end
+    
+    it "should return address" do
+      address = PostcodeAnywhere::Lookup.lookup(:number => 87, :postcode => "SW1X 7XL")
+      address.company.should == "Harrods"
+      address.line1.should == "87-135 Brompton Road"
+    end
+  end
+end

data/spec/postcode_anywhere/validator_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe PostcodeAnywhere::Validator do
+  it "should return false with invalid postcode" do
+    PostcodeAnywhere::Validator.valid_postcode?("S").should be_false
+  end
+  
+  it "should return true with valid postcode" do
+    PostcodeAnywhere::Validator.valid_postcode?("S61 1LD").should be_true
+  end
+end

data/spec/postcode_anywhere_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe PostcodeAnywhere do
+  
+  let(:fake_successful_request) {
+    success_file = File.open(File.expand_path("../fixtures/success.xml", __FILE__)).read
+    FakeWeb.register_uri(:get, "http://services.postcodeanywhere.co.uk/PostcodeAnywhere/Interactive/RetrieveByPostcodeAndBuilding/v1.00/xmle.ws?Key=AAAA-BBBB-CCCC-DDDD&Postcode=SW1X+7XL&Building=87", :body => success_file, :content_type => "application/xml")
+  }
+  
+  context "Invalid API credentials provided" do
+    it "should raise if not API credientials are provided" do
+      expect { PostcodeAnywhere.lookup(:number => 87, :postcode => "SW1X 7XL") }.to raise_error
+    end
+  end
+  
+  context "Valid API credentials provided" do
+    
+    before(:each) do
+      PostcodeAnywhere.key = "AAAA-BBBB-CCCC-DDDD"
+    end
+    
+    it "should raise if no postcode is provided" do
+      expect { PostcodeAnywhere.lookup }.to raise_error
+    end
+    
+    it "should return an address if address is found" do
+      fake_successful_request
+      address = PostcodeAnywhere.lookup(:number => 87, :postcode => "SW1X 7XL")
+      address.company.should == "Harrods"
+      address.line1.should == "87-135 Brompton Road"
+    end
+  end
+  
+  context "Legacy API" do
+    
+    before(:each) do
+      PostcodeAnywhere.key = "AAAA-BBBB-CCCC-DDDD"
+    end
+    
+    it "should allow find_by_number_and_postcode to be used" do
+      fake_successful_request
+      address = PostcodeAnywhere.find_by_number_and_postcode(87, "SW1X 7XL")
+      address.company.should == "Harrods"
+      address.line1.should == "87-135 Brompton Road"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift "#{dir}/../lib"
+ 
+require 'rubygems'
+require 'rspec'
+require 'fakeweb'
+require 'postcode_anywhere'

metadata

@@ -1,80 +1,107 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: postcode_anywhere
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  version: "0.2"
+version: !ruby/object:Gem::Version
+  version: '0.3'
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Matthew Crouch
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-31 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: httparty
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2168666160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 7
-        - 7
+      - !ruby/object:Gem::Version
         version: 0.7.7
   type: :runtime
-  version_requirements: *id001
-description: 
-email: mcrouch@mobilezil.la
+  prerelease: false
+  version_requirements: *2168666160
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2168664860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2168664860
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &2168664220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2168664220
+description: Find addresses by postcode and building number via Postcode Anywhere
+  API
+email:
+- matthew@springydevelopment.co.uk
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files: []
+files:
+- Gemfile
 - README.markdown
-files: 
-- init.rb
 - Rakefile
-- README.markdown
+- init.rb
 - lib/postcode_anywhere.rb
-has_rdoc: true
-homepage: http://github.com/mobzilla/postcode_anywhere
+- lib/postcode_anywhere/address.rb
+- lib/postcode_anywhere/error_handler.rb
+- lib/postcode_anywhere/lookup.rb
+- lib/postcode_anywhere/validator.rb
+- postcode_anywhere.gemspec
+- spec/fixtures/no-results.xml
+- spec/fixtures/postcode-error.xml
+- spec/fixtures/success.xml
+- spec/fixtures/system_errors/unknown_error.xml
+- spec/postcode_anywhere/address_spec.rb
+- spec/postcode_anywhere/lookup_spec.rb
+- spec/postcode_anywhere/validator_spec.rb
+- spec/postcode_anywhere_spec.rb
+- spec/spec_helper.rb
+homepage: ''
 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: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: postcode_anywhere
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Find addresses by postcode and building number via Postcode Anywhere API
-test_files: []
-
+summary: Postcode Anywhere - Wrapper for postcode lookups
+test_files:
+- spec/fixtures/no-results.xml
+- spec/fixtures/postcode-error.xml
+- spec/fixtures/success.xml
+- spec/fixtures/system_errors/unknown_error.xml
+- spec/postcode_anywhere/address_spec.rb
+- spec/postcode_anywhere/lookup_spec.rb
+- spec/postcode_anywhere/validator_spec.rb
+- spec/postcode_anywhere_spec.rb
+- spec/spec_helper.rb