ats-sdk 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cc57165dd92bd828b321a7527599fa9a4a8e923f614377df9adc4e0ba92e0e3
-  data.tar.gz: bd42dfdb04df86825c81546a01bfc4560b742e02b535f90461a48548c3d90f2e
+  metadata.gz: ec55809b7ce4eb291ff66e5b1cb2d89fc0defecb03cbf71b9208f57a70187d5e
+  data.tar.gz: 4c0a56b41a766c63e99a633d05ab016ef7db74dd77ed5e3c08b105a1a8eb9cee
 SHA512:
-  metadata.gz: b3bbcf30297abdc28977fae82b0885b02bf6c5832f2e4790d0001403cfbace0e610855e9a761bb0d0132cff60e8e39ed6100c814dc3ee8fdbc2be199c3610aba
-  data.tar.gz: cf4d5fe52daf290fc8232e8fd6af61e4b277fd9b875f3d0a001054a9195bd5ae6d9f6518162c7c94e6903c9048750bef0f92703ca5efdda71c1cd19a0ddcfbf3
+  metadata.gz: 6e11402bb87d2cd3d8a0f4c7db403c76be3f76e23d099591bf63be16010fcdf050b43330a80e3790415845d45c4968d3e95726a2f61e4f75a60a126fd2a453d7
+  data.tar.gz: ba667280e673ef818f8b04642c5176df647f67510577e183c587f37c95c2ed00535054b25976f6a28e83c7f8cd2939ff62068a5a747e1f2c3316a81c463a32d8

data/README.md

@@ -0,0 +1,52 @@
+# Ruby SDK for Entera's Activity Tracking System
+
+> The **ATS SDK for Ruby** is a convenient way to create analytics [Events](https://sudomafia.quip.com/YoyKAtd4kYaQ#JYcABAVioB9) and publish them to an SNS topic
+
+## Getting Started
+
+### **Installation**
+
+The **ATS SDK** is available from [RubyGems](http://https://rubygems.org). Add the following dependency to your Gemfile:
+   
+   ```ruby
+   gem 'ats-sdk'
+   ```
+
+## Configuration
+
+The **ATS SDK** uses the credentials and region from your **AWS SDK** configuration.
+
+### **Rails**
+
+To use in a `Rails` application, we recommend creating an initializer under the `config/initializers` directory in order to bootstrap the `ATS` object. There you will configure the **ATS SDK** with your `SNS` topic:
+
+```ruby
+# config/initializers/ats.rb
+ATS.configure do |config|
+  config.topic = 'arn:aws:sns:us-east-1:123456789012:my-topic'
+end
+```
+
+## Quick Example
+
+### Create and publish an Event
+
+```ruby
+event = {
+  subject: {
+    type: 'User',
+    key: 'fm-12iubg9uhaf82f'
+  },
+  verb: 'edit',
+  direct_object: {
+    type: 'Opportunity',
+    key: 'fe8f3a65-13ed-45b7-8ebf-45c24d321023'
+  },
+  context: {
+    field: 'broker_signature',
+    previous_value: 'Robert Salmos',
+    current_value: 'Robert Salmons'
+  }
+}
+ATS::Event.create(event)
+```

data/ats-sdk.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'ats-sdk'
-  s.version     = '1.0.0'
+  s.version     = '1.1.0'
   s.summary     = "Ruby sdk for Entera's Activity Tracking System"
   s.description = 'ATS tracks activities using the Event Grammar.'
   s.authors     = ['Carlos González']

data/lib/ats/event.rb

@@ -11,7 +11,7 @@ module ATS
 
       event.merge!(params)
 
-      topic.publish({ message: JSON.generate(event) })
+      topic.publish({ message: JSON.pretty_generate(event) })
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ats-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Carlos González
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-03 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sns