postcode_software 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8fcd0a5548ed9196d57b763770a21255d771cf08
+  data.tar.gz: b4b02d5a0a8fcce3aadc336f9c8cbb6a09f2632c
+SHA512:
+  metadata.gz: df7be95cc6bd8c7af85e8d09c457b5d3dbb27a2cd65d94ec3cb749b5770a253a914c1bab7b3812e4f3012bbda79cf1ae7080c95ba952097d053e76a285a0df72
+  data.tar.gz: 06813bab3a314ec7ccc9882b8bb78eced091a7ebfa69667102d221fff783d316a19e9d21067b7aecfc0924a53284056171e906ff411a38738932b42e264393ab

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Ian Fleeton, Your e Solutions Ltd
+
+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.rdoc

@@ -0,0 +1,20 @@
+== README
+
+Unofficial Ruby wrapper for using the web SDK provided by postcodesoftware.net.
+
+=== Installation
+
+gem install postcode_software
+
+=== Usage
+
+  require 'postcode_software'
+  PostcodeSoftware.account  = 'myaccount'
+  PostcodeSoftware.password = 'mypassword'
+  response = PostcodeSoftware.look_up('LS18 4AB')
+  response.address_1 # => "North Broadgate Lane"
+  response.address_2 # => "Horsforth"
+  response.town      # => "Leeds"
+  response.postcode  # => "LS18 4AB"
+  response.premises[0]
+  # => {:organisation=>nil, :building_details=>"Broadgate House", :number=>nil}

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run specs'
+task default: :spec

data/lib/postcode_software.rb

@@ -0,0 +1,39 @@
+require 'postcode_software/response'
+require 'cgi'
+require 'open-uri'
+
+# Provides postcode look up service for postcodesoftware.net
+#
+#   PostcodeSoftware.account  = 'myaccount'
+#   PostcodeSoftware.password = 'mypassword'
+#   response = PostcodeSoftware.look_up('LS18 4AB')
+module PostcodeSoftware
+
+  class << self
+    # Account for the service
+    attr_accessor :account
+    # Password for the service
+    attr_accessor :password
+  end
+
+  @account  = 'test'
+  @password = 'test'
+
+  # Looks up the given +postcode+ and returns found addresses in a
+  # <tt>PostcodeSoftware::Response</tt>.
+  def self.look_up(postcode)
+    Response.new(open(sdk_url(postcode)))
+  end
+
+  # Returns the web SDK URL for the given postcode.
+  def self.sdk_url(postcode)
+    [
+      'http://ws1.postcodesoftware.co.uk/lookup.asmx/getAddress?account=',
+      CGI::escape(account),
+      '&password=',
+      CGI::escape(password),
+      '&postcode=',
+      CGI.escape(postcode)
+    ].join
+  end
+end

data/lib/postcode_software/response.rb

@@ -0,0 +1,91 @@
+require 'nokogiri'
+
+module PostcodeSoftware
+  # Groups together addresses and status information returned from the
+  # PostcodeSoftware.net web SDK.
+  class Response
+    # Initialise with the XML returned from the PostcodeSoftware service.
+    #
+    # The +xml+ parameter can be a filename, string or input stream as
+    # compatible with Nokogiri.
+    def initialize(xml)
+      @doc = Nokogiri::XML(xml)
+      @doc.remove_namespaces!
+    end
+
+    # Returns the error number.
+    def error_number
+      @doc.at_xpath('//Address//ErrorNumber').content.to_i
+    end
+
+    # Returns the error message.
+    def error_message
+      @doc.at_xpath('//Address//ErrorMessage').content
+    end
+
+    # Street name of the postcode.
+    def address_1
+      try_content '//Address//Address1'
+    end
+
+    # Locality of the postcode or dependent street name if exists.
+    def address_2
+      try_content '//Address//Address2'
+    end
+
+    # Dependent Locality of the postcode.
+    def address_3
+      try_content '//Address//Address3'
+    end
+
+    # Double Dependent Locality of the postcode.
+    def address_4
+      try_content '//Address//Address4'
+    end
+
+    # Town of the postcode.
+    def town
+      try_content '//Address//Town'
+    end
+
+    # County of the postcode.
+    def county
+      try_content '//Address//County'
+    end
+
+    # Postcode that has been searched.
+    def postcode
+      try_content '//Address//Postcode'
+    end
+
+    # Returns premise data for this postcode.
+    #
+    #   [
+    #     {
+    #       :organisation=>'Organisation',
+    #       :building_details=>'Bulding Details',
+    #       :number=>'123'
+    #     },
+    #     ...
+    #   ]
+    def premises
+      if @doc.at_xpath('//Address//PremiseData')
+        str = @doc.at_xpath('//Address//PremiseData').content
+        str
+          .split(';')
+          .map do |x|
+            y = x.split('|', -1)
+            {organisation:y[0], building_details:y[1], number:y[2]}
+          end
+      else
+        []
+      end
+    end
+
+    private
+
+    def try_content(path)
+      @doc.at_xpath(path).content if @doc.at_xpath(path)
+    end
+  end
+end

data/spec/lib/postcode_software/response_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+require 'postcode_software/response'
+
+module PostcodeSoftware
+  describe Response do
+    let(:xml) do
+      <<-xml
+      <?xml version="1.0" encoding="utf-8"?>
+      <Address xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://postcodesoftware.co.uk/">
+      <ErrorNumber>5</ErrorNumber>
+      <ErrorMessage>Test accounts can only be used with LS18 postcodes</ErrorMessage>
+      </Address>
+      xml
+    end
+
+    subject(:response) { Response.new(xml) }
+
+    describe '#error_number' do
+      subject { response.error_number }
+
+      it { is_expected.to eq 5 }
+    end
+
+    describe '#error_message' do
+      subject { response.error_message }
+
+      it { is_expected.to eq 'Test accounts can only be used with LS18 postcodes' }
+    end
+
+    context 'without premise level data' do
+      let(:xml) { xml_fixture('LS184AF-no-premise.xml') }
+
+      it 'has no premises' do
+        expect(subject.premises).to eq []
+      end
+    end
+
+    context 'with LS18 4AA' do
+      let(:xml) { xml_fixture('LS184AA.xml') }
+
+      it 'has address_1 set' do
+        expect(response.address_1).to eq 'South Row'
+      end
+
+      it 'has address_2 set' do
+        expect(response.address_2).to eq 'Horsforth'
+      end
+
+      it 'has address_3 unset' do
+        expect(response.address_3).to be_nil
+      end
+
+      it 'has address_4 unset' do
+        expect(response.address_4).to be_nil
+      end
+
+      it 'has town set' do
+        expect(response.town).to eq 'Leeds'
+      end
+
+      it 'has county set' do
+        expect(response.county).to eq 'West Yorkshire'
+      end
+
+      it 'has postcode set' do
+        expect(response.postcode).to eq 'LS18 4AA'
+      end
+
+      describe 'premises' do
+        subject { response.premises }
+
+        it { expect(subject.length).to eq 4 }
+
+        it 'sets organisation' do
+          expect(subject[1][:organisation]).to eq 'Organisation'
+        end
+
+        it 'sets building details' do
+          expect(subject[2][:building_details]).to eq 'Building Details'
+        end
+
+        it 'sets number' do
+          expect(subject[0][:number]).to eq '1'
+        end
+      end
+    end
+
+    private
+
+    def xml_fixture(filename)
+      File.open(
+        File.join [File.dirname(__FILE__), '..', '..', 'support', 'fixtures', filename]
+      )
+    end
+  end
+end

data/spec/lib/postcode_software_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'postcode_software'
+
+RSpec.describe PostcodeSoftware do
+  describe '.look_up' do
+    subject { PostcodeSoftware.look_up(postcode) }
+
+    context 'with account and password unset' do
+      context 'using example LS18 postcodes' do
+        let(:postcode) { 'LS18 4AA' }
+        it { is_expected.to be_kind_of(PostcodeSoftware::Response) }
+
+        it 'has error_number of 0' do
+          expect(subject.error_number).to eq 0
+        end
+
+        it 'has empty error message' do
+          expect(subject.error_message).to eq ''
+        end
+      end
+
+      context 'using example DN1 postcodes' do
+        let(:postcode) { 'DN1 2QP' }
+        it { is_expected.to be_kind_of(PostcodeSoftware::Response) }
+
+        it 'has error_number of 5' do
+          expect(subject.error_number).to eq 5
+        end
+
+        it 'has error_message set' do
+          expect(subject.error_message).to eq 'Test accounts can only be used with LS18 postcodes'
+        end
+      end
+    end
+
+    context 'with valid account and password' do
+      before do
+        PostcodeSoftware.account = 'valid'
+        PostcodeSoftware.password = 'valid'
+      end
+
+      context 'using example LS18 postcodes' do
+        let(:postcode) { 'LS18 4AA' }
+
+        it { is_expected.to be_kind_of(PostcodeSoftware::Response) }
+      end
+    end
+
+    context 'with invalid account or password' do
+      before do
+        PostcodeSoftware.account = 'invalid'
+      end
+
+      let(:postcode) { 'LS18 4AA' }
+
+      it 'has error_number of 1' do
+        expect(subject.error_number).to eq 1
+      end
+
+      it 'has error_message set' do
+        expect(subject.error_message).to eq 'Account not active'
+      end
+    end
+  end
+
+  describe '.sdk_url' do
+    it 'returns the URL containing auth and postcode params' do
+      PostcodeSoftware.account = 'u'
+      PostcodeSoftware.password = 'p'
+      postcode = 'LS18 4AA'
+      expected = 'http://ws1.postcodesoftware.co.uk/lookup.asmx/getAddress?account=u&password=p&postcode=LS18+4AA'
+      expect(PostcodeSoftware.sdk_url(postcode)).to eq expected
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'webmock/rspec'
+require 'support/fake_postcode_software'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    stub_request(:any, /ws1.postcodesoftware.co.uk/).to_rack(FakePostcodeSoftware)
+  end
+end

data/spec/support/fake_postcode_software.rb

@@ -0,0 +1,37 @@
+require 'sinatra/base'
+
+class FakePostcodeSoftware < Sinatra::Base
+  get '/lookup.asmx/getAddress' do
+    case params[:account]
+    when 'test'     then handle_test
+    when 'valid'    then handle_valid
+    when 'invalid'  then handle_invalid
+    end
+  end
+
+  private
+
+  def handle_test
+    case params[:postcode]
+    when 'LS18 4AA' then xml_response('LS184AA.xml')
+    else
+      xml_response 'only-LS18.xml'
+    end
+  end
+
+  def handle_valid
+    case params[:postcode]
+    when 'LS18 4AA' then xml_response('LS184AA.xml')
+    end
+  end
+
+  def handle_invalid
+    xml_response('account-not-active.xml')
+  end
+
+  def xml_response(file_name)
+    content_type :xml
+    status 200
+    File.open(File.dirname(__FILE__) + '/fixtures/' + file_name, 'rb').read
+  end
+end

data/spec/support/fixtures/LS184AA.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Address xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://postcodesoftware.co.uk/">
+  <Address1>South Row</Address1>
+  <Address2>Horsforth</Address2>
+  <Town>Leeds</Town>
+  <County>West Yorkshire</County>
+  <Postcode>LS18 4AA</Postcode>
+  <PremiseData>||1;Organisation||;|Building Details|;||15;</PremiseData>
+  <ErrorNumber>0</ErrorNumber>
+  <ErrorMessage />
+</Address>

data/spec/support/fixtures/LS184AF-no-premise.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Address xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://postcodesoftware.co.uk/">
+  <Address1>Sylvan View</Address1>
+  <Address2>Horsforth</Address2>
+  <Town>Leeds</Town>
+  <County>West Yorkshire</County>
+  <Postcode>LS18 4AF</Postcode>
+  <ErrorNumber>0</ErrorNumber>
+  <ErrorMessage />
+</Address>

data/spec/support/fixtures/account-not-active.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Address xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://postcodesoftware.co.uk/">
+  <ErrorNumber>1</ErrorNumber>
+  <ErrorMessage>Account not active</ErrorMessage>
+</Address>

data/spec/support/fixtures/only-LS18.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Address xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://postcodesoftware.co.uk/">
+  <ErrorNumber>5</ErrorNumber>
+  <ErrorMessage>Test accounts can only be used with LS18 postcodes</ErrorMessage>
+</Address>

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: postcode_software
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ian Fleeton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: Ruby wrapper for PostcodeSoftware's web SDK, see http://www.postcodesoftware.net/sdk_web.htm
+email: ianfleeton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/postcode_software.rb
+- lib/postcode_software/response.rb
+- spec/lib/postcode_software/response_spec.rb
+- spec/lib/postcode_software_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_postcode_software.rb
+- spec/support/fixtures/LS184AA.xml
+- spec/support/fixtures/LS184AF-no-premise.xml
+- spec/support/fixtures/account-not-active.xml
+- spec/support/fixtures/only-LS18.xml
+homepage: http://rubygems.org/gems/postcode_software
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Postcode Software
+test_files: []