first-class-postcodes 0.0.1

data/lib/first-class-postcodes/version.rb

@@ -0,0 +1,3 @@
+module FCP
+  VERSION = '0.0.1'
+end

data/spec/api/api_api_spec.rb

@@ -0,0 +1,46 @@
+=begin
+#First Class Postcodes
+
+#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. 
+
+The version of the OpenAPI document: 0.0.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for FCP::APIApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'APIApi' do
+  before do
+    # run before each test
+    @api_instance = FCP::APIApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of APIApi' do
+    it 'should create an instance of APIApi' do
+      expect(@api_instance).to be_instance_of(FCP::APIApi)
+    end
+  end
+
+  # unit tests for get_specification
+  # OpenAPI Specification
+  # Retrieve the OpenAPI Specification for this base path. 
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'get_specification test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/data_api_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'json'
+
+describe 'DataApi' do
+
+  let(:instance) { FCP::DataApi.new }
+
+  specify { expect(instance).to be_instance_of(FCP::DataApi) }
+
+  # tests for #get_lookup
+  # 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). 
+  # 
+  # Test positions are based upon data here: 
+  # 
+  # https://github.com/firstclasspostcodes/firstclasspostcodes-mock/blob/master/DATA.md
+  #
+  # @param latitude The latitude for the query 
+  # @param longitude The latitude for the query 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Float] :radius The radius, in kilometers. 
+  # @return [Array<Point>]
+  describe '#get_lookup' do
+    [%w(51.469275	-0.266110), %w(51.469284	-0.266096)].each do |position|
+      specify { expect(instance.get_lookup(*position)).to all(be_instance_of(FCP::Point)) }
+    end
+
+    describe 'when an unsupported position' do
+      specify { expect(instance.get_lookup(51.90026, 2.62673)).to be_nil }
+    end
+  end
+
+  # tests for #get_postcode
+  # Postcode Lookup
+  #
+  # Retrieves street numbers, address and location information for a specific postcode provided in the search query parameter. 
+  # 
+  # Test postcodes are based upon data here: 
+  # 
+  # https://github.com/firstclasspostcodes/firstclasspostcodes-mock/blob/master/DATA.md
+  #
+  # @param search The postcode to retrieve address information for. 
+  # @param [Hash] opts the optional parameters
+  # @return [Address]
+  describe '#get_postcode' do
+    ['TW9 1XW', 'tw91xw', 'tw9 1xw'].each do |postcode|
+      describe "Response when '?search=#{postcode}'" do
+        specify { expect(instance.get_postcode(postcode)).to be_instance_of(FCP::Address) }
+      end
+    end
+
+    describe 'with an unsupported postcode' do
+      specify { expect(instance.get_postcode('XX43 FGH')).to be_nil }
+    end
+  end
+
+  # tests for #get_typeahead
+  # Typeahead Search
+  #
+  # Performs a typeahead search for an address, allowing the user to enter their address naturally.  
+  #
+  # @param search The typeahead search query to return matching results for. 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Typeahead>]
+  describe '#get_typeahead' do
+    ['fl', 'fla', 'flat', '1', '13', '25'].each do |search|
+      describe "Response when '?search=#{search}'" do
+        specify { expect(instance.get_typeahead(search)).to all(be_instance_of(FCP::Typeahead)) }
+      end
+    end
+  end
+
+end

data/spec/api_client_spec.rb

@@ -0,0 +1,214 @@
+require 'spec_helper'
+
+describe FCP::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          FCP.configure { |c| c.host = 'http://example.com' }
+          expect(FCP::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          FCP.configure { |c| c.host = 'https://wookiee.com' }
+          expect(FCP::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          FCP.configure { |c| c.host = 'hobo.com/v4' }
+          expect(FCP::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          FCP.configure { |c| c.base_path = 'v4/dog' }
+          expect(FCP::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          FCP.configure { |c| c.base_path = '/v4/dog' }
+          expect(FCP::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          FCP.configure { |c| c.base_path = nil }
+          expect(FCP::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { FCP::Configuration.new }
+    let(:api_client) { FCP::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(FCP::Configuration.default.params_encoding).to eq(nil)
+      expect(config.params_encoding).to eq(nil)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(nil)
+    end
+
+    it 'can be customized' do
+      config.params_encoding = :multi
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(:multi)
+    end
+  end
+
+  describe 'timeout in #build_request' do
+    let(:config) { FCP::Configuration.new }
+    let(:api_client) { FCP::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(FCP::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it 'can be customized' do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe '#deserialize' do
+    it "handles Array<Integer>" do
+      api_client = FCP::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it 'handles Array<Array<Integer>>' do
+      api_client = FCP::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it 'handles Hash<String, String>' do
+      api_client = FCP::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq(:message => 'Hello')
+    end
+  end
+
+  describe "#object_to_hash" do
+    it 'ignores nils and includes empty arrays' do
+      # uncomment below to test object_to_hash for model
+      # api_client = FCP::ApiClient.new
+      # _model = FCP::ModelName.new
+      # update the model attribute below
+      # _model.id = 1
+      # update the expected value (hash) below
+      # expected = {id: 1, name: '', tags: []}
+      # expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe '#build_collection_param' do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { FCP::ApiClient.new }
+
+    it 'works for csv' do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it 'works for ssv' do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it 'works for tsv' do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it 'works for pipes' do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it 'works for multi' do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it 'fails for invalid collection format' do
+      expect(proc { api_client.build_collection_param(param, :INVALID) }).to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe '#json_mime?' do
+    let(:api_client) { FCP::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe '#select_header_accept' do
+    let(:api_client) { FCP::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe '#select_header_content_type' do
+    let(:api_client) { FCP::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe '#sanitize_filename' do
+    let(:api_client) { FCP::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,28 @@
+require 'uri'
+require 'spec_helper'
+
+describe FCP::Configuration do
+  let(:config) { FCP::Configuration.default }
+
+  before(:each) do
+    uri = URI.parse("https://api.firstclasspostcodes.com/data")
+    FCP.configure do |c|
+      c.scheme = 'https'
+      c.host = uri.host
+      c.base_path = uri.path
+    end
+  end
+
+  describe '#base_url' do
+    it 'should have the default value' do
+      expect(config.base_url).to eq("https://api.firstclasspostcodes.com/data")
+    end
+
+    it 'should remove trailing slashes' do
+      [nil, '', '/', '//'].each do |base_path|
+        config.base_path = base_path
+        expect(config.base_url).to eq("https://api.firstclasspostcodes.com")
+      end
+    end
+  end
+end

data/spec/models/address_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for FCP::Address
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'Address' do
+  before do
+    # run before each test
+    @instance = FCP::Address.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Address' do
+    it 'should create an instance of Address' do
+      expect(@instance).to be_instance_of(FCP::Address)
+    end
+  end
+  describe 'test attribute "street"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "numbers"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "city"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "district"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "county"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "postcode"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "country"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "position"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/error_raw_gateway_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for FCP::ErrorRawGateway
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ErrorRawGateway' do
+  before do
+    # run before each test
+    @instance = FCP::ErrorRawGateway.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ErrorRawGateway' do
+    it 'should create an instance of ErrorRawGateway' do
+      expect(@instance).to be_instance_of(FCP::ErrorRawGateway)
+    end
+  end
+  describe 'test attribute "type"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "message"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end