tacklebox 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0830dd71c9f6e169e746eb6f5be84a3f106146d0b73916099d7d0078db7aa5bd'
-  data.tar.gz: f322bd5f41986a62f9003e2b022b9d55f8f52e99f0d7da1f61a34566f9382f44
+  metadata.gz: e8e3d624ae5ea05d0c2f98c7d083dd9b2464261582a79a15f34d9782012d4d8f
+  data.tar.gz: 0bbc789c6655d0412acf79497b596d2c131d8b90abd2a60fe979e224a4dafab6
 SHA512:
-  metadata.gz: 8d49e4064fa68c9d17061b8313778281212d9fb3a5baa2f611d3bdb99c54d5a43f8a8c2f7bbfa3f4d1a36754188929709fb497db92db1aa78ffe7ddc257821e9
-  data.tar.gz: 2f6befa174227691f2de508071412526ec4ce56ca6e411a1f585e5efeb9c898f9ca18ce4a90117dc53e0340b0ea4fecf0042a8d5e7a46642a4365c4b0c7cd3f9
+  metadata.gz: 03a5e13b17675b1787a9f2166f4870c262076800384eb7e81b7d6b6d7635734fb3298b8991689dcf5ee9b9b4ac41ced811bd771ef2110c826b09e51f5dcd7c5f
+  data.tar.gz: 1421f67ec2105d57ab255013417bcb5f340909d154971494bf37f3046bfb7ce24099bf6f9963ab8e84dbf4417499103ea31788c6069b81f563b61c6b40edccbb

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.1.2 / 2021-05-30
+
+* Updated README
+
 === 0.1.1 / 2021-05-22
 
 * Deleted extra slash on base URL.

data/README.md

@@ -1,10 +1,39 @@
-# Tacklebox
+<p align="center">
+  <img src="https://i.imgur.com/s9Gvwsg.png">
+</p>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tacklebox`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Tacklebox](https://img.shields.io/badge/tacklebox-case%20study-blue)](https://tacklebox-webhooks.github.io)
 
-TODO: Delete this and the text above, and describe your gem
+## Overview
 
-## Installation
+These are the instructions to install and use the Ruby client library for Tacklebox.
+Tacklebox is an open-source serverless framework that offers webhooks as a service.
+
+It includes:
+- a [CLI tool](https://github.com/tacklebox-webhooks/cli) to deploy and manage AWS infrastructure
+- 4 client libraries ([Ruby](https://github.com/tacklebox-webhooks/Ruby),
+    [Ruby](https://github.com/tacklebox-webhooks/ruby),
+    [Python](https://github.com/tacklebox-webhooks/python),
+    and [Go](https://github.com/tacklebox-webhooks/golang))
+- a RESTful API with docs
+- a management UI
+
+You can read more about our case study [here](https://tacklebox-webhooks.github.io"),
+and you can also watch our presentation [here](https://www.youtube.com/watch?v=QEFFlWNNwk8&t=1s).
+
+## The Team
+
+**Juan Palma** *Software Engineer* Phoenix, AZ
+
+**Kevin Counihan** *Software Engineer* Seattle, WA
+
+**Armando Mota** *Software Engineer* Los Angeles, CA
+
+**Kayl Thomas** *Software Engineer* Atlanta, GA
+
+## Getting Started
+
+### Install the Ruby library
 
 Add this line to your application's Gemfile:
 
@@ -20,21 +49,48 @@ Or install it yourself as:
 
     $ gem install tacklebox
 
-## Usage
+### Use the Ruby library
 
-TODO: Write usage instructions here
+Once you install the Ruby library for Tacklebox, you can start using it like so:
 
-## Development
+```ruby
+require 'tacklebox'
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# Initialize a Tacklebox object using the API Key and API Host
+# obtained after running 'tacklebox deploy'
+tacklebox = Tacklebox.new(API_KEY, API_HOST);
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Once you include the package and initialize a Tacklebox object, you can do
+many things. For example, you can create a service like so:
 
-## Contributing
+```ruby
+tacklebox.service.create({ "name" => "service1" });
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tacklebox.
+Once you create services, event types, users and subscriptions,
+you can create a new event like so:
 
+```ruby
+service_id = "d90af763-5839-4a90-834c-5512980984f5";
+user_id = "cabea1b5-b485-41b7-8146-72ece22dc458";
+
+event_data = {
+  "event_type" => "greet",
+  "payload" => {
+  	"message" => "Hello from the Ruby wrapper!"
+  },
+  "idempotency_key" => "1"
+}
+
+tacklebox.event.create(service_id, user_id, event_data);
+```
+
+If you want to see the message log for a specific user and service:
 
-## License
+```ruby
+service_id = "d90af763-5839-4a90-834c-5512980984f5";
+user_id = "cabea1b5-b485-41b7-8146-72ece22dc458";
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+tacklebox.message.list(service_id, user_id);
+```

data/lib/tacklebox/version.rb

@@ -1,3 +1,3 @@
 module Tacklebox
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tacklebox
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Juan Palma
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-22 00:00:00.000000000 Z
+date: 2021-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -84,6 +84,7 @@ files:
 - lib/tacklebox/components/user.rb
 - lib/tacklebox/version.rb
 - pkg/tacklebox-0.1.0.gem
+- pkg/tacklebox-0.1.1.gem
 - tacklebox.gemspec
 homepage: https://github.com/tacklebox-webhooks/ruby
 licenses: