get_address 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 687f37a76cdb66c01e10b6df9161b9bbfbf50fcb
+  data.tar.gz: e43589a7468adeceb20ae80b884596cda0170181
+SHA512:
+  metadata.gz: 901d7b19a0f9dfdd64f6d441c525c9d2a70b9e59d3d31fd050c8fa3eab0ac7f0d73c347d7c2b52ac593b0ad1e28b99e826842d0a117963f4a1ebc04abf23117a
+  data.tar.gz: 7f2097df7e7810c18c4acc089d4ff9a63522c27579aec7e7f5a6e9dbb7975482bc143d2a4834cb2f7d5280bac13fd780ed7a431b504e087fcc8a93069d8bdf29

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem
+.idea
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.2.6
+before_install: gem install bundler -v 1.16.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in get_address.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 CorsaiR
+
+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

@@ -0,0 +1,58 @@
+# GetAddress Ruby Library
+
+A ruby wrapper for [getaddress.io](https://getaddress.io/) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'get_address'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install get_address
+
+## Usage
+```ruby
+GetAddress.get_address postcode, house, options
+```
+
+**Arguments**
+
+- `postcode` (string). The postcode you want to find.
+- `house` (string, optional). House name/number.
+- `options` (hash, optional). 
+	- `sort` (boolean). Numerically sorts the addresses.
+
+**Returns**
+
+Returns a list of addresses for a postcode.
+
+**Example**
+
+```ruby
+GetAddress.api_key = 'getaddress_api_key'
+
+addresses = GetAddress.get_address 'XX2 00X'
+addresses.each do |address|
+  puts "Line 1: #{address.line1}"
+  puts "Line 2: #{address.line2}"
+  puts "Line 3: #{address.line3}"
+  puts "Town/City: #{address.city}"
+  puts "County: #{address.county}"
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/elCorsaiR/get_address.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/get_address.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'get_address/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "get_address"
+  spec.version       = GetAddress::VERSION
+  spec.authors       = ['CorsaiR']
+  spec.email         = ['alezander82@mail.ru']
+
+  spec.summary       = 'Wrapper for the getaddress.io API'
+  spec.description   = 'A simple API for finding postal addresses'
+  spec.homepage      = 'http://rubygems.org/gems/get_address'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rest-client', '>= 1.8', '< 3.0'
+  spec.add_dependency 'virtus', '~> 1.0', '>= 1.0.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'webmock', '~> 2.3', '>= 2.3.1'
+end

data/lib/get_address.rb

@@ -0,0 +1,98 @@
+require 'uri'
+require 'cgi'
+require 'rest-client'
+require 'json'
+
+require 'get_address/version'
+require 'get_address/errors'
+require 'get_address/utils'
+require 'get_address/address'
+
+module GetAddress
+  @endpoint = 'https://api.getAddress.io'
+
+  class << self
+    attr_accessor :api_key, :endpoint
+  end
+
+
+  def self.get_address(postcode, house = '', options = {})
+    path = Utils.present?(house) ? "find/#{postcode}/#{house}" : "find/#{postcode}"
+    query = options[:sort].nil? ? {} : { sort: options[:sort] }
+    GetAddress.request :get, path, query
+  rescue ResourceNotFoundError => error
+    []
+  end
+
+  private
+
+  def self.request(method, path, params = {})
+    unless @api_key
+      raise AuthenticationError.new('No API Key provided')
+    end
+
+    url = URI.parse(resource_url(path))
+
+    params.merge!({ 'api-key' => @api_key, 'format' => true })
+    url.query = Utils.escape_params(params)
+
+    request_options = {
+        method: method,
+        url: url.to_s
+    }
+
+    begin
+      response = RestClient::Request.execute(request_options)
+    rescue RestClient::ExceptionWithResponse => error
+      if (code = error.http_code) && (body = error.http_body)
+        handle_rest_error(code, body)
+      else
+        handle_error(error)
+      end
+    rescue RestClient::Exception, Errno::ECONNREFUSED => error
+      handle_error(error)
+    end
+
+    process response.body
+  end
+
+  def self.resource_url(path = '')
+    URI.escape "#{@endpoint}/#{path}"
+  end
+
+  def self.handle_rest_error(http_code, http_body)
+    error = parse http_body
+    message = error['Message']
+
+    case http_code
+    when 401
+      raise AuthenticationError.new message, http_code
+    when 404
+      raise ResourceNotFoundError.new message, http_code
+    else
+      raise GetAddressError.new message, http_code
+    end
+  end
+
+  def self.process(response)
+    response_hash = parse response
+
+    latitude = response_hash['latitude']
+    longitude = response_hash['longitude']
+    response_hash['addresses'].map do |addr_hash|
+      Address.new line1: addr_hash[0], line2: addr_hash[1], line3: addr_hash[2], city: addr_hash[3],
+                  county: addr_hash[4], latitude: latitude, longitude: longitude
+    end
+  end
+
+  def self.parse(response)
+    JSON.parse(response)
+  rescue JSON::ParserError => e
+    raise handle_error(e)
+  end
+
+  def self.handle_error(error)
+    raise GetAddressError.new("An unexpected error occurred: #{error.message})")
+  end
+
+end

data/lib/get_address/address.rb

@@ -0,0 +1,15 @@
+require 'virtus'
+
+module GetAddress
+  class Address
+    include Virtus.model
+
+    attribute :line1, String
+    attribute :line2, String
+    attribute :line3, String
+    attribute :city, String
+    attribute :county, String
+    attribute :latitude,  Float
+    attribute :longitude, Float
+  end
+end

data/lib/get_address/errors.rb

@@ -0,0 +1,18 @@
+module GetAddress
+  class GetAddressError < StandardError
+    attr_reader :message
+    attr_reader :code
+
+    def initialize(message = nil, code = nil)
+      @message = message
+      @code = code
+    end
+
+    def to_s
+      "#{code}: #{message}"
+    end
+  end
+
+  class AuthenticationError < GetAddressError; end
+  class ResourceNotFoundError < GetAddressError; end
+end

data/lib/get_address/utils.rb

@@ -0,0 +1,16 @@
+module GetAddress
+  class Utils
+
+    def self.escape_params(hash)
+      result = []
+      hash.each do |key, value|
+        result.push "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
+      end
+      result.join('&')
+    end
+
+    def self.present?(param)
+      param.respond_to?(:empty?) ? !param.empty? : !param.nil?
+    end
+  end
+end

data/lib/get_address/version.rb

@@ -0,0 +1,3 @@
+module GetAddress
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: get_address
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- CorsaiR
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-09 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.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+description: A simple API for finding postal addresses
+email:
+- alezander82@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- get_address.gemspec
+- lib/get_address.rb
+- lib/get_address/address.rb
+- lib/get_address/errors.rb
+- lib/get_address/utils.rb
+- lib/get_address/version.rb
+homepage: http://rubygems.org/gems/get_address
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.5.2
+signing_key: 
+specification_version: 4
+summary: Wrapper for the getaddress.io API
+test_files: []