reference_service 0.0.1

data/spec/api/reports_api_spec.rb

@@ -0,0 +1,77 @@
+=begin
+#Golden Service API
+
+#An API that conforms to the standards and best practices that should be adhered to in all Mastercard owned APIs. Can be used to create subscriptions to reports that are generated twice daily (6am & 6pm) that deliver e-commerce spending across multiple sectors and locations. <br/> --- * **All requests must be signed using oauth 1.0a. Please refer to: https://developer.mastercard.com/platform/documentation/using-oauth-1a-to-access-mastercard-apis/** --- * **The user must provide their card details when creating a subscription. These details must be encrypted before entering transit. Please refer to [Mastercard security](https://stage.developer.mastercard.com/platform/documentation/securing-sensitive-data-using-payload-encryption/)** --- 
+
+The version of the OpenAPI document: 1.1.0
+Contact: developers@mastercard.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::ReportsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ReportsApi' do
+  before do
+    # run before each test
+    @api_instance = OpenapiClient::ReportsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ReportsApi' do
+    it 'should create an instance of ReportsApi' do
+      expect(@api_instance).to be_instance_of(OpenapiClient::ReportsApi)
+    end
+  end
+
+  # unit tests for get_spending
+  # Retrieves e-commerce spending for a particular location, sector and date range or single date
+  # @param date The date for the requested data
+  # @param location The location for which you wish to receive the top-sectors report.
+  # @param spending_type Used to distinguish between gross spending (GS) &amp; average transaction value (ATV)
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :sector The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call
+  # @return [SpendingReport]
+  describe 'get_spending 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_top_locations
+  # Retrieves the top grossing locations for the specified date/sector/spending type
+  # @param date The date for the requested data
+  # @param spending_type Used to distinguish between gross spending (GS) &amp; average transaction value (ATV)
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :sector The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call
+  # @option opts [Integer] :limit Can be used to limit the amount of results returned from a query (Pagination)
+  # @option opts [Integer] :offset The number of items to offset the start of the list from (Pagination)
+  # @return [TopLocationsReport]
+  describe 'get_top_locations 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_top_sectors
+  # Retrieves the top grossing sectors for the specified date &amp; location
+  # @param date The date for the requested data
+  # @param location The location for which you wish to receive the top-sectors report.
+  # @param spending_type Used to distinguish between gross spending (GS) &amp; average transaction value (ATV)
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Array>]
+  describe 'get_top_sectors 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/sector_api_spec.rb

@@ -0,0 +1,58 @@
+=begin
+#Golden Service API
+
+#An API that conforms to the standards and best practices that should be adhered to in all Mastercard owned APIs. Can be used to create subscriptions to reports that are generated twice daily (6am & 6pm) that deliver e-commerce spending across multiple sectors and locations. <br/> --- * **All requests must be signed using oauth 1.0a. Please refer to: https://developer.mastercard.com/platform/documentation/using-oauth-1a-to-access-mastercard-apis/** --- * **The user must provide their card details when creating a subscription. These details must be encrypted before entering transit. Please refer to [Mastercard security](https://stage.developer.mastercard.com/platform/documentation/securing-sensitive-data-using-payload-encryption/)** --- 
+
+The version of the OpenAPI document: 1.1.0
+Contact: developers@mastercard.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::SectorApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SectorApi' do
+  before do
+    # run before each test
+    @api_instance = OpenapiClient::SectorApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SectorApi' do
+    it 'should create an instance of SectorApi' do
+      expect(@api_instance).to be_instance_of(OpenapiClient::SectorApi)
+    end
+  end
+
+  # unit tests for get_sectors
+  # Returns the valid sectors which can be passed to various other endpoints in the sector field
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Sector>]
+  describe 'get_sectors 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_top_sectors
+  # Retrieves the top grossing sectors for the specified date &amp; location
+  # @param date The date for the requested data
+  # @param location The location for which you wish to receive the top-sectors report.
+  # @param spending_type Used to distinguish between gross spending (GS) &amp; average transaction value (ATV)
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Array>]
+  describe 'get_top_sectors 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/subscribe_api_spec.rb

@@ -0,0 +1,92 @@
+=begin
+#Golden Service API
+
+#An API that conforms to the standards and best practices that should be adhered to in all Mastercard owned APIs. Can be used to create subscriptions to reports that are generated twice daily (6am & 6pm) that deliver e-commerce spending across multiple sectors and locations. <br/> --- * **All requests must be signed using oauth 1.0a. Please refer to: https://developer.mastercard.com/platform/documentation/using-oauth-1a-to-access-mastercard-apis/** --- * **The user must provide their card details when creating a subscription. These details must be encrypted before entering transit. Please refer to [Mastercard security](https://stage.developer.mastercard.com/platform/documentation/securing-sensitive-data-using-payload-encryption/)** --- 
+
+The version of the OpenAPI document: 1.1.0
+Contact: developers@mastercard.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::SubscribeApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SubscribeApi' do
+  before do
+    # run before each test
+    @api_instance = OpenapiClient::SubscribeApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SubscribeApi' do
+    it 'should create an instance of SubscribeApi' do
+      expect(@api_instance).to be_instance_of(OpenapiClient::SubscribeApi)
+    end
+  end
+
+  # unit tests for get_subscription
+  # Gets a specific subscription using a subscription Id passed as in the path
+  # @param subscription_id Unique identifier of a particular subscription (UUID Version 4)
+  # @param [Hash] opts the optional parameters
+  # @return [SubscriptionResponse]
+  describe 'get_subscription 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 list_subscriptions
+  # gets all active subscriptions for a particular user. Returned list size can be limited using the limit parameter
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Can be used to limit the amount of results returned from a query (Pagination)
+  # @option opts [Integer] :offset The number of items to offset the start of the list from (Pagination)
+  # @return [Array<ActiveSubscription>]
+  describe 'list_subscriptions 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 subscribe
+  # Allows the user to subscribe to a particular location and receive updates on e-commerce spending in their chosen area. The user can pay for the subscription on a daily basis. The user is charged for every report they receive until their subscription is cancelled
+  # @param request_body Request body required to create a particular subscription
+  # @param [Hash] opts the optional parameters
+  # @return [Array<SubscriptionResponse>]
+  describe 'subscribe 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 unsubscribe
+  # Un-subscribes from a specified subcription
+  # @param subscription_id Unique identifier of a particular subscription (Version 4 UUID)
+  # @param [Hash] opts the optional parameters
+  # @return [UnsubscribedResponse]
+  describe 'unsubscribe 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_subscription
+  # Updates an active subscription
+  # @param subscription_id Unique identifier of a particular subscription (UUID Version 4)
+  # @param subscription_object Request body required to update a particular subscription
+  # @param [Hash] opts the optional parameters
+  # @return [SubscriptionResponse]
+  describe 'update_subscription 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
+#Golden Service API
+
+#An API that conforms to the standards and best practices that should be adhered to in all Mastercard owned APIs. Can be used to create subscriptions to reports that are generated twice daily (6am & 6pm) that deliver e-commerce spending across multiple sectors and locations. <br/> --- * **All requests must be signed using oauth 1.0a. Please refer to: https://developer.mastercard.com/platform/documentation/using-oauth-1a-to-access-mastercard-apis/** --- * **The user must provide their card details when creating a subscription. These details must be encrypted before entering transit. Please refer to [Mastercard security](https://stage.developer.mastercard.com/platform/documentation/securing-sensitive-data-using-payload-encryption/)** --- 
+
+The version of the OpenAPI document: 1.1.0
+Contact: developers@mastercard.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+
+describe OpenapiClient::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          OpenapiClient.configure { |c| c.host = 'http://example.com' }
+          expect(OpenapiClient::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          OpenapiClient.configure { |c| c.host = 'https://wookiee.com' }
+          expect(OpenapiClient::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          OpenapiClient.configure { |c| c.host = 'hobo.com/v4' }
+          expect(OpenapiClient::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          OpenapiClient.configure { |c| c.base_path = 'v4/dog' }
+          expect(OpenapiClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          OpenapiClient.configure { |c| c.base_path = '/v4/dog' }
+          expect(OpenapiClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          OpenapiClient.configure { |c| c.base_path = nil }
+          expect(OpenapiClient::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { OpenapiClient::Configuration.new }
+    let(:api_client) { OpenapiClient::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(OpenapiClient::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) { OpenapiClient::Configuration.new }
+    let(:api_client) { OpenapiClient::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(OpenapiClient::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 = OpenapiClient::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 = OpenapiClient::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 = OpenapiClient::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 = OpenapiClient::ApiClient.new
+      # _model = OpenapiClient::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) { OpenapiClient::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) { OpenapiClient::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) { OpenapiClient::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) { OpenapiClient::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) { OpenapiClient::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