atrium-ruby 1.3.2 → 2.0.0

data/spec/api/transactions_api_spec.rb

@@ -0,0 +1,71 @@
+=begin
+#MX API
+
+#The MX Atrium API supports over 48,000 data connections to thousands of financial institutions. It provides secure access to your users' accounts and transactions with industry-leading cleansing, categorization, and classification.  Atrium is designed according to resource-oriented REST architecture and responds with JSON bodies and HTTP response codes.  Use Atrium's development environment, vestibule.mx.com, to quickly get up and running. The development environment limits are 100 users, 25 members per user, and access to the top 15 institutions. Contact MX to purchase production access. 
+
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Atrium::TransactionsApi
+# Please update as you see appropriate
+describe 'TransactionsApi' do
+  before do
+    # run before each test
+    @instance = Atrium::TransactionsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TransactionsApi' do
+    it 'should create an instance of TransactionsApi' do
+      expect(@instance).to be_instance_of(Atrium::TransactionsApi)
+    end
+  end
+
+  # unit tests for cleanse_and_categorize_transactions
+  # Categorize transactions
+  # Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform.
+  # @param body User object to be created with optional parameters (amount, type) amd required parameters (description, identifier)
+  # @param [Hash] opts the optional parameters
+  # @return [TransactionsCleanseAndCategorizeResponseBody]
+  describe 'cleanse_and_categorize_transactions 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_user_transactions
+  # List transactions for a user
+  # Use this endpoint to get all transactions that belong to a specific user, across all the user's members and accounts.<br> This endpoint accepts optional query parameters, from_date and to_date, which filter transactions according to the date they were posted. If no values are given, from_date will default to 90 days prior to the request, and to_date will default to 5 days from the time of the request. 
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [String] :from_date Filter transactions from this date.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @option opts [String] :to_date Filter transactions to this date.
+  # @return [TransactionsResponseBody]
+  describe 'list_user_transactions 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 read_transaction
+  # Read a transaction
+  # This endpoint allows you to view information about a specific transaction that belongs to a user.<br>
+  # @param transaction_guid The unique identifier for a `transaction`.
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @return [TransactionResponseBody]
+  describe 'read_transaction 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/users_api_spec.rb

@@ -0,0 +1,92 @@
+=begin
+#MX API
+
+#The MX Atrium API supports over 48,000 data connections to thousands of financial institutions. It provides secure access to your users' accounts and transactions with industry-leading cleansing, categorization, and classification.  Atrium is designed according to resource-oriented REST architecture and responds with JSON bodies and HTTP response codes.  Use Atrium's development environment, vestibule.mx.com, to quickly get up and running. The development environment limits are 100 users, 25 members per user, and access to the top 15 institutions. Contact MX to purchase production access. 
+
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Atrium::UsersApi
+# Please update as you see appropriate
+describe 'UsersApi' do
+  before do
+    # run before each test
+    @instance = Atrium::UsersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UsersApi' do
+    it 'should create an instance of UsersApi' do
+      expect(@instance).to be_instance_of(Atrium::UsersApi)
+    end
+  end
+
+  # unit tests for create_user
+  # Create user
+  # Call this endpoint to create a new user. Atrium will respond with the newly-created user object if successful. This endpoint accepts several parameters: identifier, metadata, and is_disabled.<br> Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user's data until they are no longer disabled. Users who are disabled for the entirety of an Atrium billing period will not be factored into that month's bill. 
+  # @param body User object to be created with optional parameters (identifier, is_disabled, metadata)
+  # @param [Hash] opts the optional parameters
+  # @return [UserResponseBody]
+  describe 'create_user 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 delete_user
+  # Delete user
+  # Calling this endpoint will permanently delete a user from Atrium. If successful, the API will respond with Status: 204 No Content. 
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_user 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_users
+  # List users
+  # Use this endpoint to list every user you've created in Atrium.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @return [UsersResponseBody]
+  describe 'list_users 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 read_user
+  # Read user
+  # Use this endpoint to read the attributes of a specific user.
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @return [UserResponseBody]
+  describe 'read_user 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_user
+  # Update user
+  # Use this endpoint to update the attributes of a specific user. Atrium will respond with the updated user object.<br> Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user's data until they are no longer disabled. Users who are disabled for the entirety of an Atrium billing period will not be factored into that month's bill.<br> To disable a user, update it and set the is_disabled parameter to true. Set it to false to re-enable the user. 
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [UserUpdateRequestBody] :body User object to be updated with optional parameters (identifier, is_disabled, metadata)
+  # @return [UserResponseBody]
+  describe 'update_user 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/verification_api_spec.rb

@@ -0,0 +1,69 @@
+=begin
+#MX API
+
+#The MX Atrium API supports over 48,000 data connections to thousands of financial institutions. It provides secure access to your users' accounts and transactions with industry-leading cleansing, categorization, and classification.  Atrium is designed according to resource-oriented REST architecture and responds with JSON bodies and HTTP response codes.  Use Atrium's development environment, vestibule.mx.com, to quickly get up and running. The development environment limits are 100 users, 25 members per user, and access to the top 15 institutions. Contact MX to purchase production access. 
+
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Atrium::VerificationApi
+# Please update as you see appropriate
+describe 'VerificationApi' do
+  before do
+    # run before each test
+    @instance = Atrium::VerificationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of VerificationApi' do
+    it 'should create an instance of VerificationApi' do
+      expect(@instance).to be_instance_of(Atrium::VerificationApi)
+    end
+  end
+
+  # unit tests for list_account_numbers
+  # Read account numbers
+  # Use this endpoint to check whether account and routing numbers are available for accounts associated with a particular member. It returns the account_numbers object, which contains account and routing number data for each account associated with the member.
+  # @param member_guid The unique identifier for a `member`.
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @return [AccountNumbersResponseBody]
+  describe 'list_account_numbers 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_account_numbers_by_account
+  # Read account numbers by account GUID
+  # Use this endpoint to check whether account and routing numbers are available for a specific account. It returns the account_numbers object, which contains account and routing number data.
+  # @param account_guid The unique identifier for an `account`.
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @return [AccountNumbersResponseBody]
+  describe 'list_account_numbers_by_account 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 verify_member
+  # Verify
+  # The verify endpoint begins a verification process for a member.
+  # @param member_guid The unique identifier for a `member`.
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @return [MemberResponseBody]
+  describe 'verify_member 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,222 @@
+=begin
+#MX API
+
+#The MX Atrium API supports over 48,000 data connections to thousands of financial institutions. It provides secure access to your users' accounts and transactions with industry-leading cleansing, categorization, and classification.  Atrium is designed according to resource-oriented REST architecture and responds with JSON bodies and HTTP response codes.  Use Atrium's development environment, vestibule.mx.com, to quickly get up and running. The development environment limits are 100 users, 25 members per user, and access to the top 15 institutions. Contact MX to purchase production access. 
+
+
+=end
+
+require 'spec_helper'
+
+describe Atrium::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          Atrium.configure { |c| c.host = 'http://example.com' }
+          expect(Atrium::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          Atrium.configure { |c| c.host = 'https://wookiee.com' }
+          expect(Atrium::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          Atrium.configure { |c| c.host = 'hobo.com/v4' }
+          expect(Atrium::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          Atrium.configure { |c| c.base_path = 'v4/dog' }
+          expect(Atrium::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          Atrium.configure { |c| c.base_path = '/v4/dog' }
+          expect(Atrium::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          Atrium.configure { |c| c.base_path = nil }
+          expect(Atrium::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { Atrium::Configuration.new }
+    let(:api_client) { Atrium::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(Atrium::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) { Atrium::Configuration.new }
+    let(:api_client) { Atrium::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(Atrium::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 = Atrium::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 = Atrium::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 = Atrium::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 = Atrium::ApiClient.new
+      # _model = Atrium::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) { Atrium::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) { Atrium::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) { Atrium::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) { Atrium::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) { Atrium::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