faithteams-api 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cc2b7c415987619e7ebcc699f37790daeb0c7c730904c6a42fd6433a7fe72cb
-  data.tar.gz: 2cb6331d07e910eeb623c5274f6e3737a335a0be39c6c1c1a68efb2badada2fe
+  metadata.gz: '01586c73ee318708383bb14df2011145b83ca9ec382ddf0cfe2ebc49cee3fac3'
+  data.tar.gz: 4a0c59dbc8428336ae1e286571679492756a8fb72aa6caec286d5d5cbf5c5d77
 SHA512:
-  metadata.gz: 057231fb75f6b1f0bb493698abbd877fbf137c38b8ed43dbbf746ef7a7d04e477fbfd615b09aa3d3d4915ebd70cc4f51817c1849f6e93385a9c1809660eb6936
-  data.tar.gz: 5b18767dbed31ac0d292c29819834fa7e367ee242243487c992e6c3f32be1da7a9956a8eb660cddc1b7586747c3eab9ccfc1f6c5b91ffb066c7df6fcf15ce395
+  metadata.gz: b702bc6fb5800697729f51a0bed56bbf6840f2d24f8da7dd9c3a9df1e32940e1e9d96155ba124f30ec1bc1cbceee3a80b9b0be1a702dd607d8298c3f90c76c79
+  data.tar.gz: 3a0380ff6826f18fcd405af6bd9bf3c0d0478bbf479cfc65f17182f620986a115564eb14ee9449276ae2d75d143e85f9728a84b037abe79c4d4f141034a3f072

data/.github/workflows/editorconfig.yml

@@ -0,0 +1,23 @@
+name: EditorConfig
+
+on:
+  pull_request:
+    types: [ opened, reopened, synchronize ]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Install editorconfig-checker
+        run: npm install --global editorconfig-checker
+      - name: Run editorconfig-checker
+        run: |
+          editorconfig-checker -verbose -exclude "(thunder-tests|Gemfile.lock|.csv)"

data/.github/workflows/rubocop.yml

@@ -0,0 +1,21 @@
+name: Rubocop
+
+on:
+  pull_request:
+    types: [ opened, reopened, synchronize ]
+  workflow_dispatch:
+
+jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+    - name: Install dependencies
+      run: bundle install
+    - name: Run Rubocop
+      run: bundle exec rubocop --parallel

data/.github/workflows/rubygems.yml

@@ -0,0 +1,36 @@
+# Builds and pushes a gem to RubyGems.
+name: RubyGems
+
+on:
+  pull_request:
+    # Only on the production branch
+    branches:
+      - production
+    # Only when closed
+    types:
+      - closed
+  workflow_dispatch:
+
+jobs:
+  push:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      id-token: write
+
+    # If you configured a GitHub environment on RubyGems, you must use it here.
+    environment: release
+
+    steps:
+      # Set up
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Release
+      - uses: rubygems/release-gem@v1

data/.github/workflows/tester.yml

@@ -0,0 +1,21 @@
+name: Tester
+
+on:
+  pull_request:
+    types: [ opened, reopened, synchronize ]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.github/workflows/yard.yml

@@ -0,0 +1,21 @@
+name: Yard
+
+on:
+  pull_request:
+    types: [ opened, reopened, synchronize ]
+  workflow_dispatch:
+
+jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+    - name: Install dependencies
+      run: bundle install
+    - name: Run Yard
+      run: bundle exec yard stats --list-undoc --fail-on-warning

data/CHANGELOG.md

@@ -7,11 +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).
 
-## [Unreleased]
+## [3.0.0] - 2024-05-20 -
+
+### Fixed
+
+1. Use basic auth for all API requests and remove User. (IN-2429)
+
+### Removed
+
+1. Remove `Resource::User` and `Resource::User#authenticate`. (IN-2429)
+
+## [2.0.2] - 2024-04-04 - https://github.com/tithely/faithteams-api/pull/5
+
+### Fixed
+
+1. Fixed gemspec metadata urls. (IN-2229)
+1. Update gem dependencies.
+1. Replace `jeweler.yml` Github Action with `rubygems.yml`.
+
+## [2.0.1] - 2024-04-03
 
 ### Changed
 
-1. *BREAKING CHANGE* Allowed for newer versions of ActiveSupport for use in projects that are targeting a higher version of Rails.
+1. Published to RubyGems. (IN-2229)
 
 ## [1.1.0] - 2023-11-01
 

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    faithteams-api (2.0.1)
+    faithteams-api (3.0.0)
       activesupport (>= 6.1.7)
       http (~> 5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3)
+    activesupport (7.1.3.2)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -22,22 +22,21 @@ GEM
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.6)
+    bigdecimal (3.1.7)
     byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
-    crack (0.4.6)
+    crack (1.0.0)
       bigdecimal
       rexml
     diff-lcs (1.5.1)
     docile (1.4.0)
     domain_name (0.6.20240107)
-    drb (2.2.0)
-      ruby2_keywords
+    drb (2.2.1)
     ffi (1.16.3)
-    ffi-compiler (1.0.1)
-      ffi (>= 1.0.0)
+    ffi-compiler (1.3.2)
+      ffi (>= 1.15.5)
       rake
     formatador (1.1.0)
     guard (2.18.1)
@@ -64,11 +63,11 @@ GEM
     http-cookie (1.0.5)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    i18n (1.14.1)
+    i18n (1.14.4)
       concurrent-ruby (~> 1.0)
     json (2.7.1)
     language_server-protocol (3.17.0.3)
-    listen (3.8.0)
+    listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     llhttp-ffi (0.5.0)
@@ -76,7 +75,7 @@ GEM
       rake (~> 13.0)
     lumberjack (1.2.10)
     method_source (1.0.0)
-    minitest (5.22.1)
+    minitest (5.22.3)
     mutex_m (0.2.0)
     nenv (0.3.0)
     notiffany (0.1.3)
@@ -89,10 +88,10 @@ GEM
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (5.0.4)
+    public_suffix (5.0.5)
     racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.1.0)
+    rake (13.2.0)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -110,8 +109,8 @@ GEM
     rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.0)
-    rubocop (1.60.2)
+    rspec-support (3.13.1)
+    rubocop (1.62.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -119,20 +118,19 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-performance (1.20.2)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-performance (1.21.0)
       rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
     rubocop-rspec (1.42.0)
       rubocop (>= 0.87.0)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
     shellany (0.0.1)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -140,15 +138,15 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    thor (1.3.0)
+    thor (1.3.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
-    webmock (3.20.0)
+    webmock (3.23.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.34)
+    yard (0.9.36)
 
 PLATFORMS
   ruby
@@ -168,4 +166,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.4.13
+   2.5.7

data/README.md

@@ -60,9 +60,7 @@ Use the Thunder Client extension for VS Code to test/inspect API calls.
 
 General instructions for publishing a gem are available in this [RubyGems guide](https://guides.rubygems.org/publishing/#publishing-to-rubygemsorg).
 
-1. Make sure you have a [RubyGems account](https://rubygems.org/sign_in).
-1. Ensure the gem can be built and is at the correct version number: `bundle exec rake install`
-1. Publish the gem `gem push pkg/faithteams-api-2.0.0.gem
+Once a gem is ready to be published, a release can be made and [the GitHub Action](https://guides.rubygems.org/trusted-publishing/releasing-gems/) [rubygems.yml](./.github/workflows/rubygems.yml) will publish the gem to RubyGems.
 
 ## License
 

data/faithteams-api.gemspec

@@ -18,8 +18,10 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/tithely/faithteams-api"
-  spec.metadata["changelog_uri"] = "https://github.com/tithely/faithteams-api/blob/master/doc/CHANGELOG.md"
   spec.metadata["github_repo"] = "https://github.com/tithely/faithteams-api"
+  spec.metadata["changelog_uri"] = "https://github.com/tithely/faithteams-api/blob/master/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/tithely/faithteams-api/issues"
+  spec.metadata["documentation_uri"] = "https://github.com/tithely/faithteams-api/blob/master/README.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/faithteams/api/v2/connection.rb

@@ -10,7 +10,6 @@ module FaithTeams
       class Connection
         # Specific base urls for different resources
         ENDPOINT_BASE_URLS = {
-          "authenticate" => "https://app.faithteams.com/api/v2",
           "batches" => "https://api-v2.faithteams.com",
           "contributions" => "https://api-v2.faithteams.com",
           "contributiontypes" => "https://api-v2.faithteams.com",
@@ -77,8 +76,6 @@ module FaithTeams
               response = http.get(url, params: params)
             end
             break if response.status != 401 || retries >= 2
-
-            authenticate
           end
 
           raise Error::Request.new(response: response, message: "Request unsuccessful (#{response.status})") unless response.status.success?
@@ -116,7 +113,7 @@ module FaithTeams
 
         # @return [HTTP::Client]
         def http
-          @http ||= HTTP.headers("Token" => "#{auth_token}")
+          @http ||= HTTP.basic_auth(user: user_id, pass: password)
         end
 
         # @param path [String]
@@ -124,18 +121,6 @@ module FaithTeams
         def base_url(path:)
           ENDPOINT_BASE_URLS[path.split("/")[1]]
         end
-
-        # Set the auth_token for these requests
-        # @return [String]
-        def auth_token
-          @auth_token ||= user_resource.authenticate
-        end
-
-        # Resets existing auth_token and re-authenticates
-        def authenticate
-          @auth_token = nil
-          auth_token
-        end
       end
     end
   end

data/lib/faithteams/api/v2/gateway.rb

@@ -32,11 +32,6 @@ module FaithTeams
           @contribution ||= Resource::Contribution.new(connection: connection)
         end
 
-        # @return [Resource::User]
-        def user
-          @user ||= Resource::User.new(connection: connection)
-        end
-
         # @return [Resource::ContributionType]
         def contribution_type
           @contribution_type ||= Resource::ContributionType.new(connection: connection)

data/lib/faithteams/api/v2/resource.rb

@@ -5,7 +5,6 @@ require_relative "resource/batch"
 require_relative "resource/fund"
 require_relative "resource/person"
 require_relative "resource/contribution"
-require_relative "resource/user"
 require_relative "resource/contribution_type"
 
 module FaithTeams

data/lib/faithteams/version.rb

@@ -2,5 +2,5 @@
 
 module FaithTeams
   # Current version number.
-  VERSION = "2.0.1"
+  VERSION = "3.0.0"
 end