botmetrics-rb 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 106cf210784c115147a4b15314e52dc43e0ba207
-  data.tar.gz: 0169bea4d06d549d4e888f38f0c98b8a627cb4aa
+  metadata.gz: 6cee50d258a296337e9a35afc509a0f11b76dd55
+  data.tar.gz: 4d5a8762e422814318ccb72526ae22cba39aed5b
 SHA512:
-  metadata.gz: 4d512ccaa2e792a4ebaee6df35e304de644e7f1d2ef05ec6c98a64863f24e19181e76d3e235a4e01214becbe0a674cbff160d85280dbd148fd57df19f96e5258
-  data.tar.gz: b3851591573805073d9cee7c77b5b6402a5939f9d164f8c0dc598c19bca3d1afbf0fe3f42ac3e61ed48d0af1cf90735ad48474c86004fe3f71391bec5121a3d2
+  metadata.gz: 8b21e93a64187138372c7c6957e6385ed43a9e52a4301edeec94927aece3cfae1fa456ad9a46e3401a6773e03483b0983487c862b838046c21191d36766e0629
+  data.tar.gz: d110efb340bf2fee7fdad04b44d192d81d818a9d6215422517c3eb0a7c2efa6eb408980120cb3d9e4716f56d032daa9d005d91e64e4b0603afed54e0dfeccefa

data/README.md

@@ -1,8 +1,8 @@
-# Botmetrics::Rb
+# Botmetrics
 
-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/botmetrics/rb`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Botmetrics is a Ruby client to the
+[BotMetrics](https://getbotmetrics.com) service which lets you collect
+& analyze metrics for your bot.
 
 ## Installation
 
@@ -22,7 +22,34 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Log in to your [BotMetrics](https://getbotmetrics.com) account, navigate
+to "Bot Settings" and find out your Team ID, Bot ID and API Key.
+
+Set the following environment variables with the Team ID, Bot ID and API
+Key respectively.
+
+```
+BOTMETRICS_TEAM_ID=your-team-id
+BOTMETRICS_BOT_ID=your-bot-id
+BOTMETRICS_API_KEY=your-api-key
+```
+
+Once you have that set up, every time you create a new Slack Bot (in the
+OAuth2 callback), and assuming the bot token you received as part of the
+OAuth2 callback is `bot-token`, make the following call:
+
+```ruby
+BotMetrics.register_bot!('bot-token')
+```
+
+### Retroactive registration
+
+If you created your bot in the past, you can pass in `created_at` with
+the UNIX timestamp of when your bot was created, like so:
+
+```ruby
+BotMetrics.register_bot!('bot-token', created_at: 1462318092)
+```
 
 ## Development
 

data/lib/botmetrics.rb

@@ -2,16 +2,12 @@ require "json"
 require "excon"
 
 class BotMetrics
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 
   def self.register_bot!(token, opts = {})
-    team_id = opts[:team_id] || opts['team_id'] || ENV['BOTMETRICS_TEAM_ID']
     bot_id = opts[:bot_id] || opts['bot_id'] || ENV['BOTMETRICS_BOT_ID']
     api_key = opts[:api_key] || opts['api_key'] || ENV['BOTMETRICS_API_KEY']
 
-    if team_id.nil? || team_id == ""
-      raise ArgumentError.new("You have to either set the env variable BOTMETRICS_TEAM_ID or pass in an as argument team_id")
-    end
     if bot_id.nil? || bot_id == ""
       raise ArgumentError.new("You have to either set the env variable BOTMETRICS_BOT_ID or pass in an as argument bot_id")
     end
@@ -34,7 +30,7 @@ class BotMetrics
     params["instance[created_at]"] = created_at.to_i if created_at.to_i != 0
     params["format"] = "json"
 
-    url = "#{host}/teams/#{team_id}/bots/#{bot_id}/instances"
+    url = "#{host}/bots/#{bot_id}/instances"
     opts[:body] = URI.encode_www_form(params)
     opts[:headers] = { "Authorization" => api_key }
 

metadata

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