virtuous 0.0.1

data/lib/virtuous/client.rb

@@ -0,0 +1,272 @@
+require 'faraday'
+
+Dir[File.expand_path('client/*.rb', __dir__)].sort.each { |f| require f }
+
+module Virtuous
+  ##
+  # An API client for Virtuous.
+  # See {initialize} for a full list of supported configuration options.
+  #
+  # ### Authentication
+  #
+  # #### Api key auth
+  #
+  # To generate an api key you need to visit the
+  # [virtuous connect dashboard](https://connect.virtuoussoftware.com/).
+  # Then you can use the key by setting the `api_key` param while creating the client or
+  # by setting the `VIRTUOUS_KEY` environment variable beforehand.
+  #
+  #     client = Virtuous::Client.new(
+  #       api_key: api_key,
+  #       # ...
+  #     )
+  #
+  # #### Oauth
+  #
+  # First, an access token needs to be fetched by providing a user's email and password.
+  # This will return an access token that lasts for 15 days, and a refresh token that should be
+  # stored and used to create clients in the future.
+  # The client will use the expiry date of the access token to automatically determine when a
+  # new one needs to be fetched.
+  #
+  #     client = Virtuous::Client.new
+  #     client.authenticate(email, password)
+  #     user.update(
+  #       access_token: client.access_token, refresh_token: client.refresh_token,
+  #       token_expiration: client.expires_at
+  #     )
+  #
+  #     # Afterwards
+  #
+  #     client = Virtuous::Client.new(
+  #       access_token: user.access_token, refresh_token: user.refresh_token,
+  #       expires_at: user.token_expiration
+  #     )
+  #
+  #     # Use client
+  #
+  #     if client.refreshed
+  #       # Update values if they changed
+  #       user.update(
+  #         access_token: client.access_token, refresh_token: client.refresh_token,
+  #         token_expiration: client.expires_at
+  #       )
+  #     end
+  #
+  # #### Two-Factor Authentication
+  #
+  #     client = Virtuous::Client.new
+  #     response = client.authenticate(email, password)
+  #     if response[:requires_otp]
+  #       # Prompt user for OTP
+  #       client.authenticate(email, password, otp)
+  #     end
+  #
+  # Check resource modules to see available client methods:
+  #
+  # - {Contact}
+  # - {Individual}
+  # - {Gift}
+  # - {GiftDesignation}
+  class Client
+    include Contact
+    include ContactAddress
+    include Individual
+    include Gift
+    include RecurringGift
+    include GiftDesignation
+
+    ##
+    # Access token used for OAuth authentication.
+    attr_reader :access_token
+    ##
+    # Token used to refresh the access token when it has expired.
+    attr_reader :refresh_token
+    ##
+    # Expiration date of the access token.
+    attr_reader :expires_at
+    ##
+    # True if the access token has been refreshed.
+    attr_reader :refreshed
+
+    ##
+    # @option config [String] :base_url The base url to use for API calls.
+    #   Default: `https://api.virtuoussoftware.com`.
+    # @option config [String] :api_key The key for the API.
+    # @option config [String] :access_token The OAuth access token.
+    # @option config [String] :refresh_token The OAuth refresh token.
+    # @option config [Time] :expires_at The expiration date of the access token.
+    # @option config [Hash] :ssl_options SSL options to use with Faraday.
+    # @option config [Logger] :logger Logger object for Faraday.
+    # @option config [Symbol] :adapter Faraday adapter to use. Default: `Faraday.default_adapter`.
+    def initialize(**config)
+      read_config(config)
+
+      @refreshed = false
+    end
+
+    ##
+    # @!method get(path, body = {})
+    # Makes a `GET` request to the path.
+    #
+    # @param path [String] The path to send the request.
+    # @param body [Hash] Hash of URI query unencoded key/value pairs.
+    #
+    # @return [Object] The body of the response.
+
+    ##
+    # @!method post(path, body = {})
+    # Makes a `POST` request to the path.
+    #
+    # @param path [String] The path to send the request.
+    # @param body [Hash] Hash of URI query unencoded key/value pairs.
+    #
+    # @return [Object] The body of the response.
+
+    ##
+    # @!method delete(path, body = {})
+    # Makes a `DELETE` request to the path.
+    #
+    # @param path [String] The path to send the request.
+    # @param body [Hash] Hash of URI query unencoded key/value pairs.
+    #
+    # @return [Object] The body of the response.
+
+    ##
+    # @!method patch(path, body = {})
+    # Makes a `PATCH` request to the path.
+    #
+    # @param path [String] The path to send the request.
+    # @param body [Hash] Hash of URI query unencoded key/value pairs.
+    #
+    # @return [Object] The body of the response.
+
+    ##
+    # @!method put(path, body = {})
+    # Makes a `PUT` request to the path.
+    #
+    # @param path [String] The path to send the request.
+    # @param body [Hash] Hash of URI query unencoded key/value pairs.
+    #
+    # @return [Object] The body of the response.
+    [:get, :post, :delete, :patch, :put].each do |http_method|
+      define_method(http_method) do |path, body = {}|
+        connection.public_send(http_method, path, body).body
+      end
+    end
+
+    ##
+    # Send a request to get an access token using the email and password of a user.
+    #
+    # @param email [String] The email of the user.
+    # @param password [String] The password of the user.
+    # @param otp [Integer] The One Time Password of the two-factor authentication flow.
+    #
+    # @return [Hash] If the authentication was a success, it contains the OAuth tokens.
+    #   If two factor is required, it will include the `:requires_otp` key.
+    # @example Output if authentication is a success
+    #       {
+    #         access_token: '<access_token>',
+    #         refresh_token: '<refresh_token>',
+    #         expires_at: Time
+    #       }
+    #
+    # @example Output if Two-Factor Authentication is required
+    #       {
+    #         requires_otp: true
+    #       }
+    def authenticate(email, password, otp = nil)
+      data = { grant_type: 'password', username: email, password: password }
+      data[:otp] = otp unless otp.nil?
+      get_access_token(data)
+    end
+
+    private
+
+    def encode(string)
+      # CGI.escape changes spaces to '+', and we need '%20' instead.
+      CGI.escape(string).gsub('+', '%20')
+    end
+
+    def read_config(config)
+      [
+        :base_url, :api_key, :access_token, :refresh_token, :expires_at, :ssl_options, :logger,
+        :adapter
+      ].each do |attribute|
+        instance_variable_set("@#{attribute}", config[attribute])
+      end
+
+      @api_key ||= ENV.fetch('VIRTUOUS_KEY', nil)
+      @base_url ||= 'https://api.virtuoussoftware.com'
+      @adapter ||= Faraday.default_adapter
+    end
+
+    def use_access_token?
+      !@access_token.nil? || !@refresh_token.nil?
+    end
+
+    def get_access_token(body)
+      response = unauthorized_connection.post('/Token', URI.encode_www_form(body))
+
+      return { requires_otp: true } if response.env.status == 202
+
+      self.oauth_tokens = response.body
+
+      { access_token: @access_token, refresh_token: @refresh_token, expires_at: @expires_at }
+    end
+
+    def oauth_tokens=(values)
+      @access_token = values['access_token']
+      @expires_at = Time.parse(values['.expires'])
+      @refresh_token = values['refresh_token']
+      @refreshed = true
+    end
+
+    def check_token_expiration
+      if !@refresh_token.nil? &&
+         ((!@expires_at.nil? && @expires_at < Time.now) || @access_token.nil?)
+        get_access_token({ grant_type: 'refresh_token', refresh_token: @refresh_token })
+      end
+    end
+
+    def parse(data)
+      data = JSON.parse(data) if data.is_a?(String)
+
+      HashHelper.deep_transform_keys(data) { |key| StringHelper.underscore(key).to_sym }
+    end
+
+    def format(data)
+      HashHelper.deep_transform_keys(data) { |key| StringHelper.camelize(key.to_s) }
+    end
+
+    def bearer_token
+      if @api_key.nil?
+        check_token_expiration
+        return @access_token
+      end
+
+      @api_key
+    end
+
+    def connection
+      unauthorized_connection do |conn|
+        conn.request :authorization, 'Bearer', -> { bearer_token }
+      end
+    end
+
+    def unauthorized_connection
+      options = { url: @base_url }
+
+      options[:ssl] = @ssl_options unless @ssl_options.nil?
+
+      Faraday.new(options) do |conn|
+        conn.request :json
+        conn.response :oj
+        conn.response :logger, @logger if @logger
+        conn.use FaradayMiddleware::VirtuousErrorHandler
+        conn.adapter @adapter
+        yield(conn) if block_given?
+      end
+    end
+  end
+end

data/lib/virtuous/error.rb

@@ -0,0 +1,54 @@
+module Virtuous # :nodoc: all
+  class Error < StandardError; end
+  class BadGateway < Error; end
+  class BadRequest < Error; end
+  class CloudflareError < Error; end
+  class Forbidden < Error; end
+  class GatewayTimeout < Error; end
+  class InternalServerError < Error; end
+  class NotFound < Error; end
+  class ServiceUnavailable < Error; end
+  class Unauthorized < Error; end
+end
+
+require 'faraday'
+module FaradayMiddleware
+  class VirtuousErrorHandler < Faraday::Middleware
+    ERROR_STATUSES = (400..600).freeze
+
+    ##
+    # Throws an exception for responses with an HTTP error code.
+    def on_complete(env)
+      message = error_message(env)
+
+      case env[:status]
+      when 400
+        raise Virtuous::BadRequest, message
+      when 401
+        raise Virtuous::Unauthorized, message
+      when 403
+        raise Virtuous::Forbidden, message
+      when 404
+        raise Virtuous::NotFound, message
+      when 500
+        raise Virtuous::InternalServerError, message
+      when 502
+        raise Virtuous::BadGateway, message
+      when 503
+        raise Virtuous::ServiceUnavailable, message
+      when 504
+        raise Virtuous::GatewayTimeout, message
+      when 520
+        raise Virtuous::CloudflareError, message
+      when ERROR_STATUSES
+        raise Virtuous::Error, message
+      end
+    end
+
+    private
+
+    def error_message(env)
+      "#{env[:status]}: #{env[:url]} #{env[:body]}"
+    end
+  end
+end

data/lib/virtuous/helpers/hash_helper.rb

@@ -0,0 +1,28 @@
+module Virtuous
+  ##
+  # Helper methods for hashes
+  class HashHelper
+    ##
+    # Recieves a block which is called on all of the keys of the hash,
+    # including the keys nested hashes inside.
+    # @param hash [Hash] the hash to call the block upon.
+    # @return [Hash] A new hash with the transformed keys.
+    def self.deep_transform_keys(hash, &transform)
+      new_hash = {}
+      hash.each_key do |key|
+        value = hash[key]
+        new_key = transform.call(key)
+        new_hash[new_key] = if value.is_a?(Array)
+                              value.map do |item|
+                                item.is_a?(Hash) ? deep_transform_keys(item, &transform) : item
+                              end
+                            elsif value.is_a?(Hash)
+                              deep_transform_keys(value, &transform)
+                            else
+                              value
+                            end
+      end
+      new_hash
+    end
+  end
+end

data/lib/virtuous/helpers/string_helper.rb

@@ -0,0 +1,31 @@
+module Virtuous
+  ##
+  # Helper methods for strings
+  class StringHelper
+    class << self
+      ##
+      # Transform a String from `CamelCase` to `snake_case`.
+      # @param string [String] the string to transform.
+      # @return [String] the `snake_case` string.
+      def underscore(string)
+        string.gsub('::', '/')
+              .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+              .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+              .tr('-', '_')
+              .downcase
+      end
+
+      ##
+      # Transform a String from `snake_case` to `CamelCase`.
+      # @param string [String] the string to transform.
+      # @return [String] the `CamelCase` string.
+      def camelize(string)
+        string = string.sub(/^(?:(?=\b|[A-Z_])|\w)/, &:downcase)
+
+        string.gsub(%r{(?:_|(/))([a-z\d]*)}) do
+          "#{::Regexp.last_match(1)}#{::Regexp.last_match(2).capitalize}"
+        end.gsub('/', '::')
+      end
+    end
+  end
+end

data/lib/virtuous/parse_oj.rb

@@ -0,0 +1,24 @@
+require 'oj'
+
+module FaradayMiddleware
+  class ParseOj < Faraday::Middleware
+    ##
+    # Parses JSON responses.
+    def on_complete(env)
+      body = env[:body]
+      env[:body] = if empty_body?(body.strip)
+                     nil
+                   else
+                     Oj.load(body, mode: :compat)
+                   end
+    end
+
+    private
+
+    def empty_body?(body)
+      body.empty? && body == ''
+    end
+  end
+end
+
+Faraday::Response.register_middleware(oj: FaradayMiddleware::ParseOj)

data/lib/virtuous/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Virtuous
+  VERSION = '0.0.1'
+end

data/lib/virtuous.rb

@@ -0,0 +1,12 @@
+require_relative 'virtuous/version'
+require_relative 'virtuous/error'
+require_relative 'virtuous/parse_oj'
+Dir[File.expand_path('virtuous/helpers/*.rb', __dir__)].sort.each { |f| require f }
+require_relative 'virtuous/client'
+
+##
+# Virtuous module documentation.
+#
+# Go to Client to see the documentation of the client.
+module Virtuous
+end

data/logo/virtuous.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 372.4 66.52"><defs><style>.cls-1{fill:#00a3e0;}.cls-2{fill:#f0f8ff;}</style></defs><g id="Layer_2" data-name="Layer 2"><g id="Logo_Variations" data-name="Logo Variations"><path class="cls-1" d="M27.76,45.66V66.52C3,45.5,0,53.55,0,27.6V6.71C24.79,27.75,27.76,19.69,27.76,45.66Z"></path><path class="cls-1" d="M59.82,6.71V27.6c0,25.95-3,17.9-27.77,38.92V45.66C32.05,19.69,35,27.75,59.82,6.71Z"></path><path class="cls-2" d="M132.58,16,116.29,56.86h-9.91L90.06,16h9.28a4,4,0,0,1,2.32.68A3.52,3.52,0,0,1,103,18.48l7.52,20.68c.37.92.66,1.84.93,2.76a24.29,24.29,0,0,1,.92-2.81l7.7-20.7a3.63,3.63,0,0,1,1.31-1.73,3.86,3.86,0,0,1,2.26-.64Z"></path><path class="cls-2" d="M148.83,16V53.35a3.51,3.51,0,0,1-3.5,3.47h-8V19.48a3.5,3.5,0,0,1,3.5-3.49Z"></path><path class="cls-2" d="M148.83,3.48V10h-8a3.49,3.49,0,0,1-3.5-3.48V0h8A3.51,3.51,0,0,1,148.83,3.48Z"></path><path class="cls-2" d="M371.48,39.05a10.08,10.08,0,0,0-2.4-3.17,13.27,13.27,0,0,0-3.32-2.14c-1.17-.52-2.38-1-3.59-1.41s-2.38-.78-3.53-1.13a20,20,0,0,1-2.91-1.09,6.21,6.21,0,0,1-1.84-1.28,1.8,1.8,0,0,1-.53-1.38,2.59,2.59,0,0,1,1.17-2.23,6.23,6.23,0,0,1,3.75-1,10.31,10.31,0,0,1,2.77.34,16.81,16.81,0,0,1,2.19.79l1.79.85a3.76,3.76,0,0,0,3.51.09,3.42,3.42,0,0,0,1.14-1.19l2.6-4-.6-.59a17.69,17.69,0,0,0-5.85-3.67,22.26,22.26,0,0,0-14.43-.38,14.9,14.9,0,0,0-4.93,2.76,11.66,11.66,0,0,0-3.05,4.11,12.24,12.24,0,0,0-1,4.95,11.64,11.64,0,0,0,.93,4.8,10.26,10.26,0,0,0,2.4,3.39,13,13,0,0,0,3.34,2.24,32.52,32.52,0,0,0,3.69,1.46c1.23.41,2.42.78,3.57,1.13a20.08,20.08,0,0,1,2.92,1.09,6.29,6.29,0,0,1,1.85,1.29,2.12,2.12,0,0,1,.53,1.52,3.34,3.34,0,0,1-.27,1.36,2.87,2.87,0,0,1-.85,1.1,5.13,5.13,0,0,1-1.64.85,8.17,8.17,0,0,1-2.55.34,9.4,9.4,0,0,1-3.16-.43,15.06,15.06,0,0,1-2.25-1c-.67-.37-1.25-.71-1.75-1a4.19,4.19,0,0,0-4.19-.16,4.06,4.06,0,0,0-1.34,1.33L341,51.85l.64.57a17,17,0,0,0,2.76,2A21.58,21.58,0,0,0,347.84,56,23.21,23.21,0,0,0,351.68,57a23.84,23.84,0,0,0,11.07-.64A15.11,15.11,0,0,0,368,53.5a12.32,12.32,0,0,0,3.3-4.43,13.94,13.94,0,0,0,1.11-5.56A10,10,0,0,0,371.48,39.05Z"></path><path class="cls-2" d="M236.88,19.47V38.74c0,3.35-.65,6.43-1.66,7.8a5.57,5.57,0,0,1-4.82,2.13,5.64,5.64,0,0,1-4.9-2.14c-1-1.44-1.66-4.46-1.66-7.79l0-19.27A3.49,3.49,0,0,0,220.3,16h-8V39.81a21.12,21.12,0,0,0,1.24,6.58,16.85,16.85,0,0,0,3.69,5.91A16,16,0,0,0,223,56.08a21.52,21.52,0,0,0,14.76,0,16,16,0,0,0,5.66-3.78,16.81,16.81,0,0,0,3.64-5.91,21.65,21.65,0,0,0,1.24-6.57V16h-8A3.48,3.48,0,0,0,236.88,19.47Z"></path><path class="cls-2" d="M155.31,30.28V56.82h8a3.49,3.49,0,0,0,3.49-3.48V34.62c0-3.35.65-6.42,1.64-7.8a5.62,5.62,0,0,1,4.83-2.13h1.4a3.5,3.5,0,0,0,3.5-3.47V16h-8.54a16.05,16.05,0,0,0-5.82,1,12.78,12.78,0,0,0-4.61,3,13.51,13.51,0,0,0-2.87,4.73,17.07,17.07,0,0,0-1,5,2.94,2.94,0,0,0,0,.42"></path><path class="cls-2" d="M268,27.44c1.37-1.92,3.44-2.85,6.35-2.85s5.06.92,6.45,2.87,2.16,5,2.16,8.95-.73,6.91-2.16,8.9-3.48,2.84-6.45,2.84-5-.92-6.36-2.82-2.14-5-2.14-8.92S266.62,29.45,268,27.44Zm-12.42.26a24.86,24.86,0,0,0-1.43,8.63A24.86,24.86,0,0,0,255.57,45a19,19,0,0,0,4.12,6.7,17.91,17.91,0,0,0,6.46,4.25,24.17,24.17,0,0,0,16.6,0,18,18,0,0,0,6.46-4.25A19.12,19.12,0,0,0,293.3,45a24.64,24.64,0,0,0,1.44-8.63,24.48,24.48,0,0,0-1.45-8.64,18.79,18.79,0,0,0-4.13-6.58,18.39,18.39,0,0,0-6.46-4.21,24.28,24.28,0,0,0-16.6,0,18.06,18.06,0,0,0-10.53,10.8Z"></path><path class="cls-2" d="M312,19.47V38.74c0,3.35.65,6.43,1.65,7.8a6.61,6.61,0,0,0,9.73,0c1-1.44,1.66-4.46,1.66-7.79l0-19.27a3.49,3.49,0,0,1,3.5-3.47h8V39.81a21.11,21.11,0,0,1-1.23,6.58,16.85,16.85,0,0,1-3.69,5.91,15.91,15.91,0,0,1-5.74,3.78,21.49,21.49,0,0,1-14.75,0,16,16,0,0,1-5.67-3.78,16.81,16.81,0,0,1-3.64-5.91,21.06,21.06,0,0,1-1.24-6.57V16h8A3.48,3.48,0,0,1,312,19.47Z"></path><path class="cls-2" d="M195.22,24.7h7.46A2.75,2.75,0,0,0,205.44,22V16H195.22V8.87a2.77,2.77,0,0,0-2.77-2.76h-8.66V45.66c0,3.61,1,6.5,3,8.59s4.89,3.17,8.53,3.17a18.6,18.6,0,0,0,5.83-.91,15.17,15.17,0,0,0,5.05-2.76l.69-.56-3.28-5.3,0-.07a4.23,4.23,0,0,0-.76-.82,2.26,2.26,0,0,0-2.56-.07c-.21.13-.45.25-.72.39a8.1,8.1,0,0,1-.92.38,3.2,3.2,0,0,1-1.11.14,2,2,0,0,1-1.66-.67,3.11,3.11,0,0,1-.64-2.14Z"></path></g></g></svg>

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift(File.join(__FILE__, '..', '..', 'lib'))
+
+SPEC_DIR = File.dirname(__FILE__)
+FIXTURES_DIR = File.join(SPEC_DIR, 'support', 'fixtures')
+
+require 'virtuous'
+require 'webmock/rspec'
+require_relative 'support/fixtures_helper'
+require_relative 'support/virtuous_mock'
+require_relative 'support/client_factory'
+
+RSpec.configure do |config|
+  config.before :suite do
+    WebMock.disable_net_connect!
+  end
+
+  config.before :each do
+    stub_request(:any, /virtuoussoftware/).to_rack(VirtuousMock)
+  end
+
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end

data/spec/support/client_factory.rb

@@ -0,0 +1,10 @@
+RSpec.shared_context 'resource specs' do
+  let(:attrs) do
+    {
+      api_key: 'test_api_key',
+      base_url: 'http://api.virtuoussoftware.com'
+    }
+  end
+
+  let(:client) { Virtuous::Client.new(**attrs) }
+end

data/spec/support/fixtures/contact.json

@@ -0,0 +1,112 @@
+{
+  "id": 1,
+  "contactType": "Organization",
+  "isPrivate": true,
+  "name": "Test Contact",
+  "informalName": "Test Contact",
+  "formalContactName": "Test Contact",
+  "alternateContactName": "Test Contact",
+  "preferredSalutationName": "Test Contact",
+  "preferredAddresseeName": "Test Contact",
+  "description": null,
+  "website": null,
+  "maritalStatus": null,
+  "anniversaryMonth": null,
+  "anniversaryDay": null,
+  "anniversaryYear": null,
+  "mergedIntoContactId": null,
+  "address": {
+    "id": 800,
+    "label": "Test address",
+    "address1": "123 test street",
+    "address2": null,
+    "city": null,
+    "state": "",
+    "postal": null,
+    "country": "",
+    "isPrimary": true,
+    "canBePrimary": false,
+    "startMonth": 1,
+    "startDay": 1,
+    "endMonth": 12,
+    "endDay": 31,
+    "createDateTimeUtc": "2023-11-30T14:20:56.34",
+    "createdByUser": "Test User",
+    "modifiedDateTimeUtc": "2023-11-30T14:20:56.3533333",
+    "modifiedByUser": "Test User"
+  },
+  "giftAskAmount": "$1,200",
+  "giftAskType": null,
+  "lifeToDateGiving": "$0",
+  "yearToDateGiving": "$0",
+  "lastGiftAmount": "$0",
+  "lastGiftDate": "Unavailable",
+  "contactIndividuals": [
+    {
+      "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.3233333",
+          "createdByUser": "Test User",
+          "modifiedDateTimeUtc": "2023-11-30T14:20:56.37",
+          "modifiedByUser": "Test User"
+        }
+      ],
+      "createDateTimeUtc": "2023-11-30T14:20:56.2933333",
+      "createdByUser": "Test User",
+      "modifiedDateTimeUtc": "2023-11-30T14:20:56.3533333",
+      "modifiedByUser": "Test User",
+      "customFields": [],
+      "customCollections": []
+    }
+  ],
+  "contactGiftsUrl": "/api/Gift/ByContact/1",
+  "contactPassthroughGiftsUrl": "/api/Gift/Passthrough/ByContact/1",
+  "contactPlannedGiftsUrl": "/api/PlannedGift/ByContact/1",
+  "contactRecurringGiftsUrl": "/api/RecurringGift/ByContact/1",
+  "contactImportantNotesUrl": "/api/ContactNote/Important/ByContact/1",
+  "contactNotesUrl": "/api/ContactNote/ByContact/1",
+  "contactTagsUrl": "/api/ContactTag/ByContact/1",
+  "contactRelationshipsUrl": "/api/Relationship/ByContact/1",
+  "primaryAvatarUrl": null,
+  "contactReferences": [],
+  "originSegmentId": null,
+  "originSegment": null,
+  "createDateTimeUtc": "2023-11-30T14:20:56.277",
+  "createdByUser": "Test User",
+  "modifiedDateTimeUtc": "2023-11-30T14:20:56.353",
+  "modifiedByUser": "Test User",
+  "tags": [],
+  "organizationGroups": [],
+  "customFields": [],
+  "customCollections": []
+}

data/spec/support/fixtures/contact_address.json

@@ -0,0 +1,20 @@
+{
+  "id": 1,
+  "label": "Home address",
+  "address1": "324 Frank Island",
+  "address2": "Apt. 366",
+  "city": "Antonioborough",
+  "state": "MA",
+  "postal": "27516",
+  "country": "United States",
+  "is_primary": true,
+  "can_be_primary": false,
+  "start_month": 1,
+  "start_day": 1,
+  "end_month": 12,
+  "end_day": 31,
+  "create_date_time_utc": "2023-11-30T14:20:56.34",
+  "created_by_user": "Test User",
+  "modified_date_time_utc": "2023-12-27T15:33:09.9",
+  "modified_by_user": "Test User"
+}

data/spec/support/fixtures/contact_addresses.json

@@ -0,0 +1,42 @@
+[
+  {
+    "id": 1,
+    "label": "Home address",
+    "address1": "324 Frank Island",
+    "address2": "Apt. 366",
+    "city": "Antonioborough",
+    "state": "MA",
+    "postal": "27516",
+    "country": "United States",
+    "is_primary": true,
+    "can_be_primary": false,
+    "start_month": 1,
+    "start_day": 1,
+    "end_month": 12,
+    "end_day": 31,
+    "create_date_time_utc": "2023-11-30T14:20:56.34",
+    "created_by_user": "Test User",
+    "modified_date_time_utc": "2023-12-27T15:33:09.9",
+    "modified_by_user": "Test User"
+  },
+  {
+    "id": 2,
+    "label": "Home address",
+    "address1": "324 Frank Island",
+    "address2": "Apt. 366",
+    "city": "Antonioborough",
+    "state": "MA",
+    "postal": "27516",
+    "country": "United States",
+    "is_primary": false,
+    "can_be_primary": true,
+    "start_month": 1,
+    "start_day": 1,
+    "end_month": 12,
+    "end_day": 31,
+    "create_date_time_utc": "2023-12-27T15:35:02.447",
+    "created_by_user": "Test User",
+    "modified_date_time_utc": "2023-12-27T15:35:02.967",
+    "modified_by_user": "Test User"
+  }
+]