yapstone-payments 1.0.0

data/spec/api/refunds_api_spec.rb

@@ -0,0 +1,127 @@
+=begin
+#Payments Orchestrator
+
+#\"REST API for Payments Orchestrator\"
+
+The version of the OpenAPI document: 1.6.4-SNAPSHOT
+Contact: test@yapstone.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Yapstone::RefundsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'RefundsApi' do
+  before do
+    # run before each test
+    @api_instance = Yapstone::RefundsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RefundsApi' do
+    it 'should create an instance of RefundsApi' do
+      expect(@api_instance).to be_instance_of(Yapstone::RefundsApi)
+    end
+  end
+
+  # unit tests for cancel_refund
+  # Cancel Payment by payment Id
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address Ip Address of the client
+  # @param refund_id refundId
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id X-Yapstone-Trace-Id
+  # @option opts [String] :x_yapstone_fpsid Device Finger Print Id
+  # @return [RefundCancelResponse]
+  describe 'cancel_refund 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_payment_refund
+  # Create a refund
+  # Create a refund for a payment that was processed
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address IP Address of the client
+  # @param refund_request 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @option opts [String] :x_yapstone_fpsid Device Finger Print Id
+  # @return [RefundResponse]
+  describe 'create_payment_refund 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_transaction_refund
+  # Create a refund
+  # Use this end point to kick off a refund for transaction. If you've already captured the transaction, this will result in a refund of the amount captured and the details of that refund will be returned in the response body. 
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address IP Address of the client
+  # @param transaction 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @option opts [String] :x_yapstone_fpsid Device Finger Print Id
+  # @return [RefundResponse]
+  describe 'create_transaction_refund 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_by_originaltransaction_id
+  # Get master Transaction details including all refund details by transaction Id
+  # Transactions are nested inside payments. Master transactions are nested inside the master payment. 
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address IP Address of the client
+  # @param transaction_id transactionId
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @return [TransactionResponse]
+  describe 'get_by_originaltransaction_id 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_refund
+  # Get master payment details including all refund detail by refund ID.
+  # A master payment is the initial payment that all other payment details and transactions tied to that payment connect to. You can use a refund ID to retrieve master payment information. 
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address IP Address of the client
+  # @param refund_id refundId
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @return [RefundResponse]
+  describe 'get_refund 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_refund_by_payment_id
+  # Get master payment details including all refund details by Payment Id.
+  # A master payment is the initial payment that all other payment details and transactions tied to that payment connect to. 
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address IP Address of the client
+  # @param payment_id paymentId
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @return [RefundResponse]
+  describe 'get_refund_by_payment_id 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/search_api_spec.rb

@@ -0,0 +1,66 @@
+=begin
+#Payments Orchestrator
+
+#\"REST API for Payments Orchestrator\"
+
+The version of the OpenAPI document: 1.6.4-SNAPSHOT
+Contact: test@yapstone.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Yapstone::SearchApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SearchApi' do
+  before do
+    # run before each test
+    @api_instance = Yapstone::SearchApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SearchApi' do
+    it 'should create an instance of SearchApi' do
+      expect(@api_instance).to be_instance_of(Yapstone::SearchApi)
+    end
+  end
+
+  # unit tests for search_by_payment_id
+  # Search with Payment Id
+  # Use this endpoint to search for a payment by payment ID. 
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address IP Address of the client
+  # @param payment_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @return [SearchPaymentResponse]
+  describe 'search_by_payment_id 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 search_by_transaction_id
+  # Search with transaction id
+  # Use this endpoint to search for particular transactions using their transaction ID. 
+  # @param authorization Authorization
+  # @param x_yapstone_fpsid Device Finger Print Id
+  # @param x_yapstone_ip_address IP Address of the client
+  # @param transaction_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @return [SearchPaymentResponse]
+  describe 'search_by_transaction_id 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/token_api_spec.rb

@@ -0,0 +1,67 @@
+=begin
+#Payments Orchestrator
+
+#\"REST API for Payments Orchestrator\"
+
+The version of the OpenAPI document: 1.6.4-SNAPSHOT
+Contact: test@yapstone.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Yapstone::TokenApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TokenApi' do
+  before do
+    # run before each test
+    @api_instance = Yapstone::TokenApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TokenApi' do
+    it 'should create an instance of TokenApi' do
+      expect(@api_instance).to be_instance_of(Yapstone::TokenApi)
+    end
+  end
+
+  # unit tests for create_token
+  # Create a Token
+  # Create a token to make a payment. In your request you specify the type of instrument and you are returned a token for that instrument in the response. 
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address IP Address of the client
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  # @option opts [String] :x_yapstone_fpsid Device Finger Print Id
+  # @option opts [TokenRequest] :token_request 
+  # @return [Token]
+  describe 'create_token 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 lookup_token
+  # Lookup a Token
+  # Lookup a token to make a payment. Submit the token ID to retrieve details about the token. 
+  # @param authorization Authorization
+  # @param x_yapstone_ip_address IP Address of the client
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_yapstone_trace_id Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.
+  # @option opts [String] :x_yapstone_fpsid Device Finger Print Id
+  # @option opts [Token] :token 
+  # @return [TokenResponse]
+  describe 'lookup_token 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
+#Payments Orchestrator
+
+#\"REST API for Payments Orchestrator\"
+
+The version of the OpenAPI document: 1.6.4-SNAPSHOT
+Contact: test@yapstone.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.1.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+
+describe Yapstone::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          Yapstone.configure { |c| c.host = 'http://example.com' }
+          expect(Yapstone::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          Yapstone.configure { |c| c.host = 'https://wookiee.com' }
+          expect(Yapstone::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          Yapstone.configure { |c| c.host = 'hobo.com/v4' }
+          expect(Yapstone::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          Yapstone.configure { |c| c.base_path = 'v4/dog' }
+          expect(Yapstone::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          Yapstone.configure { |c| c.base_path = '/v4/dog' }
+          expect(Yapstone::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          Yapstone.configure { |c| c.base_path = nil }
+          expect(Yapstone::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { Yapstone::Configuration.new }
+    let(:api_client) { Yapstone::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(Yapstone::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) { Yapstone::Configuration.new }
+    let(:api_client) { Yapstone::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(Yapstone::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 = Yapstone::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 = Yapstone::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 = Yapstone::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 = Yapstone::ApiClient.new
+      # _model = Yapstone::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) { Yapstone::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) { Yapstone::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) { Yapstone::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) { Yapstone::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) { Yapstone::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