Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phcdevworks/ruby_api_pack_active_campaign
RubyApiPackActiveCampaign is a Ruby gem designed to simplify interaction with the ActiveCampaign API. This gem offers an easy-to-use interface for managing contacts, lists, and automations within ActiveCampaign.
https://github.com/phcdevworks/ruby_api_pack_active_campaign
activecampaign activecampaign-api api bradpotts ruby ruby-gem ruby-on-rails
Last synced: 5 days ago
JSON representation
RubyApiPackActiveCampaign is a Ruby gem designed to simplify interaction with the ActiveCampaign API. This gem offers an easy-to-use interface for managing contacts, lists, and automations within ActiveCampaign.
- Host: GitHub
- URL: https://github.com/phcdevworks/ruby_api_pack_active_campaign
- Owner: phcdevworks
- License: mit
- Created: 2024-09-25T16:35:42.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-28T03:14:24.000Z (2 months ago)
- Last Synced: 2024-12-25T19:26:35.616Z (10 days ago)
- Topics: activecampaign, activecampaign-api, api, bradpotts, ruby, ruby-gem, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 45.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: FUNDING.yml
- License: MIT-LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# PHCDevworks RubyApiPackCloudways
## Overview
[](https://codecov.io/gh/phcdevworks/ruby_api_pack_active_campaign)
[](https://github.com/phcdevworks/ruby_api_pack_active_campaign/actions/workflows/github-code-scanning/codeql)
RubyApiPackActiveCampaign is a Ruby gem designed to simplify interaction with the ActiveCampaign API. This gem offers an easy-to-use interface for managing contacts, lists, and automations within ActiveCampaign, enabling seamless integration of marketing automation functionality into your Ruby applications. With a modular and extensible design, it allows developers to work with ActiveCampaign resources without handling raw HTTP requests or worrying about low-level API details.
## Key Features:
- **Contact Management**: Easily fetch, create, and update contacts within ActiveCampaign.
- **Contact Lists**: Retrieve lists of contacts or specific contact details using intuitive methods.
- **Resource Fetching**: Use high-level methods to access ActiveCampaign resources with minimal setup.
- **Seamless API Interaction:**: Abstracts complex HTTP requests into simple, reusable Ruby methods.
- **Secure API Configuration**: Manage API tokens and URLs securely through environment variables or configuration blocks.
- **Extensible Design**: Built to support additional ActiveCampaign API resources, making it easy to extend functionality as needed.
- **Error Handling**: Gracefully handle API errors with descriptive messages, ensuring smooth API interactions.
- **RSpec-Ready**: Includes test support and easy-to-mock API responses, facilitating efficient development and testing.
This gem is perfect for Ruby developers looking to integrate ActiveCampaign into their applications, providing essential marketing automation tools with minimal effort.
## Usage
### 1. Set up Active Campaign API credentials
You will need to configure your Active Campaign API credentials in your Ruby environment. Here’s how you can do it:
1. Open your configuration block in the initializer or main application file:
```ruby
RubyApiPackActiveCampaign.configure do |config|
config.ac_api_url = ''
config.ac_api_token = ''
end
```
2. Save and restart your application.
## Installation
Add this line to your application's Gemfile:
```ruby
gem "ruby_api_pack_active_campaign"
```
And then execute:
```bash
$ bundle
```
Or install it yourself as:
```bash
$ gem install ruby_api_pack_active_campaign
```
## Contributing
[](https://github.com/phcdevworks/ruby_api_pack_active_campaign/graphs/contributors)
[](#contributors-)
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
