suretax 0.1.0

data/spec/lib/suretax/api/request_validations_spec.rb

@@ -0,0 +1,384 @@
+require 'spec_helper'
+
+describe "Suretax API Request Validations" do
+
+  let(:request) do
+    Suretax::Api::Request.new(suretax_valid_request_params)
+  end
+
+  describe "#items" do
+    context "when valid" do
+      it "shows errors" do
+        expect(request.errors.any?).to eq false
+      end
+    end
+
+    context "when invalid" do
+      it "shows no errors" do
+        item = Suretax::Api::RequestItem.new(suretax_valid_request_item_params)
+        item.customer_number = 'a' * 9
+        item.regulatory_code = 11111
+        request.items = [item]
+
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to \
+          eq([%Q{Invalid items: ["Invalid customer_number: aaaaaaaaa, Invalid regulatory_code: 11111"]}])
+      end
+    end
+  end
+
+  describe '#client_number' do
+    context 'when present' do
+      it 'can be ten characters or less' do
+        request.client_number = '1234567890'
+        expect(request.errors.any?).to eq false
+
+        request.client_number = '12345678901'
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid client_number: 12345678901}]
+      end
+
+      it 'must be a number' do
+        request.client_number = '1'
+        expect(request.errors.any?).to eq false
+
+        request.client_number = 'abcdefghij'
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid client_number: abcdefghij}]
+      end
+    end
+
+    context 'when absent' do
+      it 'should fail validation' do
+        request.client_number = nil
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid client_number: nil}]
+      end
+    end
+  end
+
+  describe '#business_unit' do
+    context 'when present' do
+      it 'can be blank' do
+        request.business_unit = nil
+        expect(request.errors.any?).to eq false
+
+        request.business_unit = ''
+        expect(request.errors.any?).to eq false
+      end
+
+      it 'can be 20 characters or less' do
+        request.business_unit = 'a' * 5
+        expect(request.errors.any?).to eq false
+
+        request.business_unit = 'a' * 20
+        expect(request.errors.any?).to eq false
+
+        request.business_unit = 'a' * 21
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid business_unit: #{'a' * 21}}]
+      end
+
+      it 'must be alphanumeric' do
+        request.business_unit = 'aa124'
+        expect(request.errors.any?).to eq false
+
+        request.business_unit = 'a_34'
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid business_unit: a_34}]
+      end
+    end
+
+    context 'when absent' do
+      it 'should pass validation' do
+        request.business_unit = nil
+        expect(request.errors.any?).to eq false
+      end
+    end
+  end
+
+  describe '#validation_key' do
+    context 'when present' do
+      it 'must be a maximum of 36 characters' do
+        request.validation_key = 'a' * 36
+        expect(request.errors.any?).to eq false
+
+        request.validation_key = 'a' * 37
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid validation_key: #{'a' * 37}}]
+      end
+    end
+
+    context 'when absent' do
+      it 'should fail validation' do
+        request.validation_key = nil
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid validation_key: nil}]
+      end
+    end
+  end
+
+  describe '#data_year' do
+    context 'when present' do
+      it 'must be a number' do
+        request.data_year = 'b' * 4
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid data_year: #{'b' * 4}}]
+
+        request.data_year = '-' * 4
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid data_year: #{'-' * 4}}]
+
+        request.data_year = '2014'
+        expect(request.errors.any?).to eq false
+      end
+
+      it 'must be exactly four digits' do
+        request.data_year = '2014'
+        expect(request.errors.any?).to eq false
+
+        request.data_year = '20120'
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid data_year: 20120}]
+
+        request.data_year = '201'
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid data_year: 201}]
+      end
+
+      it 'must be in the range 1990-2050' do
+        request.data_year = '1989'
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid data_year: 1989}]
+
+        request.data_year = '2051'
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid data_year: 2051}]
+      end
+    end
+
+    context 'when absent' do
+      it 'fails validation' do
+        request.data_year = nil
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid data_year: nil}]
+      end
+    end
+  end
+
+  describe '#data_month' do
+    context 'when present' do
+      it "must allow all valid month numbers" do
+        (1..12).each do |month_number|
+          request.data_month = month_number.to_s
+          expect(request.errors.any?).to eq false
+
+          request.data_month = "%02d" % month_number.to_s
+          expect(request.errors.any?).to eq false
+        end
+      end
+
+      it "must allow all valid month numbers with a preceding zero" do
+        (1..12).each do |month_number|
+          request.data_month = "%02d" % month_number.to_s
+          expect(request.errors.any?).to eq false
+        end
+      end
+
+      it 'must not allow invalid months' do
+        request.data_month = '13'
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid data_month: 13}]
+      end
+    end
+
+    context 'when absent' do
+      it 'should fail validation' do
+        request.data_month = nil
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid data_month: nil}]
+      end
+    end
+  end
+
+  describe '#total_revenue' do
+    context 'when present' do
+      it 'can only be digits and the minus symbol' do
+        request.total_revenue = 'abcdefghi.jklm'
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid total_revenue: abcdefghi.jklm}]
+
+        request.total_revenue = '+1234'
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid total_revenue: +1234}]
+      end
+
+      it 'can have up to four decimal places' do
+        request.total_revenue = '123456789.1234'
+        expect(request.errors.any?).to eq false
+
+        request.total_revenue = '123456789.1'
+        expect(request.errors.any?).to eq false
+      end
+
+      it 'must not have more than four decimal places' do
+        request.total_revenue = '123456789.12345'
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid total_revenue: 123456789.12345}]
+      end
+
+      context 'and when the value is positive' do
+        it 'should have no symbol' do
+          request.total_revenue = '+23456789.1234'
+          expect(request.errors.any?).to eq true
+          expect(request.errors.messages).to eq [%Q{Invalid total_revenue: +23456789.1234}]
+        end
+
+        it 'can have up to nine positions to the left of the decimal' do
+          request.total_revenue = '123456789.1234'
+          expect(request.errors.any?).to eq false
+
+          request.total_revenue = '1.1234'
+          expect(request.errors.any?).to eq false
+
+          request.total_revenue = '1234567890.1234'
+          expect(request.errors.any?).to eq true
+          expect(request.errors.messages).to eq [%Q{Invalid total_revenue: 1234567890.1234}]
+        end
+
+        it 'can be a simple integer' do
+          request.total_revenue = '1'
+          expect(request.errors.any?).to eq false
+        end
+
+      end
+
+      context 'and when the value is negative' do
+        it 'should have a "minus" symbol in the first position' do
+          request.total_revenue = '-23456789.1234'
+          expect(request.errors.any?).to eq false
+        end
+
+        it 'must have nine positions to the left of the decimal' do
+          request.total_revenue = '-23456789.1234'
+          expect(request.errors.any?).to eq false
+        end
+
+        it 'must not have more than nine positions to the left of the decimal' do
+          request.total_revenue = '-234567890.1234'
+          expect(request.errors.any?).to eq true
+          expect(request.errors.messages).to eq [%Q{Invalid total_revenue: -234567890.1234}]
+        end
+      end
+    end
+
+    context 'when absent' do
+      it 'should fail validation' do
+        request.total_revenue = nil
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid total_revenue: nil}]
+      end
+    end
+  end
+
+  describe '#client_tracking' do
+    context 'when present' do
+      it 'must not be longer than 100 characters' do
+        request.client_tracking = 'a' * 101
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid client_tracking: #{'a' * 101}}]
+      end
+    end
+
+    context 'when absent' do
+      it 'should pass validation' do
+        request.client_tracking = nil
+        expect(request.errors.any?).to eq false
+      end
+    end
+  end
+
+  describe '#return_file_code' do
+    context 'when present' do
+      it 'must be a valid code' do
+        request.return_file_code = 0
+        expect(request.errors.any?).to eq false
+
+        request.return_file_code = 'Q'
+        expect(request.errors.any?).to eq false
+      end
+
+      it 'cannot be any other value' do
+        request.return_file_code = 'a'
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid return_file_code: a}]
+
+        request.return_file_code = 1
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid return_file_code: 1}]
+
+        request.return_file_code = '_'
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid return_file_code: _}]
+      end
+    end
+
+    context 'when absent' do
+      it 'should fail validation' do
+        request.return_file_code = nil
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid return_file_code: nil}]
+      end
+    end
+  end
+
+  describe '#response_group' do
+    context 'when present' do
+      it "must be a valid code" do
+        %w{00 01 02 03}.each do |code|
+          request.response_group = code
+          expect(request.errors.any?).to eq false
+        end
+
+        %w{a 04 _}.each do |wrong_value|
+          request.response_group = wrong_value
+          expect(request.errors.any?).to eq true
+          expect(request.errors.messages).to eq [%Q{Invalid response_group: #{wrong_value}}]
+        end
+      end
+    end
+
+    context 'when absent' do
+      it 'should fail validation' do
+        request.response_group = nil
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid response_group: nil}]
+      end
+    end
+  end
+
+  describe '#response_type' do
+    context 'when present' do
+      it "must be a valid code combination'" do
+        %w{D1 D9 S1 S9}.each do |type|
+          request.response_type = type
+          expect(request.errors.any?).to eq false
+        end
+
+        %w{a D0 S10 _}.each do |bad_type|
+          request.response_type = bad_type
+          expect(request.errors.any?).to eq true
+          expect(request.errors.messages).to eq [%Q{Invalid response_type: #{bad_type}}]
+        end
+      end
+    end
+
+    context 'when absent' do
+      it 'should fail validation' do
+        request.response_type = nil
+        expect(request.errors.any?).to eq true
+        expect(request.errors.messages).to eq [%Q{Invalid response_type: nil}]
+      end
+    end
+  end
+end

data/spec/lib/suretax/api/response_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+
+describe Suretax::Api::Response do
+
+  let(:api_response) { Suretax::Api::Response.new(response_body) }
+
+
+  context 'for a normal post request' do
+    context 'with a successful response' do
+      let(:response_body) { valid_test_response_body }
+
+      it 'should return the API status code' do
+        expect(api_response.status).to eql('9999')
+      end
+
+      it 'should be successful' do
+        expect(api_response).to be_success
+      end
+
+      it 'should not have item errors' do
+        expect(api_response).not_to be_item_errors
+      end
+
+      it 'should have a message of "Success"' do
+        expect(api_response.message).to eql('Success')
+      end
+
+      it 'should have the correct total tax' do
+        expect(api_response.total_tax.to_f).to eql(1.394490)
+      end
+
+      it 'should have a transaction id' do
+        expect(api_response.transaction).to eql('2664495')
+      end
+
+      context 'invoice groups' do
+        it 'should be the correct number' do
+          expect(api_response.groups.count).to eql(1)
+        end
+
+        it 'should respond to #invoice' do
+          expect(api_response.groups.first).to respond_to(:invoice)
+        end
+      end
+    end
+
+    context 'with a partially successful response' do
+      let(:response_body) { success_with_item_errors }
+
+      describe '#status' do
+        it 'should return the API status code' do
+          expect(api_response.status).to eql('9001')
+        end
+      end
+
+      describe '#success?' do
+        it 'should be true' do
+          expect(api_response).to be_success
+        end
+      end
+
+      describe "#item_errors?" do
+        it 'should be true' do
+          expect(api_response).to be_item_errors
+        end
+      end
+
+      describe "#item_messages" do
+        it 'should be the correct number' do
+          expect(api_response.item_messages.size).to eql(1)
+        end
+
+        it 'should response to #message' do
+          expect(api_response.item_messages.first).to respond_to(:message)
+        end
+      end
+
+      describe '#message' do
+        it 'should start with "Failure"' do
+          expect(api_response.message).to match(/\ASuccess with item errors/i)
+        end
+      end
+    end
+
+    context 'with a failure response' do
+      let(:response_body) { post_failed_response_body }
+
+      describe '#status' do
+        it 'should return the API status code' do
+          expect(api_response.status).to eql('1101')
+        end
+      end
+
+      describe '#success?' do
+        it 'should be false' do
+          expect(api_response.success?).to eql false
+        end
+      end
+
+      describe "#item_errors?" do
+        it 'should be false' do
+          expect(api_response).not_to be_item_errors
+        end
+      end
+
+      describe '#message' do
+        it 'should start with "Failure"' do
+          expect(api_response.message).to match(/\AFailure/)
+        end
+      end
+    end
+  end
+
+  context 'for a cancel post request' do
+    context 'with a successful response' do
+      let(:response_body) { cancel_response_body }
+
+      it 'should return the API status code' do
+        expect(api_response.status).to eql('9999')
+      end
+
+      it 'should be successful' do
+        expect(api_response).to be_success
+      end
+
+      it 'should have a message of "Success"' do
+        expect(api_response.message).to eql('Success')
+      end
+
+      it 'should have a transaction id' do
+        expect(api_response.transaction).to eql('0')
+      end
+
+      it 'should have the client tracking code set' do
+        expect(api_response.client_tracking).to eql('test')
+      end
+    end
+
+    context 'with a failed request' do
+
+      let(:response_body) { cancel_failed_response_body }
+
+      it 'should return the API status code' do
+        expect(api_response.status).to be_nil
+      end
+
+      it 'should be successful' do
+        expect(api_response).to_not be_success
+      end
+
+      it 'should have a message of "Success"' do
+        expect(api_response.message).to be_nil
+      end
+
+      it 'should have a transaction id' do
+        expect(api_response.transaction).to eql('0')
+      end
+
+      it 'should have the client tracking code set' do
+        expect(api_response.client_tracking).to be_nil
+      end
+    end
+  end
+
+end