digital_femsa 1.0.0 → 1.1.1

data/spec/api/companies_api_spec.rb

@@ -13,51 +13,73 @@ Generator version: 7.5.0
 require 'spec_helper'
 require 'json'
 
-# Unit tests for DigitalFemsa::CompaniesApi
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'CompaniesApi' do
-  before do
-    # run before each test
-    @api_instance = DigitalFemsa::CompaniesApi.new
-  end
+RSpec.describe DigitalFemsa::CompaniesApi 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 CompaniesApi' do
-    it 'should create an instance of CompaniesApi' do
-      expect(@api_instance).to be_instance_of(DigitalFemsa::CompaniesApi)
+    it 'creates an instance of CompaniesApi' do
+      expect(api_instance).to be_instance_of(DigitalFemsa::CompaniesApi)
     end
   end
 
-  # unit tests for get_companies
-  # Get List of Companies
-  # Consume the list of child companies.  This is used for holding companies with several child entities.
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @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 [GetCompaniesResponse]
-  describe 'get_companies test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#get_companies_with_http_info' do
+    it 'raises for limit higher than 250' do
+      expect do
+        api_instance.get_companies_with_http_info(limit: 251)
+      end.to raise_error(ArgumentError, /must be smaller than or equal to 250/)
     end
-  end
 
-  # unit tests for get_company
-  # Get Company
-  # @param id Identifier of the resource
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @return [CompanyResponse]
-  describe 'get_company test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    it 'raises for limit lower than 1' do
+      expect do
+        api_instance.get_companies_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, '/companies', hash_including(
+        operation: :'CompaniesApi.get_companies',
+        query_params: {
+          limit: 25,
+          search: 'subsidiary',
+          next: 'next_token',
+          previous: 'prev_token'
+        },
+        return_type: 'GetCompaniesResponse'
+      )).and_return([:companies, 200, {}])
+
+      data = api_instance.get_companies(
+        limit: 25,
+        search: 'subsidiary',
+        _next: 'next_token',
+        previous: 'prev_token'
+      )
+
+      expect(data).to eq(:companies)
     end
   end
 
+  describe '#get_company_with_http_info' do
+    it 'raises when id is missing' do
+      expect do
+        api_instance.get_company_with_http_info(nil)
+      end.to raise_error(ArgumentError, /Missing the required parameter 'id'/)
+    end
+
+    it 'sends GET request with escaped company id path' do
+      expect(api_client).to receive(:call_api).with(:GET, '/companies/com%2F123', hash_including(
+        operation: :'CompaniesApi.get_company',
+        return_type: 'CompanyResponse'
+      )).and_return([:company, 200, {}])
+
+      data = api_instance.get_company('com/123')
+      expect(data).to eq(:company)
+    end
+  end
 end

data/spec/api/customers_api_spec.rb

@@ -13,128 +13,144 @@ Generator version: 7.5.0
 require 'spec_helper'
 require 'json'
 
-# Unit tests for DigitalFemsa::CustomersApi
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'CustomersApi' do
-  before do
-    # run before each test
-    @api_instance = DigitalFemsa::CustomersApi.new
-  end
+RSpec.describe DigitalFemsa::CustomersApi 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 CustomersApi' do
-    it 'should create an instance of CustomersApi' do
-      expect(@api_instance).to be_instance_of(DigitalFemsa::CustomersApi)
+    it 'creates an instance of CustomersApi' do
+      expect(api_instance).to be_instance_of(DigitalFemsa::CustomersApi)
     end
   end
 
-  # unit tests for create_customer
-  # Create customer
-  # The purpose of business is to create and keep a customer, you will learn what elements you need to create a customer. 
-  # @param customer requested field for customer
-  # @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 [CustomerResponse]
-  describe 'create_customer test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#create_customer_with_http_info' do
+    it 'raises when customer is missing' do
+      expect do
+        api_instance.create_customer_with_http_info(nil)
+      end.to raise_error(ArgumentError, /Missing the required parameter 'customer'/)
     end
-  end
 
-  # unit tests for create_customer_fiscal_entities
-  # Create Fiscal Entity
-  # Create Fiscal entity resource that corresponds to a customer ID.
-  # @param id Identifier of the resource
-  # @param customer_fiscal_entities_request requested field for customer fiscal entities
-  # @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 [CreateCustomerFiscalEntitiesResponse]
-  describe 'create_customer_fiscal_entities 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 customer body' do
+      payload = { name: 'Vicente', email: 'vicente@example.com' }
+
+      expect(api_client).to receive(:call_api).with(:POST, '/customers', hash_including(
+        operation: :'CustomersApi.create_customer',
+        body: payload.to_json,
+        return_type: 'CustomerResponse'
+      )).and_return([:created, 201, {}])
+
+      data = api_instance.create_customer(payload)
+      expect(data).to eq(:created)
     end
   end
 
-  # unit tests for delete_customer_by_id
-  # Delete Customer
-  # Deleted a customer resource that corresponds to a customer 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 [CustomerResponse]
-  describe 'delete_customer_by_id test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#create_customer_fiscal_entities_with_http_info' do
+    it 'raises when id is missing' do
+      expect do
+        api_instance.create_customer_fiscal_entities_with_http_info(nil, { rfc: 'XAXX010101000' })
+      end.to raise_error(ArgumentError, /Missing the required parameter 'id'/)
     end
-  end
 
-  # unit tests for get_customer_by_id
-  # Get Customer
-  # Gets a customer resource that corresponds to a customer 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 [CustomerResponse]
-  describe 'get_customer_by_id test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    it 'raises when fiscal entity payload is missing' do
+      expect do
+        api_instance.create_customer_fiscal_entities_with_http_info('cus_123', nil)
+      end.to raise_error(ArgumentError, /Missing the required parameter 'customer_fiscal_entities_request'/)
     end
-  end
 
-  # unit tests for get_customers
-  # Get a list of customers
-  # The purpose of business is to create and maintain a client, you will learn what elements you need to obtain a list of clients, which can be paged.
-  # @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 [CustomersResponse]
-  describe 'get_customers 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
+      payload = { rfc: 'XAXX010101000' }
+
+      expect(api_client).to receive(:call_api).with(:POST, '/customers/cus%2F123/fiscal_entities', hash_including(
+        operation: :'CustomersApi.create_customer_fiscal_entities',
+        body: payload.to_json,
+        return_type: 'CreateCustomerFiscalEntitiesResponse'
+      )).and_return([:created, 201, {}])
+
+      data = api_instance.create_customer_fiscal_entities('cus/123', payload)
+      expect(data).to eq(:created)
     end
   end
 
-  # unit tests for update_customer
-  # Update customer
-  # You can update customer-related data
-  # @param id Identifier of the resource
-  # @param update_customer requested field for customer
-  # @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 [CustomerResponse]
-  describe 'update_customer test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#delete_customer_by_id_with_http_info' do
+    it 'raises when id is missing' do
+      expect do
+        api_instance.delete_customer_by_id_with_http_info(nil)
+      end.to raise_error(ArgumentError, /Missing the required parameter 'id'/)
+    end
+
+    it 'sends DELETE request to customer resource' do
+      expect(api_client).to receive(:call_api).with(:DELETE, '/customers/cus_123', hash_including(
+        operation: :'CustomersApi.delete_customer_by_id',
+        return_type: 'CustomerResponse'
+      )).and_return([:deleted, 200, {}])
+
+      data = api_instance.delete_customer_by_id('cus_123')
+      expect(data).to eq(:deleted)
     end
   end
 
-  # unit tests for update_customer_fiscal_entities
-  # Update  Fiscal Entity
-  # Update Fiscal Entity resource that corresponds to a customer ID.
-  # @param id Identifier of the resource
-  # @param fiscal_entities_id identifier
-  # @param customer_update_fiscal_entities_request requested field for customer update fiscal entities
-  # @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 [UpdateCustomerFiscalEntitiesResponse]
-  describe 'update_customer_fiscal_entities test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#get_customers_with_http_info' do
+    it 'raises for limit higher than 250' do
+      expect do
+        api_instance.get_customers_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_customers_with_http_info(limit: 0)
+      end.to raise_error(ArgumentError, /must be greater than or equal to 1/)
+    end
+
+    it 'maps pagination and search filters to query params' do
+      expect(api_client).to receive(:call_api).with(:GET, '/customers', hash_including(
+        operation: :'CustomersApi.get_customers',
+        query_params: {
+          limit: 20,
+          search: 'vicente',
+          next: 'next_token',
+          previous: 'prev_token'
+        },
+        return_type: 'CustomersResponse'
+      )).and_return([:list, 200, {}])
+
+      data = api_instance.get_customers(
+        limit: 20,
+        search: 'vicente',
+        _next: 'next_token',
+        previous: 'prev_token'
+      )
+
+      expect(data).to eq(:list)
     end
   end
 
+  describe '#update_customer_fiscal_entities_with_http_info' do
+    it 'raises when fiscal_entities_id is missing' do
+      expect do
+        api_instance.update_customer_fiscal_entities_with_http_info('cus_123', nil, { business_name: 'Test SA' })
+      end.to raise_error(ArgumentError, /Missing the required parameter 'fiscal_entities_id'/)
+    end
+
+    it 'sends PUT request with expected path and body' do
+      payload = { business_name: 'Test SA' }
+
+      expect(api_client).to receive(:call_api).with(:PUT, '/customers/cus_123/fiscal_entities/fis_123', hash_including(
+        operation: :'CustomersApi.update_customer_fiscal_entities',
+        body: payload.to_json,
+        return_type: 'UpdateCustomerFiscalEntitiesResponse'
+      )).and_return([:updated, 200, {}])
+
+      data = api_instance.update_customer_fiscal_entities('cus_123', 'fis_123', payload)
+      expect(data).to eq(:updated)
+    end
+  end
 end

data/spec/api/events_api_spec.rb

@@ -13,67 +13,91 @@ Generator version: 7.5.0
 require 'spec_helper'
 require 'json'
 
-# Unit tests for DigitalFemsa::EventsApi
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'EventsApi' do
-  before do
-    # run before each test
-    @api_instance = DigitalFemsa::EventsApi.new
-  end
+RSpec.describe DigitalFemsa::EventsApi 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 EventsApi' do
-    it 'should create an instance of EventsApi' do
-      expect(@api_instance).to be_instance_of(DigitalFemsa::EventsApi)
+    it 'creates an instance of EventsApi' do
+      expect(api_instance).to be_instance_of(DigitalFemsa::EventsApi)
     end
   end
 
-  # unit tests for get_event
-  # Get Event
-  # Returns a single event
-  # @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 [EventResponse]
-  describe 'get_event test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#get_event_with_http_info' do
+    it 'raises when id is missing' do
+      expect do
+        api_instance.get_event_with_http_info(nil)
+      end.to raise_error(ArgumentError, /Missing the required parameter 'id'/)
     end
-  end
 
-  # unit tests for get_events
-  # Get list of Events
-  # @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 [GetEventsResponse]
-  describe 'get_events 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 event path' do
+      expect(api_client).to receive(:call_api).with(:GET, '/events/evt%2F123', hash_including(
+        operation: :'EventsApi.get_event',
+        return_type: 'EventResponse'
+      )).and_return([:event, 200, {}])
+
+      data = api_instance.get_event('evt/123')
+      expect(data).to eq(:event)
     end
   end
 
-  # unit tests for resend_event
-  # Resend Event
-  # Try to send an event
-  # @param event_id event identifier
-  # @param webhook_log_id webhook log identifier
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :accept_language Use for knowing which language to use
-  # @return [EventsResendResponse]
-  describe 'resend_event test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe '#get_events_with_http_info' do
+    it 'raises for limit higher than 250' do
+      expect do
+        api_instance.get_events_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_events_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, '/events', hash_including(
+        operation: :'EventsApi.get_events',
+        query_params: {
+          limit: 30,
+          search: 'charge.paid',
+          next: 'next_token',
+          previous: 'prev_token'
+        },
+        return_type: 'GetEventsResponse'
+      )).and_return([:list, 200, {}])
+
+      data = api_instance.get_events(
+        limit: 30,
+        search: 'charge.paid',
+        _next: 'next_token',
+        previous: 'prev_token'
+      )
+
+      expect(data).to eq(:list)
     end
   end
 
+  describe '#resend_event_with_http_info' do
+    it 'raises when webhook_log_id is missing' do
+      expect do
+        api_instance.resend_event_with_http_info('evt_123', nil)
+      end.to raise_error(ArgumentError, /Missing the required parameter 'webhook_log_id'/)
+    end
+
+    it 'sends POST request with escaped event and webhook log ids' do
+      expect(api_client).to receive(:call_api).with(:POST, '/events/evt%2F123/webhook_logs/log%2F123/resend', hash_including(
+        operation: :'EventsApi.resend_event',
+        return_type: 'EventsResendResponse'
+      )).and_return([:resent, 200, {}])
+
+      data = api_instance.resend_event('evt/123', 'log/123')
+      expect(data).to eq(:resent)
+    end
+  end
 end

data/spec/api/generated_apis_coverage_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+require 'logger'
+
+RSpec.describe 'Generated APIs coverage smoke tests' do
+  api_classes = DigitalFemsa.constants.filter_map do |const_name|
+    constant = DigitalFemsa.const_get(const_name)
+    next unless constant.is_a?(Class)
+    next unless constant.name.end_with?('Api')
+
+    constant
+  rescue NameError
+    nil
+  end.sort_by(&:name)
+
+  required_arg_value = lambda do |name|
+    name_str = name.to_s
+
+    if name_str == 'id' || name_str.end_with?('_id')
+      'id_123'
+    elsif name_str.include?('request')
+      {}
+    elsif name_str.include?('amount')
+      100
+    elsif name_str.include?('date')
+      '2024-01-01'
+    else
+      'value'
+    end
+  end
+
+  optional_arg_value = lambda do |name|
+    unless name.to_s == 'opts'
+      return required_arg_value.call(name)
+    end
+
+    {
+      accept_language: 'es',
+      x_child_company_id: 'child_company_123',
+      limit: 20,
+      search: 'test',
+      _next: 'next_token',
+      previous: 'prev_token'
+    }
+  end
+
+  args_for = lambda do |method|
+    method.parameters.map do |kind, name|
+      kind == :opt ? optional_arg_value.call(name) : required_arg_value.call(name)
+    end
+  end
+
+  let(:config) do
+    double('Configuration', debugging: false, client_side_validation: true, logger: Logger.new(nil))
+  end
+
+  let(:api_client) do
+    double('ApiClient').tap do |client|
+      allow(client).to receive(:config).and_return(config)
+      allow(client).to receive(:select_header_accept).and_return('application/json')
+      allow(client).to receive(:select_header_content_type).and_return('application/json')
+      allow(client).to receive(:object_to_http_body) { |body| body }
+      allow(client).to receive(:call_api).and_return([{ 'ok' => true }, 200, { 'X-Test' => '1' }])
+    end
+  end
+
+  api_classes.each do |klass|
+    describe klass.name do
+      let(:api_instance) { klass.new(api_client) }
+
+      it 'creates an instance with injected api_client' do
+        expect(api_instance).to be_instance_of(klass)
+        expect(api_instance.api_client).to eq(api_client)
+      end
+
+      klass.instance_methods(false).sort.each do |method_name|
+        next if method_name == :initialize
+        next if %i[api_client api_client=].include?(method_name)
+
+        it "invokes ##{method_name}" do
+          method = klass.instance_method(method_name)
+          args = args_for.call(method)
+
+          result = api_instance.public_send(method_name, *args)
+
+          if method_name.to_s.end_with?('_with_http_info')
+            expect(result).to eq([{ 'ok' => true }, 200, { 'X-Test' => '1' }])
+          else
+            expect(result).to eq('ok' => true)
+          end
+        end
+      end
+    end
+  end
+end