postcodeinfo-client-ruby 0.1.0

data/spec/postcode_spec.rb

@@ -0,0 +1,225 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe PostcodeInfo::Postcode do
+  let(:api_client){ double('api client', make_request: nil) }
+  let(:postcode){ described_class.new('SN51NB', api_client) }
+
+  describe 'constructing a Postcode' do
+    let(:postcode){ 'SN51NB' }
+
+    context 'that is valid' do
+      context 'and does not contain whitespace' do
+        let(:postcode){ 'YO165RB' }
+
+        it 'does not raise an error' do
+          expect{described_class.new(postcode, api_client)}.to_not raise_error
+        end
+      end
+      context 'and contains whitespace' do
+        let(:postcode){ 'N2 8AS'}
+
+        it 'does not raise an error' do
+          expect{described_class.new(postcode, api_client)}.to_not raise_error
+        end
+      end
+
+      it 'does not make an API request' do
+        expect( api_client ).to_not receive(:make_request)
+        described_class.new(postcode, api_client)
+      end
+
+      it 'stores a normalised version of the given postcode ' do
+        expect(described_class.new(" AB12  4DE\n", api_client).normalised).to eq('ab124de')
+      end
+    end
+
+    context 'that is invalid' do
+      let(:postcode){ 'd0nk 3y5' }
+
+      it 'does not raise an error' do
+        expect{described_class.new(postcode, api_client)}.to_not raise_error
+      end
+    end
+
+  end
+
+  describe 'valid?' do
+    let(:postcode){ described_class.new('SN51NB', api_client) }
+
+    context 'when the instance variable is nil' do
+      before do
+        postcode.send(:instance_variable_set, '@valid', nil)
+      end
+
+      it 'performs a lookup on the API' do
+        expect( api_client ).to receive(:valid?)
+        postcode.valid?
+      end
+
+      it 'stores the return value from the API in the instance variable' do
+        allow(api_client).to receive(:valid?).and_return('foo')
+        expect(postcode.valid?).to eq('foo')
+      end
+    end
+        
+    context 'when the instance variable has a value' do
+      before do
+        postcode.send(:instance_variable_set, '@valid', 'bar')
+      end
+      
+      it 'does not perform a lookup on the API' do
+        expect( api_client ).to_not receive(:valid?)
+        postcode.valid?
+      end
+
+      it 'returns the existing value' do
+        expect(postcode.valid?).to eq('bar')
+      end
+    end
+  end
+
+
+  describe 'addresses' do
+    let(:postcode){ described_class.new('SN51NB', api_client) }
+
+    context 'when the instance variable is nil' do
+      before do
+        postcode.send(:instance_variable_set, '@addresses', nil)
+      end
+
+      it 'performs a lookup on the API' do
+        expect( api_client ).to receive(:addresses)
+        postcode.addresses
+      end
+
+      it 'stores the return value from the API in the instance variable' do
+        allow(api_client).to receive(:addresses).and_return('foo')
+        expect(postcode.addresses).to eq('foo')
+      end
+    end
+        
+    context 'when the instance variable has a value' do
+      before do
+        postcode.send(:instance_variable_set, '@addresses', 'bar')
+      end
+      
+      it 'does not perform a lookup on the API' do
+        expect( api_client ).to_not receive(:addresses)
+        postcode.addresses
+      end
+
+      it 'returns the existing value' do
+        expect(postcode.addresses).to eq('bar')
+      end
+    end
+  end
+
+  [:longitude, :latitude].each do |method|
+    describe method do
+      let(:postcode){ PostcodeInfo::Postcode.new('SN51NB', api_client) }
+      before do
+        postcode.send(:instance_variable_set, "@#{method}", method.to_s)
+      end
+
+      context 'when the @info instance variable is nil' do
+        before do
+          postcode.send(:instance_variable_set, '@info', nil)
+        end
+
+        it 'performs a lookup on the API' do
+          expect( postcode ).to receive(:lookup_info!)
+          postcode.send(method)
+        end
+      end
+          
+      context 'when the @info instance variable has a value' do
+        before do
+          postcode.send(:instance_variable_set, '@info', 'info')
+        end
+        
+        it 'does not perform a lookup on the API' do
+          expect( postcode ).to_not receive(:lookup_info!)
+          postcode.send(method)
+        end
+      end
+
+      it "returns the value of @#{method}" do
+        allow(postcode).to receive(:lookup_info!)
+        expect(postcode.send(method)).to eq(method.to_s)
+      end
+    end
+  end
+
+  describe "lookup_info!" do
+    before do
+      allow(api_client).to receive(:info).and_return('info')
+    end
+
+    it "gets info from the client" do
+      expect(api_client).to receive(:info)      
+      allow(postcode).to receive(:parse_info!)
+      postcode.lookup_info!
+    end
+
+    it "stores the info returned from the client" do
+      allow(postcode).to receive(:parse_info!)
+      postcode.lookup_info!
+      expect(postcode.send(:instance_variable_get, '@info')).to eq('info')
+    end
+
+    it 'parses the info' do
+      expect(postcode).to receive(:parse_info!)
+      postcode.lookup_info!
+    end
+  end
+
+  describe "parse_info!" do
+    let(:stored_info){ {key: 'value', local_authority:'local authority'} }
+
+    before do
+      postcode.send(:instance_variable_set, '@info', stored_info )
+    end
+
+    it 'sets coordinates with @info' do
+      expect(postcode).to receive(:set_coordinates!).with(stored_info)
+      postcode.send(:parse_info!)
+    end
+
+    it 'stores the local_authority in @local_authority' do
+      postcode.send(:parse_info!)
+      expect(postcode.local_authority).to eq('local authority')
+    end
+
+    it 'sets the valid flag' do
+      expect{postcode.send(:parse_info!)}.to change{postcode.send(:instance_variable_get, '@valid')}.to(true)
+    end
+  end
+
+  describe 'set_coordinates!' do
+    context 'when the given info has a :centre key' do
+      let(:info){ {centre: {latitude: 1.0, longitude: 256.8}} }
+
+      it 'stores the latitude sub-key as @latitude' do
+        postcode.send(:set_coordinates!, info)
+        expect(postcode.send(:instance_variable_get, '@latitude')).to eq(1.0)
+      end
+
+      it 'stores the longitude sub-key as @longitude' do
+        postcode.send(:set_coordinates!, info)
+        expect(postcode.send(:instance_variable_get, '@longitude')).to eq(256.8)
+      end
+    end
+
+    context 'when the given info does not have :centre' do
+      let(:info){ {} }
+
+      it 'does not change @latitude' do
+        expect{ postcode.send(:set_coordinates!, info) }.to_not change{ postcode.send(:instance_variable_get, '@latitude') }
+      end
+      it 'does not change @longitude' do
+        expect{ postcode.send(:set_coordinates!, info) }.to_not change{ postcode.send(:instance_variable_get, '@longitude') }
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'simplecov'
+SimpleCov.start
+
+
+
+SimpleCov.configure do
+  load_adapter 'test_frameworks'
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'postcodeinfo-client-ruby'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: postcodeinfo-client-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Al Davidson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Provides a convenient interface for looking up postcodes in an instance of the MoJ postcodeinfo API (https://://github.com/ministryofjustice/postcodeinfo).
+      Lets you check if a postcode is valid, and ookup:
+      * all addresses with that postcode
+      * the latitude/longitude of its centre point
+      * the name & GSS code of the local authority under which it resides.
+email: alistair.davidson@digital.justice.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.MD
+- README.md
+files:
+- ".document"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".simplecov"
+- Gemfile
+- Gemfile.lock
+- LICENSE.MD
+- README.md
+- Rakefile
+- VERSION
+- lib/postcodeinfo-client-ruby.rb
+- lib/postcodeinfo/client.rb
+- lib/postcodeinfo/exceptions.rb
+- lib/postcodeinfo/postcode.rb
+- postcodeinfo-client-ruby.gemspec
+- spec/client_spec.rb
+- spec/postcode_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ministryofjustice/postcodeinfo-client-ruby
+licenses:
+- Open Government License
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Client for postcodeinfo API (https://://github.com/ministryofjustice/postcodeinfo)
+test_files: []