virtuous 0.0.2 → 0.0.4

data/spec/support/fixtures/projects.json

@@ -0,0 +1,93 @@
+{
+  "list": [
+    {
+      "id": 1,
+      "name": "Test project 1",
+      "projectCode": "test_project_1",
+      "externalAccountingCode": null,
+      "onlineDisplayName": null,
+      "description": null,
+      "photoUrl": null,
+      "parentId": null,
+      "parentName": null,
+      "isSubProject": false,
+      "inventoryStatus": null,
+      "type": null,
+      "location": null,
+      "isRestrictedToGiftSpecifications": false,
+      "isLimitedToFinancialNeed": false,
+      "isPublic": true,
+      "isActive": true,
+      "isAvailableOnline": true,
+      "isTaxDeductible": true,
+      "treatAsAccountsPayable": false,
+      "beginningBalance": 0.0,
+      "currentBalance": 123.123,
+      "financialNeedType": null,
+      "financialNeedFrequency": null,
+      "financialNeedAmount": 0.0,
+      "startDate": "2023-12-08T00:00:00",
+      "endDate": "2024-12-08T00:00:00",
+      "durationType": null,
+      "lifeToDateGiving": null,
+      "lifeToDateGiftCount": null,
+      "lifeToDateGiversCount": null,
+      "lifeToDateExpenseTotal": null,
+      "calendarYearToDateGiving": null,
+      "calendarYearToDateGiftCount": null,
+      "calendarYearToDateGiversCount": null,
+      "calendarYearToDateExpenseTotal": null,
+      "createDateTimeUtc": "2023-12-08T00:00:00",
+      "createdByUser": "Test User",
+      "modifiedDateTimeUtc": "2023-12-08T00:00:00",
+      "modifiedByUser": "Test User",
+      "giftSpecifications": [],
+      "customFields": {}
+    },
+    {
+      "id": 2,
+      "name": "Test project 2",
+      "projectCode": "test_project_2",
+      "externalAccountingCode": null,
+      "onlineDisplayName": null,
+      "description": null,
+      "photoUrl": null,
+      "parentId": null,
+      "parentName": null,
+      "isSubProject": false,
+      "inventoryStatus": null,
+      "type": null,
+      "location": null,
+      "isRestrictedToGiftSpecifications": false,
+      "isLimitedToFinancialNeed": false,
+      "isPublic": true,
+      "isActive": true,
+      "isAvailableOnline": true,
+      "isTaxDeductible": true,
+      "treatAsAccountsPayable": false,
+      "beginningBalance": 0.0,
+      "currentBalance": 123.123,
+      "financialNeedType": null,
+      "financialNeedFrequency": null,
+      "financialNeedAmount": 0.0,
+      "startDate": "2023-12-08T00:00:00",
+      "endDate": "2024-12-08T00:00:00",
+      "durationType": null,
+      "lifeToDateGiving": null,
+      "lifeToDateGiftCount": null,
+      "lifeToDateGiversCount": null,
+      "lifeToDateExpenseTotal": null,
+      "calendarYearToDateGiving": null,
+      "calendarYearToDateGiftCount": null,
+      "calendarYearToDateGiversCount": null,
+      "calendarYearToDateExpenseTotal": null,
+      "createDateTimeUtc": "2023-12-08T00:00:00",
+      "createdByUser": "Test User",
+      "modifiedDateTimeUtc": "2023-12-08T00:00:00",
+      "modifiedByUser": "Test User",
+      "giftSpecifications": [],
+      "customFields": {}
+    }
+  ],
+  "total": 123
+}

data/spec/support/virtuous_mock.rb

@@ -14,7 +14,8 @@ class VirtuousMock < Sinatra::Base
     'Gift/:id' => :gift,
     'RecurringGift/:id' => :recurring_gift,
     'Gift/:transaction_source/:transaction_id' => :gift,
-    'GiftDesignation/QueryOptions' => :gift_designation_query_options
+    'GiftDesignation/QueryOptions' => :gift_designation_query_options,
+    'Project/QueryOptions' => :project_query_options # TODO: change fixture
   }.each do |end_point, json|
     get "/api/#{end_point}" do
       json_response 200, "#{json}.json"
@@ -32,6 +33,7 @@ class VirtuousMock < Sinatra::Base
     'RecurringGift' => :recurring_gift,
     'Gift/Bulk' => :gifts,
     'GiftDesignation/Query' => :gift_designations,
+    'Project/Query' => :projects, # TODO: change fixture
     'ContactAddress' => :contact_address
   }.each do |end_point, json|
     post "/api/#{end_point}" do

data/spec/virtuous/resources/project_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+RSpec.describe Virtuous::Client::Individual, type: :model do
+  include_context 'resource specs'
+
+  describe '#project_query_options' do
+    it 'returns a hash' do
+      expect(client.project_query_options).to be_a(Hash)
+    end
+
+    it 'queries options' do
+      expect(client).to receive(:get).with('api/Project/QueryOptions').and_call_original
+
+      response = client.project_query_options
+
+      expect(response).to have_key(:options)
+    end
+  end
+
+  describe '#query_projects(**options)' do
+    it 'returns a list of projects' do
+      response = client.query_projects
+      expect(response).to be_a(Hash)
+
+      expect(response).to have_key(:list)
+      expect(response).to have_key(:total)
+    end
+
+    it 'sends take as a query param' do
+      expect(client).to receive(:post).with(URI('api/Project/Query?take=12'),
+                                            {}).and_call_original
+
+      client.query_projects(take: 12)
+    end
+
+    it 'sends skip as a query param' do
+      expect(client).to receive(:post).with(URI('api/Project/Query?skip=12'),
+                                            {}).and_call_original
+
+      client.query_projects(skip: 12)
+    end
+
+    it 'sends sort_by in the body' do
+      expect(client).to receive(:post).with(URI('api/Project/Query'), { 'sortBy' => 'Id' })
+                                      .and_call_original
+
+      client.query_projects(sort_by: 'Id')
+    end
+
+    it 'sends descending in the body' do
+      expect(client).to receive(:post).with(
+        URI('api/Project/Query'), { 'descending' => true }
+      ).and_call_original
+
+      client.query_projects(descending: true)
+    end
+
+    it 'sends conditions in the body' do
+      expect(client).to receive(:post).with(
+        URI('api/Project/Query'), { 'groups' => [{ 'conditions' => [{
+          'parameter' => 'Project Code', 'operator' => 'Is', 'value' => 102
+        }] }] }
+      ).and_call_original
+
+      client.query_projects(conditions: [{
+                              parameter: 'Project Code', operator: 'Is', value: 102
+                            }])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: virtuous
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Taylor Brooks
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-05 00:00:00.000000000 Z
+date: 2024-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: A Ruby wrapper for the Virtuous CRM API
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -63,6 +63,7 @@ files:
 - lib/virtuous/client/gift.rb
 - lib/virtuous/client/gift_designation.rb
 - lib/virtuous/client/individual.rb
+- lib/virtuous/client/project.rb
 - lib/virtuous/client/recurring_gift.rb
 - lib/virtuous/error.rb
 - lib/virtuous/helpers/hash_helper.rb
@@ -82,6 +83,8 @@ files:
 - spec/support/fixtures/gifts.json
 - spec/support/fixtures/import.json
 - spec/support/fixtures/individual.json
+- spec/support/fixtures/project_query_options.json
+- spec/support/fixtures/projects.json
 - spec/support/fixtures/recurring_gift.json
 - spec/support/fixtures_helper.rb
 - spec/support/virtuous_mock.rb
@@ -92,6 +95,7 @@ files:
 - spec/virtuous/resources/gift_designation_spec.rb
 - spec/virtuous/resources/gift_spec.rb
 - spec/virtuous/resources/individual_spec.rb
+- spec/virtuous/resources/project_spec.rb
 - spec/virtuous/resources/recurring_gift_spec.rb
 - spec/virtuous_spec.rb
 - virtuous.gemspec
@@ -100,7 +104,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A Ruby wrapper for the Virtuous CRM API
 test_files: []