FaithTeams API

FaithTeams API client gem for use with FaithTeams API. See FaithTeams API Documentation for more information.

Overview and Purpose

It provides a wrapper around the FaithTeams API and includes the following collection of classes and methods for each API version that can be used to interact with the FaithTeams API:

• FaithTeams::API::V*::Connection - Takes FaithTeams credentials (user_id and password) and is responsible for:
  • establishing and validating a connection to the FaithTeams API
  • providing the underlying methods used by the various API resources to make specific API calls.
  • handling request errors.
• FaithTeams::API::V*::Gateway - Takes a FaithTeams::Connection and is responsible for providing a collection of API resources.
• FaithTeams::API::V*::Resource - Provides CRUD functionality for each resource.
• FaithTeams::API::V*::Error::* - All necessary errors.
• FaithTeams::API::V*::Entity::* - All necessary entities.

Installation

Add this line to your application's Gemfile:

gem "faithteams"

And then execute:

bundle install

Or install it yourself as:

gem install faithteams

Contributing

How to Contribute

1. Adhere to the Code of Conduct
2. Fork the project.
3. Create a new branch for your feature: git checkout -b feature-name.
4. Commit your changes: git commit -m 'Add new feature'. Please reference a GitHub issue if applicable. See linking a pull request to an issue. Please be sure to include an appropriate entry in the CHANGELOG.md.
5. Push to your branch: git push origin feature-name.
6. Open a pull request. Please add information about why this is necessary, citing specific examples if possible.

Code of Conduct

This project has a Code of Conduct. Please read through this document and ensure compliance before contributing.

Contributor Guidelines

Contributions should adhere to the API Client Gateway Resource Interface. Additional API endpoints should be added to the Thunder Client Collection with appropriate tests included.

Testing

To run the tests in the gem: bundle exec rspec

To run a specific test, use a pattern: bundle exec rspec -P "**/contribution_spec.rb"

Use the Thunder Client extension for VS Code to test/inspect API calls.

Gem Publishing

General instructions for publishing a gem are available in this RubyGems guide.

Once a gem is ready to be published:

1. Create a PR to merge master into production
2. After merge, create a release on the production branch
3. The GitHub Action rubygems.yml will publish the gem to RubyGems.

License

This project is licensed under the MIT License.

Contact and Bug Reports

You can contact the project maintainers or file a bug report through GitHub Issues on this repository. Please provide complete details so that your question or issue may be resolved as soon as possible.

Project Status

This project is being actively maintained and is stable for production use.

Tithe.ly

With tools like text and email messaging, custom church apps and websites, church management software, and digital giving, Tithe.ly provides the tools you need to engage with your church online, stay connected, increase generosity, and simplify the lives of your staff.