nfg-client 1.0.0 → 1.0.1

data/spec/unit/create_cof_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'unit/response_stubs/create_cof_stubs'
+
+describe NFGClient::Client do
+  let(:nfg_client) { NFGClient.new('aiduuad', 'aooaid', 'sosois', 'ksidi', true) }
+  subject { nfg_client.create_cof(create_cof_params) }
+  describe "#create_cof" do
+    context "with a successful response" do
+      it "should return a hash with a new COFId" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',successful_create_cof_response('ISUDUD')))
+        expect(subject['StatusCode']).to eq('Success')
+        expect(subject['DonorToken']).to eq('ISUDUD')
+        expect(subject['COFId']).to eq('1111111')
+      end
+    end
+
+    context "with a server error" do
+      it "should return an UnexpectedError" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('500',server_error_response))
+        expect(subject['StatusCode']).to eq('UnexpectedError')      
+      end
+    end
+
+    context "with an unsuccessful response" do
+      it "should return the appropriate error with new COFid" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',unsuccessful_create_cof_response('ISUDUD')))
+        expect(subject['StatusCode']).to eq('ChargeFailed')   
+        expect(subject['DonorToken']).to eq('ISUDUD')
+
+      end
+    end
+  end
+end
+

data/spec/unit/delete_donor_cof_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'unit/response_stubs/delete_donor_cof_stubs'
+
+describe NFGClient::Client do
+  let(:nfg_client) { NFGClient.new('aiduuad', 'aooaid', 'sosois', 'ksidi', true) }
+  subject { nfg_client.delete_donor_cof(delete_donor_cof_params) }
+  describe "#delete_donor_cof" do
+    context "with a successful response" do
+      it "should return a hash with a status code of success" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',successful_delete_donor_cof_response))
+        expect(subject['StatusCode']).to eq('Success')
+      end
+    end
+
+    context "with a server error" do
+      it "should return an UnexpectedError" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('500',server_error_response))
+        expect(subject['StatusCode']).to eq('UnexpectedError')
+      end
+    end
+
+    context "with an unsuccessful response" do
+      it "should return the appropriate error with new COFid" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',unsuccessful_delete_donor_cof_response))
+        expect(subject['StatusCode']).to eq('ValidationFailed')
+        expect(subject['Message']).to eq('COFAlreadyDeleted - Attempt made to delete a Card on File that has already been deleted')
+
+      end
+    end
+  end
+end
+

data/spec/unit/get_donation_report_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'unit/response_stubs/get_donation_report_stubs'
+
+describe NFGClient::Client do
+  let(:nfg_client) { NFGClient.new('aiduuad', 'aooaid', 'sosois', 'ksidi', true) }
+  subject { nfg_client.get_donation_report(get_donation_report_params) }
+
+  describe "#get_donation_report" do
+    context "with a successful response" do
+      it "should return a hash with a new TotalChargeAmount" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',successful_get_donation_report_response))
+        expect(subject['StatusCode']).to eq('Success')
+        expect(subject['ReturnCount']).to eq("2")
+        expect(subject['ReportResults'].length).to eq(2)
+        expect(subject['ReportResults'].first['ChargeId']).to eq('123587')
+        expect(subject['ReportResults'].last['ChargeId']).to eq('5555846')
+      end
+    end
+
+    context "with a server error" do
+      it "should return an UnexpectedError" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('500',server_error_response))
+        expect(subject['StatusCode']).to eq('UnexpectedError')
+      end
+    end
+
+    context "with an unsuccessful response" do
+      it "should return the appropriate error with new COFid" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',unsuccessful_get_donation_report_response))
+        expect(subject['StatusCode']).to eq('ValidationFailed')
+        expect(subject['ReportResults'].length).to eq(0)
+      end
+    end
+  end
+end

data/spec/unit/get_donor_cofs_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'unit/response_stubs/get_donor_cofs_stubs'
+
+describe NFGClient::Client do
+  let(:nfg_client) { NFGClient.new('aiduuad', 'aooaid', 'sosois', 'ksidi', true) }
+  subject { nfg_client.get_donor_cofs(get_donor_cofs_params) }
+  describe "#get_donor_cofs" do
+    context "with a successful response" do
+      it "should return a hash with a an array of COFs" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',successful_get_donor_cofs_response('ISUDUD')))
+        expect(subject['StatusCode']).to eq('Success')
+        expect(subject['DonorToken']).to eq('ISUDUD')
+        expect(subject['Cards'].length).to eq(2)
+        expect(subject['Cards'].first['COFId']).to eq('33333333')
+        expect(subject['Cards'].last['COFId']).to eq('44444444')
+      end
+    end
+
+    context "with a server error" do
+      it "should return an UnexpectedError" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('500',server_error_response))
+        expect(subject['StatusCode']).to eq('UnexpectedError')
+      end
+    end
+
+    context "with an unsuccessful response" do
+      it "should return the appropriate error with the DonorToken" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',unsuccessful_get_donor_cofs_response('ISUDUD')))
+        expect(subject['StatusCode']).to eq('ValidationFailed')
+        expect(subject['DonorToken']).to eq('ISUDUD')
+
+      end
+    end
+  end
+end
+

data/spec/unit/get_donor_donation_history_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'unit/response_stubs/get_donor_donation_history_stubs'
+
+describe NFGClient::Client do
+  let(:nfg_client) { NFGClient.new('aiduuad', 'aooaid', 'sosois', 'ksidi', true) }
+  subject { nfg_client.get_donor_donation_history(get_donor_donation_history_params) }
+
+  describe "#get_donor_donation_history" do
+    context "with a successful response" do
+      it "should return a hash with a new TotalChargeAmount" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',successful_get_donor_donation_history_response))
+        expect(subject['StatusCode']).to eq('Success')
+        expect(subject['DonorToken']).to eq('1828282')
+        expect(subject['Donations'].length).to eq(2)
+        expect(subject['Donations'].first['ChargeId']).to eq('292929')
+        expect(subject['Donations'].last['ChargeId']).to eq('8939399')
+      end
+    end
+
+    context "with a server error" do
+      it "should return an UnexpectedError" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('500',server_error_response))
+        expect(subject['StatusCode']).to eq('UnexpectedError')
+      end
+    end
+
+    context "with an unsuccessful response" do
+      it "should return the appropriate error with new COFid" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',unsuccessful_get_donor_donation_history_response))
+        expect(subject['StatusCode']).to eq('Success')
+        expect(subject['Donations'].length).to eq(0)
+      end
+    end
+  end
+end

data/spec/unit/get_fee_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'unit/response_stubs/get_fee_stubs'
+
+describe NFGClient::Client do
+  let(:nfg_client) { NFGClient.new('aiduuad', 'aooaid', 'sosois', 'ksidi', true) }
+  subject { nfg_client.get_fee(get_fee_params) }
+
+  describe "#get_fee" do
+    context "with a successful response" do
+      it "should return a hash with a new TotalChargeAmount" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',successful_get_fee_response))
+        expect(subject['StatusCode']).to eq('Success')
+        expect(subject['TotalChargeAmount']).to eq("110.00")
+      end
+    end
+
+    context "with a server error" do
+      it "should return an UnexpectedError" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('500',server_error_response))
+        expect(subject['StatusCode']).to eq('UnexpectedError')
+      end
+    end
+
+    context "with an unsuccessful response" do
+      it "should return the appropriate error with new COFid" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',unsuccessful_get_fee_response))
+        expect(subject['StatusCode']).to eq('ValidationFailed')
+        expect(subject['TotalChargeAmount']).to eq('0.0')
+      end
+    end
+  end
+end

data/spec/unit/make_cof_donation_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'unit/response_stubs/make_cof_donation_stubs'
+
+describe NFGClient::Client do
+  let(:nfg_client) { NFGClient.new('aiduuad', 'aooaid', 'sosois', 'ksidi', true) }
+  subject { nfg_client.make_cof_donation(make_cof_donation_params) }
+
+  describe "#make_cof_donation" do
+    context "with a successful response" do
+      it "should return a hash with a new COFId" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',successful_make_cof_donation_response))
+        expect(subject['StatusCode']).to eq('Success')
+        expect(subject['COFId']).to eq('1111111')
+      end
+
+      it "should return a hash with a transaction Id" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',successful_make_cof_donation_response))
+        expect(subject['StatusCode']).to eq('Success')
+        expect(subject['ChargeId']).to eq('3333333')
+      end
+    end
+
+    context "with a server error" do
+      it "should return an UnexpectedError" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('500',server_error_response))
+        expect(subject['StatusCode']).to eq('UnexpectedError')
+      end
+    end
+
+    context "with an unsuccessful response" do
+      it "should return the appropriate error with new COFid" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',unsuccessful_make_cof_donation_response))
+        expect(subject['StatusCode']).to eq('ChargeFailed')
+        expect(subject['DonorToken']).to_not be
+
+      end
+    end
+  end
+end

data/spec/unit/make_donation_add_cof_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'unit/response_stubs/make_donation_add_cof_stubs'
+
+describe NFGClient::Client do
+  let(:nfg_client) { NFGClient.new('aiduuad', 'aooaid', 'sosois', 'ksidi', true) }
+  subject { nfg_client.make_donation_add_cof(make_donation_add_cof_params) }
+
+  describe "#make_donation_add_cof" do
+    context "with a successful response" do
+      it "should return a hash with a new COFId" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',successful_make_donation_add_cof_response('ISUDUD')))
+        expect(subject['StatusCode']).to eq('Success')
+        expect(subject['COFId']).to eq('1111111')
+      end
+
+      it "should return a hash with a transaction Id" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',successful_make_donation_add_cof_response('ISUDUD')))
+        expect(subject['StatusCode']).to eq('Success')
+        expect(subject['ChargeId']).to eq('3333333')
+      end
+    end
+
+    context "with a server error" do
+      it "should return an UnexpectedError" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('500',server_error_response))
+        expect(subject['StatusCode']).to eq('UnexpectedError')      
+      end
+    end
+
+    context "with an unsuccessful response" do
+      it "should return the appropriate error with new COFid" do
+        nfg_client.expects(:ssl_post).returns(nfg_response('200',unsuccessful_make_donation_add_cof_response('ISUDUD')))
+        expect(subject['StatusCode']).to eq('ChargeFailed')   
+        expect(subject['DonorToken']).to_not be
+
+      end
+    end
+  end
+end

data/spec/unit/response_stubs/create_cof_stubs.rb

@@ -0,0 +1,46 @@
+require 'unit/response_stubs/spec_response_helpers'
+
+def successful_create_cof_response(donor_token)
+  <<-XML
+    <?xml version="1.0" encoding="utf-8"?>
+    <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+      <soap:Body>
+        <CreateCOFResponse xmlns="http://api.networkforgood.org/partnerdonationservice">
+          <CreateCOFResult>
+            <DonorToken>#{donor_token}</DonorToken>
+            <CofId>1111111</CofId>
+            <StatusCode>Success</StatusCode>
+            <Message></Message>
+            <ErrorDetails></ErrorDetails>
+            <CallDuration>0.051235</CallDuration>
+          </CreateCOFResult>
+        </CreateCOFResponse>
+      </soap:Body>
+    </soap:Envelope>
+  XML
+end
+
+def unsuccessful_create_cof_response(donor_token)
+  <<-XML
+    <?xml version="1.0" encoding="utf-8"?>
+    <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+      <soap:Body>
+        <CreateCOFResponse xmlns="http://api.networkforgood.org/partnerdonationservice">
+          <CreateCOFResult>
+            <DonorToken>#{donor_token}</DonorToken>
+            <StatusCode>ChargeFailed</StatusCode>
+            <CofId></CofId>
+            <Message>InvalidCreditCardNumber - Credit Card Number failed validation</Message>
+            <ErrorDetails>
+              <ErrorInfo>
+                <ErrCode>InvalidCreditCardNumber</ErrCode>
+                <ErrData></ErrData>
+              </ErrorInfo>
+            </ErrorDetails>
+            <CallDuration>0.051235</CallDuration>
+          </CreateCOFResult>
+        </CreateCOFResponse>
+      </soap:Body>
+    </soap:Envelope>
+  XML
+end

data/spec/unit/response_stubs/delete_donor_cof_stubs.rb

@@ -0,0 +1,42 @@
+require 'unit/response_stubs/spec_response_helpers'
+
+def successful_delete_donor_cof_response
+  <<-XML
+    <?xml version="1.0" encoding="utf-8"?>
+    <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+      <soap:Body>
+        <DeleteDonorCOFResponse xmlns="http://api.networkforgood.org/partnerdonationservice">
+          <DeleteDonorCOFResult>
+            <StatusCode>Success</StatusCode>
+            <Message></Message>
+            <ErrorDetails></ErrorDetails>
+            <CallDuration>0.051235</CallDuration>
+          </DeleteDonorCOFResult>
+        </DeleteDonorCOFResponse>
+      </soap:Body>
+    </soap:Envelope>
+  XML
+end
+
+def unsuccessful_delete_donor_cof_response
+  <<-XML
+    <?xml version="1.0" encoding="utf-8"?>
+    <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+      <soap:Body>
+        <DeleteDonorCOFResponse xmlns="http://api.networkforgood.org/partnerdonationservice">
+          <DeleteDonorCOFResult>
+            <StatusCode>ValidationFailed</StatusCode>
+            <Message>COFAlreadyDeleted - Attempt made to delete a Card on File that has already been deleted</Message>
+            <ErrorDetails>
+              <ErrorInfo>
+                <ErrCode>COFAlreadyDeleted</ErrCode>
+                <ErrData></ErrData>
+              </ErrorInfo>
+            </ErrorDetails>
+            <CallDuration>0.051235</CallDuration>
+          </DeleteDonorCOFResult>
+        </DeleteDonorCOFResponse>
+      </soap:Body>
+    </soap:Envelope>
+  XML
+end

data/spec/unit/response_stubs/get_donation_report_stubs.rb

@@ -0,0 +1,99 @@
+require 'unit/response_stubs/spec_response_helpers'
+
+def successful_get_donation_report_response
+  <<-XML
+    <?xml version="1.0" encoding="utf-8"?>
+    <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+      <soap:Body>
+      <GetDonationReportResponse xmlns="http://api.networkforgood.org/partnerdonationservice">
+        <GetDonationReportResult>
+          <ReportResults>
+            <DonationReportResult>
+              <Source>GiveCorps</Source>
+              <Campaign>GivingDay</Campaign>
+              <ChargeId>123587</ChargeId>
+              <ShareWithCharity>Yes</ShareWithCharity>
+              <DonorEmail>jimmy@smith.com</DonorEmail>
+              <DonorFirstName>Jimmy</DonorFirstName>
+              <DonorLastName>Smith</DonorLastName>
+              <DonorAddress1>123 This Street</DonorAddress1>
+              <DonorAddress2></DonorAddress2>
+              <DonorCity>Baltimore</DonorCity>
+              <DonorState>MD</DonorState>
+              <DonorZip>21210</DonorZip>
+              <DonorCountry>US</DonorCountry>
+              <DonorPhone>410-555-5555</DonorPhone>
+              <Designation>Annual Giving</Designation>
+              <DonateInName></DonateInName>
+              <RecurringPeriod></RecurringPeriod>
+              <EventDate></EventDate>
+              <NpoEIN>45-454545</NpoEIN>
+              <NpoName>My Charity</NpoName>
+              <ChargeStatus>Accepted</ChargeStatus>
+              <ChargeAmount>100.00</ChargeAmount>
+              <NpoTPC>0.00</NpoTPC>
+              <DonationItemAmount>100.00</DonationItemAmount>
+              <TotalDonationAmount>100.00</TotalDonationAmount>
+              <HistoryRecordId>132588</HistoryRecordId>
+            </DonationReportResult>
+            <DonationReportResult>
+              <Source>GiveCorps</Source>
+              <Campaign>Christmas</Campaign>
+              <ChargeId>5555846</ChargeId>
+              <ShareWithCharity>No</ShareWithCharity>
+              <DonorEmail>janet@smith.com</DonorEmail>
+              <DonorFirstName>Janet</DonorFirstName>
+              <DonorLastName>Smith</DonorLastName>
+              <DonorAddress1>456 That Street</DonorAddress1>
+              <DonorAddress2></DonorAddress2>
+              <DonorCity>Glen Burnie</DonorCity>
+              <DonorState>MD</DonorState>
+              <DonorZip>21564</DonorZip>
+              <DonorCountry>US</DonorCountry>
+              <DonorPhone>410-444-5585</DonorPhone>
+              <Designation>Boat Race</Designation>
+              <DonateInName>Doris Smith</DonateInName>
+              <RecurringPeriod>Monthly</RecurringPeriod>
+              <EventDate></EventDate>
+              <NpoEIN>56-89898</NpoEIN>
+              <NpoName>Great Foundation</NpoName>
+              <ChargeStatus>Accepted</ChargeStatus>
+              <ChargeAmount>50.00</ChargeAmount>
+              <NpoTPC>2.50</NpoTPC>
+              <DonationItemAmount>50.00</DonationItemAmount>
+              <TotalDonationAmount>50.00</TotalDonationAmount>
+              <HistoryRecordId>12355</HistoryRecordId>
+            </DonationReportResult>
+          </ReportResults>
+          <ReturnCount>2</ReturnCount>
+          <ErrorDetails/>
+          <Message/>
+          <CallDuration>0.0312504</CallDuration>
+          <StatusCode>Success</StatusCode>
+        </GetDonationReportResult>
+      </GetDonationReportResponse>
+      </soap:Body>
+    </soap:Envelope>
+  XML
+end
+
+def unsuccessful_get_donation_report_response
+  <<-XML
+    <?xml version="1.0" encoding="utf-8"?>
+    <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+      <soap:Body>
+        <GetDonationReportResponse xmlns="http://api.networkforgood.org/partnerdonationservice">
+          <GetDonationReportResult>
+            <Message>Report query range is greater than 24 hours.</Message>
+            <CallDuration>0.0312504</CallDuration>
+            <StatusCode>ValidationFailed</StatusCode>
+            <ReportResults/>
+            <ReturnCount>0</ReturnCount>
+            <ErrorDetails/>
+          </GetDonationReportResult>
+        </GetDonationReportResponse>
+      </soap:Body>
+    </soap:Envelope>
+  XML
+end
+