postcode_anywhere 0.1 → 0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. data/README.markdown +18 -1
  2. data/Rakefile +2 -2
  3. metadata +3 -3
data/README.markdown CHANGED
@@ -1,4 +1,21 @@
1
1
  Postcode Anywhere
2
2
  =================
3
3
 
4
- A simple plugin for Rails 3 to find addresses by postcode and building number using the Postcode Anywhere service.
4
+ A simple plugin for Rails 3 to find addresses by postcode and building number using the Postcode Anywhere service.
5
+
6
+ Usage
7
+ -----
8
+
9
+ First you must supply the class with a valid Postcode Anywhere key, you can do this in a Rails initializer.
10
+
11
+ PostcodeAnywhere.key = "YOUR-VALID-KEY"
12
+
13
+ To perform a lookup:
14
+
15
+ PostcodeAnywhere.find_by_number_and_postcode(87, "SW1X 7XL")
16
+
17
+ (Harrods London)
18
+
19
+ A hash will then be returned with the address details:
20
+
21
+ {"Udprn"=>"0", "Company"=>nil, "Department"=>nil, "Line1"=>"87 Brompton Road", "Line2"=>nil, "Line3"=>nil, "Line4"=>nil, "Line5"=>nil, "PostTown"=>"London", "County"=>nil, "Postcode"=>"SW1X 7XL", "Mailsort"=>"72114", "Barcode"=>"(SW1X7XL9Z9)", "Type"=>"Residential", "DeliveryPointSuffix"=>"9Z", "SubBuilding"=>nil, "BuildingName"=>nil, "BuildingNumber"=>"87", "PrimaryStreet"=>"Brompton Road", "SecondaryStreet"=>nil, "DoubleDependentLocality"=>nil, "DependentLocality"=>nil, "PoBox"=>nil}
data/Rakefile CHANGED
@@ -10,10 +10,10 @@ PKG_FILES = FileList[
10
10
 
11
11
  spec = Gem::Specification.new do |s|
12
12
  s.name = "postcode_anywhere"
13
- s.version = "0.1"
13
+ s.version = "0.2"
14
14
  s.author = "Matthew Crouch"
15
15
  s.email = "mcrouch@mobilezil.la"
16
- s.homepage = "http://mobilezil.la/"
16
+ s.homepage = "http://github.com/mobzilla/postcode_anywhere"
17
17
  s.platform = Gem::Platform::RUBY
18
18
  s.summary = "Find addresses by postcode and building number via Postcode Anywhere API"
19
19
  s.files = PKG_FILES.to_a
metadata CHANGED
@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
4
4
  prerelease: false
5
5
  segments:
6
6
  - 0
7
- - 1
8
- version: "0.1"
7
+ - 2
8
+ version: "0.2"
9
9
  platform: ruby
10
10
  authors:
11
11
  - Matthew Crouch
@@ -45,7 +45,7 @@ files:
45
45
  - README.markdown
46
46
  - lib/postcode_anywhere.rb
47
47
  has_rdoc: true
48
- homepage: http://mobilezil.la/
48
+ homepage: http://github.com/mobzilla/postcode_anywhere
49
49
  licenses: []
50
50
 
51
51
  post_install_message: