telesink 1.0.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/CHANGELOG.md +5 -0
- data/LICENSE.md +20 -0
- data/README.md +78 -0
- data/Rakefile +8 -0
- data/lib/telesink/version.rb +3 -0
- data/lib/telesink.rb +102 -0
- data/telesink.gemspec +34 -0
- metadata +90 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: b38d9848f1923c7e6e5097cecb4e74e77a10f4b07b88721a99feab0a4f2331b2
|
|
4
|
+
data.tar.gz: 4b1aab123dbebc5d02ac8f810553dcc56b641325aa82e294e41bf29fd015dc0a
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: a7401b47e134000d2df96b98619bf8607f0d26c2077984f6e3243d97648f642ac360d74953ab3564ed7a4c0dd7ef41f4fdb915415ea8649911ff83b65115fe51
|
|
7
|
+
data.tar.gz: 3da4064dc588e1b4b930235d085e495d8c5d9c7524a01a0d7ece0d96195cb546ba4d084ce1b7db1e011987df0c951b4641887fa3bf98561ece49708ea4f827a6
|
data/CHANGELOG.md
ADDED
data/LICENSE.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# The MIT License
|
|
2
|
+
|
|
3
|
+
Copyright © 2026 Telesink
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
6
|
+
this software and associated documentation files (the 'Software'), to deal in
|
|
7
|
+
the Software without restriction, including without limitation the rights to
|
|
8
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
9
|
+
the Software, and to permit persons to whom the Software is furnished to do so,
|
|
10
|
+
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, FITNESS
|
|
17
|
+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
18
|
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
19
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
20
|
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# Telesink SDK for Ruby
|
|
2
|
+
|
|
3
|
+
Official Ruby client for [telesink.com](https://telesink.com) - real-time event tracking.
|
|
4
|
+
|
|
5
|
+
## Requirements
|
|
6
|
+
|
|
7
|
+
- Ruby 3.0+
|
|
8
|
+
|
|
9
|
+
## Getting started
|
|
10
|
+
|
|
11
|
+
### Install
|
|
12
|
+
|
|
13
|
+
Add this line to your application's `Gemfile`:
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
gem "telesink"
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Then run:
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
bundle install
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Configuration
|
|
26
|
+
|
|
27
|
+
#### Recommended: Environment Variables (zero-code setup)
|
|
28
|
+
|
|
29
|
+
```sh
|
|
30
|
+
export TELESINK_TOKEN=your_sink_token_here
|
|
31
|
+
# Optional:
|
|
32
|
+
# export TELESINK_BASE_URL=https://custom.telesink.com
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
The SDK automatically reads these.
|
|
36
|
+
|
|
37
|
+
#### Explicit configuration
|
|
38
|
+
|
|
39
|
+
```rb
|
|
40
|
+
require "telesink"
|
|
41
|
+
|
|
42
|
+
Telesink.configure do |config|
|
|
43
|
+
config.token = <sink-token> # required
|
|
44
|
+
config.base_url = "https://telesink.com" # default
|
|
45
|
+
config.enabled = true # default
|
|
46
|
+
config.logger = Logger.new(STDERR)
|
|
47
|
+
end
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Usage
|
|
51
|
+
|
|
52
|
+
```rb
|
|
53
|
+
Telesink.track(
|
|
54
|
+
event: "user.signed.up",
|
|
55
|
+
text: "New user registered",
|
|
56
|
+
emoji: "🎉",
|
|
57
|
+
properties: { plan: "pro", source: "landing_page" },
|
|
58
|
+
occurred_at: Time.now, # optional, auto-converted to UTC ISO8601
|
|
59
|
+
idempotency_key: "my-custom-key" # optional, auto-generated UUID if omitted
|
|
60
|
+
)
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
#### Returns
|
|
64
|
+
|
|
65
|
+
- `true` - request was sent
|
|
66
|
+
- `false` - disabled or missing token
|
|
67
|
+
|
|
68
|
+
Failures are never raised. They are logged via your configured logger and fail silently.
|
|
69
|
+
|
|
70
|
+
### Testing
|
|
71
|
+
|
|
72
|
+
```
|
|
73
|
+
bundle exec rake test
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### License
|
|
77
|
+
|
|
78
|
+
MIT (see [LICENSE.md](/LICENSE.md)).
|
data/Rakefile
ADDED
data/lib/telesink.rb
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "net/http"
|
|
4
|
+
require "uri"
|
|
5
|
+
require "json"
|
|
6
|
+
require "securerandom"
|
|
7
|
+
require "logger"
|
|
8
|
+
|
|
9
|
+
module Telesink
|
|
10
|
+
class Config
|
|
11
|
+
attr_accessor :token, :base_url, :enabled, :logger
|
|
12
|
+
|
|
13
|
+
def initialize
|
|
14
|
+
@base_url = ENV.fetch("TELESINK_BASE_URL", "https://telesink.com")
|
|
15
|
+
@token = ENV["TELESINK_TOKEN"]
|
|
16
|
+
@enabled = true
|
|
17
|
+
@logger = ::Logger.new(STDERR)
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
class << self
|
|
22
|
+
attr_writer :config
|
|
23
|
+
|
|
24
|
+
def config
|
|
25
|
+
@config ||= Config.new
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
def configure
|
|
29
|
+
yield config
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
def track(
|
|
33
|
+
event:,
|
|
34
|
+
text:,
|
|
35
|
+
emoji: nil,
|
|
36
|
+
properties: {},
|
|
37
|
+
occurred_at: nil,
|
|
38
|
+
idempotency_key: nil
|
|
39
|
+
)
|
|
40
|
+
return false unless config.enabled
|
|
41
|
+
return false if config.token.to_s.strip.empty?
|
|
42
|
+
|
|
43
|
+
payload = {
|
|
44
|
+
event: event,
|
|
45
|
+
text: text,
|
|
46
|
+
emoji: emoji,
|
|
47
|
+
properties: properties,
|
|
48
|
+
occurred_at: occurred_at&.utc&.iso8601,
|
|
49
|
+
idempotency_key: (idempotency_key.to_s.empty? ? SecureRandom.uuid : idempotency_key),
|
|
50
|
+
sdk: {
|
|
51
|
+
name: "telesink.ruby",
|
|
52
|
+
version: VERSION
|
|
53
|
+
}
|
|
54
|
+
}.compact
|
|
55
|
+
|
|
56
|
+
safely_send_event(payload, payload[:idempotency_key])
|
|
57
|
+
true
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
private
|
|
61
|
+
|
|
62
|
+
def safely_send_event(payload, idempotency_key)
|
|
63
|
+
send_event(payload, idempotency_key)
|
|
64
|
+
rescue Net::OpenTimeout,
|
|
65
|
+
Net::ReadTimeout,
|
|
66
|
+
Net::WriteTimeout,
|
|
67
|
+
SocketError,
|
|
68
|
+
SystemCallError,
|
|
69
|
+
IOError,
|
|
70
|
+
Errno::ECONNREFUSED,
|
|
71
|
+
Errno::ECONNRESET => e
|
|
72
|
+
config.logger.error("[Telesink] Network error sending '#{payload[:event]}': #{e.class} - #{e.message}")
|
|
73
|
+
rescue => e
|
|
74
|
+
config.logger.error("[Telesink] Unexpected error sending '#{payload[:event]}': #{e.class} - #{e.message}")
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
def send_event(payload, idempotency_key)
|
|
78
|
+
uri = URI("#{config.base_url}/api/v1/sinks/#{config.token}/events")
|
|
79
|
+
|
|
80
|
+
http = Net::HTTP.new(uri.host, uri.port)
|
|
81
|
+
http.use_ssl = true
|
|
82
|
+
http.open_timeout = 3
|
|
83
|
+
http.read_timeout = 3
|
|
84
|
+
http.write_timeout = 3 if http.respond_to?(:write_timeout)
|
|
85
|
+
|
|
86
|
+
request = Net::HTTP::Post.new(uri)
|
|
87
|
+
request["Content-Type"] = "application/json"
|
|
88
|
+
request["User-Agent"] = "telesink.ruby/#{VERSION}"
|
|
89
|
+
request["Idempotency-Key"] = idempotency_key
|
|
90
|
+
|
|
91
|
+
request.body = payload.to_json
|
|
92
|
+
|
|
93
|
+
response = http.request(request)
|
|
94
|
+
|
|
95
|
+
unless response.is_a?(Net::HTTPSuccess)
|
|
96
|
+
config.logger.warn("[Telesink] API returned #{response.code} for event '#{payload[:event]}'")
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
response
|
|
100
|
+
end
|
|
101
|
+
end
|
|
102
|
+
end
|
data/telesink.gemspec
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
require_relative "lib/telesink/version"
|
|
3
|
+
|
|
4
|
+
Gem::Specification.new do |spec|
|
|
5
|
+
spec.name = "telesink"
|
|
6
|
+
spec.version = Telesink::VERSION
|
|
7
|
+
spec.authors = ["Kyrylo Silin"]
|
|
8
|
+
spec.email = ["kyrylo@telesink.com"]
|
|
9
|
+
|
|
10
|
+
spec.summary = "Track events with Telesink using the official Ruby SDK."
|
|
11
|
+
|
|
12
|
+
spec.homepage = "https://telesink.com"
|
|
13
|
+
spec.required_ruby_version = ">= 3.0.0"
|
|
14
|
+
|
|
15
|
+
spec.metadata["homepage_uri"] = spec.homepage
|
|
16
|
+
spec.metadata["source_code_uri"] = "https://github.com/telesink/telesink-ruby"
|
|
17
|
+
|
|
18
|
+
spec.files = Dir.chdir(__dir__) do
|
|
19
|
+
`git ls-files -z`.split("\x0").reject do |f|
|
|
20
|
+
(File.expand_path(f) == __FILE__) ||
|
|
21
|
+
f.start_with?(*%w[bin/ test/ .git .github Gemfile])
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
spec.bindir = "exe"
|
|
25
|
+
spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
|
|
26
|
+
spec.require_paths = ["lib"]
|
|
27
|
+
|
|
28
|
+
spec.metadata["rubygems_mfa_required"] = "true"
|
|
29
|
+
|
|
30
|
+
spec.add_runtime_dependency "logger", "~> 1.7"
|
|
31
|
+
|
|
32
|
+
spec.add_development_dependency "minitest", "~> 5.0"
|
|
33
|
+
spec.add_development_dependency "rake", "~> 13.0"
|
|
34
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: telesink
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Kyrylo Silin
|
|
8
|
+
bindir: exe
|
|
9
|
+
cert_chain: []
|
|
10
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
11
|
+
dependencies:
|
|
12
|
+
- !ruby/object:Gem::Dependency
|
|
13
|
+
name: logger
|
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
|
15
|
+
requirements:
|
|
16
|
+
- - "~>"
|
|
17
|
+
- !ruby/object:Gem::Version
|
|
18
|
+
version: '1.7'
|
|
19
|
+
type: :runtime
|
|
20
|
+
prerelease: false
|
|
21
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
22
|
+
requirements:
|
|
23
|
+
- - "~>"
|
|
24
|
+
- !ruby/object:Gem::Version
|
|
25
|
+
version: '1.7'
|
|
26
|
+
- !ruby/object:Gem::Dependency
|
|
27
|
+
name: minitest
|
|
28
|
+
requirement: !ruby/object:Gem::Requirement
|
|
29
|
+
requirements:
|
|
30
|
+
- - "~>"
|
|
31
|
+
- !ruby/object:Gem::Version
|
|
32
|
+
version: '5.0'
|
|
33
|
+
type: :development
|
|
34
|
+
prerelease: false
|
|
35
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
36
|
+
requirements:
|
|
37
|
+
- - "~>"
|
|
38
|
+
- !ruby/object:Gem::Version
|
|
39
|
+
version: '5.0'
|
|
40
|
+
- !ruby/object:Gem::Dependency
|
|
41
|
+
name: rake
|
|
42
|
+
requirement: !ruby/object:Gem::Requirement
|
|
43
|
+
requirements:
|
|
44
|
+
- - "~>"
|
|
45
|
+
- !ruby/object:Gem::Version
|
|
46
|
+
version: '13.0'
|
|
47
|
+
type: :development
|
|
48
|
+
prerelease: false
|
|
49
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
50
|
+
requirements:
|
|
51
|
+
- - "~>"
|
|
52
|
+
- !ruby/object:Gem::Version
|
|
53
|
+
version: '13.0'
|
|
54
|
+
email:
|
|
55
|
+
- kyrylo@telesink.com
|
|
56
|
+
executables: []
|
|
57
|
+
extensions: []
|
|
58
|
+
extra_rdoc_files: []
|
|
59
|
+
files:
|
|
60
|
+
- CHANGELOG.md
|
|
61
|
+
- LICENSE.md
|
|
62
|
+
- README.md
|
|
63
|
+
- Rakefile
|
|
64
|
+
- lib/telesink.rb
|
|
65
|
+
- lib/telesink/version.rb
|
|
66
|
+
- telesink.gemspec
|
|
67
|
+
homepage: https://telesink.com
|
|
68
|
+
licenses: []
|
|
69
|
+
metadata:
|
|
70
|
+
homepage_uri: https://telesink.com
|
|
71
|
+
source_code_uri: https://github.com/telesink/telesink-ruby
|
|
72
|
+
rubygems_mfa_required: 'true'
|
|
73
|
+
rdoc_options: []
|
|
74
|
+
require_paths:
|
|
75
|
+
- lib
|
|
76
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
77
|
+
requirements:
|
|
78
|
+
- - ">="
|
|
79
|
+
- !ruby/object:Gem::Version
|
|
80
|
+
version: 3.0.0
|
|
81
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
82
|
+
requirements:
|
|
83
|
+
- - ">="
|
|
84
|
+
- !ruby/object:Gem::Version
|
|
85
|
+
version: '0'
|
|
86
|
+
requirements: []
|
|
87
|
+
rubygems_version: 4.0.3
|
|
88
|
+
specification_version: 4
|
|
89
|
+
summary: Track events with Telesink using the official Ruby SDK.
|
|
90
|
+
test_files: []
|