virtuous 0.0.1

data/spec/virtuous/resources/gift_spec.rb

@@ -0,0 +1,249 @@
+require 'spec_helper'
+
+RSpec.describe Virtuous::Client::Gift, type: :model do
+  include_context 'resource specs'
+
+  describe '#get_contact_gifts(contact_id, **options)' do
+    subject(:resource) do
+      client.get_contact_gifts(
+        1,
+        sort_by: 'GiftDate',
+        skip: 10,
+        take: 10
+      )
+    end
+
+    it 'returns a list of gifts' do
+      expect(subject[:list]).to be_a(Array)
+    end
+
+    it 'passes options' do
+      expect(client).to receive(:get)
+        .with(
+          'api/Gift/ByContact/1',
+          {
+            'sortBy' => 'GiftDate',
+            'skip' => 10,
+            'take' => 10
+          }
+        )
+        .and_call_original
+      resource
+    end
+  end
+
+  describe '#get_gift(id)' do
+    it 'returns a hash' do
+      expect(client.get_gift(1)).to be_a(Hash)
+    end
+
+    it 'queries gifts' do
+      expect(client).to receive(:get).with('api/Gift/1').and_call_original
+
+      resource = client.get_gift(1)
+
+      expect(resource[:id]).to eq(1)
+    end
+  end
+
+  describe '#find_gift_by_transaction_id(id)' do
+    let(:transaction_source) { 'source' }
+    let(:transaction_id) { 42 }
+
+    it 'returns a hash' do
+      expect(client.find_gift_by_transaction_id(transaction_source, transaction_id)).to be_a(Hash)
+    end
+
+    it 'queries gifts' do
+      expect(client).to receive(:get).with("api/Gift/#{transaction_source}/#{transaction_id}")
+                                     .and_call_original
+
+      resource = client.find_gift_by_transaction_id(transaction_source, transaction_id)
+
+      expect(resource[:transaction_source]).to eq(transaction_source)
+      expect(resource[:transaction_id]).to eq(transaction_id)
+    end
+  end
+
+  describe '#import_gift(data)' do
+    subject(:resource) do
+      client.import_gift(
+        gift_type: 'Cash', amount: 10.5, currency_code: 'USD', gift_date: Date.today,
+        contact: {
+          contact_type: 'Organization', name: 'Org name', first_name: 'John',
+          last_name: 'Doe', email: 'john_doe@email.com'
+        }
+      )
+    end
+
+    it 'passes options' do
+      expect(client).to receive(:post)
+        .with(
+          'api/v2/Gift/Transaction',
+          {
+            'giftType' => 'Cash', 'amount' => 10.5, 'currencyCode' => 'USD',
+            'giftDate' => Date.today, 'contact' => {
+              'contactType' => 'Organization', 'name' => 'Org name', 'firstName' => 'John',
+              'lastName' => 'Doe', 'email' => 'john_doe@email.com'
+            }
+          }
+        )
+        .and_call_original
+      resource
+    end
+  end
+
+  describe '#import_gifts(data)' do
+    subject(:resource) do
+      client.import_gifts(
+        transaction_source: 'Source', transactions: [
+          {
+            gift_type: 'Cash', amount: 10.5, currency_code: 'USD', gift_date: Date.today,
+            contact: {
+              contact_type: 'Organization', name: 'Org name', first_name: 'John',
+              last_name: 'Doe', email: 'john_doe@email.com'
+            }
+          },
+          {
+            gift_type: 'Cash', amount: 5.0, currency_code: 'USD', gift_date: Date.today,
+            contact: {
+              contact_type: 'Organization', name: 'Org name', first_name: 'John',
+              last_name: 'Doe', email: 'john_doe@email.com'
+            }
+          }
+        ]
+      )
+    end
+
+    it 'passes options' do
+      expect(client).to receive(:post)
+        .with(
+          'api/v2/Gift/Transactions',
+          {
+            'transactionSource' => 'Source', 'transactions' => [
+              {
+                'giftType' => 'Cash', 'amount' => 10.5, 'currencyCode' => 'USD',
+                'giftDate' => Date.today, 'contact' => {
+                  'contactType' => 'Organization', 'name' => 'Org name', 'firstName' => 'John',
+                  'lastName' => 'Doe', 'email' => 'john_doe@email.com'
+                }
+              },
+              {
+                'giftType' => 'Cash', 'amount' => 5.0, 'currencyCode' => 'USD',
+                'giftDate' => Date.today, 'contact' => {
+                  'contactType' => 'Organization', 'name' => 'Org name', 'firstName' => 'John',
+                  'lastName' => 'Doe', 'email' => 'john_doe@email.com'
+                }
+              }
+            ]
+
+          }
+        )
+        .and_call_original
+      resource
+    end
+  end
+
+  describe '#create_gift(data)' do
+    subject(:resource) do
+      client.create_gift(
+        contact_id: 1, gift_type: 'Cash', amount: 10.5, currency_code: 'USD',
+        gift_date: Date.today
+      )
+    end
+
+    it 'passes options' do
+      expect(client).to receive(:post)
+        .with(
+          'api/Gift',
+          {
+            'contactId' => 1, 'giftType' => 'Cash', 'amount' => 10.5, 'currencyCode' => 'USD',
+            'giftDate' => Date.today
+          }
+        )
+        .and_call_original
+      resource
+    end
+
+    it 'returns a hash' do
+      expect(resource).to be_a(Hash)
+    end
+  end
+
+  describe '#create_gifts(data)' do
+    subject(:resource) do
+      client.create_gifts(
+        [
+          {
+            contact_id: 1, gift_type: 'Cash', amount: 10.5, currency_code: 'USD',
+            gift_date: Date.today
+          },
+          {
+            contact_id: 2, gift_type: 'Cash', amount: 5.0, currency_code: 'USD',
+            gift_date: Date.today
+          }
+        ]
+      )
+    end
+
+    it 'passes options' do
+      expect(client).to receive(:post)
+        .with(
+          'api/Gift/Bulk',
+          [
+            {
+              'contactId' => 1, 'giftType' => 'Cash', 'amount' => 10.5, 'currencyCode' => 'USD',
+              'giftDate' => Date.today
+            },
+            {
+              'contactId' => 2, 'giftType' => 'Cash', 'amount' => 5.0, 'currencyCode' => 'USD',
+              'giftDate' => Date.today
+            }
+          ]
+        )
+        .and_call_original
+      resource
+    end
+
+    it 'returns a array' do
+      expect(resource).to be_a(Array)
+    end
+  end
+
+  describe '#update_gift(id, data)' do
+    subject(:resource) do
+      client.update_gift(
+        1, gift_type: 'Cash', amount: 5.0, currency_code: 'USD',
+           gift_date: Date.today
+      )
+    end
+
+    it 'passes options' do
+      expect(client).to receive(:put)
+        .with(
+          'api/Gift/1',
+          {
+            'giftType' => 'Cash', 'amount' => 5.0, 'currencyCode' => 'USD',
+            'giftDate' => Date.today
+          }
+        )
+        .and_call_original
+      resource
+    end
+
+    it 'returns a hash' do
+      expect(resource).to be_a(Hash)
+    end
+  end
+
+  describe '#delete_gift(id)' do
+    subject(:resource) { client.delete_gift(1) }
+
+    it 'calls delete on the gift' do
+      expect(client).to receive(:delete)
+        .with('api/Gift/1')
+        .and_call_original
+      resource
+    end
+  end
+end

data/spec/virtuous/resources/individual_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+RSpec.describe Virtuous::Client::Individual, type: :model do
+  include_context 'resource specs'
+
+  describe '#find_individual_by_email(email)' do
+    it 'returns a hash' do
+      expect(client.find_individual_by_email('email@test.com')).to be_a(Hash)
+    end
+
+    it 'queries individuals' do
+      expect(client).to receive(:get).with('api/ContactIndividual/Find',
+                                           { email: 'email@test.com' }).and_call_original
+
+      resource = client.find_individual_by_email('email@test.com')
+
+      expect(resource[:id]).to eq(2)
+    end
+  end
+
+  describe '#get_individual(id)' do
+    it 'returns a hash' do
+      expect(client.get_individual(2)).to be_a(Hash)
+    end
+
+    it 'queries individuals' do
+      expect(client).to receive(:get).with('api/ContactIndividual/2').and_call_original
+
+      resource = client.get_individual(2)
+
+      expect(resource[:id]).to eq(2)
+    end
+  end
+
+  describe '#create_individual(data)' do
+    subject(:resource) do
+      client.create_individual(first_name: 'John', last_name: 'Doe', contact_id: 1)
+    end
+
+    it 'passes options' do
+      expect(client).to receive(:post)
+        .with(
+          'api/ContactIndividual',
+          {
+            'firstName' => 'John',
+            'lastName' => 'Doe',
+            'contactId' => 1
+          }
+        )
+        .and_call_original
+      resource
+    end
+
+    it 'returns a hash' do
+      expect(resource).to be_a(Hash)
+    end
+  end
+
+  describe '#update_individual(id, data)' do
+    subject(:resource) do
+      client.update_individual(
+        2,
+        first_name: 'John', last_name: 'Doe'
+      )
+    end
+
+    it 'passes options' do
+      expect(client).to receive(:put)
+        .with(
+          'api/ContactIndividual/2',
+          {
+            'firstName' => 'John',
+            'lastName' => 'Doe'
+          }
+        )
+        .and_call_original
+      resource
+    end
+
+    it 'returns a hash' do
+      expect(resource).to be_a(Hash)
+    end
+  end
+
+  describe '#delete_individual(id)' do
+    subject(:resource) { client.delete_individual(2) }
+
+    it 'calls delete on the individual' do
+      expect(client).to receive(:delete)
+        .with('api/ContactIndividual/2')
+        .and_call_original
+      resource
+    end
+  end
+end

data/spec/virtuous/resources/recurring_gift_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+RSpec.describe Virtuous::Client::RecurringGift, type: :model do
+  include_context 'resource specs'
+
+  describe '#get_recurring_gift(id)' do
+    it 'returns a hash' do
+      expect(client.get_recurring_gift(1)).to be_a(Hash)
+    end
+
+    it 'queries gifts' do
+      expect(client).to receive(:get).with('api/RecurringGift/1').and_call_original
+
+      resource = client.get_recurring_gift(1)
+
+      expect(resource[:id]).to eq(1)
+    end
+  end
+
+  describe '#create_recurring_gift(data)' do
+    subject(:resource) do
+      client.create_recurring_gift(
+        contact_id: 1, start_date: Date.today, frequency: 'Monthly', amount: 1000
+      )
+    end
+
+    it 'passes options' do
+      expect(client).to receive(:post)
+        .with(
+          'api/RecurringGift',
+          {
+            'contactId' => 1, 'startDate' => Date.today, 'frequency' => 'Monthly', 'amount' => 1000
+          }
+        )
+        .and_call_original
+      resource
+    end
+
+    it 'returns a hash' do
+      expect(resource).to be_a(Hash)
+    end
+  end
+
+  describe '#update_recurring_gift(id, data)' do
+    subject(:resource) do
+      client.update_recurring_gift(
+        1, start_date: Date.today, frequency: 'Daily', amount: 500
+      )
+    end
+
+    it 'passes options' do
+      expect(client).to receive(:put)
+        .with(
+          'api/RecurringGift/1',
+          {
+            'startDate' => Date.today, 'frequency' => 'Daily', 'amount' => 500
+          }
+        )
+        .and_call_original
+      resource
+    end
+
+    it 'returns a hash' do
+      expect(resource).to be_a(Hash)
+    end
+  end
+end

data/spec/virtuous_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+RSpec.describe Virtuous do
+  it 'has a version number' do
+    expect(described_class::VERSION).to_not be_nil
+  end
+end

data/virtuous.gemspec

@@ -0,0 +1,25 @@
+require 'English'
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'virtuous/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'virtuous'
+  s.version       = Virtuous::VERSION
+  s.authors       = ['Taylor Brooks']
+  s.homepage      = 'https://github.com/taylorbrooks/virtuous'
+  s.summary       = 'A Ruby wrapper for the Virtuous CRM API'
+  s.description   = 'A Ruby wrapper for the Virtuous CRM API'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.executables   = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+
+  s.required_ruby_version = '>= 2.7'
+
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'faraday', '> 2.0'
+  s.add_runtime_dependency 'oj'
+
+  s.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: virtuous
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Taylor Brooks
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby wrapper for the Virtuous CRM API
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".reek.yml"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/virtuous.rb
+- lib/virtuous/client.rb
+- lib/virtuous/client/contact.rb
+- lib/virtuous/client/contact_address.rb
+- lib/virtuous/client/gift.rb
+- lib/virtuous/client/gift_designation.rb
+- lib/virtuous/client/individual.rb
+- lib/virtuous/client/recurring_gift.rb
+- lib/virtuous/error.rb
+- lib/virtuous/helpers/hash_helper.rb
+- lib/virtuous/helpers/string_helper.rb
+- lib/virtuous/parse_oj.rb
+- lib/virtuous/version.rb
+- logo/virtuous.svg
+- spec/spec_helper.rb
+- spec/support/client_factory.rb
+- spec/support/fixtures/contact.json
+- spec/support/fixtures/contact_address.json
+- spec/support/fixtures/contact_addresses.json
+- spec/support/fixtures/contact_gifts.json
+- spec/support/fixtures/gift.json
+- spec/support/fixtures/gift_designation_query_options.json
+- spec/support/fixtures/gift_designations.json
+- spec/support/fixtures/gifts.json
+- spec/support/fixtures/import.json
+- spec/support/fixtures/individual.json
+- spec/support/fixtures/recurring_gift.json
+- spec/support/fixtures_helper.rb
+- spec/support/virtuous_mock.rb
+- spec/virtuous/client_spec.rb
+- spec/virtuous/error_spec.rb
+- spec/virtuous/resources/contact_address_spec.rb
+- spec/virtuous/resources/contact_spec.rb
+- spec/virtuous/resources/gift_designation_spec.rb
+- spec/virtuous/resources/gift_spec.rb
+- spec/virtuous/resources/individual_spec.rb
+- spec/virtuous/resources/recurring_gift_spec.rb
+- spec/virtuous_spec.rb
+- virtuous.gemspec
+homepage: https://github.com/taylorbrooks/virtuous
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A Ruby wrapper for the Virtuous CRM API
+test_files: []