digital_femsa 1.0.0 → 1.1.1

data/spec/api/logs_api_spec.rb

@@ -13,54 +13,73 @@ Generator version: 7.5.0
 require 'spec_helper'
 require 'json'
 
-# Unit tests for DigitalFemsa::LogsApi
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'LogsApi' do
-  before do
-    # run before each test
-    @api_instance = DigitalFemsa::LogsApi.new
-  end
+RSpec.describe DigitalFemsa::LogsApi do
+  let(:config) { DigitalFemsa::Configuration.new }
+  let(:api_client) { instance_double(DigitalFemsa::ApiClient) }
+  let(:api_instance) { described_class.new(api_client) }
 
-  after do
-    # run after each test
+  before do
+    allow(api_client).to receive(:config).and_return(config)
+    allow(api_client).to receive(:select_header_accept).and_return('application/vnd.app-v2.1.0+json')
   end
 
   describe 'test an instance of LogsApi' do
-    it 'should create an instance of LogsApi' do
-      expect(@api_instance).to be_instance_of(DigitalFemsa::LogsApi)
+    it 'creates an instance of LogsApi' do
+      expect(api_instance).to be_instance_of(DigitalFemsa::LogsApi)
     end
   end
 
-  # unit tests for get_log_by_id
-  # Get Log
-  # Get the details of a specific log
-  # @param id Identifier of the resource
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
-  # @return [LogResponse]
-  describe 'get_log_by_id test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#get_log_by_id_with_http_info' do
+    it 'raises when id is missing' do
+      expect do
+        api_instance.get_log_by_id_with_http_info(nil)
+      end.to raise_error(ArgumentError, /Missing the required parameter 'id'/)
     end
-  end
 
-  # unit tests for get_logs
-  # Get List Of Logs
-  # Get log details in the form of a list
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
-  # @option opts [Integer] :limit The numbers of items to return, the maximum value is 250
-  # @option opts [String] :search General order search, e.g. by mail, reference etc.
-  # @option opts [String] :_next next page
-  # @option opts [String] :previous previous page
-  # @return [LogsResponse]
-  describe 'get_logs test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    it 'sends GET request with escaped id path' do
+      expect(api_client).to receive(:call_api).with(:GET, '/logs/log%2F123', hash_including(
+        operation: :'LogsApi.get_log_by_id',
+        return_type: 'LogResponse'
+      )).and_return([:log, 200, {}])
+
+      data = api_instance.get_log_by_id('log/123')
+      expect(data).to eq(:log)
     end
   end
 
+  describe '#get_logs_with_http_info' do
+    it 'raises for limit higher than 250' do
+      expect do
+        api_instance.get_logs_with_http_info(limit: 251)
+      end.to raise_error(ArgumentError, /must be smaller than or equal to 250/)
+    end
+
+    it 'raises for limit lower than 1' do
+      expect do
+        api_instance.get_logs_with_http_info(limit: 0)
+      end.to raise_error(ArgumentError, /must be greater than or equal to 1/)
+    end
+
+    it 'maps pagination and search query params' do
+      expect(api_client).to receive(:call_api).with(:GET, '/logs', hash_including(
+        operation: :'LogsApi.get_logs',
+        query_params: {
+          limit: 15,
+          search: 'timeout',
+          next: 'next_token',
+          previous: 'prev_token'
+        },
+        return_type: 'LogsResponse'
+      )).and_return([:list, 200, {}])
+
+      data = api_instance.get_logs(
+        limit: 15,
+        search: 'timeout',
+        _next: 'next_token',
+        previous: 'prev_token'
+      )
+
+      expect(data).to eq(:list)
+    end
+  end
 end

data/spec/api/orders_api_spec.rb

@@ -13,141 +13,167 @@ Generator version: 7.5.0
 require 'spec_helper'
 require 'json'
 
-# Unit tests for DigitalFemsa::OrdersApi
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'OrdersApi' do
-  before do
-    # run before each test
-    @api_instance = DigitalFemsa::OrdersApi.new
-  end
+RSpec.describe DigitalFemsa::OrdersApi do
+  let(:config) { DigitalFemsa::Configuration.new }
+  let(:api_client) { instance_double(DigitalFemsa::ApiClient) }
+  let(:api_instance) { described_class.new(api_client) }
 
-  after do
-    # run after each test
+  before do
+    allow(api_client).to receive(:config).and_return(config)
+    allow(api_client).to receive(:select_header_accept).and_return('application/vnd.app-v2.1.0+json')
+    allow(api_client).to receive(:select_header_content_type).and_return('application/json')
+    allow(api_client).to receive(:object_to_http_body) { |value| value.to_json }
   end
 
   describe 'test an instance of OrdersApi' do
-    it 'should create an instance of OrdersApi' do
-      expect(@api_instance).to be_instance_of(DigitalFemsa::OrdersApi)
+    it 'creates an instance of OrdersApi' do
+      expect(api_instance).to be_instance_of(DigitalFemsa::OrdersApi)
     end
   end
 
-  # unit tests for cancel_order
-  # Cancel Order
-  # Cancel an order that has been previously created.
-  # @param id Identifier of the resource
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
-  # @return [OrderResponse]
-  describe 'cancel_order test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#cancel_order_with_http_info' do
+    it 'raises when id is missing' do
+      expect do
+        api_instance.cancel_order_with_http_info(nil)
+      end.to raise_error(ArgumentError, /Missing the required parameter 'id'/)
     end
-  end
 
-  # unit tests for create_order
-  # Create order
-  # Create a new order.
-  # @param order_request requested field for order
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
-  # @return [OrderResponse]
-  describe 'create_order test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    it 'builds escaped path and sends POST request' do
+      expect(api_client).to receive(:call_api).with(:POST, '/orders/order%2F123/cancel', hash_including(
+        operation: :'OrdersApi.cancel_order',
+        return_type: 'OrderResponse',
+        auth_names: ['bearerAuth']
+      )).and_return([:ok, 200, {}])
+
+      data, status, _headers = api_instance.cancel_order_with_http_info('order/123')
+      expect(data).to eq(:ok)
+      expect(status).to eq(200)
     end
   end
 
-  # unit tests for get_order_by_id
-  # Get Order
-  # Info for a specific order
-  # @param id Identifier of the resource
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
-  # @return [OrderResponse]
-  describe 'get_order_by_id test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#create_order_with_http_info' do
+    it 'raises when order_request is missing' do
+      expect do
+        api_instance.create_order_with_http_info(nil)
+      end.to raise_error(ArgumentError, /Missing the required parameter 'order_request'/)
     end
-  end
 
-  # unit tests for get_orders
-  # Get a list of Orders
-  # Get order details in the form of a list
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
-  # @option opts [Integer] :limit The numbers of items to return, the maximum value is 250
-  # @option opts [String] :search General order search, e.g. by mail, reference etc.
-  # @option opts [String] :_next next page
-  # @option opts [String] :previous previous page
-  # @return [GetOrdersResponse]
-  describe 'get_orders test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    it 'sends serialized body and headers' do
+      payload = { amount: 1000, currency: 'MXN' }
+
+      expect(api_client).to receive(:call_api).with(:POST, '/orders', hash_including(
+        operation: :'OrdersApi.create_order',
+        body: payload.to_json,
+        return_type: 'OrderResponse'
+      )).and_return([:created, 201, {}])
+
+      data = api_instance.create_order(payload, accept_language: 'es', x_child_company_id: 'company_1')
+      expect(data).to eq(:created)
     end
   end
 
-  # unit tests for order_cancel_refund
-  # Cancel Refund
-  # A refunded order describes the items, amount, and reason an order is being refunded.
-  # @param id Identifier of the resource
-  # @param refund_id refund identifier
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
-  # @return [OrderResponse]
-  describe 'order_cancel_refund test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#get_orders_with_http_info' do
+    it 'raises for limit higher than 250' do
+      expect do
+        api_instance.get_orders_with_http_info(limit: 251)
+      end.to raise_error(ArgumentError, /must be smaller than or equal to 250/)
+    end
+
+    it 'raises for limit lower than 1' do
+      expect do
+        api_instance.get_orders_with_http_info(limit: 0)
+      end.to raise_error(ArgumentError, /must be greater than or equal to 1/)
+    end
+
+    it 'maps pagination and search into query params' do
+      expect(api_client).to receive(:call_api).with(:GET, '/orders', hash_including(
+        operation: :'OrdersApi.get_orders',
+        query_params: {
+          limit: 10,
+          search: 'john',
+          next: 'next_token',
+          previous: 'prev_token'
+        },
+        return_type: 'GetOrdersResponse'
+      )).and_return([:list, 200, {}])
+
+      data = api_instance.get_orders(
+        limit: 10,
+        search: 'john',
+        _next: 'next_token',
+        previous: 'prev_token'
+      )
+
+      expect(data).to eq(:list)
     end
   end
 
-  # unit tests for order_refund
-  # Refund Order
-  # A refunded order describes the items, amount, and reason an order is being refunded.
-  # @param id Identifier of the resource
-  # @param order_refund_request requested field for a refund
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
-  # @return [OrderResponse]
-  describe 'order_refund test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#order_cancel_refund_with_http_info' do
+    it 'raises when refund_id is missing' do
+      expect do
+        api_instance.order_cancel_refund_with_http_info('ord_123', nil)
+      end.to raise_error(ArgumentError, /Missing the required parameter 'refund_id'/)
+    end
+
+    it 'sends DELETE request with expected path' do
+      expect(api_client).to receive(:call_api).with(:DELETE, '/orders/ord_123/refunds/ref_123', hash_including(
+        operation: :'OrdersApi.order_cancel_refund',
+        return_type: 'OrderResponse'
+      )).and_return([:deleted, 200, {}])
+
+      data = api_instance.order_cancel_refund('ord_123', 'ref_123')
+      expect(data).to eq(:deleted)
     end
   end
 
-  # unit tests for orders_create_capture
-  # Capture Order
-  # Processes an order that has been previously authorized.
-  # @param id Identifier of the resource
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
-  # @option opts [OrderCaptureRequest] :order_capture_request requested fields for capture order
-  # @return [OrderResponse]
-  describe 'orders_create_capture test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#order_refund_with_http_info' do
+    it 'sends refund payload in POST body' do
+      payload = { reason: 'requested_by_customer', amount: 500 }
+
+      expect(api_client).to receive(:call_api).with(:POST, '/orders/ord_123/refunds', hash_including(
+        operation: :'OrdersApi.order_refund',
+        body: payload.to_json,
+        return_type: 'OrderResponse'
+      )).and_return([:refunded, 200, {}])
+
+      data = api_instance.order_refund('ord_123', payload)
+      expect(data).to eq(:refunded)
     end
   end
 
-  # unit tests for update_order
-  # Update Order
-  # Update an existing Order.
-  # @param id Identifier of the resource
-  # @param order_update_request requested field for an order
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @return [OrderResponse]
-  describe 'update_order test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#orders_create_capture_with_http_info' do
+    it 'sends capture payload in POST body' do
+      payload = { amount: 300 }
+
+      expect(api_client).to receive(:call_api).with(:POST, '/orders/ord_123/capture', hash_including(
+        operation: :'OrdersApi.orders_create_capture',
+        body: payload.to_json,
+        return_type: 'OrderResponse'
+      )).and_return([:captured, 200, {}])
+
+      data = api_instance.orders_create_capture('ord_123', order_capture_request: payload)
+      expect(data).to eq(:captured)
     end
   end
 
+  describe '#update_order_with_http_info' do
+    it 'raises when order_update_request is missing' do
+      expect do
+        api_instance.update_order_with_http_info('ord_123', nil)
+      end.to raise_error(ArgumentError, /Missing the required parameter 'order_update_request'/)
+    end
+
+    it 'sends PUT request with serialized body' do
+      payload = { metadata: { source: 'tests' } }
+
+      expect(api_client).to receive(:call_api).with(:PUT, '/orders/ord_123', hash_including(
+        operation: :'OrdersApi.update_order',
+        body: payload.to_json,
+        return_type: 'OrderResponse'
+      )).and_return([:updated, 200, {}])
+
+      data = api_instance.update_order('ord_123', payload, accept_language: 'en')
+      expect(data).to eq(:updated)
+    end
+  end
 end

data/spec/api/payment_link_api_spec.rb

@@ -13,107 +13,117 @@ Generator version: 7.5.0
 require 'spec_helper'
 require 'json'
 
-# Unit tests for DigitalFemsa::PaymentLinkApi
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'PaymentLinkApi' do
-  before do
-    # run before each test
-    @api_instance = DigitalFemsa::PaymentLinkApi.new
-  end
+RSpec.describe DigitalFemsa::PaymentLinkApi do
+  let(:config) { DigitalFemsa::Configuration.new }
+  let(:api_client) { instance_double(DigitalFemsa::ApiClient) }
+  let(:api_instance) { described_class.new(api_client) }
 
-  after do
-    # run after each test
+  before do
+    allow(api_client).to receive(:config).and_return(config)
+    allow(api_client).to receive(:select_header_accept).and_return('application/vnd.app-v2.1.0+json')
+    allow(api_client).to receive(:select_header_content_type).and_return('application/json')
+    allow(api_client).to receive(:object_to_http_body) { |value| value.to_json }
   end
 
   describe 'test an instance of PaymentLinkApi' do
-    it 'should create an instance of PaymentLinkApi' do
-      expect(@api_instance).to be_instance_of(DigitalFemsa::PaymentLinkApi)
+    it 'creates an instance of PaymentLinkApi' do
+      expect(api_instance).to be_instance_of(DigitalFemsa::PaymentLinkApi)
     end
   end
 
-  # unit tests for cancel_checkout
-  # Cancel Payment Link
-  # @param id Identifier of the resource
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
-  # @return [CheckoutResponse]
-  describe 'cancel_checkout test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#cancel_checkout_with_http_info' do
+    it 'raises when id is missing' do
+      expect do
+        api_instance.cancel_checkout_with_http_info(nil)
+      end.to raise_error(ArgumentError, /Missing the required parameter 'id'/)
     end
-  end
 
-  # unit tests for create_checkout
-  # Create Unique Payment Link
-  # @param checkout requested field for checkout
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
-  # @return [CheckoutResponse]
-  describe 'create_checkout test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    it 'sends PUT request with escaped path' do
+      expect(api_client).to receive(:call_api).with(:PUT, '/checkouts/cko%2F123/cancel', hash_including(
+        operation: :'PaymentLinkApi.cancel_checkout',
+        return_type: 'CheckoutResponse'
+      )).and_return([:cancelled, 200, {}])
+
+      data = api_instance.cancel_checkout('cko/123')
+      expect(data).to eq(:cancelled)
     end
   end
 
-  # unit tests for email_checkout
-  # Send an email
-  # @param id Identifier of the resource
-  # @param email_checkout_request requested field for sms checkout
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
-  # @return [CheckoutResponse]
-  describe 'email_checkout test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#create_checkout_with_http_info' do
+    it 'raises when checkout payload is missing' do
+      expect do
+        api_instance.create_checkout_with_http_info(nil)
+      end.to raise_error(ArgumentError, /Missing the required parameter 'checkout'/)
     end
-  end
 
-  # unit tests for get_checkout
-  # Get a payment link by ID
-  # @param id Identifier of the resource
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
-  # @return [CheckoutResponse]
-  describe 'get_checkout test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    it 'sends POST request with serialized body' do
+      payload = { name: 'Checkout Link', recurrent: false }
+
+      expect(api_client).to receive(:call_api).with(:POST, '/checkouts', hash_including(
+        operation: :'PaymentLinkApi.create_checkout',
+        body: payload.to_json,
+        return_type: 'CheckoutResponse'
+      )).and_return([:created, 201, {}])
+
+      data = api_instance.create_checkout(payload)
+      expect(data).to eq(:created)
     end
   end
 
-  # unit tests for get_checkouts
-  # Get a list of payment links
-  # Returns a list of links generated by the merchant
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
-  # @option opts [Integer] :limit The numbers of items to return, the maximum value is 250
-  # @option opts [String] :search General order search, e.g. by mail, reference etc.
-  # @option opts [String] :_next next page
-  # @option opts [String] :previous previous page
-  # @return [CheckoutsResponse]
-  describe 'get_checkouts test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#email_checkout_with_http_info' do
+    it 'raises when email payload is missing' do
+      expect do
+        api_instance.email_checkout_with_http_info('cko_123', nil)
+      end.to raise_error(ArgumentError, /Missing the required parameter 'email_checkout_request'/)
     end
-  end
 
-  # unit tests for sms_checkout
-  # Send an sms
-  # @param id Identifier of the resource
-  # @param sms_checkout_request requested field for sms checkout
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
-  # @return [CheckoutResponse]
-  describe 'sms_checkout test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    it 'sends POST request to email endpoint' do
+      payload = { email: 'buyer@example.com' }
+
+      expect(api_client).to receive(:call_api).with(:POST, '/checkouts/cko_123/email', hash_including(
+        operation: :'PaymentLinkApi.email_checkout',
+        body: payload.to_json,
+        return_type: 'CheckoutResponse'
+      )).and_return([:sent, 200, {}])
+
+      data = api_instance.email_checkout('cko_123', payload)
+      expect(data).to eq(:sent)
     end
   end
 
+  describe '#get_checkouts_with_http_info' do
+    it 'raises for limit higher than 250' do
+      expect do
+        api_instance.get_checkouts_with_http_info(limit: 251)
+      end.to raise_error(ArgumentError, /must be smaller than or equal to 250/)
+    end
+
+    it 'raises for limit lower than 1' do
+      expect do
+        api_instance.get_checkouts_with_http_info(limit: 0)
+      end.to raise_error(ArgumentError, /must be greater than or equal to 1/)
+    end
+
+    it 'maps pagination and search into query params' do
+      expect(api_client).to receive(:call_api).with(:GET, '/checkouts', hash_including(
+        operation: :'PaymentLinkApi.get_checkouts',
+        query_params: {
+          limit: 30,
+          search: 'order_123',
+          next: 'next_token',
+          previous: 'prev_token'
+        },
+        return_type: 'CheckoutsResponse'
+      )).and_return([:list, 200, {}])
+
+      data = api_instance.get_checkouts(
+        limit: 30,
+        search: 'order_123',
+        _next: 'next_token',
+        previous: 'prev_token'
+      )
+
+      expect(data).to eq(:list)
+    end
+  end
 end