tango-api-client 0.1.0 → 0.1.1
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 +4 -4
- data/CHANGELOG.md +15 -3
- data/CONTRIBUTING.md +58 -0
- data/lib/tango/api/client/version.rb +1 -1
- metadata +2 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: aaca119882836f7c7ce028b229ef0bab2e57766b388aaab5825a6e8a03b336c1
|
|
4
|
+
data.tar.gz: c32dd9d3e4ae82a78731d7408ade3a22a08f69e9c39b558b51700ca141d9d80b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7ed6160b4286d4628a79d961581bc6165a01f9a4446255a65663e0ff27a5145138da42b958b04bba2209168a103c74df4f29d3bdc930a02bb6f74202578414cb
|
|
7
|
+
data.tar.gz: b2a464703e63b4a5869a3c61f0d670aafb906b757c020a58abd62935dbaea23b1331be6d342830ca439dc9018fe0e990e477e4730a3c2a74451091c57943784d
|
data/CHANGELOG.md
CHANGED
|
@@ -2,10 +2,22 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
|
|
5
|
+
## [Unreleased]
|
|
6
|
+
- Nothing yet.
|
|
7
|
+
|
|
5
8
|
## [0.1.0] - 2025-11-07
|
|
6
9
|
- Initial release
|
|
7
10
|
- Basic and OAuth2 auth strategies
|
|
8
|
-
-
|
|
9
|
-
- Faraday-based client with retries/timeouts
|
|
10
|
-
- Structured error mapping
|
|
11
|
+
- Faraday-based client with retries/timeouts and structured error mapping
|
|
11
12
|
- README and RSpec scaffolding
|
|
13
|
+
- Resources and capabilities:
|
|
14
|
+
- Catalogs: `get` and convenience filters (`get_by_brand_key`, `get_by_brand_name`, `get_by_utid`, `get_by_reward_name`)
|
|
15
|
+
- Orders: `create`, `get`, `list`, `resend` (supports `Idempotency-Key`)
|
|
16
|
+
- Accounts: `get`, `list_for_customer`, `create`, `update_under_customer`
|
|
17
|
+
- Low balance alerts under accounts: list/create/get/update/delete
|
|
18
|
+
- Customers: `list`, `get`, `create`, `accounts`
|
|
19
|
+
- Choice Products: `get`, `get_for_utid`, `catalog`
|
|
20
|
+
- Exchange Rates: `get`, `get_for_utid`
|
|
21
|
+
- Status: `get`
|
|
22
|
+
- Base helpers: `patch_json`, `delete_json`
|
|
23
|
+
- Smoke script expanded; RuboCop clean
|
data/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
## Contributing to tango-api-client
|
|
2
|
+
|
|
3
|
+
Thanks for helping improve this gem! This guide explains how to set up your environment, run tests, lint the code, and propose changes.
|
|
4
|
+
|
|
5
|
+
### Prerequisites
|
|
6
|
+
- Ruby 3.0+ (tested on 3.0–3.3)
|
|
7
|
+
- Bundler
|
|
8
|
+
|
|
9
|
+
### Setup
|
|
10
|
+
```bash
|
|
11
|
+
git clone https://github.com/Engagedly-Inc/tango-api-client.git
|
|
12
|
+
cd tango-api-client
|
|
13
|
+
bin/setup
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
### Running the test suite and linters
|
|
17
|
+
```bash
|
|
18
|
+
bundle exec rake spec
|
|
19
|
+
bundle exec rubocop
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Optional: run the smoke script (read the file for env vars and opt-ins)
|
|
23
|
+
```bash
|
|
24
|
+
ruby bin/smoke
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Development workflow
|
|
28
|
+
1. Create a branch from `master`.
|
|
29
|
+
2. Make focused changes (with tests where applicable).
|
|
30
|
+
3. Ensure `rake spec` and `rubocop` pass locally.
|
|
31
|
+
4. Update `README.md` or `CHANGELOG.md` if behavior changes or new endpoints are added.
|
|
32
|
+
5. Open a pull request describing:
|
|
33
|
+
- What changed and why
|
|
34
|
+
- Any breaking changes
|
|
35
|
+
- How to test/verify
|
|
36
|
+
|
|
37
|
+
### Versioning and releases
|
|
38
|
+
- Maintainers bump the version in `lib/tango/api/client/version.rb` and update `CHANGELOG.md`.
|
|
39
|
+
- Releasing is done via:
|
|
40
|
+
```bash
|
|
41
|
+
bundle exec rake release
|
|
42
|
+
```
|
|
43
|
+
This tags the repo and pushes the gem to RubyGems (requires RubyGems API key and MFA).
|
|
44
|
+
|
|
45
|
+
### Code style
|
|
46
|
+
- Ruby style is enforced with RuboCop (see `.rubocop.yml`).
|
|
47
|
+
- Prefer small, composable methods and clear names.
|
|
48
|
+
- Avoid duplicating API validations; rely on server responses unless a simple presence check clearly improves developer experience.
|
|
49
|
+
|
|
50
|
+
### Security
|
|
51
|
+
- Do not include secrets or tokens in commits, logs, or examples.
|
|
52
|
+
- Report security issues privately via GitHub Security Advisories.
|
|
53
|
+
|
|
54
|
+
### Questions and support
|
|
55
|
+
- Open a “Question” issue if something is unclear.
|
|
56
|
+
- PRs are welcome—thanks for contributing!
|
|
57
|
+
|
|
58
|
+
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: tango-api-client
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Puneeth Kumar DN
|
|
@@ -76,6 +76,7 @@ extra_rdoc_files: []
|
|
|
76
76
|
files:
|
|
77
77
|
- ".rspec"
|
|
78
78
|
- CHANGELOG.md
|
|
79
|
+
- CONTRIBUTING.md
|
|
79
80
|
- LICENSE.txt
|
|
80
81
|
- README.md
|
|
81
82
|
- Rakefile
|