virtuous 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9f937cdf43802f0f1a11389e495f22a8dcbbce4899bab8489305b2cd33f70f6
-  data.tar.gz: 76d4f355d36fb2ed6e5bb9cfbc4e4f4fa89b6bb3cc03666fe12ef7699b5784d8
+  metadata.gz: dde636ea3b588b861eb1571600585b5a92f221c427b1de5d0dd5da6019f19906
+  data.tar.gz: c82140d46fe427a713015074ae28c81fa2ef7494cc9a527cd1dac9f129525b69
 SHA512:
-  metadata.gz: eb33edfcd401c81370d6079b9d85d67036e2c27e40cd1d441ae94bc34de34c50b6609e73ccfe6bc323d38bd224d98f4420996e83a85b387956517e20256ba9c9
-  data.tar.gz: f3021bf9fc25965c14e902f68678e41faffb3bad502ff25dd23c06504147aee5ebaa3edc5de33a07a6baf2d09665320b00c4a1c5cdcb2217b922128033483ed4
+  metadata.gz: 408bdd4c97d63495fca22af299e1878ef70ca601428bde15ecc684c59f8d01cb0d3340389de1b4adb77958d6fc9972f2864338d31b729ef1e8db2a3951b3c180
+  data.tar.gz: a917e9353ad30d8ac5f4626dedf67890fa5cbc3123d9559aa0a61475034e7e98faf2e0e45644428326326529392c215c1fb0a91beb3955cdac3ef0ff46c33179

data/.reek.yml

@@ -8,7 +8,7 @@ detectors:
       - "Virtuous::Client#connection"
       - "Virtuous::Client#unauthorized_connection"
       - "Virtuous::HashHelper#self.deep_transform_keys"
-      - "FaradayMiddleware::ParseOj#on_complete"
+      - "Virtuous::FaradayMiddleware::ParseOj#on_complete"
   NilCheck:
     exclude:
       - "Virtuous::Client#initialize"
@@ -22,7 +22,7 @@ detectors:
       - "Virtuous::HashHelper#self.deep_transform_keys"
       - "Virtuous::Client#connection"
       - "Virtuous::Client#unauthorized_connection"
-      - "FaradayMiddleware::VirtuousErrorHandler#on_complete"
+      - "Virtuous::FaradayMiddleware::VirtuousErrorHandler#on_complete"
   ControlParameter:
     exclude:
       - "Virtuous::Client#initialize"

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.
@@ -263,7 +264,7 @@ module Virtuous
         conn.request :json
         conn.response :oj
         conn.response :logger, @logger if @logger
-        conn.use FaradayMiddleware::VirtuousErrorHandler
+        conn.use Virtuous::FaradayMiddleware::VirtuousErrorHandler
         conn.adapter @adapter
         yield(conn) if block_given?
       end

data/lib/virtuous/error.rb

@@ -1,3 +1,5 @@
+require 'faraday'
+
 module Virtuous # :nodoc: all
   class Error < StandardError; end
   class BadGateway < Error; end
@@ -9,46 +11,45 @@ module Virtuous # :nodoc: all
   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
+  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)
+      ##
+      # 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
+        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
-    end
 
-    private
+      private
 
-    def error_message(env)
-      "#{env[:status]}: #{env[:url]} #{env[:body]}"
+      def error_message(env)
+        "#{env[:status]}: #{env[:url]} #{env[:body]}"
+      end
     end
   end
 end

data/lib/virtuous/parse_oj.rb

@@ -1,24 +1,26 @@
 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
+module Virtuous
+  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
+      private
 
-    def empty_body?(body)
-      body.empty? && body == ''
+      def empty_body?(body)
+        body.empty? && body == ''
+      end
     end
   end
 end
 
-Faraday::Response.register_middleware(oj: FaradayMiddleware::ParseOj)
+Faraday::Response.register_middleware(oj: Virtuous::FaradayMiddleware::ParseOj)

data/lib/virtuous/version.rb

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