virtuous 0.0.1

data/spec/support/fixtures/gift_designations.json

@@ -0,0 +1,175 @@
+{
+  "list": [
+    {
+      "id": 1,
+      "createDate": "9/14/2023",
+      "amountDesignated": 1000.0,
+      "giftId": 79,
+      "giftDate": "10/26/2022",
+      "giftType": "Check",
+      "giftIsPrivate": false,
+      "giftCustomFields": {},
+      "giftUrl": "/api/Gift/79",
+      "contactId": 13,
+      "contactName": "Donor 13",
+      "contactType": "Household",
+      "contactUrl": "/api/Contact/13",
+      "projectId": 3,
+      "project": "Direct Support",
+      "projectCode": "DirectSupport",
+      "projectExternalAccountingCode": null,
+      "projectType": "Unspecified",
+      "projectLocation": "Unspecified",
+      "projectCustomFields": {},
+      "projectUrl": "/api/Project/3",
+      "parentProjectId": null,
+      "parentProject": null,
+      "parentProjectCode": null,
+      "parentProjectExternalAccountingCode": null,
+      "parentProjectType": null,
+      "parentProjectLocation": null,
+      "parentProjectCustomFields": null,
+      "parentProjectUrl": null,
+      "batch": null,
+      "segmentName": null,
+      "segmentCode": null
+    },
+    {
+      "id": 2,
+      "createDate": "9/14/2023",
+      "amountDesignated": 9250.26,
+      "giftId": 102,
+      "giftDate": "10/27/2022",
+      "giftType": "Credit",
+      "giftIsPrivate": false,
+      "giftCustomFields": {},
+      "giftUrl": "/api/Gift/102",
+      "contactId": 422,
+      "contactName": "Donor 422",
+      "contactType": "Organization",
+      "contactUrl": "/api/Contact/422",
+      "projectId": 3,
+      "project": "Direct Support",
+      "projectCode": "DirectSupport",
+      "projectExternalAccountingCode": null,
+      "projectType": "Unspecified",
+      "projectLocation": "Unspecified",
+      "projectCustomFields": {},
+      "projectUrl": "/api/Project/3",
+      "parentProjectId": null,
+      "parentProject": null,
+      "parentProjectCode": null,
+      "parentProjectExternalAccountingCode": null,
+      "parentProjectType": null,
+      "parentProjectLocation": null,
+      "parentProjectCustomFields": null,
+      "parentProjectUrl": null,
+      "batch": null,
+      "segmentName": null,
+      "segmentCode": null
+    },
+    {
+      "id": 3,
+      "createDate": "9/14/2023",
+      "amountDesignated": 250.26,
+      "giftId": 102,
+      "giftDate": "10/27/2022",
+      "giftType": "Credit",
+      "giftIsPrivate": false,
+      "giftCustomFields": {},
+      "giftUrl": "/api/Gift/102",
+      "contactId": 422,
+      "contactName": "Donor 422",
+      "contactType": "Organization",
+      "contactUrl": "/api/Contact/422",
+      "projectId": 4,
+      "project": "Processing Fee",
+      "projectCode": "ProcessingFee",
+      "projectExternalAccountingCode": null,
+      "projectType": "Unspecified",
+      "projectLocation": "Unspecified",
+      "projectCustomFields": {},
+      "projectUrl": "/api/Project/4",
+      "parentProjectId": null,
+      "parentProject": null,
+      "parentProjectCode": null,
+      "parentProjectExternalAccountingCode": null,
+      "parentProjectType": null,
+      "parentProjectLocation": null,
+      "parentProjectCustomFields": null,
+      "parentProjectUrl": null,
+      "batch": null,
+      "segmentName": null,
+      "segmentCode": null
+    },
+    {
+      "id": 4,
+      "createDate": "9/14/2023",
+      "amountDesignated": 4042.0,
+      "giftId": 78,
+      "giftDate": "10/6/2022",
+      "giftType": "Check",
+      "giftIsPrivate": false,
+      "giftCustomFields": {},
+      "giftUrl": "/api/Gift/78",
+      "contactId": 159,
+      "contactName": "Donor 159",
+      "contactType": "Organization",
+      "contactUrl": "/api/Contact/159",
+      "projectId": 3,
+      "project": "Direct Support",
+      "projectCode": "DirectSupport",
+      "projectExternalAccountingCode": null,
+      "projectType": "Unspecified",
+      "projectLocation": "Unspecified",
+      "projectCustomFields": {},
+      "projectUrl": "/api/Project/3",
+      "parentProjectId": null,
+      "parentProject": null,
+      "parentProjectCode": null,
+      "parentProjectExternalAccountingCode": null,
+      "parentProjectType": null,
+      "parentProjectLocation": null,
+      "parentProjectCustomFields": null,
+      "parentProjectUrl": null,
+      "batch": null,
+      "segmentName": null,
+      "segmentCode": null
+    },
+    {
+      "id": 5,
+      "createDate": "9/14/2023",
+      "amountDesignated": 8333.33,
+      "giftId": 50,
+      "giftDate": "1/10/2023",
+      "giftType": "Check",
+      "giftIsPrivate": false,
+      "giftCustomFields": {},
+      "giftUrl": "/api/Gift/50",
+      "contactId": 429,
+      "contactName": "Donor 429",
+      "contactType": "Organization",
+      "contactUrl": "/api/Contact/429",
+      "projectId": 3,
+      "project": "Direct Support",
+      "projectCode": "DirectSupport",
+      "projectExternalAccountingCode": null,
+      "projectType": "Unspecified",
+      "projectLocation": "Unspecified",
+      "projectCustomFields": {},
+      "projectUrl": "/api/Project/3",
+      "parentProjectId": null,
+      "parentProject": null,
+      "parentProjectCode": null,
+      "parentProjectExternalAccountingCode": null,
+      "parentProjectType": null,
+      "parentProjectLocation": null,
+      "parentProjectCustomFields": null,
+      "parentProjectUrl": null,
+      "batch": null,
+      "segmentName": null,
+      "segmentCode": null
+    }
+  ],
+  "total": 110
+}

data/spec/support/fixtures/gifts.json

@@ -0,0 +1,112 @@
+[
+  {
+    "id": 1,
+    "transactionSource": null,
+    "transactionId": null,
+    "contactId": 1,
+    "contactName": "Test Contact",
+    "contactUrl": "/api/Contact/1",
+    "giftType": "Cash",
+    "giftTypeFormatted": "Cash",
+    "giftDate": "2023-12-08T00:00:00",
+    "giftDateFormatted": "12/8/2023",
+    "amount": 10.5,
+    "amountFormatted": "$10.50",
+    "currencyCode": "USD",
+    "exchangeRate": 1.0,
+    "baseCurrencyCode": "USD",
+    "batch": null,
+    "createDateTimeUtc": "2023-12-08T16:56:52.6126031Z",
+    "createdByUser": "Test User",
+    "modifiedDateTimeUtc": "2023-12-08T16:56:52.6126031Z",
+    "modifiedByUser": "Test User",
+    "segmentId": null,
+    "segment": null,
+    "segmentCode": null,
+    "segmentUrl": null,
+    "mediaOutletId": null,
+    "mediaOutlet": null,
+    "grantId": null,
+    "grant": null,
+    "grantUrl": null,
+    "notes": null,
+    "tribute": null,
+    "tributeId": null,
+    "tributeType": null,
+    "acknowledgeeIndividualId": null,
+    "isAcknowledgedGift": false,
+    "acknowledgementDate": null,
+    "acknowledgementNotes": null,
+    "receiptDate": null,
+    "receiptDateFormatted": "",
+    "contactPassthroughId": null,
+    "contactPassthroughUrl": null,
+    "contactIndividualId": null,
+    "cashAccountingCode": null,
+    "giftAskId": null,
+    "contactMembershipId": null,
+    "giftDesignations": [],
+    "giftPremiums": [],
+    "pledgePayments": [],
+    "recurringGiftPayments": [],
+    "giftUrl": "/api/Gift/1",
+    "isPrivate": false,
+    "isTaxDeductible": true,
+    "customFields": []
+  },
+  {
+    "id": 2,
+    "transactionSource": null,
+    "transactionId": null,
+    "contactId": 1,
+    "contactName": "Test Contact",
+    "contactUrl": "/api/Contact/1",
+    "giftType": "Cash",
+    "giftTypeFormatted": "Cash",
+    "giftDate": "2023-12-08T00:00:00",
+    "giftDateFormatted": "12/8/2023",
+    "amount": 5.0,
+    "amountFormatted": "$5.00",
+    "currencyCode": "USD",
+    "exchangeRate": 1.0,
+    "baseCurrencyCode": "USD",
+    "batch": null,
+    "createDateTimeUtc": "2023-12-08T16:56:52.6282311Z",
+    "createdByUser": "Test User",
+    "modifiedDateTimeUtc": "2023-12-08T16:56:52.6282311Z",
+    "modifiedByUser": "Test User",
+    "segmentId": null,
+    "segment": null,
+    "segmentCode": null,
+    "segmentUrl": null,
+    "mediaOutletId": null,
+    "mediaOutlet": null,
+    "grantId": null,
+    "grant": null,
+    "grantUrl": null,
+    "notes": null,
+    "tribute": null,
+    "tributeId": null,
+    "tributeType": null,
+    "acknowledgeeIndividualId": null,
+    "isAcknowledgedGift": false,
+    "acknowledgementDate": null,
+    "acknowledgementNotes": null,
+    "receiptDate": null,
+    "receiptDateFormatted": "",
+    "contactPassthroughId": null,
+    "contactPassthroughUrl": null,
+    "contactIndividualId": null,
+    "cashAccountingCode": null,
+    "giftAskId": null,
+    "contactMembershipId": null,
+    "giftDesignations": [],
+    "giftPremiums": [],
+    "pledgePayments": [],
+    "recurringGiftPayments": [],
+    "giftUrl": "/api/Gift/2",
+    "isPrivate": false,
+    "isTaxDeductible": true,
+    "customFields": []
+  }
+]

data/spec/support/fixtures/individual.json

@@ -0,0 +1,46 @@
+{
+  "id": 2,
+  "contactId": 1,
+  "prefix": "Mr",
+  "prefix2": null,
+  "firstName": "Test",
+  "middleName": null,
+  "lastName": "Individual",
+  "preMarriageName": null,
+  "suffix": null,
+  "nickname": null,
+  "gender": "Male",
+  "isPrimary": true,
+  "canBePrimary": false,
+  "isSecondary": false,
+  "canBeSecondary": false,
+  "birthMonth": 9,
+  "birthDay": 4,
+  "birthYear": 1998,
+  "birthDate": "9/4/1998",
+  "approximateAge": 25,
+  "isDeceased": false,
+  "deceasedDate": "",
+  "passion": null,
+  "avatarUrl": null,
+  "contactMethods": [
+    {
+      "id": 2081,
+      "type": "Work Email",
+      "value": "email@test.com",
+      "isOptedIn": false,
+      "isPrimary": true,
+      "canBePrimary": false,
+      "createDateTimeUtc": "2023-11-30T14:20:56.323",
+      "createdByUser": "Test User",
+      "modifiedDateTimeUtc": "2023-11-30T14:20:56.37",
+      "modifiedByUser": "Test User"
+    }
+  ],
+  "createDateTimeUtc": "2023-11-30T14:20:56.293",
+  "createdByUser": "Test User",
+  "modifiedDateTimeUtc": "2023-11-30T14:20:56.353",
+  "modifiedByUser": "Test User",
+  "customFields": [],
+  "customCollections": []
+}

data/spec/support/fixtures/recurring_gift.json

@@ -0,0 +1,26 @@
+{
+  "id": 1,
+  "transactionSource": null,
+  "transactionId": null,
+  "contactId": 1,
+  "recurringGiftDate": "2023-12-21T00:00:00",
+  "startDate": "2023-12-21T00:00:00",
+  "amount": 1000,
+  "frequency": "Monthly",
+  "anticipatedEndDate": null,
+  "cancelDateTimeUtc": null,
+  "createDateTimeUtc": "2023-12-21T19:44:49.317",
+  "createdByUser": "Test User",
+  "modifiedDateTimeUtc": "2023-12-22T13:42:34.34",
+  "modifiedByUser": "Test User",
+  "segmentId": null,
+  "segment": null,
+  "segmentUrl": null,
+  "automatedPayments": false,
+  "trackPayments": false,
+  "isPrivate": false,
+  "status": "UpToDate",
+  "nextExpectedPaymentDate": "2023-12-21T00:00:00",
+  "designations": [],
+  "customFields": []
+}

data/spec/support/fixtures_helper.rb

@@ -0,0 +1,5 @@
+class FixturesHelper
+  def self.read(path)
+    File.binread(File.join(FIXTURES_DIR, path))
+  end
+end

data/spec/support/virtuous_mock.rb

@@ -0,0 +1,101 @@
+require 'sinatra/base'
+require 'securerandom'
+require_relative 'fixtures_helper'
+
+class VirtuousMock < Sinatra::Base
+  # GET requests
+  {
+    'Contact/Find' => :contact,
+    'Contact/:id' => :contact,
+    'ContactIndividual/Find' => :individual,
+    'ContactIndividual/:id' => :individual,
+    'Gift/ByContact/:id' => :contact_gifts,
+    'ContactAddress/ByContact/:id' => :contact_addresses,
+    'Gift/:id' => :gift,
+    'RecurringGift/:id' => :recurring_gift,
+    'Gift/:transaction_source/:transaction_id' => :gift,
+    'GiftDesignation/QueryOptions' => :gift_designation_query_options
+  }.each do |end_point, json|
+    get "/api/#{end_point}" do
+      json_response 200, "#{json}.json"
+    end
+  end
+
+  # POST requests
+  {
+    'Contact/Transaction' => :import,
+    'Contact' => :contact,
+    'ContactIndividual' => :individual,
+    'v2/Gift/Transaction' => :import,
+    'v2/Gift/Transactions' => :import,
+    'Gift' => :gift,
+    'RecurringGift' => :recurring_gift,
+    'Gift/Bulk' => :gifts,
+    'GiftDesignation/Query' => :gift_designations,
+    'ContactAddress' => :contact_address
+  }.each do |end_point, json|
+    post "/api/#{end_point}" do
+      json_response 200, "#{json}.json"
+    end
+  end
+
+  # PUT requests
+  {
+    'Contact/:id' => :contact,
+    'ContactIndividual/:id' => :individual,
+    'Gift/:id' => :gift,
+    'RecurringGift/:id' => :recurring_gift,
+    'ContactAddress/:id' => :contact_address
+  }.each do |end_point, json|
+    put "/api/#{end_point}" do
+      json_response 200, "#{json}.json"
+    end
+  end
+
+  # DELETE requests
+  [
+    'ContactIndividual/:id',
+    'Gift/:id'
+  ].each do |end_point|
+    delete "/api/#{end_point}" do
+      content_type :json
+      status 204
+    end
+  end
+
+  # Auth request
+
+  post '/Token' do
+    content_type :json
+
+    body = URI.decode_www_form(request.body.read).to_h
+
+    if body['username'] == 'otp@user.com' && body['otp'].nil?
+      status 202
+      return {
+        error: 'awaiting_verification',
+        error_description: '2-step verification code (OTP) sent.'
+      }.to_json
+    end
+
+    status 200
+    {
+      access_token: 'new_access_token',
+      token_type: 'bearer',
+      expires_in: 1_295_999,
+      refresh_token: 'new_refresh_token',
+      userName: 'user@email.com',
+      twoFactorEnabled: 'False',
+      '.issued': Time.now.gmtime,
+      '.expires': (Time.now + 1_295_999).gmtime
+    }.to_json
+  end
+
+  private
+
+  def json_response(response_code, file_name)
+    content_type :json
+    status response_code
+    FixturesHelper.read(file_name)
+  end
+end