virtuous 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c435c6a389b27d1644f8fa32d0df952aa9bcb83baf152973c8e2f55b0b418a1
-  data.tar.gz: 13075eb9634a01b1597c6a8be58444b1ec89738efe8842b124e4e640237163a4
+  metadata.gz: 21706d887ab7c6356cf12b521724170cd196d432d73bca548d678240f593a0c7
+  data.tar.gz: 79702a4ff37002499687c5eb6d2bd52d5b5ca719ad7654a0d40ed4213af7e6a5
 SHA512:
-  metadata.gz: 720aaf08ccabd9f7d1b7da3b07b4d028646c910c32605d85c4fe915050799eec9880b70f377674af848af13cab25fe18e92c3c6f460393499739188d5010ed29
-  data.tar.gz: 8b65f36c8bef728c092210f0448769b2d581d445755ca35d23eea6d1ae9e624bc9bad1602fa5edc4f0f45ac9920cf5f6c02b5877f07444366133422f9457d4bf
+  metadata.gz: cd02d1df0306c1d7c575e8dc4c782f9047599b3eb0c3820b09fc240ccaa49a708c9310115b993e8f00041069442565770beb57b744ef8c2be8f11c7bae36523d
+  data.tar.gz: 25c7401a3029d7d5796a416b07081a921b33d34cadb31c9a091e6f4276d6939f49a90b61f0743d8fd76795960e777c55ae019cc1adc218a3462db0853b65838a

data/.github/workflows/publish.yml

@@ -0,0 +1,23 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read # to checkout the code (actions/checkout)
+jobs:
+  build:
+    name: Publish to Rubygems
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Publish to RubyGems
+        uses: dawidd6/action-publish-gem@v1
+        with:
+          api_key: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/CHANGELOG.md

@@ -9,10 +9,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Method to query projects
+
+## [0.0.2] - 2024-01-04
+
+### Added
+
 - A Client class with support for api key and OAuth authentication
 - Methods to find, create and update contacts
 - Methods to find, create, update and delete individuals
 - Methods to find, create, update and delete gifts
 - Method query gift designations
 
-[unreleased]: https://github.com/taylorbrooks/virtuous/compare/v0.0.0...HEAD
+[unreleased]: https://github.com/taylorbrooks/virtuous/compare/v0.0.2...HEAD

data/README.md

@@ -14,7 +14,7 @@ Add this line to your application's Gemfile:
 
 ```ruby
   # in your Gemfile
-  gem 'virtuous', '~> 0.0.1'
+  gem 'virtuous', '~> 0.0.2'
 
   # then...
   bundle install

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.1'
+  VERSION = '0.0.3'
 end