ideal_postcodes 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.travis.yml +6 -3
- data/CHANGELOG.md +15 -0
- data/LICENSE +21 -0
- data/README.md +7 -14
- data/ideal-postcodes-ruby.gemspec +6 -5
- data/lib/idealpostcodes/version.rb +1 -1
- metadata +30 -27
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 91d21e12afb59f29866e16bb6d408c51e20caa02
|
4
|
+
data.tar.gz: 0f6f2b343c2433106e231fa9fd30d296f6807893
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 467086e974cb4beb9b6c1c84b75751ba999223be717a9c2fb3341930e91901bbebddfd51fe6f657f654cebce494eed30bda204a3fbfb5217eb5c79b5d2d5df31
|
7
|
+
data.tar.gz: 2b3883441d16d1532bbc44c29866f42c00be005bc239d206effb857ae0bc024b4463ccdd68f2819c6910a0b4063a6d3c0465cfcb5c74c9df024693b34a44f974
|
data/.travis.yml
CHANGED
data/CHANGELOG.md
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
# Changelog
|
2
|
+
|
3
|
+
Any changes, including backwards incompatible changes will be listed here
|
4
|
+
|
5
|
+
## 1.1.0 (22/6/2017)
|
6
|
+
|
7
|
+
- Updated rest-client dependency
|
8
|
+
|
9
|
+
## 1.0.0
|
10
|
+
- Major rewrite to make way for more resources
|
11
|
+
- Breaking change applied to postcode lookup functionality
|
12
|
+
- Implemented [addresses resource](https://ideal-postcodes.co.uk/documentation/addresses)
|
13
|
+
- Implemented [keys resource](https://ideal-postcodes.co.uk/documentation/keys)
|
14
|
+
- Implemented [postcodes resource](https://ideal-postcodes.co.uk/documentation/postcodes). Added location-based postcode searches
|
15
|
+
- Swapped out test suite with rspec and vcr
|
data/LICENSE
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2016 Ideal Postcodes
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
data/README.md
CHANGED
@@ -50,7 +50,7 @@ rescue => e
|
|
50
50
|
end
|
51
51
|
```
|
52
52
|
|
53
|
-
Possible errors to look out for are listed in the [documentation](https://ideal-postcodes.co.uk/
|
53
|
+
Possible errors to look out for are listed in the [documentation](https://ideal-postcodes.co.uk/documentation/response-codes).
|
54
54
|
|
55
55
|
## Methods
|
56
56
|
|
@@ -113,6 +113,10 @@ Use the postcode "ID1 1QD" to test this method for free. The complete list of te
|
|
113
113
|
|
114
114
|
Perform a search for addresses which match your search term.
|
115
115
|
|
116
|
+
```ruby
|
117
|
+
IdealPostcodes::Address.search search_term, limit: 20, page: 0
|
118
|
+
```
|
119
|
+
|
116
120
|
**Arguments**
|
117
121
|
|
118
122
|
- `search_term` (string). The address you wish to search for
|
@@ -287,7 +291,7 @@ None.
|
|
287
291
|
IdealPostcodes.key_available # => true, you're clear to make lookups
|
288
292
|
```
|
289
293
|
|
290
|
-
###
|
294
|
+
### Retrieve private key information [(docs)](https://ideal-postcodes.co.uk/documentation/keys#details)
|
291
295
|
|
292
296
|
This method reveals private information about your key such as the lookup balance, whitelisted URLs, etc. Note: a secret key is required to invoke this method.
|
293
297
|
|
@@ -335,17 +339,6 @@ IdealPostcodes.apply_secret "your secret key"
|
|
335
339
|
|
336
340
|
Do not share your secret key and avoid commiting this key to your codebase.
|
337
341
|
|
338
|
-
|
339
|
-
## Changelog
|
340
|
-
|
341
|
-
*1.0.0*
|
342
|
-
- Major rewrite to make way for more resources
|
343
|
-
- Breaking change applied to postcode lookup functionality
|
344
|
-
- Implemented [addresses resource](https://ideal-postcodes.co.uk/documentation/addresses)
|
345
|
-
- Implemented [keys resource](https://ideal-postcodes.co.uk/documentation/keys)
|
346
|
-
- Implemented [postcodes resource](https://ideal-postcodes.co.uk/documentation/postcodes). Added location-based postcode searches
|
347
|
-
- Swapped out test suite with rspec and vcr
|
348
|
-
|
349
342
|
## Testing
|
350
343
|
|
351
344
|
```
|
@@ -354,4 +347,4 @@ bundle exec rake
|
|
354
347
|
|
355
348
|
## License
|
356
349
|
|
357
|
-
MIT
|
350
|
+
MIT
|
@@ -10,13 +10,14 @@ spec = Gem::Specification.new do |s|
|
|
10
10
|
s.authors = ['Ideal Postcodes']
|
11
11
|
s.email = ['support@ideal-postcodes.co.uk']
|
12
12
|
s.homepage = 'https://ideal-postcodes.co.uk/'
|
13
|
+
s.licenses = ['MIT']
|
13
14
|
|
14
|
-
s.add_dependency('rest-client', '~> 1.
|
15
|
+
s.add_dependency('rest-client', '~> 1.8')
|
15
16
|
|
16
|
-
s.add_development_dependency 'rake', '~> 10.1
|
17
|
-
s.add_development_dependency 'vcr', '~> 2.9
|
18
|
-
s.add_development_dependency 'rspec', '~> 3.1
|
19
|
-
s.add_development_dependency 'webmock', '~> 1.20
|
17
|
+
s.add_development_dependency 'rake', '~> 10.1'
|
18
|
+
s.add_development_dependency 'vcr', '~> 2.9'
|
19
|
+
s.add_development_dependency 'rspec', '~> 3.1'
|
20
|
+
s.add_development_dependency 'webmock', '~> 1.20'
|
20
21
|
|
21
22
|
s.files = `git ls-files`.split("\n")
|
22
23
|
s.test_files = `git ls-files -- spec/*`.split("\n")
|
metadata
CHANGED
@@ -1,85 +1,85 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: ideal_postcodes
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.1.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Ideal Postcodes
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2017-06-22 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rest-client
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
|
-
- - ~>
|
17
|
+
- - "~>"
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: '1.
|
19
|
+
version: '1.8'
|
20
20
|
type: :runtime
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
|
-
- - ~>
|
24
|
+
- - "~>"
|
25
25
|
- !ruby/object:Gem::Version
|
26
|
-
version: '1.
|
26
|
+
version: '1.8'
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
28
|
name: rake
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
30
30
|
requirements:
|
31
|
-
- - ~>
|
31
|
+
- - "~>"
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version: 10.1
|
33
|
+
version: '10.1'
|
34
34
|
type: :development
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
|
-
- - ~>
|
38
|
+
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version: 10.1
|
40
|
+
version: '10.1'
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: vcr
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
44
44
|
requirements:
|
45
|
-
- - ~>
|
45
|
+
- - "~>"
|
46
46
|
- !ruby/object:Gem::Version
|
47
|
-
version: 2.9
|
47
|
+
version: '2.9'
|
48
48
|
type: :development
|
49
49
|
prerelease: false
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
|
-
- - ~>
|
52
|
+
- - "~>"
|
53
53
|
- !ruby/object:Gem::Version
|
54
|
-
version: 2.9
|
54
|
+
version: '2.9'
|
55
55
|
- !ruby/object:Gem::Dependency
|
56
56
|
name: rspec
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|
58
58
|
requirements:
|
59
|
-
- - ~>
|
59
|
+
- - "~>"
|
60
60
|
- !ruby/object:Gem::Version
|
61
|
-
version: 3.1
|
61
|
+
version: '3.1'
|
62
62
|
type: :development
|
63
63
|
prerelease: false
|
64
64
|
version_requirements: !ruby/object:Gem::Requirement
|
65
65
|
requirements:
|
66
|
-
- - ~>
|
66
|
+
- - "~>"
|
67
67
|
- !ruby/object:Gem::Version
|
68
|
-
version: 3.1
|
68
|
+
version: '3.1'
|
69
69
|
- !ruby/object:Gem::Dependency
|
70
70
|
name: webmock
|
71
71
|
requirement: !ruby/object:Gem::Requirement
|
72
72
|
requirements:
|
73
|
-
- - ~>
|
73
|
+
- - "~>"
|
74
74
|
- !ruby/object:Gem::Version
|
75
|
-
version: 1.20
|
75
|
+
version: '1.20'
|
76
76
|
type: :development
|
77
77
|
prerelease: false
|
78
78
|
version_requirements: !ruby/object:Gem::Requirement
|
79
79
|
requirements:
|
80
|
-
- - ~>
|
80
|
+
- - "~>"
|
81
81
|
- !ruby/object:Gem::Version
|
82
|
-
version: 1.20
|
82
|
+
version: '1.20'
|
83
83
|
description: Ideal Postcodes is a simple postcode lookup API for UK addresses. See
|
84
84
|
https://ideal-postcodes.co.uk
|
85
85
|
email:
|
@@ -88,8 +88,10 @@ executables: []
|
|
88
88
|
extensions: []
|
89
89
|
extra_rdoc_files: []
|
90
90
|
files:
|
91
|
-
- .travis.yml
|
91
|
+
- ".travis.yml"
|
92
|
+
- CHANGELOG.md
|
92
93
|
- Gemfile
|
94
|
+
- LICENSE
|
93
95
|
- README.md
|
94
96
|
- Rakefile
|
95
97
|
- ideal-postcodes-ruby.gemspec
|
@@ -138,7 +140,8 @@ files:
|
|
138
140
|
- spec/vcr_cassettes/IdealPostcodes_request_raises_limit_reached_error_if_a_limit_has_been_breached.yml
|
139
141
|
- spec/vcr_cassettes/IdealPostcodes_request_raises_token_exhausted_error_if_key_balance_is_depleted.yml
|
140
142
|
homepage: https://ideal-postcodes.co.uk/
|
141
|
-
licenses:
|
143
|
+
licenses:
|
144
|
+
- MIT
|
142
145
|
metadata: {}
|
143
146
|
post_install_message:
|
144
147
|
rdoc_options: []
|
@@ -146,17 +149,17 @@ require_paths:
|
|
146
149
|
- lib
|
147
150
|
required_ruby_version: !ruby/object:Gem::Requirement
|
148
151
|
requirements:
|
149
|
-
- -
|
152
|
+
- - ">="
|
150
153
|
- !ruby/object:Gem::Version
|
151
154
|
version: '0'
|
152
155
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
153
156
|
requirements:
|
154
|
-
- -
|
157
|
+
- - ">="
|
155
158
|
- !ruby/object:Gem::Version
|
156
159
|
version: '0'
|
157
160
|
requirements: []
|
158
161
|
rubyforge_project:
|
159
|
-
rubygems_version: 2.
|
162
|
+
rubygems_version: 2.6.11
|
160
163
|
signing_key:
|
161
164
|
specification_version: 4
|
162
165
|
summary: Wrapper for the Ideal-Postcodes.co.uk API
|