idealpostcodesrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ef5b1df933b79c7a2469d6158cb3e9d37648c1b5c685033a49fe3ce33d675642
+  data.tar.gz: 032db0a324989a3a179bf499328e069c3a592b7e0349888eb335b0373513f7d1
+SHA512:
+  metadata.gz: 498af55a7b5ff6810d47a3899912639e687074ef2c9bb705352f73c98a7be441a978aa0186885884e7092148af8df58bc17c8c8ef0481f1930cbca0c747e41e0
+  data.tar.gz: 0f2031224b9d9fe33cc4935a05228e7925cf9049224375ece7fe596371a20727f4218766b38a29566a65c8dd972847fa1ab674506c92f429f912d332ae4d2d34

data/.env.example

@@ -0,0 +1 @@
+API_KEY=

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in youtuberb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "dotenv"

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    idealpostcodesrb (0.1.0)
+      faraday (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (2.7.6)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv
+  idealpostcodesrb!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Dean Perry
+
+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,86 @@
+# Ideal Postcodes
+
+**This library is a work in progress**
+
+IdealPostcodes is a Ruby library for the Ideal-Postcodes.co.uk API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'idealpostcodes'
+```
+
+## Usage
+
+### Set your API Key
+
+You can find your API Key from the [Ideal Postcodes account](https://account.ideal-postcodes.co.uk/tokens) page, then set it like so:
+
+```ruby
+@client = IdealPostcodes::Client.new(api_key: "abc123")
+```
+
+### Address
+
+```ruby
+# Find an address
+# Docs: https://docs.ideal-postcodes.co.uk/api#tag/Address-Search/operation/AddressAutocomplete
+@client.addresses.find query: "10 drowning street"
+#=> #<IdealPostcodes::Collection...
+
+# Lookup address for a postcode
+@client.addresses.lookup postcode: "sw1a 0aa"
+#=> #<IdealPostcodes::Collection...
+
+# Resolve an address
+# Kind should be GBR or USA
+# Address would be the ID of the Address in Ideal Postcodes
+@client.addresses.resolve kind: "gbr", address: "paf_22690298"
+
+# Retrieves an address as identified by its Unique Delivery Point Reference Number (UDPRN).
+@client.addresses.udprn query: "abc123"
+
+# Retrieves an address as identified by its UMPRN (Multiple Residence Unique ID.
+@client.addresses.umprn query: "abc123"
+```
+
+### Places
+
+```ruby
+# Query places across countries
+# Docs: https://docs.ideal-postcodes.co.uk/api#tag/Place-Search/operation/FindPlace
+@client.places.find query: "London"
+#=> #<IdealPostcodes::Collection
+
+# Resolve a Place
+@client.places.resolve place: "geonames_2643743"
+#=> #<IdealPostcodes::Place id="geonames_2643743"...
+```
+
+### Email Validation
+
+Queries and validates a given email address.
+
+```ruby
+@client.emails.validate email: "test-email@example.com"
+#=> #<IdealPostcodes::Email result="deliverable"...
+```
+
+### Phone Validation
+
+Queries and validates a given phone number. Number should include the country code.
+
+```ruby
+@client.phones.validate number: "447123123123"
+#=> #<IdealPostcodes::Phone valid=true...
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/idealpostcodes.
+
+## 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,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ideal_postcodes"
+
+# Load environment variables from .env file
+require 'dotenv/load'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+@client = IdealPostcodes::Client.new(api_key: ENV["API_KEY"])
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/idealpostcodesrb.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/ideal_postcodes/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "idealpostcodesrb"
+  spec.version = IdealPostcodes::VERSION
+  spec.authors = ["Dean Perry"]
+  spec.email = ["dean@deanpcmad.com"]
+
+  spec.summary = "A Ruby library for the Ideal Postcodes API"
+  spec.homepage = "https://deanpcmad.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/deanpcmad/idealpostcodesrb"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 2.0"
+end

data/lib/ideal_postcodes/client.rb

@@ -0,0 +1,46 @@
+module IdealPostcodes
+  class Client
+    attr_reader :api_key, :adapter
+
+    def initialize(api_key:, adapter: Faraday.default_adapter, stubs: nil)
+      @api_key = api_key
+      @adapter = adapter
+
+      # Test stubs for requests
+      @stubs = stubs
+    end
+
+    def addresses
+      AddressesResource.new(self)
+    end
+
+    def places
+      PlacesResource.new(self)
+    end
+
+    def emails
+      EmailsResource.new(self)
+    end
+
+    def phones
+      PhonesResource.new(self)
+    end
+
+    def connection
+      url = "https://api.ideal-postcodes.co.uk/v1"
+
+      @connection ||= Faraday.new(url) do |conn|
+        conn.headers = {
+          "User-Agent" => "idealpostcodes/v#{VERSION} (github.com/deanpcmad/idealpostcodes)",
+          "Authorization" => "api_key=\"#{api_key}\""
+        }
+        
+        conn.request :json
+        conn.response :json
+
+        conn.adapter adapter, @stubs
+      end
+    end
+
+  end
+end

data/lib/ideal_postcodes/collection.rb

@@ -0,0 +1,25 @@
+module IdealPostcodes
+  class Collection
+    attr_reader :data, :total
+
+    def self.from_response(response, type:)
+      body = response.body
+
+      if body["result"] and body["result"].include? "hits"
+        data = body["result"]["hits"]
+      else
+        data = body["result"]
+      end
+
+      new(
+        data: data.map { |attrs| type.new(attrs) },
+        total: data.count
+      )
+    end
+
+    def initialize(data:, total:)
+      @data = data
+      @total = total
+    end
+  end
+end

data/lib/ideal_postcodes/error.rb

@@ -0,0 +1,4 @@
+module IdealPostcodes
+  class Error < StandardError
+  end
+end

data/lib/ideal_postcodes/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module IdealPostcodes
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/ideal_postcodes/objects/address.rb

@@ -0,0 +1,4 @@
+module IdealPostcodes
+  class Address < Object
+  end
+end

data/lib/ideal_postcodes/objects/email.rb

@@ -0,0 +1,4 @@
+module IdealPostcodes
+  class Email < Object
+  end
+end

data/lib/ideal_postcodes/objects/phone.rb

@@ -0,0 +1,4 @@
+module IdealPostcodes
+  class Phone < Object
+  end
+end

data/lib/ideal_postcodes/objects/place.rb

@@ -0,0 +1,4 @@
+module IdealPostcodes
+  class Place < Object
+  end
+end

data/lib/ideal_postcodes/resource.rb

@@ -0,0 +1,56 @@
+module IdealPostcodes
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, headers)
+    end
+
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Error 400: Your request was malformed. '#{response.body["message"]}'"
+      when 401
+        raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["message"]}'"
+      when 403
+        raise Error, "Error 403: You are not allowed to perform that action. '#{response.body["message"]}'"
+      when 404
+        raise Error, "Error 404: No results were found for your request. '#{response.body["message"]}'"
+      when 409
+        raise Error, "Error 409: Your request was a conflict. '#{response.body["message"]}'"
+      when 422
+        raise Error, "Error 422: Unprocessable Entity. '#{response.body["message"]}'"
+      when 429
+        raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["message"]}'"
+      when 500
+        raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body["message"]}'"
+      when 503
+        raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["message"]}'"
+      end
+
+      response
+    end
+  end
+end

data/lib/ideal_postcodes/resources/addresses.rb

@@ -0,0 +1,31 @@
+module IdealPostcodes
+  class AddressesResource < Resource
+
+    def find(**params)
+      response = get_request("autocomplete/addresses", params: params)
+      Collection.from_response(response, type: Address)
+    end
+
+    def resolve(kind:, address:)
+      response = get_request("autocomplete/addresses/#{address}/#{kind}")
+      Address.new(response.body["result"])
+    end
+
+    def lookup(postcode:)
+      query = postcode.gsub(" ", "")
+      response = get_request("postcodes/#{query}")
+      Collection.from_response(response, type: Address)
+    end
+
+    def udprn(query:)
+      response = get_request("udprn/#{query}")
+      Address.new(response.body["result"])
+    end
+
+    def umprn(query:)
+      response = get_request("umprn/#{query}")
+      Address.new(response.body["result"])
+    end
+
+  end
+end

data/lib/ideal_postcodes/resources/emails.rb

@@ -0,0 +1,10 @@
+module IdealPostcodes
+  class EmailsResource < Resource
+
+    def validate(email:)
+      response = get_request("emails", params: {query: email})
+      Email.new(response.body["result"])
+    end
+
+  end
+end

data/lib/ideal_postcodes/resources/phones.rb

@@ -0,0 +1,10 @@
+module IdealPostcodes
+  class PhonesResource < Resource
+
+    def validate(number:)
+      response = get_request("phone_numbers", params: {query: number})
+      Phone.new(response.body["result"])
+    end
+
+  end
+end

data/lib/ideal_postcodes/resources/places.rb

@@ -0,0 +1,15 @@
+module IdealPostcodes
+  class PlacesResource < Resource
+
+    def find(**params)
+      response = get_request("places", params: params)
+      Collection.from_response(response, type: Place)
+    end
+
+    def resolve(place:)
+      response = get_request("places/#{place}")
+      Place.new(response.body["result"])
+    end
+
+  end
+end

data/lib/ideal_postcodes/version.rb

@@ -0,0 +1,3 @@
+module IdealPostcodes
+  VERSION = "0.1.0"
+end

data/lib/ideal_postcodes.rb

@@ -0,0 +1,24 @@
+require "faraday"
+require "json"
+
+require_relative "ideal_postcodes/version"
+
+module IdealPostcodes
+
+  autoload :Client, "ideal_postcodes/client"
+  autoload :Collection, "ideal_postcodes/collection"
+  autoload :Error, "ideal_postcodes/error"
+  autoload :Resource, "ideal_postcodes/resource"
+  autoload :Object, "ideal_postcodes/object"
+  
+  autoload :AddressesResource, "ideal_postcodes/resources/addresses"
+  autoload :EmailsResource, "ideal_postcodes/resources/emails"
+  autoload :PhonesResource, "ideal_postcodes/resources/phones"
+  autoload :PlacesResource, "ideal_postcodes/resources/places"
+
+  autoload :Address, "ideal_postcodes/objects/address"
+  autoload :Email, "ideal_postcodes/objects/email"
+  autoload :Phone, "ideal_postcodes/objects/phone"
+  autoload :Place, "ideal_postcodes/objects/place"
+
+end

data/lib/idealpostcodesrb.rb

@@ -0,0 +1 @@
+require "ideal_postcodes"

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: idealpostcodesrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Perry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- dean@deanpcmad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- idealpostcodesrb.gemspec
+- lib/ideal_postcodes.rb
+- lib/ideal_postcodes/client.rb
+- lib/ideal_postcodes/collection.rb
+- lib/ideal_postcodes/error.rb
+- lib/ideal_postcodes/object.rb
+- lib/ideal_postcodes/objects/address.rb
+- lib/ideal_postcodes/objects/email.rb
+- lib/ideal_postcodes/objects/phone.rb
+- lib/ideal_postcodes/objects/place.rb
+- lib/ideal_postcodes/resource.rb
+- lib/ideal_postcodes/resources/addresses.rb
+- lib/ideal_postcodes/resources/emails.rb
+- lib/ideal_postcodes/resources/phones.rb
+- lib/ideal_postcodes/resources/places.rb
+- lib/ideal_postcodes/version.rb
+- lib/idealpostcodesrb.rb
+homepage: https://deanpcmad.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://deanpcmad.com
+  source_code_uri: https://github.com/deanpcmad/idealpostcodesrb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: A Ruby library for the Ideal Postcodes API
+test_files: []