ruby_api_pack_active_campaign 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.all-contributorsrc +23 -0
- data/.circleci/config.yml +44 -0
- data/.claude/settings.json +36 -0
- data/.claude/settings.local.json +36 -0
- data/.coderabbit.yaml +75 -0
- data/.codex/README.md +32 -0
- data/.codex/change-watch.md +17 -0
- data/.codex/release-readiness.md +30 -0
- data/.editorconfig +22 -0
- data/.rspec +3 -0
- data/.rubocop.yml +71 -0
- data/AGENTS.md +107 -0
- data/CHANGELOG.md +140 -0
- data/CLAUDE.md +91 -0
- data/CODEX.md +63 -0
- data/CODE_OF_CONDUCT.md +132 -0
- data/CONTRIBUTING.md +118 -0
- data/COPILOT.md +29 -0
- data/FUNDING.yml +1 -0
- data/JULES.md +33 -0
- data/MIT-LICENSE +21 -0
- data/README.md +270 -0
- data/ROADMAP.md +40 -0
- data/Rakefile +12 -0
- data/SECURITY.md +43 -0
- data/TODO.md +31 -0
- data/lib/ruby_api_pack_active_campaign/api/ac_contacts.rb +145 -0
- data/lib/ruby_api_pack_active_campaign/configuration.rb +12 -0
- data/lib/ruby_api_pack_active_campaign/connection/ac_connect.rb +15 -0
- data/lib/ruby_api_pack_active_campaign/version.rb +5 -0
- data/lib/ruby_api_pack_active_campaign.rb +15 -0
- data/ruby_api_pack_active_campaign.code-workspace +8 -0
- data/sig/ruby_api_pack_active_campaign.rbs +4 -0
- metadata +99 -0
data/CLAUDE.md
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# CLAUDE.md - Ruby API Pack ActiveCampaign
|
|
2
|
+
|
|
3
|
+
## Project Identity
|
|
4
|
+
|
|
5
|
+
**Gem:** `ruby_api_pack_active_campaign`
|
|
6
|
+
**Owner:** PHCDevworks
|
|
7
|
+
**Primary implementation agent:** Claude Code
|
|
8
|
+
|
|
9
|
+
This repository is a Ruby gem that wraps ActiveCampaign API calls for
|
|
10
|
+
PHCDevworks applications. This file is the implementation guide for Claude Code.
|
|
11
|
+
Read `AGENTS.md` first for shared agent boundaries.
|
|
12
|
+
|
|
13
|
+
This gem depends on `ruby_api_pack_core` for its connection wrapper base class
|
|
14
|
+
(`RubyApiPackCore::Connection::Base`), response validator
|
|
15
|
+
(`RubyApiPackCore::Handlers::ResponseValidator`), and configuration mixin
|
|
16
|
+
(`RubyApiPackCore::Configurable`). Shared HTTP plumbing belongs upstream in
|
|
17
|
+
`ruby_api_pack_core`, not duplicated here — see that repo's own `CLAUDE.md`
|
|
18
|
+
before changing anything that looks like generic request/response handling.
|
|
19
|
+
|
|
20
|
+
## Commit Policy
|
|
21
|
+
|
|
22
|
+
Claude Code does not create commits in this repository unless explicitly asked.
|
|
23
|
+
Prepare changes, run validation, and leave commit, tag, push, and release
|
|
24
|
+
authority to the human maintainer.
|
|
25
|
+
|
|
26
|
+
## Development Workflow
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
bundle install
|
|
30
|
+
bundle exec rspec
|
|
31
|
+
bundle exec rubocop
|
|
32
|
+
gem build ruby_api_pack_active_campaign.gemspec
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Ruby Gem Contract
|
|
36
|
+
|
|
37
|
+
The public behavior surface is:
|
|
38
|
+
|
|
39
|
+
- `lib/ruby_api_pack_active_campaign.rb`
|
|
40
|
+
- `lib/ruby_api_pack_active_campaign/configuration.rb`
|
|
41
|
+
- `lib/ruby_api_pack_active_campaign/connection/ac_connect.rb`
|
|
42
|
+
- `lib/ruby_api_pack_active_campaign/api/ac_contacts.rb`
|
|
43
|
+
- `README.md`
|
|
44
|
+
|
|
45
|
+
Configuration, connection, API helper, and response behavior changes require
|
|
46
|
+
matching specs and a changelog entry.
|
|
47
|
+
|
|
48
|
+
## Implementation Rules
|
|
49
|
+
|
|
50
|
+
1. Keep HTTParty calls inside the connection wrapper, which subclasses
|
|
51
|
+
`RubyApiPackCore::Connection::Base` — implement only `#auth_headers` there,
|
|
52
|
+
do not reimplement URL building, status handling, or JSON parsing locally.
|
|
53
|
+
2. Keep API URL and token assumptions configurable through
|
|
54
|
+
`RubyApiPackActiveCampaign.configure`.
|
|
55
|
+
3. Preserve helper method names unless the change is intentionally breaking.
|
|
56
|
+
4. Keep request payloads aligned with ActiveCampaign's documented API shapes.
|
|
57
|
+
5. Avoid broad refactors unless they directly support the requested change.
|
|
58
|
+
6. Do not expose API tokens, production account URLs, contact data, request
|
|
59
|
+
payloads, or sensitive response bodies in logs, fixtures, docs, or test
|
|
60
|
+
output.
|
|
61
|
+
7. If a change requires modifying shared HTTP behavior (URL building, status
|
|
62
|
+
handling, JSON parsing, response validation, or the `configure` pattern),
|
|
63
|
+
make that change in `ruby_api_pack_core` instead, and coordinate the
|
|
64
|
+
version bump here.
|
|
65
|
+
|
|
66
|
+
## Testing Expectations
|
|
67
|
+
|
|
68
|
+
- Configuration changes need direct configuration specs.
|
|
69
|
+
- Connection changes need specs for HTTP verb, headers, body, response parsing,
|
|
70
|
+
and error behavior.
|
|
71
|
+
- API helper changes need delegation specs that verify endpoint path, verb, and
|
|
72
|
+
payload handling.
|
|
73
|
+
- Security-sensitive changes should include both success and failure coverage.
|
|
74
|
+
|
|
75
|
+
## Documentation Expectations
|
|
76
|
+
|
|
77
|
+
Update:
|
|
78
|
+
|
|
79
|
+
- `README.md` for public installation, configuration, endpoint, or usage
|
|
80
|
+
changes.
|
|
81
|
+
- `CHANGELOG.md` for every behavior-impacting change.
|
|
82
|
+
- `SECURITY.md` when security reporting or guidance changes.
|
|
83
|
+
- AI docs when agent workflows or authority boundaries change.
|
|
84
|
+
|
|
85
|
+
## Release Procedure
|
|
86
|
+
|
|
87
|
+
1. Update `lib/ruby_api_pack_active_campaign/version.rb`.
|
|
88
|
+
2. Move changelog notes from `[Unreleased]` into a dated version section.
|
|
89
|
+
3. Run `bundle exec rspec`.
|
|
90
|
+
4. Run `bundle exec rubocop`.
|
|
91
|
+
5. Build and publish only when the maintainer explicitly approves.
|
data/CODEX.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# CODEX.md - Ruby API Pack ActiveCampaign
|
|
2
|
+
|
|
3
|
+
## Role
|
|
4
|
+
|
|
5
|
+
Codex owns documentation standardization, release readiness, repo hygiene,
|
|
6
|
+
production stabilization, and configuration consistency for this Ruby gem.
|
|
7
|
+
Claude Code leads implementation changes. Human maintainers own final commit,
|
|
8
|
+
merge, tag, publish, and release decisions.
|
|
9
|
+
|
|
10
|
+
## Default Workflow
|
|
11
|
+
|
|
12
|
+
1. Inspect the current working tree and preserve unrelated local changes.
|
|
13
|
+
2. Read the relevant source, specs, and docs before editing.
|
|
14
|
+
3. Make focused changes using existing Ruby and RSpec patterns.
|
|
15
|
+
4. Update README, changelog, and AI docs when public guidance changes.
|
|
16
|
+
5. Run `bundle exec rspec` and `bundle exec rubocop` when feasible.
|
|
17
|
+
6. Build with `gem build ruby_api_pack_active_campaign.gemspec` when packaging
|
|
18
|
+
or release metadata changed.
|
|
19
|
+
7. Report any validation that could not be run.
|
|
20
|
+
|
|
21
|
+
## Documentation Scope
|
|
22
|
+
|
|
23
|
+
Codex may update:
|
|
24
|
+
|
|
25
|
+
- `README.md`
|
|
26
|
+
- `CONTRIBUTING.md`
|
|
27
|
+
- `SECURITY.md`
|
|
28
|
+
- `CODE_OF_CONDUCT.md`
|
|
29
|
+
- `CHANGELOG.md`
|
|
30
|
+
- `ROADMAP.md`
|
|
31
|
+
- `TODO.md`
|
|
32
|
+
- `AGENTS.md`, `CLAUDE.md`, `CODEX.md`, `COPILOT.md`, `JULES.md`
|
|
33
|
+
- `.github/` templates and assistant instructions
|
|
34
|
+
- `.codex/` workspace notes
|
|
35
|
+
|
|
36
|
+
## Review Scope
|
|
37
|
+
|
|
38
|
+
When reviewing changes, Codex checks:
|
|
39
|
+
|
|
40
|
+
1. Configuration, connection, and API helper behavior drift.
|
|
41
|
+
2. Missing RSpec coverage for ActiveCampaign helper changes.
|
|
42
|
+
3. ActiveCampaign API tokens, production account URLs, contact data, request
|
|
43
|
+
payloads, or sensitive response bodies exposed in docs, logs, fixtures, or
|
|
44
|
+
examples.
|
|
45
|
+
4. Inconsistent response parsing or error behavior.
|
|
46
|
+
5. README or changelog drift from the public behavior surface.
|
|
47
|
+
6. CI and release workflow mismatch with documented commands.
|
|
48
|
+
|
|
49
|
+
## Validation Commands
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
bundle exec rspec
|
|
53
|
+
bundle exec rubocop
|
|
54
|
+
gem build ruby_api_pack_active_campaign.gemspec
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Hard Limits
|
|
58
|
+
|
|
59
|
+
- Do not publish the gem unless explicitly asked.
|
|
60
|
+
- Do not create commits, tags, or releases unless explicitly asked.
|
|
61
|
+
- Do not overwrite unrelated local changes.
|
|
62
|
+
- Do not add real credentials, ActiveCampaign API tokens, production account
|
|
63
|
+
URLs, contact data, or sensitive payloads to documentation or tests.
|
data/CODE_OF_CONDUCT.md
ADDED
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
10
|
+
identity and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
14
|
+
|
|
15
|
+
## Our Standards
|
|
16
|
+
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
19
|
+
|
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
+
community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
29
|
+
|
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or advances of
|
|
31
|
+
any kind
|
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
+
* Public or private harassment
|
|
34
|
+
* Publishing others' private information, such as a physical or email address,
|
|
35
|
+
without their explicit permission
|
|
36
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
38
|
+
|
|
39
|
+
## Enforcement Responsibilities
|
|
40
|
+
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
45
|
+
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official email address,
|
|
56
|
+
posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
58
|
+
|
|
59
|
+
## Enforcement
|
|
60
|
+
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to the community leaders responsible for enforcement at
|
|
63
|
+
development@phcdevworks.com.
|
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
+
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
68
|
+
|
|
69
|
+
## Enforcement Guidelines
|
|
70
|
+
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
+
|
|
74
|
+
### 1. Correction
|
|
75
|
+
|
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
unprofessional or unwelcome in the community.
|
|
78
|
+
|
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
|
82
|
+
|
|
83
|
+
### 2. Warning
|
|
84
|
+
|
|
85
|
+
**Community Impact**: A violation through a single incident or series of
|
|
86
|
+
actions.
|
|
87
|
+
|
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
|
93
|
+
ban.
|
|
94
|
+
|
|
95
|
+
### 3. Temporary Ban
|
|
96
|
+
|
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
sustained inappropriate behavior.
|
|
99
|
+
|
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
communication with the community for a specified period of time. No public or
|
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
+
Violating these terms may lead to a permanent ban.
|
|
105
|
+
|
|
106
|
+
### 4. Permanent Ban
|
|
107
|
+
|
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
+
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
113
|
+
community.
|
|
114
|
+
|
|
115
|
+
## Attribution
|
|
116
|
+
|
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
+
version 2.1, available at
|
|
119
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
120
|
+
|
|
121
|
+
Community Impact Guidelines were inspired by
|
|
122
|
+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
123
|
+
|
|
124
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
125
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
126
|
+
[https://www.contributor-covenant.org/translations][translations].
|
|
127
|
+
|
|
128
|
+
[homepage]: https://www.contributor-covenant.org
|
|
129
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
130
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
131
|
+
[FAQ]: https://www.contributor-covenant.org/faq
|
|
132
|
+
[translations]: https://www.contributor-covenant.org/translations
|
data/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
# Contributing to Ruby API Pack ActiveCampaign
|
|
2
|
+
|
|
3
|
+
Thanks for helping improve `ruby_api_pack_active_campaign`. This gem is
|
|
4
|
+
maintained by PHCDevworks as a Ruby client for ActiveCampaign API helpers.
|
|
5
|
+
|
|
6
|
+
## Development Setup
|
|
7
|
+
|
|
8
|
+
1. Clone the repository.
|
|
9
|
+
2. Install dependencies with `bundle install`.
|
|
10
|
+
3. Configure test credentials with non-production values when needed:
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
export AC_API_URL="https://youraccountname.api-us1.com/api/3"
|
|
14
|
+
export AC_API_TOKEN="test-token"
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
4. Run `bundle exec rspec`.
|
|
18
|
+
5. Run `bundle exec rubocop`.
|
|
19
|
+
6. Build the gem with `gem build ruby_api_pack_active_campaign.gemspec` when
|
|
20
|
+
preparing a release or changing packaging metadata.
|
|
21
|
+
|
|
22
|
+
## Project Structure
|
|
23
|
+
|
|
24
|
+
- `lib/ruby_api_pack_active_campaign.rb`: public gem entry point
|
|
25
|
+
- `lib/ruby_api_pack_active_campaign/configuration.rb`: API URL and token
|
|
26
|
+
configuration
|
|
27
|
+
- `lib/ruby_api_pack_active_campaign/connection/`: HTTParty connection wrapper
|
|
28
|
+
- `lib/ruby_api_pack_active_campaign/api/`: ActiveCampaign API helper methods
|
|
29
|
+
- `lib/ruby_api_pack_active_campaign/version.rb`: gem version
|
|
30
|
+
- `spec/`: RSpec coverage for configuration, connection, and API helpers
|
|
31
|
+
|
|
32
|
+
## Contribution Guidelines
|
|
33
|
+
|
|
34
|
+
### API helper changes
|
|
35
|
+
|
|
36
|
+
1. Keep public helper names stable unless the change is intentionally breaking.
|
|
37
|
+
2. Add or update focused specs for any endpoint path, HTTP verb, request body,
|
|
38
|
+
or response behavior change.
|
|
39
|
+
3. Keep ActiveCampaign SDK or HTTP access centralized in the connection layer.
|
|
40
|
+
4. Pass payloads through in shapes that match ActiveCampaign's documented API.
|
|
41
|
+
5. Update `README.md` when public usage changes.
|
|
42
|
+
|
|
43
|
+
### Connection and configuration changes
|
|
44
|
+
|
|
45
|
+
1. Keep token and base URL handling behind
|
|
46
|
+
`RubyApiPackActiveCampaign.configure`.
|
|
47
|
+
2. Do not log API tokens, request payloads with sensitive contact data, or full
|
|
48
|
+
ActiveCampaign responses by default.
|
|
49
|
+
3. Keep response parsing and error behavior covered by specs.
|
|
50
|
+
4. Preserve backward compatibility unless the changelog and PR clearly classify
|
|
51
|
+
a breaking change.
|
|
52
|
+
|
|
53
|
+
### Code and tooling
|
|
54
|
+
|
|
55
|
+
- Follow the repo's RuboCop configuration.
|
|
56
|
+
- Prefer small, pattern-aligned changes.
|
|
57
|
+
- Keep comments brief and only add them when they explain a non-obvious reason.
|
|
58
|
+
- Preserve unrelated local changes.
|
|
59
|
+
- Do not create commits, tags, releases, or publish gems unless explicitly
|
|
60
|
+
asked by a maintainer.
|
|
61
|
+
|
|
62
|
+
## Behavior-Impacting Change Checklist
|
|
63
|
+
|
|
64
|
+
Use this checklist when touching any public behavior surface:
|
|
65
|
+
|
|
66
|
+
- `lib/ruby_api_pack_active_campaign.rb`
|
|
67
|
+
- `lib/ruby_api_pack_active_campaign/configuration.rb`
|
|
68
|
+
- `lib/ruby_api_pack_active_campaign/connection/`
|
|
69
|
+
- `lib/ruby_api_pack_active_campaign/api/`
|
|
70
|
+
- `README.md`
|
|
71
|
+
|
|
72
|
+
Before merge:
|
|
73
|
+
|
|
74
|
+
1. Update or add focused specs.
|
|
75
|
+
2. Run `bundle exec rspec`.
|
|
76
|
+
3. Run `bundle exec rubocop`.
|
|
77
|
+
4. Build with `gem build ruby_api_pack_active_campaign.gemspec` when packaging
|
|
78
|
+
metadata changed.
|
|
79
|
+
5. Update `README.md` if installation, configuration, endpoint, or usage
|
|
80
|
+
guidance changed.
|
|
81
|
+
6. Update `CHANGELOG.md` under `[Unreleased]`.
|
|
82
|
+
7. Classify the change as additive, behavior change, breaking, or docs/config
|
|
83
|
+
only in the pull request.
|
|
84
|
+
8. Confirm no ActiveCampaign API tokens, production account URLs, contact data,
|
|
85
|
+
or other sensitive identifiers appear in logs, fixtures, docs, or examples.
|
|
86
|
+
|
|
87
|
+
## Pull Request Checklist
|
|
88
|
+
|
|
89
|
+
1. Keep the change focused.
|
|
90
|
+
2. Fill out every section of `.github/pull_request_template.md`.
|
|
91
|
+
3. Link an issue or write `N/A`.
|
|
92
|
+
4. Include a concise summary and reviewer notes.
|
|
93
|
+
5. Leave blocked checklist items unchecked with a short note.
|
|
94
|
+
|
|
95
|
+
## Release Hygiene
|
|
96
|
+
|
|
97
|
+
For maintainers, a release should keep these records aligned:
|
|
98
|
+
|
|
99
|
+
1. Update `lib/ruby_api_pack_active_campaign/version.rb`.
|
|
100
|
+
2. Move relevant `CHANGELOG.md` `[Unreleased]` notes into a dated version entry.
|
|
101
|
+
3. Run `bundle exec rspec`.
|
|
102
|
+
4. Run `bundle exec rubocop`.
|
|
103
|
+
5. Build the gem from the matching source state.
|
|
104
|
+
6. Publish release notes from the matching changelog entry.
|
|
105
|
+
|
|
106
|
+
## Questions
|
|
107
|
+
|
|
108
|
+
Open an issue if you need direction before making a larger change.
|
|
109
|
+
|
|
110
|
+
## Code of Conduct
|
|
111
|
+
|
|
112
|
+
By participating in this project, you agree to follow the
|
|
113
|
+
[Code of Conduct](CODE_OF_CONDUCT.md).
|
|
114
|
+
|
|
115
|
+
## License
|
|
116
|
+
|
|
117
|
+
By contributing, you agree that your contributions will be licensed under the
|
|
118
|
+
MIT License.
|
data/COPILOT.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# COPILOT.md - Ruby API Pack ActiveCampaign
|
|
2
|
+
|
|
3
|
+
## Role
|
|
4
|
+
|
|
5
|
+
GitHub Copilot is a support assistant for local development in this repository.
|
|
6
|
+
It may help with Ruby, RSpec, documentation, and small refactors, but it does
|
|
7
|
+
not own architecture, release decisions, or final handoff authority.
|
|
8
|
+
|
|
9
|
+
## Repository Conventions
|
|
10
|
+
|
|
11
|
+
- Keep HTTParty calls centralized in the connection wrapper.
|
|
12
|
+
- Keep ActiveCampaign credentials configurable.
|
|
13
|
+
- Add focused RSpec coverage for behavior changes.
|
|
14
|
+
- Keep README and changelog aligned with public usage.
|
|
15
|
+
- Do not create commits unless explicitly asked.
|
|
16
|
+
|
|
17
|
+
## Validation
|
|
18
|
+
|
|
19
|
+
Run these before handing off non-trivial changes:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
bundle exec rspec
|
|
23
|
+
bundle exec rubocop
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Security
|
|
27
|
+
|
|
28
|
+
Never suggest adding real ActiveCampaign API tokens, production account URLs,
|
|
29
|
+
contact data, request payloads, or sensitive response bodies to source control.
|
data/FUNDING.yml
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
github: phcdevworks
|
data/JULES.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# JULES.md - Ruby API Pack ActiveCampaign
|
|
2
|
+
|
|
3
|
+
## Role
|
|
4
|
+
|
|
5
|
+
Google Jules may perform bounded automated maintenance in this repository.
|
|
6
|
+
Jules should keep work small, mechanical, and easy to review.
|
|
7
|
+
|
|
8
|
+
## Appropriate Work
|
|
9
|
+
|
|
10
|
+
- Dependency update follow-ups
|
|
11
|
+
- Small documentation corrections
|
|
12
|
+
- CI or configuration cleanup
|
|
13
|
+
- Narrow test maintenance
|
|
14
|
+
- Formatting updates aligned with RuboCop
|
|
15
|
+
|
|
16
|
+
## Not Appropriate
|
|
17
|
+
|
|
18
|
+
- New ActiveCampaign resource groups
|
|
19
|
+
- Public API redesigns
|
|
20
|
+
- Release publishing
|
|
21
|
+
- Large refactors
|
|
22
|
+
- Security-sensitive behavior changes without human review
|
|
23
|
+
|
|
24
|
+
## Validation
|
|
25
|
+
|
|
26
|
+
Before handoff, run:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
bundle exec rspec
|
|
30
|
+
bundle exec rubocop
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
If validation cannot run, report why.
|
data/MIT-LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Copyright Bradley J Potts
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|