faithteams-api 4.4.0 → 4.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eebefdf4e9bede5d027923cd5a90d20ee1e127d75108e1ac1fa9959137a17c4
-  data.tar.gz: f9856698e3a8f6121de80db4d0b5d1ec3d650a42fd75e36a22e811ee36173b95
+  metadata.gz: 7094affc4f1e85b777c3c0753bb70419dbfc5fc837026f3eadce7c4e5016fde7
+  data.tar.gz: 23d30acf16c0e1873848e13600ebb7ec5c7224ed30bfa60f5534d08fe429d1d5
 SHA512:
-  metadata.gz: ab0dc289ad48586c3c82db322fdddfde8c35f62e5dc62746a274f792f10552dcd09bb4ee3df932f751c5c05559f96d0f6245cb160ad34c208eae6127cc0dcc89
-  data.tar.gz: e36503ba66dae11eb177f88d102c7a3ff394ca81bcf10b699e486f001bde8267e867892fe2e86b2ae6e14af665e281e67d354c7fbd6974406e8310ad1bda46af
+  metadata.gz: e5821e8131f2a41b8049095e177dd1ef60585d9ee9713e4d3d254e68ca1d87794ee561aa6608d8ccd819faba90828b914eb269bde83676cc06dae1f780405bdb
+  data.tar.gz: d7d99a29756dbd95b214694029f1cd7b35c3a1f42d57a99fc40bcb5ae5fa64b56d25f68af8430c36d1a97eb9274d4dc95dd669fce69ef628baafd1cc28ee657d

data/.github/workflows/editorconfig.yml

@@ -11,11 +11,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 24
       - name: Install editorconfig-checker
         run: npm install --global editorconfig-checker
       - name: Run editorconfig-checker

data/.github/workflows/rubocop.yml

@@ -10,7 +10,7 @@ jobs:
     name: Check
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.github/workflows/rubygems.yml

@@ -25,12 +25,12 @@ jobs:
 
     steps:
       # Set up
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-          ruby-version: ruby
+          ruby-version: 3.3
 
       # Release
       - uses: rubygems/release-gem@v1

data/.github/workflows/tester.yml

@@ -10,7 +10,7 @@ jobs:
     name: Test
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.github/workflows/yard.yml

@@ -10,7 +10,7 @@ jobs:
     name: Check
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/faithteams-api/*.env
 
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -7,6 +7,29 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [4.6.1]
+
+### Changed
+
+1. Use GH actions for Node 24. (ISG-92)
+
+### Fixed
+
+1. Lock rubygems.yml ruby version to 3.3. (ISG-92)
+
+## [4.6.0]
+
+### Changed
+
+1. Relax patch-level dependency pins to minor-level to allow security patch updates. (ISG-92)
+1. Remove transitive dependencies (logger, ostruct, rexml, thor) from gemspec; add rexml and thor as Gemfile security floor constraints. (ISG-92)
+
+## [4.5.0]
+
+### Added
+
+1. Add Bruno API Client (to eventually replace ThunderClient). (IN-2728)
+
 ## [4.4.0]
 
 ### Changed

data/Gemfile

@@ -4,3 +4,8 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in faithteams-api.gemspec
 gemspec
+
+# Security floors for transitive dependencies not declared in the gemspec.
+# These are not upper-bounded — bundle audit is the ongoing security check.
+gem "rexml", ">= 3.4.2" # webmock → crack → rexml
+gem "thor", ">= 1.4.0"  # guard-rspec → guard → thor

data/Gemfile.lock

@@ -1,18 +1,14 @@
 PATH
   remote: .
   specs:
-    faithteams-api (4.4.0)
-      activesupport (~> 7.2.2)
+    faithteams-api (4.6.1)
+      activesupport (~> 7.2)
       http (~> 5.1)
-      logger (~> 1.6.1)
-      ostruct (~> 0.6.0)
-      rexml (~> 3.3.9)
-      thor (~> 1.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.2.2.1)
+    activesupport (7.2.3.1)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -21,34 +17,36 @@ GEM
       drb
       i18n (>= 1.6, < 2)
       logger (>= 1.4.2)
-      minitest (>= 5.1)
+      minitest (>= 5.1, < 6)
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
+    addressable (2.8.9)
+      public_suffix (>= 2.0.2, < 8.0)
     ast (2.4.3)
-    base64 (0.2.0)
-    benchmark (0.4.0)
-    bigdecimal (3.1.8)
+    base64 (0.3.0)
+    benchmark (0.5.0)
+    bigdecimal (4.0.1)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.3.4)
-    connection_pool (2.4.1)
-    crack (1.0.0)
+    concurrent-ruby (1.3.6)
+    connection_pool (3.0.2)
+    crack (1.0.1)
       bigdecimal
       rexml
-    diff-lcs (1.5.1)
+    diff-lcs (1.6.2)
     docile (1.4.1)
     domain_name (0.6.20240107)
-    drb (2.2.1)
-    ffi (1.17.0)
+    drb (2.2.3)
+    ffi (1.17.4)
     ffi-compiler (1.3.2)
       ffi (>= 1.15.5)
       rake
-    formatador (1.1.0)
-    guard (2.19.0)
+    formatador (1.2.3)
+      reline
+    guard (2.20.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
+      logger (~> 1.6)
       lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
@@ -60,67 +58,70 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hashdiff (1.1.2)
-    http (5.2.0)
+    hashdiff (1.2.1)
+    http (5.3.1)
       addressable (~> 2.8)
-      base64 (~> 0.1)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
       llhttp-ffi (~> 0.5.0)
-    http-cookie (1.0.8)
+    http-cookie (1.1.0)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    i18n (1.14.6)
+    i18n (1.14.8)
       concurrent-ruby (~> 1.0)
-    json (2.13.2)
+    io-console (0.8.2)
+    json (2.19.3)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
-    listen (3.9.0)
+    listen (3.10.0)
+      logger
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    llhttp-ffi (0.5.0)
+    llhttp-ffi (0.5.1)
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
-    logger (1.6.3)
-    lumberjack (1.2.10)
+    logger (1.7.0)
+    lumberjack (1.4.2)
     method_source (1.1.0)
-    minitest (5.25.4)
+    minitest (5.27.0)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    ostruct (0.6.1)
     parallel (1.27.0)
-    parser (3.3.9.0)
+    parser (3.3.11.0)
       ast (~> 2.4.1)
       racc
-    prism (1.4.0)
-    pry (0.15.0)
+    prism (1.9.0)
+    pry (0.16.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (6.0.1)
+      reline (>= 0.6.0)
+    public_suffix (7.0.5)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.2.1)
+    rake (13.3.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
-    regexp_parser (2.11.2)
-    rexml (3.3.9)
-    rspec (3.13.0)
+    regexp_parser (2.11.3)
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rexml (3.4.4)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.2)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
-    rubocop (1.73.2)
+    rspec-support (3.13.7)
+    rubocop (1.86.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -128,22 +129,22 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.46.0)
+    rubocop-ast (1.49.1)
       parser (>= 3.3.7.2)
-      prism (~> 1.4)
-    rubocop-performance (1.24.0)
+      prism (~> 1.7)
+    rubocop-performance (1.26.1)
       lint_roller (~> 1.1)
-      rubocop (>= 1.72.1, < 2.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.5.0)
+    rubocop-rspec (3.9.0)
       lint_roller (~> 1.1)
-      rubocop (~> 1.72, >= 1.72.1)
+      rubocop (~> 1.81)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
     shellany (0.0.1)
@@ -151,19 +152,19 @@ GEM
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.13.1)
+    simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
-    thor (1.4.0)
+    thor (1.5.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (3.1.5)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
-    webmock (3.24.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    webmock (3.26.2)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.37)
+    yard (0.9.38)
 
 PLATFORMS
   ruby
@@ -173,14 +174,16 @@ DEPENDENCIES
   faithteams-api!
   guard-rspec (~> 4.7)
   rake (~> 13.0)
+  rexml (>= 3.4.2)
   rspec (~> 3.12)
-  rubocop (~> 1.73.2)
-  rubocop-performance (~> 1.24.0)
-  rubocop-rake (~> 0.7.1)
-  rubocop-rspec (~> 3.5.0)
+  rubocop (~> 1.73)
+  rubocop-performance (~> 1.24)
+  rubocop-rake (~> 0.7)
+  rubocop-rspec (~> 3.5)
   simplecov (~> 0.21)
+  thor (>= 1.4.0)
   webmock (~> 3.18)
-  yard (~> 0.9.36)
+  yard (~> 0.9)
 
 BUNDLED WITH
-   2.5.7
+   2.5.17

data/README.md

@@ -29,6 +29,25 @@ Or install it yourself as:
 
 `gem install faithteams`
 
+## VS Code Bruno Extension
+
+We are now using the [Bruno API Client](https://docs.usebruno.com/introduction/what-is-bruno) for developing and testing 2nd party API requests. You can use a desktop app or VS Code extension to use Bruno.
+
+### Desktop App
+
+1. Simply follow these instructions for your desktop app [installation options](https://docs.usebruno.com/get-started/bruno-basics/download).
+
+### VS Code Extension
+
+1. If you don't already have it, install the VS Code Bruno Extension.
+1. After opening the extension, click the + button to open a "collection".
+    1. Find the root level '[second_party]-api' directory. (ie 'faithteams-api')
+1. Make a copy of the .env.template file (and make sure to just call it .env) and fill in the necessary values from 1Password.
+1. In the left pane, open the ... menu beside faithteams-api and select *settings*.
+1. Select your desired environment to use with this collection in the upper right (most likely *FaithTeams*).
+1. You should now be ready to make some API calls!
+1. See Bruno's [VS Code Extension Documentation](https://docs.usebruno.com/vs-code-extension/overview) for more details.
+
 ## Contributing
 
 ### How to Contribute

data/faithteams-api/.env.template

@@ -0,0 +1,4 @@
+# API V1 & V2
+user_id=
+password=
+user_credentials=<user_id>:<password>

data/faithteams-api/Authenticate.bru

@@ -0,0 +1,25 @@
+meta {
+  name: Authenticate
+  type: http
+  seq: 1
+}
+
+get {
+  url: https://api.faithteams.com/api/v1/authenticate
+  body: none
+  auth: basic
+}
+
+auth:basic {
+  username: {{process.env.user_id}}
+  password: {{process.env.password}}
+}
+
+script:post-response {
+  let body = res.getBody();
+  bru.setEnvVar("auth_token", body.data.token);
+}
+
+settings {
+  encodeUrl: true
+}

data/faithteams-api/api-v2.faithteams.com/Batch/Batch Create.bru

@@ -0,0 +1,23 @@
+meta {
+  name: Batch Create
+  type: http
+  seq: 3
+}
+
+post {
+  url: https://api-v2.faithteams.com/batches
+  body: json
+  auth: inherit
+}
+
+body:json {
+  {
+    "title":"Tithely 2023-07-19 Bank",
+    "dtm":"2023-07-19 00:00:00",
+    "status":"O"
+  }
+}
+
+settings {
+  encodeUrl: true
+}

data/faithteams-api/api-v2.faithteams.com/Batch/Batch Totals.bru

@@ -0,0 +1,19 @@
+meta {
+  name: Batch Totals
+  type: http
+  seq: 4
+}
+
+get {
+  url: https://api-v2.faithteams.com/batches/totals?batchIds={{batch_id}},{{batch_id_2}}
+  body: none
+  auth: inherit
+}
+
+params:query {
+  batchIds: {{batch_id}},{{batch_id_2}}
+}
+
+settings {
+  encodeUrl: true
+}

data/faithteams-api/api-v2.faithteams.com/Batch/Batch Update.bru

@@ -0,0 +1,27 @@
+meta {
+  name: Batch Update
+  type: http
+  seq: 5
+}
+
+put {
+  url: https://api-v2.faithteams.com/batches/{{batch_id}}
+  body: json
+  auth: inherit
+}
+
+body:json {
+  {
+      "orgId": {{organization_id}},
+      "status": "D",
+      "title": "Tithely 2023-07-19 Bank",
+      "dtm": "2023-07-19 00:00:00",
+      "updatedDtm": "2023-08-28 23:45:44",
+      "updatedUser": 27985,
+      "contributions": []
+  }
+}
+
+settings {
+  encodeUrl: true
+}

data/faithteams-api/api-v2.faithteams.com/Batch/Batch.bru

@@ -0,0 +1,15 @@
+meta {
+  name: Batch
+  type: http
+  seq: 2
+}
+
+get {
+  url: https://api-v2.faithteams.com/batches/{{batch_id}}
+  body: none
+  auth: inherit
+}
+
+settings {
+  encodeUrl: true
+}

data/faithteams-api/api-v2.faithteams.com/Batch/Batches.bru

@@ -0,0 +1,32 @@
+meta {
+  name: Batches
+  type: http
+  seq: 1
+}
+
+get {
+  url: https://api-v2.faithteams.com/batches?sort=dtm&sortDirection=desc&dtm=2023-08-28
+  body: none
+  auth: inherit
+}
+
+params:query {
+  sort: dtm
+  sortDirection: desc
+  dtm: 2023-08-28
+  ~status: O
+  ~title: 2023-08-28 Central Campus Tithely Card
+  ~limit:
+  ~start:
+  ~batchIds: 200782
+}
+
+script:post-response {
+  let body = res.getBody();
+  bru.setEnvVar("batch_id", String(body.data[0].batchId));
+  bru.setEnvVar("batch_id_2", String(body.data[1].batchId));
+}
+
+settings {
+  encodeUrl: true
+}

data/faithteams-api/api-v2.faithteams.com/Batch/folder.bru

@@ -0,0 +1,8 @@
+meta {
+  name: Batch
+  seq: 1
+}
+
+auth {
+  mode: inherit
+}

data/faithteams-api/api-v2.faithteams.com/Contribution/Contribution Create.bru

@@ -0,0 +1,40 @@
+meta {
+  name: Contribution Create
+  type: http
+  seq: 3
+}
+
+post {
+  url: https://api-v2.faithteams.com/contributions
+  body: json
+  auth: inherit
+}
+
+body:json {
+  [
+    {
+      "recordType":"H",
+      "personId":779137,
+      "batchId":195770,
+      "amount":"100.00",
+      "fee":"2.00",
+      "netAmount":"98.00",
+      "contributionTypeId":24,
+      "status":"A",
+      "note":"Date: 2023-07-17, Method: card, Memo: for the animals"
+    },
+    {
+      "recordType":"D",
+      "fundId":7894,
+      "personId":779137,
+      "batchId":195770,
+      "amount":"100.00",
+      "fee":"2.00",
+      "netAmount":"98.00"
+    }
+  ]
+}
+
+settings {
+  encodeUrl: true
+}

data/faithteams-api/api-v2.faithteams.com/Contribution/Contribution.bru

@@ -0,0 +1,15 @@
+meta {
+  name: Contribution
+  type: http
+  seq: 2
+}
+
+get {
+  url: https://api-v2.faithteams.com/contributions/{{contribution_parent_id}}
+  body: none
+  auth: inherit
+}
+
+settings {
+  encodeUrl: true
+}

data/faithteams-api/api-v2.faithteams.com/Contribution/Contributions.bru

@@ -0,0 +1,34 @@
+meta {
+  name: Contributions
+  type: http
+  seq: 1
+}
+
+get {
+  url: https://api-v2.faithteams.com/contributions?startDt=1923-01-01&endDt=2033-01-01&resultType=sum&statuses=A
+  body: none
+  auth: inherit
+}
+
+params:query {
+  startDt: 1923-01-01
+  endDt: 2033-01-01
+  resultType: sum
+  statuses: A
+  ~filters: true
+  ~personIds: 769839
+  ~groupBy: personId,fundId
+  ~limit: 500
+  ~sort: dtm
+  ~sortDirection: asc
+}
+
+script:post-response {
+  let body = res.getBody();
+  bru.setEnvVar("contribution_id", String(body.data[0].contributionId));
+  bru.setEnvVar("contribution_parent_id", String(body.data[0].parentId));
+}
+
+settings {
+  encodeUrl: true
+}

data/faithteams-api/api-v2.faithteams.com/Contribution/folder.bru

@@ -0,0 +1,8 @@
+meta {
+  name: Contribution
+  seq: 3
+}
+
+auth {
+  mode: inherit
+}

data/faithteams-api/api-v2.faithteams.com/Contribution Type/Contribution Type.bru

@@ -0,0 +1,15 @@
+meta {
+  name: Contribution Type
+  type: http
+  seq: 2
+}
+
+get {
+  url: https://api-v2.faithteams.com/contributiontypes/{{contribution_type_id}}
+  body: none
+  auth: inherit
+}
+
+settings {
+  encodeUrl: true
+}