ideal_postcodes 0.1.1 → 2.0.1

metadata

@@ -1,121 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: ideal_postcodes
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 2.0.1
 platform: ruby
 authors:
-- Chris Blanchard
+- Ideal Postcodes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-08 00:00:00.000000000 Z
+date: 2021-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
+        version: '1.8'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.7.9
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.7.9
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '10.1'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Ideal Postcodes is a simple postcode lookup API for UK addresses.  See
+        version: 2.3.1
+description: Ideal Postcodes is a simple postcode lookup API for UK addresses. See
   https://ideal-postcodes.co.uk
 email:
-- cablanchard@gmail.com
+- support@ideal-postcodes.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - ideal-postcodes-ruby.gemspec
 - lib/ideal_postcodes.rb
 - lib/idealpostcodes.rb
+- lib/idealpostcodes/address.rb
 - lib/idealpostcodes/errors.rb
+- lib/idealpostcodes/key.rb
 - lib/idealpostcodes/postcode.rb
 - lib/idealpostcodes/util.rb
 - lib/idealpostcodes/version.rb
-- test/test_helper.rb
-- test/test_ideal_postcodes.rb
-homepage: https://ideal-postcodes.co.uk/documentation
-licenses: []
+- spec/addresses_spec.rb
+- spec/idealpostcodes_spec.rb
+- spec/keys_spec.rb
+- spec/postcodes_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_cassettes/IdealPostcodes_Address_lookup_raises_an_exception_if_invalid_key.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_lookup_raises_an_exception_if_limit_breached.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_lookup_raises_an_exception_if_no_lookups_remaining.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_lookup_returns_an_address_for_a_valid_UDPRN.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_lookup_returns_nil_for_an_invalid_UDPRN.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_search_is_sensitive_to_limit.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_search_is_sensitive_to_page.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_search_raises_an_exception_if_invalid_key.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_search_raises_an_exception_if_limit_breached.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_search_raises_an_exception_if_no_lookups_remaining.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_search_returns_results_in_a_SearchResult_object.yml
+- spec/vcr_cassettes/IdealPostcodes_Key_lookup_details_returns_key_details.yml
+- spec/vcr_cassettes/IdealPostcodes_Key_lookup_returns_the_availability_status_of_a_key_false_key_.yml
+- spec/vcr_cassettes/IdealPostcodes_Key_lookup_returns_the_availability_status_of_a_key_true_key_.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_find_by_location_is_sensitive_to_limit_parameter.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_find_by_location_is_sensitive_to_radius_parament.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_find_by_location_returns_an_array_of_postcodes_and_locations.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_find_by_location_returns_an_empty_array_if_no_results_are_found.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_lookup_raises_an_exception_if_invalid_key.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_lookup_raises_an_exception_if_key_has_run_out_of_balance.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_lookup_raises_an_exception_if_limit_has_been_reached.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_lookup_returns_a_list_of_addresses_for_a_postcode.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_lookup_returns_an_empty_array_if_postcode_does_not_exist.yml
+- spec/vcr_cassettes/IdealPostcodes_key_available_returns_false_if_key_is_unavailable.yml
+- spec/vcr_cassettes/IdealPostcodes_key_available_returns_true_if_key_is_available.yml
+- spec/vcr_cassettes/IdealPostcodes_key_details_raises_an_exception_if_no_secret_is_provided.yml
+- spec/vcr_cassettes/IdealPostcodes_key_details_returns_key_information.yml
+- spec/vcr_cassettes/IdealPostcodes_request_generates_a_HTTP_request.yml
+- spec/vcr_cassettes/IdealPostcodes_request_raises_authentication_error_if_invalid_key_is_provided.yml
+- spec/vcr_cassettes/IdealPostcodes_request_raises_limit_reached_error_if_a_limit_has_been_breached.yml
+- spec/vcr_cassettes/IdealPostcodes_request_raises_token_exhausted_error_if_key_balance_is_depleted.yml
+homepage: https://ideal-postcodes.co.uk/
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -123,20 +155,53 @@ 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
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Wrapper for the Ideal-Postcodes.co.uk API
 test_files:
-- test/test_helper.rb
-- test/test_ideal_postcodes.rb
+- spec/addresses_spec.rb
+- spec/idealpostcodes_spec.rb
+- spec/keys_spec.rb
+- spec/postcodes_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_cassettes/IdealPostcodes_Address_lookup_raises_an_exception_if_invalid_key.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_lookup_raises_an_exception_if_limit_breached.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_lookup_raises_an_exception_if_no_lookups_remaining.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_lookup_returns_an_address_for_a_valid_UDPRN.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_lookup_returns_nil_for_an_invalid_UDPRN.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_search_is_sensitive_to_limit.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_search_is_sensitive_to_page.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_search_raises_an_exception_if_invalid_key.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_search_raises_an_exception_if_limit_breached.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_search_raises_an_exception_if_no_lookups_remaining.yml
+- spec/vcr_cassettes/IdealPostcodes_Address_search_returns_results_in_a_SearchResult_object.yml
+- spec/vcr_cassettes/IdealPostcodes_Key_lookup_details_returns_key_details.yml
+- spec/vcr_cassettes/IdealPostcodes_Key_lookup_returns_the_availability_status_of_a_key_false_key_.yml
+- spec/vcr_cassettes/IdealPostcodes_Key_lookup_returns_the_availability_status_of_a_key_true_key_.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_find_by_location_is_sensitive_to_limit_parameter.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_find_by_location_is_sensitive_to_radius_parament.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_find_by_location_returns_an_array_of_postcodes_and_locations.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_find_by_location_returns_an_empty_array_if_no_results_are_found.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_lookup_raises_an_exception_if_invalid_key.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_lookup_raises_an_exception_if_key_has_run_out_of_balance.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_lookup_raises_an_exception_if_limit_has_been_reached.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_lookup_returns_a_list_of_addresses_for_a_postcode.yml
+- spec/vcr_cassettes/IdealPostcodes_Postcode_lookup_returns_an_empty_array_if_postcode_does_not_exist.yml
+- spec/vcr_cassettes/IdealPostcodes_key_available_returns_false_if_key_is_unavailable.yml
+- spec/vcr_cassettes/IdealPostcodes_key_available_returns_true_if_key_is_available.yml
+- spec/vcr_cassettes/IdealPostcodes_key_details_raises_an_exception_if_no_secret_is_provided.yml
+- spec/vcr_cassettes/IdealPostcodes_key_details_returns_key_information.yml
+- spec/vcr_cassettes/IdealPostcodes_request_generates_a_HTTP_request.yml
+- spec/vcr_cassettes/IdealPostcodes_request_raises_authentication_error_if_invalid_key_is_provided.yml
+- spec/vcr_cassettes/IdealPostcodes_request_raises_limit_reached_error_if_a_limit_has_been_breached.yml
+- spec/vcr_cassettes/IdealPostcodes_request_raises_token_exhausted_error_if_key_balance_is_depleted.yml

data/test/test_helper.rb

@@ -1,77 +0,0 @@
-require 'test/unit'
-require 'mocha/setup'
-require 'ideal_postcodes'
-require 'shoulda'
-
-module IdealPostcodes
-
-	attr_accessor :mock
-
-	def self.mock=(mock)
-		@mock = mock
-	end
-
-	def self.generate_request(options)
-		method = options[:method]
-		url = options[:url]
-		@mock.execute method, url
-	end
-
-end
-
-def test_response(body, status=200)
-	body = MultiJson.dump(body)
-	m = mock
-	m.instance_variable_set('@instance_vals', {code: status, body: body})
-	def m.body; @instance_vals[:body]; end
-	def m.code; @instance_vals[:code]; end
-	m
-end
-
-def test_postcode
-	"ID11QD"
-end
-
-def valid_postcode(params={})
-	{
-		result: [
-			{
-				postcode: "ID1 1QD",
-				post_town: "LONDON",
-				line_1: "Kingsley Hall",
-				line_2: "Powis Road",
-				line_3: ""
-			}
-		],
-		message: "Success",
-		code: 2000 
-	}
-end
-
-def invalid_postcode
-	{
-		message: "Postcode not found",
-		code: 4040
-	}
-end
-
-def invalid_token
-	{
-		message: "Invalid key",
-		code: 4010 
-	}
-end
-
-def limit_reached
-	{
-		code: 4021,
-		message: "Lookup Limit Reached"
-	}
-end
-
-def token_exhausted
-	{
-		code: 4020,
-		message: "Token exhausted"
-	}
-end

data/test/test_ideal_postcodes.rb

@@ -1,78 +0,0 @@
-require File.expand_path('../test_helper', __FILE__)
-
-class TestIdealPostcodes < Test::Unit::TestCase
-	include Mocha
-
-	context "API" do
-
-		setup do
-			@mock = mock
-			IdealPostcodes.mock = @mock
-		end
-
-		teardown do
-			IdealPostcodes.mock = nil
-		end
-
-		should "raise an exception if no API key set" do
-			IdealPostcodes.api_key = nil
-			assert_raises IdealPostcodes::AuthenticationError do
-				postcode = IdealPostcodes::Postcode.lookup(test_postcode)
-			end
-		end
-
-		should "raise an exception if authentication failed" do
-			IdealPostcodes.api_key = "BOGUS"
-			response = test_response invalid_token
-			assert_raises IdealPostcodes::AuthenticationError do
-				@mock.expects(:execute).raises(RestClient::ExceptionWithResponse.new(response, 401))
-				IdealPostcodes::Postcode.lookup(test_postcode)
-			end
-		end
-
-		context "Valid API key" do
-
-			setup do
-				IdealPostcodes.api_key = "correctkey"
-			end
-
-			teardown do
-				IdealPostcodes.api_key = nil
-			end
-
-			should "raise an exception if tokens exhausted" do
-				response = test_response token_exhausted
-				assert_raises IdealPostcodes::TokenExhaustedError do
-					@mock.expects(:execute).raises(RestClient::ExceptionWithResponse.new(response, 402))
-					IdealPostcodes::Postcode.lookup(test_postcode)
-				end
-			end
-
-			should "raise an exception if limit has been breached" do
-				response = test_response limit_reached
-				assert_raises IdealPostcodes::LimitReachedError do
-					@mock.expects(:execute).raises(RestClient::ExceptionWithResponse.new(response, 402))
-					IdealPostcodes::Postcode.lookup(test_postcode)
-				end
-			end
-
-			should "return postcode object with addresses for valid postcode" do
-				response = test_response valid_postcode
-				@mock.expects(:execute).returns(response)
-				postcode = IdealPostcodes::Postcode.lookup(test_postcode)
-				assert_equal postcode.empty?, false
-				assert_equal postcode.addresses, valid_postcode[:result]
-			end
-
-			should "return postcode object with empty array for non-existent postcode" do
-				response = test_response invalid_postcode
-				@mock.expects(:execute).raises(RestClient::ExceptionWithResponse.new(response, 404))
-				postcode = IdealPostcodes::Postcode.lookup(test_postcode)
-				assert_equal postcode.empty?, true
-			end
-
-		end
-
-	end
-
-end