virtuous 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9f937cdf43802f0f1a11389e495f22a8dcbbce4899bab8489305b2cd33f70f6
-  data.tar.gz: 76d4f355d36fb2ed6e5bb9cfbc4e4f4fa89b6bb3cc03666fe12ef7699b5784d8
+  metadata.gz: 21706d887ab7c6356cf12b521724170cd196d432d73bca548d678240f593a0c7
+  data.tar.gz: 79702a4ff37002499687c5eb6d2bd52d5b5ca719ad7654a0d40ed4213af7e6a5
 SHA512:
-  metadata.gz: eb33edfcd401c81370d6079b9d85d67036e2c27e40cd1d441ae94bc34de34c50b6609e73ccfe6bc323d38bd224d98f4420996e83a85b387956517e20256ba9c9
-  data.tar.gz: f3021bf9fc25965c14e902f68678e41faffb3bad502ff25dd23c06504147aee5ebaa3edc5de33a07a6baf2d09665320b00c4a1c5cdcb2217b922128033483ed4
+  metadata.gz: cd02d1df0306c1d7c575e8dc4c782f9047599b3eb0c3820b09fc240ccaa49a708c9310115b993e8f00041069442565770beb57b744ef8c2be8f11c7bae36523d
+  data.tar.gz: 25c7401a3029d7d5796a416b07081a921b33d34cadb31c9a091e6f4276d6939f49a90b61f0743d8fd76795960e777c55ae019cc1adc218a3462db0853b65838a

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Method to query projects
+
 ## [0.0.2] - 2024-01-04
 
 ### Added

data/lib/virtuous/client/project.rb

@@ -0,0 +1,58 @@
+module Virtuous
+  class Client
+    module Project
+      ##
+      # Queries a list of available project query options.
+      # @return [Hash] A list of available project query options.
+      def project_query_options
+        parse(get('api/Project/QueryOptions'))
+      end
+
+      ##
+      # Queries projects.
+      #
+      # @example
+      #      client.query_projects(
+      #        take: 5, skip: 0, sort_by: 'Id',
+      #        conditions: [{ parameter: 'Project Code', operator: 'Is', value: 102 }]
+      #      )
+      #
+      # @option options [Integer] :take The maximum amount of projects to query. Default: 10.
+      #   Max is 1000.
+      # @option options [Integer] :skip The number of projects to skip. Default: 0.
+      # @option options [String] :sort_by The value to sort records by.
+      # @option options [Boolean] :descending If true the records will be sorted in descending
+      #   order.
+      # @option options [Array] :conditions An array of conditions to filter the project.
+      #   Use {project_query_options} to see
+      #   a full list of available conditions.
+      #
+      # @return [Hash] A hash with a list and the total amount of projects that satisfy
+      #   the conditions.
+      # @example Output
+      #     { list: [...], total: n }
+      #
+      def query_projects(**options)
+        uri = URI('api/Project/Query')
+        query_params = options.slice(:take, :skip)
+        uri.query = URI.encode_www_form(query_params) unless query_params.empty?
+
+        parse(post(uri, format(query_projects_body(options))))
+      end
+
+      private
+
+      def query_projects_body(options)
+        conditions = options[:conditions]
+        body = options.slice(:sort_by, :descending)
+        return body if conditions.nil?
+
+        body.merge({
+                     groups: [{
+                       conditions: conditions
+                     }]
+                   })
+      end
+    end
+  end
+end

data/lib/virtuous/client.rb

@@ -75,6 +75,7 @@ module Virtuous
     include Gift
     include RecurringGift
     include GiftDesignation
+    include Project
 
     ##
     # Access token used for OAuth authentication.

data/lib/virtuous/version.rb

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