tacklebox 0.1.1 → 0.1.2
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/History.txt +4 -0
- data/README.md +69 -13
- data/lib/tacklebox/version.rb +1 -1
- data/pkg/tacklebox-0.1.1.gem +0 -0
- metadata +3 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e8e3d624ae5ea05d0c2f98c7d083dd9b2464261582a79a15f34d9782012d4d8f
|
|
4
|
+
data.tar.gz: 0bbc789c6655d0412acf79497b596d2c131d8b90abd2a60fe979e224a4dafab6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 03a5e13b17675b1787a9f2166f4870c262076800384eb7e81b7d6b6d7635734fb3298b8991689dcf5ee9b9b4ac41ced811bd771ef2110c826b09e51f5dcd7c5f
|
|
7
|
+
data.tar.gz: 1421f67ec2105d57ab255013417bcb5f340909d154971494bf37f3046bfb7ce24099bf6f9963ab8e84dbf4417499103ea31788c6069b81f563b61c6b40edccbb
|
data/History.txt
CHANGED
data/README.md
CHANGED
|
@@ -1,10 +1,39 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://i.imgur.com/s9Gvwsg.png">
|
|
3
|
+
</p>
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
[](https://tacklebox-webhooks.github.io)
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
## Overview
|
|
6
8
|
|
|
7
|
-
|
|
9
|
+
These are the instructions to install and use the Ruby client library for Tacklebox.
|
|
10
|
+
Tacklebox is an open-source serverless framework that offers webhooks as a service.
|
|
11
|
+
|
|
12
|
+
It includes:
|
|
13
|
+
- a [CLI tool](https://github.com/tacklebox-webhooks/cli) to deploy and manage AWS infrastructure
|
|
14
|
+
- 4 client libraries ([Ruby](https://github.com/tacklebox-webhooks/Ruby),
|
|
15
|
+
[Ruby](https://github.com/tacklebox-webhooks/ruby),
|
|
16
|
+
[Python](https://github.com/tacklebox-webhooks/python),
|
|
17
|
+
and [Go](https://github.com/tacklebox-webhooks/golang))
|
|
18
|
+
- a RESTful API with docs
|
|
19
|
+
- a management UI
|
|
20
|
+
|
|
21
|
+
You can read more about our case study [here](https://tacklebox-webhooks.github.io"),
|
|
22
|
+
and you can also watch our presentation [here](https://www.youtube.com/watch?v=QEFFlWNNwk8&t=1s).
|
|
23
|
+
|
|
24
|
+
## The Team
|
|
25
|
+
|
|
26
|
+
**Juan Palma** *Software Engineer* Phoenix, AZ
|
|
27
|
+
|
|
28
|
+
**Kevin Counihan** *Software Engineer* Seattle, WA
|
|
29
|
+
|
|
30
|
+
**Armando Mota** *Software Engineer* Los Angeles, CA
|
|
31
|
+
|
|
32
|
+
**Kayl Thomas** *Software Engineer* Atlanta, GA
|
|
33
|
+
|
|
34
|
+
## Getting Started
|
|
35
|
+
|
|
36
|
+
### Install the Ruby library
|
|
8
37
|
|
|
9
38
|
Add this line to your application's Gemfile:
|
|
10
39
|
|
|
@@ -20,21 +49,48 @@ Or install it yourself as:
|
|
|
20
49
|
|
|
21
50
|
$ gem install tacklebox
|
|
22
51
|
|
|
23
|
-
|
|
52
|
+
### Use the Ruby library
|
|
24
53
|
|
|
25
|
-
|
|
54
|
+
Once you install the Ruby library for Tacklebox, you can start using it like so:
|
|
26
55
|
|
|
27
|
-
|
|
56
|
+
```ruby
|
|
57
|
+
require 'tacklebox'
|
|
28
58
|
|
|
29
|
-
|
|
59
|
+
# Initialize a Tacklebox object using the API Key and API Host
|
|
60
|
+
# obtained after running 'tacklebox deploy'
|
|
61
|
+
tacklebox = Tacklebox.new(API_KEY, API_HOST);
|
|
62
|
+
```
|
|
30
63
|
|
|
31
|
-
|
|
64
|
+
Once you include the package and initialize a Tacklebox object, you can do
|
|
65
|
+
many things. For example, you can create a service like so:
|
|
32
66
|
|
|
33
|
-
|
|
67
|
+
```ruby
|
|
68
|
+
tacklebox.service.create({ "name" => "service1" });
|
|
69
|
+
```
|
|
34
70
|
|
|
35
|
-
|
|
71
|
+
Once you create services, event types, users and subscriptions,
|
|
72
|
+
you can create a new event like so:
|
|
36
73
|
|
|
74
|
+
```ruby
|
|
75
|
+
service_id = "d90af763-5839-4a90-834c-5512980984f5";
|
|
76
|
+
user_id = "cabea1b5-b485-41b7-8146-72ece22dc458";
|
|
77
|
+
|
|
78
|
+
event_data = {
|
|
79
|
+
"event_type" => "greet",
|
|
80
|
+
"payload" => {
|
|
81
|
+
"message" => "Hello from the Ruby wrapper!"
|
|
82
|
+
},
|
|
83
|
+
"idempotency_key" => "1"
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
tacklebox.event.create(service_id, user_id, event_data);
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
If you want to see the message log for a specific user and service:
|
|
37
90
|
|
|
38
|
-
|
|
91
|
+
```ruby
|
|
92
|
+
service_id = "d90af763-5839-4a90-834c-5512980984f5";
|
|
93
|
+
user_id = "cabea1b5-b485-41b7-8146-72ece22dc458";
|
|
39
94
|
|
|
40
|
-
|
|
95
|
+
tacklebox.message.list(service_id, user_id);
|
|
96
|
+
```
|
data/lib/tacklebox/version.rb
CHANGED
|
Binary file
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: tacklebox
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Juan Palma
|
|
@@ -11,7 +11,7 @@ authors:
|
|
|
11
11
|
autorequire:
|
|
12
12
|
bindir: exe
|
|
13
13
|
cert_chain: []
|
|
14
|
-
date: 2021-05-
|
|
14
|
+
date: 2021-05-30 00:00:00.000000000 Z
|
|
15
15
|
dependencies:
|
|
16
16
|
- !ruby/object:Gem::Dependency
|
|
17
17
|
name: faraday
|
|
@@ -84,6 +84,7 @@ files:
|
|
|
84
84
|
- lib/tacklebox/components/user.rb
|
|
85
85
|
- lib/tacklebox/version.rb
|
|
86
86
|
- pkg/tacklebox-0.1.0.gem
|
|
87
|
+
- pkg/tacklebox-0.1.1.gem
|
|
87
88
|
- tacklebox.gemspec
|
|
88
89
|
homepage: https://github.com/tacklebox-webhooks/ruby
|
|
89
90
|
licenses:
|