botmetrics-rb 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cee50d258a296337e9a35afc509a0f11b76dd55
-  data.tar.gz: 4d5a8762e422814318ccb72526ae22cba39aed5b
+  metadata.gz: d52b84166c8dc99b99d90eca6b723ea10f562a5d
+  data.tar.gz: cd8db70b02fa23b83af2cec3659601c1de625eb7
 SHA512:
-  metadata.gz: 8b21e93a64187138372c7c6957e6385ed43a9e52a4301edeec94927aece3cfae1fa456ad9a46e3401a6773e03483b0983487c862b838046c21191d36766e0629
-  data.tar.gz: d110efb340bf2fee7fdad04b44d192d81d818a9d6215422517c3eb0a7c2efa6eb408980120cb3d9e4716f56d032daa9d005d91e64e4b0603afed54e0dfeccefa
+  metadata.gz: 24bd20b4b6522fa31b662ffb298b17cb527b2f5fd5b9a1ff4095d15d1cdeafa10a2baf8596767cd13a7b76105457c4401e3fea7ab28c3ff9da6e6340ac5311e6
+  data.tar.gz: 359eb18be44c0d2d6a6357ffeb47a930d2b3267e31aa53d4c775966bda98fbd47d873e534d50550b637751238c27246c0b05058d0b8d1531bca80d442906e555

data/README.md

@@ -23,37 +23,89 @@ Or install it yourself as:
 ## Usage
 
 Log in to your [BotMetrics](https://getbotmetrics.com) account, navigate
-to "Bot Settings" and find out your Team ID, Bot ID and API Key.
+to "Bot Settings" and find out your Bot ID and API Key.
 
-Set the following environment variables with the Team ID, Bot ID and API
-Key respectively.
+With that, you can initialize a `BotMetrics::Client`:
 
+```ruby
+client = BotMetrics::Client.new(api_key: '123', bot_id: '123')
 ```
-BOTMETRICS_TEAM_ID=your-team-id
-BOTMETRICS_BOT_ID=your-bot-id
-BOTMETRICS_API_KEY=your-api-key
+
+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:
+
+```ruby
+client = BotMetrics::Client.new
 ```
 
-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:
+### `register_bot!`
+
+With a `BotMetrics::Client` instance,
+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`,
+you can make the following call:
 
 ```ruby
-BotMetrics.register_bot!('bot-token')
+client = BotMetrics::Client.new(api_key: '123', bot_id: '123')
+client.register_bot!('bot-token')
 ```
 
-### Retroactive registration
+#### 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)
+client = BotMetrics::Client.new(api_key: '123', bot_id: '123')
+client.register_bot!('bot-token', created_at: 1462318092)
+```
+
+### `message`
+
+You can send messages to a Slack channel or user using the `#message` method:
+
+#### Sending a Message to a Channel
+
+```ruby
+client = BotMetrics::Client.new(api_key: '123', bot_id: '123')
+client.message(team_id: 'T123', channel: 'C123', text: 'Hello!')
+```
+
+#### Sending an Attachment to a User
+
+```ruby
+client = BotMetrics::Client.new(api_key: '123', bot_id: '123')
+client.message(
+  team_id: 'T123',
+  user: 'U123',
+  attachments:
+    [
+      {
+          "title": "Title",
+          "pretext": "Pretext _supports_ mrkdwn",
+          "text": "Testing *right now!*",
+          "mrkdwn_in": ["text", "pretext"]
+      }
+    ]
+)
 ```
 
+Accepted parameters include:
+
+- `team_id`: This is the Slack ID
+- `channel`: This is the Slack channel's UID
+- `user`: This is the Slack user's UID
+- `text`: A string
+- `attachments`: Attachments that follows the Slack's [message attachment structure](https://api.slack.com/docs/attachments)
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment with the gem.
 
 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).
 
@@ -65,4 +117,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "botmetrics/rb"
+require_relative "../lib/botmetrics"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/botmetrics-rb.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'botmetrics'
+require 'botmetrics-rb/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "botmetrics-rb"
@@ -27,8 +27,8 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "json",         "~> 1.8.3"
-  spec.add_dependency "excon",        "~> 0.49.0"
+  spec.add_dependency "json", "~> 1.8.3"
+  spec.add_dependency "http", "~> 2.0.0"
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/botmetrics-rb/version.rb

@@ -0,0 +1,3 @@
+module BotMetrics
+  VERSION = "0.0.5"
+end

data/lib/botmetrics.rb

@@ -1,42 +1,90 @@
 require "json"
-require "excon"
+require "http"
 
-class BotMetrics
-  VERSION = "0.0.3"
+module BotMetrics
+  class Client
+    DEFAULT_API_HOST = "https://www.getbotmetrics.com".freeze
 
-  def self.register_bot!(token, opts = {})
-    bot_id = opts[:bot_id] || opts['bot_id'] || ENV['BOTMETRICS_BOT_ID']
-    api_key = opts[:api_key] || opts['api_key'] || ENV['BOTMETRICS_API_KEY']
+    def initialize(api_key: nil, bot_id: nil, api_host: nil)
+      @api_key  = api_key  || ENV['BOTMETRICS_API_KEY']
+      @bot_id   = bot_id   || ENV['BOTMETRICS_BOT_ID']
+      @api_host = api_host || ENV['BOTMETRICS_API_HOST'] || DEFAULT_API_HOST
 
-    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")
+      if blank?(@api_key)
+        raise ArgumentError.new("Missing argument api_key. Please pass api_key in as an argument.")
+      end
+
+      if blank?(@bot_id)
+        raise ArgumentError.new("Missing argument bot_id. Please pass bot_id in as an argument.")
+      end
+    end
+
+    def register_bot!(token, opts = {})
+      params = { "format" => "json", "instance[token]" => token }
+
+      created_at = opts[:created_at] || opts["created_at"]
+      params["instance[created_at]"] = created_at.to_i if created_at.to_i != 0
+
+      response = HTTP.auth(api_key).post("#{api_url}/instances", params: params)
+
+      response.code == 201
     end
-    if api_key.nil? || api_key == ""
-      raise ArgumentError.new("You have to either set the env variable BOTMETRICS_API_KEY or pass in an as argument api_key")
+
+    def message(team_id:, channel: nil, user: nil, text: nil, attachments: nil)
+      if blank?(channel) && blank?(user)
+        raise ArgumentError.new("Missing argument channel and user. Please provide at least one.")
+      end
+
+      if blank?(text) && blank?(attachments)
+        raise ArgumentError.new("Missing argument text and attachments. Please provide at least one.")
+      end
+
+      params = {
+        "message[team_id]"     => team_id,
+        "message[channel]"     => channel,
+        "message[user]"        => user,
+        "message[text]"        => text,
+        "message[attachments]" => message_attachments(attachments)
+      }.delete_if { |_, v| v.nil? }
+
+      response = HTTP.auth(api_key).post("#{api_url}/messages", params: params)
+
+      response.code == 202
     end
 
-    created_at = opts[:created_at] || opts['created_at']
-    host = ENV['BOTMETRICS_API_HOST'] || 'https://www.getbotmetrics.com'
+    private
 
-    opts = {
-      omit_default_port: true,
-      idempotent: true,
-      retry_limit: 6,
-      read_timeout: 360,
-      connect_timeout: 360
-    }
+      attr_accessor :api_key, :bot_id, :api_host
 
-    params = { "instance[token]" => token }
-    params["instance[created_at]"] = created_at.to_i if created_at.to_i != 0
-    params["format"] = "json"
+      def blank?(attr)
+        attr.nil? || attr == ''
+      end
 
-    url = "#{host}/bots/#{bot_id}/instances"
-    opts[:body] = URI.encode_www_form(params)
-    opts[:headers] = { "Authorization" => api_key }
+      def api_url
+        "#{api_host}/bots/#{bot_id}"
+      end
 
-    connection = Excon.new(url, opts)
-    response = connection.request(method: :post)
+      def options(extra_params)
+        {
+          headers: { "Authorization" => api_key },
+          omit_default_port: true,
+          idempotent: true,
+          retry_limit: 6,
+          read_timeout: 360,
+          connect_timeout: 360
+        }.merge(extra_params)
+      end
 
-    response.status == 201
+      def message_attachments(attachments)
+        if attachments.nil?
+          nil
+        else
+          if attachments.is_a? String
+            attachments
+          else
+            attachments.to_json
+          end
+        end
+      end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: botmetrics-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - arunthampi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.8.3
 - !ruby/object:Gem::Dependency
-  name: excon
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -113,6 +113,7 @@ files:
 - bin/console
 - bin/setup
 - botmetrics-rb.gemspec
+- lib/botmetrics-rb/version.rb
 - lib/botmetrics.rb
 homepage: https://www.getbotmetrics.com
 licenses: