botmetrics-rb 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bfdb6f2c5185bfc55b0e3d513f5373543c46c96
-  data.tar.gz: 3e0bba776347f42429dabdb50299f0b0d0f0c691
+  metadata.gz: 98ba5b37417b450981dc1c20cbc1fce08f94bae2
+  data.tar.gz: c0d606e3e92f79f473be28a3bbeda0b7f83787d7
 SHA512:
-  metadata.gz: acca01aad2a3fe7384cea188e4c696700759903e57e9346d0fea31cd98c304e10477c999f880543eccd0632b86528ecb04918aece220b40fc734bc89baf270cb
-  data.tar.gz: 60d7b9f43b5c980b7feb29ef599361388bd04ba8186b4cfca0ef6c4b4c8a26c28cde8290722c5810b1f13ae75d4ef965883a53c62d33b82544143de7ffe48211
+  metadata.gz: 9b9c84184f3c351748482bebe7d01d236db4320f3d873bb4c6f247f5c78ae314d2052311262ed6a1dbdd36ba8b93f3719319f56a110dd4e65a7c427fd238911e
+  data.tar.gz: 46286a5e0b11525edcb5c6be9e524fd61674ac789debdaffbc26d31d7b09ebd1a1763cba38842671db11bfd1621668c29e73880804278d81d3524c85162da044

data/README.md

@@ -12,7 +12,7 @@ Status](https://travis-ci.org/botmetrics/botmetrics-rb.svg?branch=master)](https
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'botmetrics-rb'
+gem 'botmetrics-rb', require: 'botmetrics'
 ```
 
 And then execute:
@@ -23,10 +23,40 @@ Or install it yourself as:
 
     $ gem install botmetrics-rb
 
-## Usage
+## Usage (Facebook)
 
-Log in to your [BotMetrics](https://getbotmetrics.com) account, navigate
-to "Bot Settings" and find out your Bot ID and API Key.
+Register your Facebook bot with
+[Botmetrics](https://getbotmetrics.com). Once you have done so, navigate to "Bot Settings" and find out your Bot ID and API Key.
+
+With that, you can initialize a `BotMetrics::Client`:
+
+```ruby
+client = BotMetrics::Client.new(api_key: '123', bot_id: '123')
+```
+
+Alternatively, you can set the following ENV variables
+
+- `ENV['BOTMETRICS_API_KEY']`
+- `ENV['BOTMETRICS_BOT_ID']`
+
+and initialize a `BotMetrics::Client` with the default ENV variables:
+
+```ruby
+client = BotMetrics::Client.new
+```
+
+### track
+
+Call the `track` API in the webhook receiver that handles all of your
+Facebook messages.
+
+```ruby
+client.track(params)
+```
+
+## Usage (Slack)
+
+Log in to your [BotMetrics](https://getbotmetrics.com) account, navigate to "Bot Settings" and find out your Bot ID and API Key.
 
 With that, you can initialize a `BotMetrics::Client`:
 
@@ -38,7 +68,6 @@ Alternatively, you can set the following ENV variables
 
 - `ENV['BOTMETRICS_API_KEY']`
 - `ENV['BOTMETRICS_BOT_ID']`
-- `ENV['BOTMETRICS_API_HOST']`
 
 and initialize a `BotMetrics::Client` with the default ENV variables:
 

data/lib/botmetrics-rb/version.rb

@@ -1,3 +1,3 @@
 module BotMetrics
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/lib/botmetrics.rb

@@ -48,7 +48,7 @@ module BotMetrics
         raise ArgumentError.new("event is not a valid JSON string or Hash")
       end
 
-      response = HTTP.auth(api_key).post("#{api_url}/events", params: {event: event_json})
+      response = HTTP.auth(api_key).post("#{api_url}/events", params: {event: event_json, format: 'json'})
       response.code == 202
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: botmetrics-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - arunthampi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-04 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json