eircode 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 539c8f5ba64069a78cbe09f59e5c5666a564a4c1
+  data.tar.gz: 48a8bce650078a856fa3f37981bb1a7775c765f1
+SHA512:
+  metadata.gz: 2784ca413876cb3dd2c1eb190d05679d0376b4504183480205c22a8909f81e84d2ce4694dc877ac5916f81f7c34e0edab662cd0edfcd1fc0de899f2e49b8c1d5
+  data.tar.gz: e748665125ae3156150906cd09c6de7d91cb849dabdfbc2b1a85af264949745cf9aa5f8541beea42ad72843bc0eb0d256a06e1058e209abf2de46ad4d386bbff

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eircode.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Colm McBarron
+
+MIT License
+
+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,29 @@
+# Eircode
+
+Simple Gem to wrap the public Eircode API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'eircode'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eircode
+
+## Usage
+
+Use at your own risk!
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/eircode/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/eircode.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eircode/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eircode"
+  spec.version       = Eircode::VERSION
+  spec.authors       = ["Colm McBarron"]
+  spec.email         = ["colm.mcbarron@eachandother.com"]
+  spec.summary       = %q{Gem to wrap/hack the Eircode API}
+  spec.description   = %q{Gem to wrap/hack the Eircode API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+  
+
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "json"
+end

data/lib/eircode.rb

@@ -0,0 +1,51 @@
+require_relative "eircode/version"
+require 'faraday'
+require 'json'
+
+
+SEARCH_URL = "https://finder-api.eircode.ie/api/autocomplete/en?key=874d0fd8-d94a-418a-8089-5d901019f88c&addressline="
+
+module Eircode
+
+  class Address
+  	def self.search(query)
+  		response = Faraday.get("#{SEARCH_URL}#{query}")
+      	result_hash = JSON.parse(response.body)
+      	results = Results.new(result_hash)
+      	return results
+  	end
+  end
+
+  class Results
+
+  	attr_accessor :total_matches
+  	attr_accessor :addresses
+
+  	def initialize(result_hash)
+  		@total_matches = result_hash["totalMatches"]
+  		addresses = result_hash["addresses"]
+  		if addresses.nil?
+  			@addresses = nil
+  		else
+  			@addresses = []
+  			addresses.each do |a|
+  				address = Address.new(a)
+  				@addresses << address;
+  			end
+  		end
+  	end
+  end
+
+  class Address
+  	attr_accessor :id
+  	attr_accessor :address
+  	attr_accessor :unique
+  	
+  	def initialize(address_hash)
+  		@id = address_hash['id']
+  		@address = address_hash['address']
+  		@unique = address_hash['unique']
+  	end
+  end
+
+end

data/lib/eircode/version.rb

@@ -0,0 +1,3 @@
+module Eircode
+  VERSION = "1.0.0"
+end

data/test/address/address_test.rb

@@ -0,0 +1,36 @@
+require './test/test_helper'
+
+class EircodeAddressTest < Minitest::Test
+  def test_exists
+    assert Eircode::Address
+  end
+
+  def test_it_gives_back_too_many_addresses
+    VCR.use_cassette('too_many_addresses') do
+      results = Eircode::Address.search("priory")
+      assert_equal Eircode::Results, results.class
+      assert_equal 137, results.total_matches
+      assert_equal nil, results.addresses
+    end
+  end
+
+  def test_it_gives_back_no_addresses
+    VCR.use_cassette('no_addresses') do
+      results = Eircode::Address.search("sdsdsdsdsdsd")
+      assert_equal Eircode::Results, results.class
+      assert_equal 0, results.total_matches
+      assert_equal nil, results.addresses
+    end
+  end
+
+  def test_it_gives_back_some_addresses
+    VCR.use_cassette('some_addresses') do
+      results = Eircode::Address.search("the priory dublin")
+      assert_equal Eircode::Results, results.class
+      assert_equal 10, results.total_matches
+      assert_equal Array, results.addresses.class
+      first_address = results.addresses.first
+      assert_equal Eircode::Address, first_address.class
+    end
+  end
+end

data/test/fixtures/no_addresses.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://finder-api.eircode.ie/api/autocomplete/en?addressline=sdsdsdsdsdsd&key=874d0fd8-d94a-418a-8089-5d901019f88c
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 14 Jul 2015 13:39:29 GMT
+      Expires:
+      - '-1'
+      Pragma:
+      - no-cache
+      Content-Length:
+      - '47'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "{\r\n  \"totalMatches\": 0,\r\n  \"addresses\": null\r\n}"
+    http_version: 
+  recorded_at: Tue, 14 Jul 2015 13:40:00 GMT
+recorded_with: VCR 2.9.3

data/test/fixtures/some_addresses.yml

@@ -0,0 +1,61 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://finder-api.eircode.ie/api/autocomplete/en?addressline=the%20priory%20dublin&key=874d0fd8-d94a-418a-8089-5d901019f88c
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 14 Jul 2015 13:39:31 GMT
+      Expires:
+      - '-1'
+      Pragma:
+      - no-cache
+      Content-Length:
+      - '1589'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "{\r\n  \"totalMatches\": 10,\r\n  \"addresses\": [\r\n    {\r\n      \"id\":
+        \"01b32136-5fbf-4081-a1bb-d5b1a223ecee\",\r\n      \"address\": \"THE PRIORY,
+        KILTIPPER ROAD, DUBLIN 24\",\r\n      \"unique\": true\r\n    },\r\n    {\r\n
+        \     \"id\": \"c7dc8456-cf3e-400b-bde2-416f503ac5b7\",\r\n      \"address\":
+        \"THE PRIORY, GREENHILLS ROAD, DUBLIN 24\",\r\n      \"unique\": true\r\n
+        \   },\r\n    {\r\n      \"id\": \"0177810a-0b4f-48a5-a871-c45509ea6eef\",\r\n
+        \     \"address\": \"THE PRIORY, MONKSTOWN ROAD, MONKSTOWN, BLACKROCK, CO.
+        DUBLIN\",\r\n      \"unique\": true\r\n    },\r\n    {\r\n      \"id\": \"ccd790dc-9063-417f-83b2-a36932c358a2\",\r\n
+        \     \"address\": \"THE PRIORY, 409 STILLORGAN ROAD, BLACKROCK, CO. DUBLIN\",\r\n
+        \     \"unique\": true\r\n    },\r\n    {\r\n      \"id\": \"740bef43-35b7-4625-a85b-f17c9c8ad9a8\",\r\n
+        \     \"address\": \"THE PRIORY, DUBLIN 16\",\r\n      \"unique\": false\r\n
+        \   },\r\n    {\r\n      \"id\": \"7e6056fd-6f05-48d8-a9d7-e64daef946d0\",\r\n
+        \     \"address\": \"THE PRIORY, JOHN STREET, DUBLIN 8\",\r\n      \"unique\":
+        true\r\n    },\r\n    {\r\n      \"id\": \"d7697fe7-41a6-4404-8014-d316366e12c6\",\r\n
+        \     \"address\": \"THE PRIORY, DONABATE, CO. DUBLIN\",\r\n      \"unique\":
+        false\r\n    },\r\n    {\r\n      \"id\": \"e55c2834-fc38-4295-9877-989947fadf64\",\r\n
+        \     \"address\": \"THE PRIORY, MAIN STREET, MALAHIDE, CO. DUBLIN\",\r\n
+        \     \"unique\": false\r\n    },\r\n    {\r\n      \"id\": \"3aa59f89-b7fd-4faa-8d21-a6f94080da60\",\r\n
+        \     \"address\": \"THE PRIORY, DUBLIN 7\",\r\n      \"unique\": false\r\n
+        \   },\r\n    {\r\n      \"id\": \"0ec9cbfd-8654-4c5c-85fb-51d29116fce8\",\r\n
+        \     \"address\": \"THE PRIORY CLINIC, 17/18 PRIORY HALL, STILLORGAN ROAD,
+        BLACKROCK, CO. DUBLIN\",\r\n      \"unique\": true\r\n    }\r\n  ]\r\n}"
+    http_version: 
+  recorded_at: Tue, 14 Jul 2015 13:40:00 GMT
+recorded_with: VCR 2.9.3

data/test/fixtures/too_many_addresses.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://finder-api.eircode.ie/api/autocomplete/en?addressline=priory&key=874d0fd8-d94a-418a-8089-5d901019f88c
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 14 Jul 2015 13:39:26 GMT
+      Expires:
+      - '-1'
+      Pragma:
+      - no-cache
+      Content-Length:
+      - '49'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "{\r\n  \"totalMatches\": 137,\r\n  \"addresses\": null\r\n}"
+    http_version: 
+  recorded_at: Tue, 14 Jul 2015 13:40:00 GMT
+recorded_with: VCR 2.9.3

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require './lib/eircode'
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = "test/fixtures"
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: eircode
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Colm McBarron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem to wrap/hack the Eircode API
+email:
+- colm.mcbarron@eachandother.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- eircode.gemspec
+- lib/eircode.rb
+- lib/eircode/version.rb
+- test/address/address_test.rb
+- test/fixtures/no_addresses.yml
+- test/fixtures/some_addresses.yml
+- test/fixtures/too_many_addresses.yml
+- test/test_helper.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Gem to wrap/hack the Eircode API
+test_files:
+- test/address/address_test.rb
+- test/fixtures/no_addresses.yml
+- test/fixtures/some_addresses.yml
+- test/fixtures/too_many_addresses.yml
+- test/test_helper.rb