psi_eligibility 1.0.1

data/lib/psi_eligibility/version.rb

@@ -0,0 +1,15 @@
+=begin
+#PSI Candidate Rest Eligibility Service
+
+#PSIs REST based service to modify candidate test eligibilities.
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.10
+
+=end
+
+module PsiEligibility
+  VERSION = '1.0.1'
+end

data/psi_eligibility.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#PSI Candidate Rest Eligibility Service
+
+#PSIs REST based service to modify candidate test eligibilities.
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.10
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "psi_eligibility/version"
+
+Gem::Specification.new do |s|
+  s.name        = "psi_eligibility"
+  s.version     = PsiEligibility::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matt Orahood"]
+  s.email       = ["morahood@gmail.com"]
+  s.homepage    = "https://github.com/swagger-api/swagger-codegen"
+  s.summary     = "This gem maps to the PSI Eligibility Swagger API."
+  s.description = "This gem maps to the PSI Eligibility Swagger API."
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.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/spec/api/default_api_spec.rb

@@ -0,0 +1,130 @@
+=begin
+#PSI Candidate Rest Eligibility Service
+
+#PSIs REST based service to modify candidate test eligibilities.
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.10
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for PsiEligibility::DefaultApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'DefaultApi' do
+  before do
+    # run before each test
+    @instance = PsiEligibility::DefaultApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DefaultApi' do
+    it 'should create an instance of DefaultApi' do
+      expect(@instance).to be_instance_of(PsiEligibility::DefaultApi)
+    end
+  end
+
+  # unit tests for cancel_candidate_eligibility
+  # Cancel a candidate's eligibility record.
+  # Cancels the eligibility matching the supplied candidate eligiblity code.
+  # @param account_code provided client specific account code.
+  # @param candidate_id The unique candidate id to act on.
+  # @param test_code The test code.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'cancel_candidate_eligibility test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_candidate
+  # Create a new candidate eligibility record.
+  # Submits a single eligibilites to the PSI Atlas system. Many parameters are optional but the more the better.
+  # @param account_code provided client specific account code.
+  # @param payload A new eligibility record.
+  # @param [Hash] opts the optional parameters
+  # @return [EligibilityResponseModel]
+  describe 'create_candidate test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_candidate
+  # Get the eligiblities associated with the candidate id.
+  # Get's all of the eligibilities associated with the supplied candidate_id. This is useful to decide which specific eligibility needs to be updated or deleted.
+  # @param account_code provided client specific account code.
+  # @param candidate_id the candidate id.
+  # @param [Hash] opts the optional parameters
+  # @return [Array<ExistingEligibilityModel>]
+  describe 'get_candidate test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_candidate_eligibilities
+  # Get the eligiblities associated with the candidate id.
+  # Get&#39;s all of the eligibilities associated with the supplied candidate_id fpr a specific test code.
+  # @param account_code provided client specific account code.
+  # @param candidate_id the candidate id.
+  # @param test_code The test code.
+  # @param [Hash] opts the optional parameters
+  # @return [Array<ExistingEligibilityModel>]
+  describe 'get_candidate_eligibilities test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_test_launch_info
+  # GET test launch url
+  # API endpoint to retrieve the test launch URL for a given eligibility code.
+  # @param psi_eligibility_code 
+  # @param [Hash] opts the optional parameters
+  # @return [TestLaunchInfoModel]
+  describe 'get_test_launch_info test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for modify_vouchers_of_eligibility
+  # Associate a set of voucher codes to PSI Candidate Test Eligibility record. Previously attached vouchers to the eligibility record but not listed in the input would be unlinked from the eligibility record. Voucher Codes are agreed upon codes between PSI and the customer (identified by account_code)
+  # @param account_code Account code or the customer code
+  # @param candidate_id Candidate Id
+  # @param test_code Test Code
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :payload Voucher Codes to be applied to the candidate&#39;s specified exam record
+  # @return [nil]
+  describe 'modify_vouchers_of_eligibility test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_candidate_eligibility
+  # Update an existing candidate&#39;s eligibility record.
+  # Update an existing candidate&#39;s eligibility details. Information such as candidate demographic data and eligibility, expiration and scheduled start date may be changed. You cannot change the associated test via this call. To do so you must cancel and create a new eligibility.
+  # @param account_code provided client specific account code.
+  # @param candidate_id The unique candidate id to update.
+  # @param test_code The test code.
+  # @param payload The candidate&#39;s updated eligibity record.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_candidate_eligibility 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_client_spec.rb

@@ -0,0 +1,226 @@
+=begin
+#PSI Candidate Rest Eligibility Service
+
+#PSIs REST based service to modify candidate test eligibilities.
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.10
+
+=end
+
+require 'spec_helper'
+
+describe PsiEligibility::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          PsiEligibility.configure { |c| c.host = 'http://example.com' }
+          expect(PsiEligibility::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          PsiEligibility.configure { |c| c.host = 'https://wookiee.com' }
+          expect(PsiEligibility::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          PsiEligibility.configure { |c| c.host = 'hobo.com/v4' }
+          expect(PsiEligibility::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          PsiEligibility.configure { |c| c.base_path = 'v4/dog' }
+          expect(PsiEligibility::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          PsiEligibility.configure { |c| c.base_path = '/v4/dog' }
+          expect(PsiEligibility::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          PsiEligibility.configure { |c| c.base_path = nil }
+          expect(PsiEligibility::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { PsiEligibility::Configuration.new }
+    let(:api_client) { PsiEligibility::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(PsiEligibility::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) { PsiEligibility::Configuration.new }
+    let(:api_client) { PsiEligibility::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(PsiEligibility::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 = PsiEligibility::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 = PsiEligibility::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 = PsiEligibility::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 = PsiEligibility::ApiClient.new
+      # _model = PsiEligibility::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) { PsiEligibility::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) { PsiEligibility::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) { PsiEligibility::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) { PsiEligibility::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) { PsiEligibility::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,42 @@
+=begin
+#PSI Candidate Rest Eligibility Service
+
+#PSIs REST based service to modify candidate test eligibilities.
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.10
+
+=end
+
+require 'spec_helper'
+
+describe PsiEligibility::Configuration do
+  let(:config) { PsiEligibility::Configuration.default }
+
+  before(:each) do
+    # uncomment below to setup host and base_path
+    # require 'URI'
+    # uri = URI.parse("https://apiuatapi.psiexams.com/eligibility_service/1.0.0")
+    # PsiEligibility.configure do |c|
+    #   c.host = uri.host
+    #   c.base_path = uri.path
+    # end
+  end
+
+  describe '#base_url' do
+    it 'should have the default value' do
+      # uncomment below to test default value of the base path
+      # expect(config.base_url).to eq("https://apiuatapi.psiexams.com/eligibility_service/1.0.0")
+    end
+
+    it 'should remove trailing slashes' do
+      [nil, '', '/', '//'].each do |base_path|
+        config.base_path = base_path
+        # uncomment below to test trailing slashes
+        # expect(config.base_url).to eq("https://apiuatapi.psiexams.com/eligibility_service/1.0.0")
+      end
+    end
+  end
+end