ferris 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44f7b3f20a88bfe85335fca5585c9defa5d0f49f
+  data.tar.gz: ef9e9b221ab4401946e385b6e9ec6325fcad3c87
+SHA512:
+  metadata.gz: e66d90192fe63c8c05216225a5dc15f9597895a1d4506a45cd2d4dceb8701bc7a7ae3c4559bc2fff95b593b02ed7b27a443e99e0ffb605c7a205791b40e74f03
+  data.tar.gz: 0fca2026e06abb0f329b565b57d84e658a979f347dd1a1624954b31764d16d57e87f0e4a4702d62a85d93becbf7a651138ae1432b556baed4d3186258601790f

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2015 Sean Clemmer and Blue Jeans Network
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/Readme.md

@@ -0,0 +1,45 @@
+# Ferris
+
+A simple Slack client for Ruby
+
+```ruby
+#!/usr/bin/env ruby
+require 'ferris'
+
+TOKEN, CHANNEL = '...', '...'
+
+# Interact with the Real-Time Messaging API
+rtm = Ferris::RTM.new token: TOKEN
+
+# Interact with the regular API methods
+api = Ferris::API.new token: TOKEN
+
+# Callback for messages from the RTM API
+rtm.on :message do |m|
+  puts m
+end
+
+# Add as many callbacks as you like, they'll
+# each get a copy of incoming messages
+rtm.on :message do |m|
+  $stderr.puts message: m
+end
+
+rtm.go # Start the RTM API worker in the background
+
+# The RTM API allows you to send basic messages
+# See https://api.slack.com/rtm for docs
+rtm.send 'message', \
+  channel: CHANNEL, text: 'Hello from the RTM API'
+
+rtm.send 'ping' # Send "ping" and get back "pong"
+
+# Use the regular API for advanced scenarios (e.g. attachments)
+# See https://api.slack.com/methods for docs
+api.send 'chat.postMessage', \
+  channel: CHANNEL, text: 'Hello from the regular API'
+
+rtm.join # Bring the RTM API worker into the foreground
+
+rtm.kill # We'll never reach here...
+```

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/ferris.rb

@@ -0,0 +1,3 @@
+require_relative 'ferris/metadata'
+require_relative 'ferris/api'
+require_relative 'ferris/rtm'

data/lib/ferris/api.rb

@@ -0,0 +1,30 @@
+require 'json'
+require 'net/http'
+
+require 'slog'
+
+Thread.abort_on_exception = true
+
+
+module Ferris
+  class API
+    def initialize options={}
+      @token   = options.fetch :token
+      @logger  = options.fetch :logger, Slog.new
+      @api_url = options.fetch :api_url, 'https://slack.com/api'
+      log.trace event: 'API client initialized'
+    end
+
+    def send method, options={}
+      uri = URI File.join(@api_url, method)
+      options = { token: @token }.merge(options)
+      log.trace event: 'sending api request', method: method, options: options
+      res = Net::HTTP.post_form uri, options
+      log.debug event: 'sent api request', method: method, options: options, response: res
+      JSON.parse res.body
+    end
+
+  private
+    def log ; @logger end
+  end
+end

data/lib/ferris/metadata.rb

@@ -0,0 +1,48 @@
+module Ferris
+
+  # We use a VERSION file to tie into our build pipeline
+  VERSION  = File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).strip
+
+  # We don't really do all that much, be humble
+  SUMMARY  = 'A simple Slack client for Ruby'
+
+  # Like the MIT license, but even simpler
+  LICENSE  = 'ISC'
+
+  # Where you should look first
+  HOMEPAGE = 'https://github.com/sczizzo/ferris'
+
+  # Your benevolent dictator for life
+  AUTHOR   = 'Sean Clemmer'
+
+  # Turn here to strangle your dictator
+  EMAIL    = 'sclemmer@bluejeans.com'
+
+  # Bundled extensions
+  TRAVELING_RUBY_BUCKET = 'http://d6r77u77i8pq3.cloudfront.net'
+  TRAVELING_RUBY_VERSION = '20150715-2.2.2'
+  EM_VERSION = '1.0.4'
+
+  # Every project deserves its own ASCII art
+  ART      = <<-'EOART' % VERSION
+
+
+       ***
+     ** ***                                        *
+    **   ***                                      ***
+    **                                             *
+    **                 ***  ****    ***  ****               ****
+    ******      ***     **** **** *  **** **** * ***       * **** *
+    *****      * ***     **   ****    **   ****   ***     **  ****
+    **        *   ***    **           **           **    ****
+    **       **    ***   **           **           **      ***
+    **       ********    **           **           **        ***
+    **       *******     **           **           **          ***
+    **       **          **           **           **     ****  **
+    **       ****    *   ***          ***          **    * **** *
+    **        *******     ***          ***         *** *    ****
+     **        *****                                ***
+                                                              v%s
+
+  EOART
+end

data/lib/ferris/rtm.rb

@@ -0,0 +1,177 @@
+require 'json'
+require 'socket'
+require 'thread'
+require 'net/http'
+
+require 'slog'
+require 'websocket/driver'
+
+Thread.abort_on_exception = true
+
+
+module Ferris
+  class RTM
+    HTTPS_PORT = 443
+    SOCKET_READ_SIZE = 1024
+
+    def initialize options={}
+      @id        = 0
+      @jobs      = []
+      @stopped   = false
+      @callbacks = Hash.new { |h,k| h[k] = [] }
+      @q         = Queue.new
+      @qlock     = Mutex.new
+      @token     = options.fetch :token
+      @api_url   = options.fetch :api_url, 'https://slack.com/api'
+      @logger    = options.fetch :logger, Slog.new
+      @wss_uri   = construct_wss_uri @token, @api_url
+      log.trace event: 'RTM client initialized', wss_uri: @wss_uri.to_s
+    end
+
+
+    def on event, &block
+      unless [ :open, :close, :error, :message ].include? event
+        log.fatal event: 'invalid event', on_event: event
+        raise ArgumentError
+      end
+
+      log.debug event: 'adding callback', on_event: event
+      @callbacks[event] << block
+    end
+
+
+    def send type, message={}
+      log.debug event: 'sending message', message: message
+      message[:id] ||= next_id
+      message[:type] = type
+      enqueue message
+      nil
+    end
+
+
+    def go
+      log.trace event: 'connecting'
+      socket, driver = connect
+      log.debug event: 'connected'
+      @jobs << go_read_input(socket, driver)
+      @jobs << go_write_output(socket, driver)
+      @jobs
+    end
+
+
+    def kill ; @jobs.map(&:kill) end
+
+    def join ; @jobs.map(&:join) end
+
+
+
+  private
+
+    def log ; @logger end
+
+
+    def construct_wss_uri token, api_url
+      uri = URI File.join(api_url, 'rtm.start')
+      req = Net::HTTP.post_form uri, token: token
+      bod = JSON.parse req.body, symbolize_names: true
+      URI bod[:url]
+
+    rescue
+      x = { event: 'could not construct WSS URI' }
+      x[:error] = bod[:error] if bod && bod[:error]
+      log.fatal x
+      raise RuntimeError
+    end
+
+
+    def next_id
+      @qlock.synchronize { @id += 1 }
+    end
+
+
+    def enqueue message
+      @qlock.synchronize { @q << message }
+    end
+
+
+    def full_dequeue q=[]
+      nq = @qlock.synchronize { q << @q.shift until @q.empty? ; q }
+      nq
+    end
+
+
+    def wrapper socket
+      s = Struct.new :url, :socket do
+        def write *args
+          self.socket.write *args
+        end
+      end
+      s.new @wss_uri.to_s, socket
+    end
+
+
+    def connect
+      tcp_socket = TCPSocket.new @wss_uri.host, HTTPS_PORT
+      ssl_socket = OpenSSL::SSL::SSLSocket.new tcp_socket
+      ssl_socket.connect
+
+      driver = WebSocket::Driver.client wrapper(ssl_socket)
+
+      driver.on :open do |_|
+        log.trace event: 'driver open'
+        @callbacks[:open].map(&:call)
+      end
+
+      driver.on :close do |_|
+        log.trace event: 'driver close'
+        @callbacks[:close].map(&:call)
+      end
+
+      driver.on :error do |_|
+        log.trace event: 'driver error'
+        @callbacks[:error].map(&:call)
+      end
+
+      driver.on :message do |event|
+        log.trace event: 'driver message', message: event
+        data = JSON.parse event.data
+        @callbacks[:message].map { |c| c.call data }
+      end
+
+      driver.start
+      [ ssl_socket, driver ]
+    end
+
+
+    def go_read_input socket, driver
+      Thread.new do
+        loop do
+          log.trace event: 'reading socket'
+          data = socket.readpartial SOCKET_READ_SIZE
+          log.debug event: 'read socket', data_size: data.size
+          next if data.nil? || data.empty?
+          driver.parse data
+        end
+      end
+    end
+
+
+    def go_write_output socket, driver, delay=0.1
+      Thread.new do
+        loop do
+          q = full_dequeue
+
+          q.each do |m|
+            sent = driver.text JSON.generate(m)
+            unless sent
+              log.fatal event: 'could not send', message: m
+              raise RuntimeError
+            end
+          end
+
+          sleep delay if q.empty?
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: ferris
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Sean Clemmer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: websocket-driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+description: A simple Slack client for Ruby.
+email: sclemmer@bluejeans.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- Readme.md
+- VERSION
+- lib/ferris.rb
+- lib/ferris/api.rb
+- lib/ferris/metadata.rb
+- lib/ferris/rtm.rb
+homepage: https://github.com/sczizzo/ferris
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A simple Slack client for Ruby
+test_files: []
+has_rdoc: