first-class-postcodes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a257d70ae0068268d9d809c0d7f5b081f87e53b146fd88cb2d50fd4692900a17
+  data.tar.gz: 25ca587f6d434487f153dfb227b0257c467f3822b4c0fbeba44555e584abd9b7
+SHA512:
+  metadata.gz: 61029c51b6fa02d41cbbeea9737676f9a7c55e31cbbc3316d794a914c8af547c26e134012b0896cc5e1ddf163c643158831fa44011d42a26a0656d75db6f5f02
+  data.tar.gz: 5f419ae72b6ac43f29b0546a8ac59a6c807d964769276428c8774479f89e5aa5d9682152255785117cd39e9f39ce92afdf10024f2337ddb760ca3aa3b1b06915

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem "coveralls", require: false
+  gem "rake", "~> 12.3.2"
+  gem "pry-byebug"
+  gem "rubocop", "~> 0.68.1"
+  gem "codecov", :require => false
+end

data/README.md

@@ -0,0 +1,74 @@
+# Ruby Library
+
+[![Gem Version](https://badge.fury.io/rb/first-class-postcodes.svg)](https://badge.fury.io/rb/first-class-postcodes) [![Build Status](https://travis-ci.org/firstclasspostcodes/firstclasspostcodes-ruby.svg?branch=master)](https://travis-ci.org/firstclasspostcodes/firstclasspostcodes-ruby) [![codecov](https://codecov.io/gh/firstclasspostcodes/firstclasspostcodes-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/firstclasspostcodes/firstclasspostcodes-ruby)
+
+The First Class Postcodes Ruby library provides convenient access to our API for applications written in the Ruby language. It includes a pre-defined set of classes for API operations and models that initialize themselves dynamically from API responses.
+
+The library also provides other features. For example:
+
+* Easy configuration path for fast setup and use.
+* Built-in mechanisms for the serialization of parameters according to the expectations of our API.
+
+
+## Installation
+
+You don't need this source code unless you want to modify the gem. If you just
+want to use the package, just run:
+
+    gem install first-class-postcodes
+
+If you want to build the gem from source:
+
+    gem build first-class-postcodes.gemspec
+
+### Requirements
+
+* Ruby >= 2.2.0.
+
+### Bundler
+
+If you are installing via bundler, you should be sure to use the https rubygems source in your Gemfile, as any gems fetched over http could potentially be compromised in transit and alter the code of gems fetched securely over https:
+
+``` ruby
+source 'https://rubygems.org'
+
+gem 'rails'
+gem 'first-class-postcodes'
+```
+
+### Install from Git
+
+You can install directly from git, add the following into your Gemfile:
+
+```ruby
+gem 'first-class-postcodes', :git => 'https://github.com/firstclasspostcodes/firstclasspostcodes-ruby.git'
+```
+
+## Usage
+
+The library needs to be configured with your API Key, which is available on the [dashboard](https://dashboard.firstclasspostcodes.com).
+
+```ruby
+# Load the gem
+require 'first-class-postcodes'
+
+# Setup authorization
+FCP.configure do |config|
+  # Configure API key authorization: Authorizer
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = FCP::DataApi.new
+search = 'search_example' # String | The typeahead search query to return matching results for. 
+
+begin
+  #Typeahead Search
+  result = api_instance.get_typeahead(search)
+  p result
+rescue FCP::ApiError => e
+  puts "Exception when calling DataApi->get_typeahead: #{e}"
+end
+
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/first-class-postcodes.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+$:.push File.expand_path("../lib", __FILE__)
+require "first-class-postcodes/version"
+
+Gem::Specification.new do |s|
+  s.name        = "first-class-postcodes"
+  s.version     = FCP::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["First Class Postcodes"]
+  s.email       = ["support+api+ruby@firstclasspostcodes.com"]
+  s.homepage    = "https://docs.firstclasspostcodes.com/clients/ruby"
+  s.summary     = "First Class Postcodes Ruby API Client"
+  s.description = "Use this API to retrieve address information for UK postcodes. You can request by postcode, filter by geolocation and provide autocomplete suggestions using natural address entry. "
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.2.0"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.3', '>= 1.3.1'
+  s.add_runtime_dependency 'json', '~> 2.2', '>= 2.2.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/lib/first-class-postcodes.rb

@@ -0,0 +1,36 @@
+# Common files
+require 'first-class-postcodes/api_client'
+require 'first-class-postcodes/api_error'
+require 'first-class-postcodes/version'
+require 'first-class-postcodes/configuration'
+
+# Models
+require 'first-class-postcodes/models/address'
+require 'first-class-postcodes/models/error'
+require 'first-class-postcodes/models/error_raw'
+require 'first-class-postcodes/models/error_raw_gateway'
+require 'first-class-postcodes/models/point'
+require 'first-class-postcodes/models/position'
+require 'first-class-postcodes/models/typeahead'
+
+# APIs
+require 'first-class-postcodes/api/api_api'
+require 'first-class-postcodes/api/data_api'
+
+module FCP
+  class << self
+    # Customize default settings for the SDK using block.
+    #   FCP.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/first-class-postcodes/api/api_api.rb

@@ -0,0 +1,66 @@
+require 'cgi'
+
+module FCP
+  class APIApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # OpenAPI Specification
+    # Retrieve the OpenAPI Specification for this base path. 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def get_specification(opts = {})
+      data, _status_code, _headers = get_specification_with_http_info(opts)
+      data
+    end
+
+    # OpenAPI Specification
+    # Retrieve the OpenAPI Specification for this base path. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def get_specification_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIApi.get_specification ...'
+      end
+      # resource path
+      local_var_path = '/.spec'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Object' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APIApi#get_specification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/first-class-postcodes/api/data_api.rb

@@ -0,0 +1,217 @@
+require 'cgi'
+
+module FCP
+  class DataApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Geo Lookup
+    # Takes a valid latitude, longitude and radius (in km) and returns all matching postcodes within that area. This operation does not return full addresses (which must be queried for separately). 
+    # @param latitude [Float] The latitude for the query 
+    # @param longitude [Float] The latitude for the query 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :radius The radius, in kilometers.  (default to 1.0)
+    # @return [Array<Point>]
+    def get_lookup(latitude, longitude, opts = {})
+      data, _status_code, _headers = get_lookup_with_http_info(latitude, longitude, opts)
+      data
+    end
+
+    # Geo Lookup
+    # Takes a valid latitude, longitude and radius (in km) and returns all matching postcodes within that area. This operation does not return full addresses (which must be queried for separately). 
+    # @param latitude [Float] The latitude for the query 
+    # @param longitude [Float] The latitude for the query 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :radius The radius, in kilometers. 
+    # @return [Array<(Array<Point>, Integer, Hash)>] Array<Point> data, response status code and response headers
+    def get_lookup_with_http_info(latitude, longitude, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DataApi.get_lookup ...'
+      end
+      # verify the required parameter 'latitude' is set
+      if @api_client.config.client_side_validation && latitude.nil?
+        fail ArgumentError, "Missing the required parameter 'latitude' when calling DataApi.get_lookup"
+      end
+      # verify the required parameter 'longitude' is set
+      if @api_client.config.client_side_validation && longitude.nil?
+        fail ArgumentError, "Missing the required parameter 'longitude' when calling DataApi.get_lookup"
+      end
+      if @api_client.config.client_side_validation && !opts[:'radius'].nil? && opts[:'radius'] > 5
+        fail ArgumentError, 'invalid value for "opts[:"radius"]" when calling DataApi.get_lookup, must be smaller than or equal to 5.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'radius'].nil? && opts[:'radius'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"radius"]" when calling DataApi.get_lookup, must be greater than or equal to 0.'
+      end
+
+      # resource path
+      local_var_path = '/lookup'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'latitude'] = latitude
+      query_params[:'longitude'] = longitude
+      query_params[:'radius'] = opts[:'radius'] if !opts[:'radius'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<Point>' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Authorizer']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DataApi#get_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Postcode Lookup
+    # Retrieves street numbers, address and location information for a specific postcode provided in the search query parameter. 
+    # @param search [String] The postcode to retrieve address information for. 
+    # @param [Hash] opts the optional parameters
+    # @return [Address]
+    def get_postcode(search, opts = {})
+      data, _status_code, _headers = get_postcode_with_http_info(search, opts)
+      data
+    end
+
+    # Postcode Lookup
+    # Retrieves street numbers, address and location information for a specific postcode provided in the search query parameter. 
+    # @param search [String] The postcode to retrieve address information for. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Address, Integer, Hash)>] Address data, response status code and response headers
+    def get_postcode_with_http_info(search, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DataApi.get_postcode ...'
+      end
+      # verify the required parameter 'search' is set
+      if @api_client.config.client_side_validation && search.nil?
+        fail ArgumentError, "Missing the required parameter 'search' when calling DataApi.get_postcode"
+      end
+      # resource path
+      local_var_path = '/postcode'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'search'] = search
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Address' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Authorizer']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DataApi#get_postcode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Typeahead Search
+    # Performs a typeahead search for an address, allowing the user to enter their address naturally.  
+    # @param search [String] The typeahead search query to return matching results for. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Typeahead>]
+    def get_typeahead(search, opts = {})
+      data, _status_code, _headers = get_typeahead_with_http_info(search, opts)
+      data
+    end
+
+    # Typeahead Search
+    # Performs a typeahead search for an address, allowing the user to enter their address naturally.  
+    # @param search [String] The typeahead search query to return matching results for. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Typeahead>, Integer, Hash)>] Array<Typeahead> data, response status code and response headers
+    def get_typeahead_with_http_info(search, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DataApi.get_typeahead ...'
+      end
+      # verify the required parameter 'search' is set
+      if @api_client.config.client_side_validation && search.nil?
+        fail ArgumentError, "Missing the required parameter 'search' when calling DataApi.get_typeahead"
+      end
+      # resource path
+      local_var_path = '/typeahead'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'search'] = search
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<Typeahead>' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Authorizer']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DataApi#get_typeahead\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end