postcode-anywhere 1.0.1 → 1.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +17 -3
- data/lib/postcode_anywhere/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1cd6f1dd187b2d91cc76a4743b0469254ed3679d
|
|
4
|
+
data.tar.gz: 3129b6960ff440d62c77c30eadb871c873ff39c7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 15203089b3833c5067957075d167cd4fcec81c41e7cb83620f10242686270c7f61d73204ae03da7f0265d86189ac822f4db19c358567e77fceb6151ddb445d9f
|
|
7
|
+
data.tar.gz: 69d5dbe0486b5cc457ec19106f35ba0d17f980691459818d1a629e3b4fb4c53d09f296e4acbc3b5ee062f39f50091509bed563a0c0d3e561333198b170415347
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -9,7 +9,7 @@ This is the Ruby gem for interacting with the [Postcode Anywhere API](http://www
|
|
|
9
9
|
Add this line to your application's Gemfile:
|
|
10
10
|
|
|
11
11
|
```ruby
|
|
12
|
-
gem '
|
|
12
|
+
gem 'postcode-anywhere'
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
And then execute:
|
|
@@ -25,6 +25,20 @@ Or install it yourself as:
|
|
|
25
25
|
This Gem consists of a numer of available clients for each key service available from
|
|
26
26
|
Postcode Anywhere
|
|
27
27
|
|
|
28
|
+
### Configuration
|
|
29
|
+
|
|
30
|
+
Each client is configured upon instantiation:
|
|
31
|
+
|
|
32
|
+
```ruby
|
|
33
|
+
client = PostcodeAnywhere::CapturePlus::Client.new(
|
|
34
|
+
# Mandatory
|
|
35
|
+
api_key: 'YOUR_API_KEY',
|
|
36
|
+
|
|
37
|
+
# Optional: If not set, defaults to: 'Postcode Anywhere Ruby Gem/1.0.1'
|
|
38
|
+
user_agent: 'YOUR_APPLICATION_USER_AGENT'
|
|
39
|
+
)
|
|
40
|
+
```
|
|
41
|
+
|
|
28
42
|
### [CapturePlus Address Validation](http://www.postcodeanywhere.co.uk/address-validation/api/)
|
|
29
43
|
|
|
30
44
|
Addresses can be searched upon by a number of different means. An array of results is always
|
|
@@ -67,7 +81,7 @@ This searches by postcode:
|
|
|
67
81
|
|
|
68
82
|
#### By company
|
|
69
83
|
|
|
70
|
-
This searches by
|
|
84
|
+
This searches by company:
|
|
71
85
|
|
|
72
86
|
```ruby
|
|
73
87
|
client = PostcodeAnywhere::CapturePlus::Client.new(
|
|
@@ -86,7 +100,7 @@ This searches by postcode:
|
|
|
86
100
|
|
|
87
101
|
#### By place
|
|
88
102
|
|
|
89
|
-
This searches by
|
|
103
|
+
This searches by place:
|
|
90
104
|
|
|
91
105
|
```ruby
|
|
92
106
|
client = PostcodeAnywhere::CapturePlus::Client.new(
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: postcode-anywhere
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.
|
|
4
|
+
version: 1.0.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Edward Woodcock
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2014-09-
|
|
11
|
+
date: 2014-09-30 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: faraday
|