ideal_postcodes 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c34b866375b1eb59033c3c9f4139ed49e1f91bd1
+  data.tar.gz: 48da9070ca6d8cb2af643879f1837d697c3a89af
+SHA512:
+  metadata.gz: 11b659c4e56fb6188874468b2c2e8363eb7088ca13672540ced297f762f5a096f53f49f51d6b2144bc6af0a3006596e2be9e550291aff14ef15d28e6ea2e04ce
+  data.tar.gz: b64a4e49837cfad1410b382600f2af5eff9ee1fbea7a833689f1b34c021c10a75154f445e6363c0e6cc9f50ce79e2082af292f3c995b084b670301b9b12b3195

data/README.md

@@ -10,32 +10,78 @@ __Install it__
 gem install ideal_postcodes
 ```
 
+Alternatively for rails, include this in your gemfile and bundle install
+
+```ruby
+gem 'ideal_postcodes'
+```
+
 __Get an API Key__
 
-Get a key [Ideal-Postcodes.co.uk](https://ideal-postcodes.co.uk). Try out the service with the test postcode 'ID1 1QD'
+Get a key at [Ideal-Postcodes.co.uk](https://ideal-postcodes.co.uk). Try out the service with the test postcode 'ID1 1QD'
 
-__Use it__
+__Configuration__
 
-Do address lookups with a few lines of Ruby
+In order to perform lookups, you'll need to configure the gem by passing in your api key by doing the following:
 
 ```ruby
 require 'ideal_postcodes'
 
 IdealPostcodes.api_key = "your_key_goes_here"
+```
+
+**For Rails**, the best way to do this is create a file in your initializers folder and drop in your key with this line of code:
 
+```ruby
+IdealPostcodes.api_key = "<your key goes here>"
+```
+
+__Usage__
+
+Simply call #lookup class method on IdealPostcodes::Postcode. This will return a Postcode object containing the complete list of addresses if the postcode exists.
+
+```ruby
 postcode = IdealPostcodes::Postcode.lookup "ID1 1QD"
 
-#	postcode.addresses =>
+if postcode.empty? 
+	puts "Your postcode doesn't have a match"
+else
+	postcode.addresses
+end
+
+# postcode.addresses =>
 #
 # [
-#		{
-#			:postcode=>"ID1 1QD",
-# 		:post_town=>"LONDON",
-# 		:line_1=>"Kingsley Hall",
-# 		:line_2=>"Powis Road",
-# 		:line_3=>""
-#		}, 
-#		... and so on
+#  {
+#   :postcode => "ID1 1QD",
+#   :post_town => "LONDON",
+#   :line_1 => "Kingsley Hall",
+#   :line_2 => "Powis Road",
+#   :line_3 => "",
+#   :organisation_name => "",
+#   :building_name => "Kingsley Hall",
+#   :udprn => 12345678
+#  }, ... and so on
+```
+
+__Exceptions__
+
+The wrapper will raise an exception for anything other than a 200 response or an empty 404 response (which means no addresses at postcode).
+
+```ruby
+begin
+  IdealPostcodes::Postcode.lookup "ID1 1QD"
+rescue IdealPostcodes::AuthenticationError => e
+	# Invalid API Key
+rescue IdealPostcodes::TokenExhaustedError => e
+	# Token has run out of lookups
+rescue IdealPostcodes::LimitReachedError => e
+	# One of your predefinied limits has been reached
+rescue IdealPostcodes::IdealPostcodesError => e
+	# API Error
+rescue => e
+	# An unexpected error
+end
 ```
 
 ## Registering
@@ -46,4 +92,13 @@ We charge _2p_ per [external](https://ideal-postcodes.co.uk/termsandconditions#e
 
 ## Documentation
 
-More documentation can be found [here](https://ideal-postcodes.co.uk/documentation/ruby-wrapper)
+More documentation can be found [here](https://ideal-postcodes.co.uk/documentation/ruby-wrapper)
+
+## Testing
+
+```
+bundle exec rake test
+```
+
+## License
+MIT

data/lib/idealpostcodes/errors.rb

@@ -14,7 +14,7 @@ module IdealPostcodes
 
 		def to_s
 			status = @http_code.nil? ? "" : "#{@http_code} error."
-			ideal_code = @response_code.nil ? "" : "(#{@response_code})"
+			ideal_code = @response_code.nil? ? "" : "(#{@response_code})"
 			"#{status} error. (#{ideal_code}) #{message}"
 		end
 	end

data/lib/idealpostcodes/version.rb

@@ -1,3 +1,3 @@
 module IdealPostcodes
-	VERSION = '0.1.0'
+	VERSION = '0.1.1'
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: ideal_postcodes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - Chris Blanchard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-20 00:00:00.000000000 Z
+date: 2014-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,23 +55,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,17 +83,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ideal Postcodes is a simple postcode lookup API for UK addresses.  See
@@ -129,27 +116,26 @@ files:
 - test/test_ideal_postcodes.rb
 homepage: https://ideal-postcodes.co.uk/documentation
 licenses: []
+metadata: {}
 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: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Wrapper for the Ideal-Postcodes.co.uk API
 test_files:
 - test/test_helper.rb