ideal_postcodes 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be3239f59167b00d3b406e3c6a45365dc7e646b4
-  data.tar.gz: 285c68271eb9fb98011e575d1bc8446c3b892e40
+  metadata.gz: 91d21e12afb59f29866e16bb6d408c51e20caa02
+  data.tar.gz: 0f6f2b343c2433106e231fa9fd30d296f6807893
 SHA512:
-  metadata.gz: bd635f4ad102fc61785c3d8d7637f2d7c5f11bd348e2ad9a14ad2f8d3222e4bd44914e6b784512ff819f8c97ec8e87df6151f7c0ba63d6c1d5bceeb6fdf71ab7
-  data.tar.gz: b596444fc91dea8b680a9681950f0c2a7f0ca712f0a879290b37c4f3a8ae2c1d7c86e2a883dcc9bd120f5cb2ecf561b8f8c721cd3ccc640984be274a0e3bd32c
+  metadata.gz: 467086e974cb4beb9b6c1c84b75751ba999223be717a9c2fb3341930e91901bbebddfd51fe6f657f654cebce494eed30bda204a3fbfb5217eb5c79b5d2d5df31
+  data.tar.gz: 2b3883441d16d1532bbc44c29866f42c00be005bc239d206effb857ae0bc024b4463ccdd68f2819c6910a0b4063a6d3c0465cfcb5c74c9df024693b34a44f974

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
+before_install:
+  - gem update bundler
 rvm:
-  - 2.1.1
+  - 2.3.4
+  - 2.2.7
+  - 2.1.10
   - 2.0.0
-  - 1.9.3
-  - jruby-19mode
+  - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+Any changes, including backwards incompatible changes will be listed here
+
+## 1.1.0 (22/6/2017)
+
+- Updated rest-client dependency
+
+## 1.0.0 
+- Major rewrite to make way for more resources
+- Breaking change applied to postcode lookup functionality
+- Implemented [addresses resource](https://ideal-postcodes.co.uk/documentation/addresses)
+- Implemented [keys resource](https://ideal-postcodes.co.uk/documentation/keys)
+- Implemented [postcodes resource](https://ideal-postcodes.co.uk/documentation/postcodes). Added location-based postcode searches
+- Swapped out test suite with rspec and vcr

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ideal Postcodes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -50,7 +50,7 @@ rescue => e
 end
 ```
 
-Possible errors to look out for are listed in the [documentation](https://ideal-postcodes.co.uk/documentatpion/response-codes).
+Possible errors to look out for are listed in the [documentation](https://ideal-postcodes.co.uk/documentation/response-codes).
 
 ## Methods
 
@@ -113,6 +113,10 @@ Use the postcode "ID1 1QD" to test this method for free. The complete list of te
 
 Perform a search for addresses which match your search term.
 
+```ruby
+IdealPostcodes::Address.search search_term, limit: 20, page: 0
+```
+
 **Arguments**
 
 - `search_term` (string). The address you wish to search for
@@ -287,7 +291,7 @@ None.
 IdealPostcodes.key_available # => true, you're clear to make lookups
 ```
 
-### Find out private key information [(docs)](https://ideal-postcodes.co.uk/documentation/keys#details)
+### Retrieve private key information [(docs)](https://ideal-postcodes.co.uk/documentation/keys#details)
 
 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.
 
@@ -335,17 +339,6 @@ IdealPostcodes.apply_secret "your secret key"
 
 Do not share your secret key and avoid commiting this key to your codebase.
 
-
-## Changelog
-
-*1.0.0*
-- Major rewrite to make way for more resources
-- Breaking change applied to postcode lookup functionality
-- Implemented [addresses resource](https://ideal-postcodes.co.uk/documentation/addresses)
-- Implemented [keys resource](https://ideal-postcodes.co.uk/documentation/keys)
-- Implemented [postcodes resource](https://ideal-postcodes.co.uk/documentation/postcodes). Added location-based postcode searches
-- Swapped out test suite with rspec and vcr
-
 ## Testing
 
 ```
@@ -354,4 +347,4 @@ bundle exec rake
 
 ## License
 
-MIT
+MIT

data/ideal-postcodes-ruby.gemspec

@@ -10,13 +10,14 @@ spec = Gem::Specification.new do |s|
   s.authors = ['Ideal Postcodes']
   s.email = ['support@ideal-postcodes.co.uk']
   s.homepage = 'https://ideal-postcodes.co.uk/'
+  s.licenses = ['MIT']
 
-  s.add_dependency('rest-client', '~> 1.6')
+  s.add_dependency('rest-client', '~> 1.8')
 
-  s.add_development_dependency 'rake', '~> 10.1.0'
-  s.add_development_dependency 'vcr', '~> 2.9.3'
-  s.add_development_dependency 'rspec', '~> 3.1.0'
-  s.add_development_dependency 'webmock', '~> 1.20.4'
+  s.add_development_dependency 'rake', '~> 10.1'
+  s.add_development_dependency 'vcr', '~> 2.9'
+  s.add_development_dependency 'rspec', '~> 3.1'
+  s.add_development_dependency 'webmock', '~> 1.20'
 
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- spec/*`.split("\n")

data/lib/idealpostcodes/version.rb

@@ -1,3 +1,3 @@
 module IdealPostcodes
-	VERSION = '1.0.0'
+	VERSION = '1.1.0'
 end

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: ideal_postcodes
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ideal Postcodes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-13 00:00:00.000000000 Z
+date: 2017-06-22 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'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.3
+        version: '2.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.3
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.4
+        version: '1.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.4
+        version: '1.20'
 description: Ideal Postcodes is a simple postcode lookup API for UK addresses. See
   https://ideal-postcodes.co.uk
 email:
@@ -88,8 +88,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .travis.yml
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - ideal-postcodes-ruby.gemspec
@@ -138,7 +140,8 @@ files:
 - 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: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -146,17 +149,17 @@ 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: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Wrapper for the Ideal-Postcodes.co.uk API