notilify 0.1.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.
Files changed (4) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +21 -0
  3. data/README.md +43 -0
  4. metadata +44 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 40b885f623c42c3883eaa84f8123fb924238d92de662d9527b9fe2f4e6acd02c
4
+ data.tar.gz: 661e52e86911ce7719f64b4e79c77297c90313cdcb2e023c795a25bd70ac3fd6
5
+ SHA512:
6
+ metadata.gz: 8b8ff7dc6b09f668f9ce4c623b35e1cb7852bd2b6f8395d4588c52b2ed00c4cfa20a0c670e7d4d892dff4ba5ffa50ef4e18572fda82504452cc7d1afaa9922aa
7
+ data.tar.gz: e383a5e50f1d31d422e577ba087af0eaf78e1d8dc625ead6ebe5f83d1bd25ffa348b02db1c771da023a9c20cc8ee691e97083bd33ae225953d9ea667f3bf4fbd
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Notilify
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.
data/README.md ADDED
@@ -0,0 +1,43 @@
1
+ # Notilify SDKs
2
+
3
+ Official, dependency-light clients for the [Notilify API](https://docs.notilify.com). Every package is named `notilify` in its language ecosystem and shares the same first-release contract.
4
+
5
+ This repository is open source under the [MIT License](LICENSE). Contributions and security reports are welcome; review [CONTRIBUTING.md](CONTRIBUTING.md), [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), and [SECURITY.md](SECURITY.md) before participating.
6
+
7
+ ## SDKs
8
+
9
+ | Language | Package | Status | Directory |
10
+ | --- | --- | --- | --- |
11
+ | Node.js | [`notilify`](https://www.npmjs.com/package/notilify) | Published | [`sdks/node`](sdks/node) |
12
+ | Python | `notilify` | Registry release pending | [`sdks/python`](sdks/python) |
13
+ | PHP | `notilify/notilify` | Registry release pending | [`sdks/php`](sdks/php) |
14
+ | Go | `github.com/codelinglabs/notilify-sdks/sdks/go` | Module tag pending | [`sdks/go`](sdks/go) |
15
+ | Ruby | `notilify` | Registry release pending | [`sdks/ruby`](sdks/ruby) |
16
+ | Java | `com.notilify:notilify` | Registry release pending | [`sdks/java`](sdks/java) |
17
+ | .NET | `Notilify` | Registry release pending | [`sdks/dotnet`](sdks/dotnet) |
18
+
19
+ ## Shared contract
20
+
21
+ Each client:
22
+
23
+ - authenticates with `Authorization: Bearer <api-key>`
24
+ - sends one SMS through `POST /v1/message`
25
+ - accepts `from`, `to`, `message`, and an optional idempotency key
26
+ - defaults to `https://api.notilify.com`
27
+ - supports a custom base URL and timeout for testing and controlled environments
28
+ - throws a structured Notilify error for non-2xx responses
29
+
30
+ ```text
31
+ Client(apiKey, options)
32
+ .sendMessage({ from, to, message, idempotencyKey })
33
+ ```
34
+
35
+ API keys must remain on a trusted server. Do not embed them in browser or mobile application bundles.
36
+
37
+ ## Versioning
38
+
39
+ SDKs begin at `0.1.0` while the common API and packaging are validated. Language packages can be released independently, but behavior changes should remain aligned across every implementation.
40
+
41
+ ## Validation
42
+
43
+ Run `./scripts/check-sdks.sh` locally. It exercises each language's request, authentication, idempotency, response, and error checks, then validates or builds the npm, Python, Composer, RubyGems, Maven, and NuGet packages using free local toolchains. It does not require hosted CI or an organization billing plan.
metadata ADDED
@@ -0,0 +1,44 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: notilify
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Notilify
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
+ dependencies: []
12
+ email:
13
+ - support@notilify.com
14
+ executables: []
15
+ extensions: []
16
+ extra_rdoc_files: []
17
+ files:
18
+ - LICENSE
19
+ - README.md
20
+ homepage: https://notilify.com
21
+ licenses:
22
+ - MIT
23
+ metadata:
24
+ source_code_uri: https://github.com/codelinglabs/notilify-sdks/tree/main/sdks/ruby
25
+ bug_tracker_uri: https://github.com/codelinglabs/notilify-sdks/issues
26
+ rubygems_mfa_required: 'true'
27
+ rdoc_options: []
28
+ require_paths:
29
+ - lib
30
+ required_ruby_version: !ruby/object:Gem::Requirement
31
+ requirements:
32
+ - - ">="
33
+ - !ruby/object:Gem::Version
34
+ version: '3.0'
35
+ required_rubygems_version: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - ">="
38
+ - !ruby/object:Gem::Version
39
+ version: '0'
40
+ requirements: []
41
+ rubygems_version: 4.0.16
42
+ specification_version: 4
43
+ summary: Official Ruby SDK for the Notilify transactional SMS API
44
+ test_files: []