relax-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: adff098dfab3b6235f2d925db88d2a1a7c626d0f
+  data.tar.gz: b7f2c5ad14d0bafacfdbabbd9aa8137b4f8ba7c6
+SHA512:
+  metadata.gz: 639d3c3e543bc5959ef656143c130d15e10f0cb5840c0c6f0197bac3ea6af0465a30439ab9c024a75d808a6b69c52952b41fd7eb7d5353ffe8ca4affe7184a11
+  data.tar.gz: 0c0fa52320c7af2cbc79a4971b9424f251136e4c89b8c9f4d43b6269f46f64603570eacd087efc2040e7c4863337c3abdc2ab7309f9a810e720507a2528ab963

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.3
+services:
+  - redis-server
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in relax-rb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 arunthampi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,130 @@
+# Relax
+
+Relax is a Ruby client/consumer library for [relax](https://github.com/zerobotlabs/relax) – which is a multitenant message broker for Slack.
+
+[![Travis Badge for relax-rb](https://api.travis-ci.org/zerobotlabs/relax-rb.svg?branch=master)](https://api.travis-ci.org/zerobotlabs/relax-rb)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'relax'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage (with Rails)
+
+[Relax](https://github.com/zerobotlabs/relax) is meant to be used in
+conjunction with a web app such as Rails. There are two primary
+functions that this library lets you perform:
+
+* Start Slack bots on Relax
+
+* Listen for events generated by Relax.
+
+### Setup (Environment Variables)
+
+The Relax Ruby client requires a few environment variables to be set up
+(these same environment variables are also used to set up the relax
+message broker).
+
+`RELAX_BOTS_KEY`: This can be any string value and is used to store state
+about all Slack clients currently controlled by Relax in Redis. (Used by
+`Relax::Bot`)
+
+`RELAX_BOTS_PUBSUB`: This can be any string value and is used to notify
+Relax brokers that a new Slack bot has been started. (Used by
+`Relax::Bot`)
+
+`RELAX_EVENTS_QUEUE`: This can be any string value and is used by Relax
+brokers to send events to the client. (Used by `Relax::EventListener`)
+
+For a full list of events that are sent from Relax brokers, visit the
+[Relax Github page](https://github.com/zerobotlabs/relax).
+
+### Starting Bots
+
+To start a bot, or update a bot with a new token, call
+`Relax::Bot.start!(team_uid, token)` where `team_uid` is the UID of the
+team (generated by the Slack API) and `token` is the API token for the
+bot (again generated by the Slack API).
+
+If a token is invalid or a bot connection is unsuccesful, you will
+receive a `disable_bot` event.
+
+### Listening for Events
+
+Events are queued in Redis by Relax brokers in the `REDIS_EVENTS_QUEUE`
+key and `Relax::EventListener.listen!` listens for events and invokes
+the callback that is set by `Relax::EventListener.callback=`.
+
+#### Setting the callback
+
+The recommended way to set the callback method for events in Rails is an
+initializer, for e.g. in a file `config/initializers/relax.rb`:
+
+```ruby
+callback = Proc.new do |event|
+  Rails.logger.info "received event: #{event}"
+  # handle event
+end
+
+Relax::EventListener.callback = callback
+```
+
+The callback can also be a class (or instance) method, in which case you should do
+something like this:
+
+```ruby
+class RelaxEventHandler
+  def self.handle_event(event)
+    Rails.logger.info "received event: #{event}"
+    # handle event
+  end
+end
+
+Relax::EventListener.callback = RelaxEventHandler.method(:handle_event)
+```
+
+#### Starting the Listener
+
+The recommended way to start the listener in a Rails app is to use
+[Foreman](https://github.com/ddollar/foreman). In your Procfile, create
+an entry like this:
+
+`relax: bundle exec rake relax:listen_for_events`
+
+And this will invoke `Relax::EventListener.listen!` as part your of your
+Rails application.
+
+This process can be scaled indepedently from the rest of your web
+application, and so the more events you get, the more "relax" listener
+processes you can have.
+
+#### Events
+
+An Event is an instance of the
+`[Relax::Event](https://github.com/zerobotlabs/relax-rb/blob/master/lib/relax/event.rb)` class.
+
+Read more about the different types of events generated by Relax
+[here](https://github.com/zerobotlabs/relax#events)
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zerobotlabs/relax-rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "relax/rb"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/relax/base.rb

@@ -0,0 +1,15 @@
+module Relax
+  class Base
+    def self.redis
+      if uri = ENV['REDISTOGO_URL']
+        redis_uri = URI.parse(uri)
+      elsif uri = ENV['REDIS_URL']
+        redis_uri = URI.parse(uri)
+      else
+        redis_uri = URI.parse("redis://localhost:6379")
+      end
+
+      @@redis ||= Redis.new(url: redis_uri, db: 0)
+    end
+  end
+end

data/lib/relax/bot.rb

@@ -0,0 +1,29 @@
+module Relax
+  class BotsKeyNotSetError < StandardError; end
+  class BotsPubsubNotSetError < StandardError; end
+
+  class Bot < Base
+    def self.start!(team_uid, token)
+      if relax_bots_key.nil? || relax_bots_key == ""
+        raise BotsKeyNotSetError, "Environment Variable RELAX_BOTS_KEY is not set"
+      end
+
+      if relax_bots_pubsub.nil? || relax_bots_pubsub == ""
+        raise BotsPubsubNotSetError, "Environment Variable RELAX_BOTS_PUBSUB is not set"
+      end
+
+      redis.multi do
+        redis.hset(relax_bots_key, team_uid, {team_id: team_uid, token: token}.to_json)
+        redis.publish(relax_bots_pubsub, {type: 'team_added', team_id: team_uid}.to_json)
+      end
+    end
+
+    def self.relax_bots_pubsub
+      ENV['RELAX_BOTS_PUBSUB']
+    end
+
+    def self.relax_bots_key
+      ENV['RELAX_BOTS_KEY']
+    end
+  end
+end

data/lib/relax/event.rb

@@ -0,0 +1,10 @@
+module Relax
+  class Event
+    attr_accessor :type, :user_uid, :channel_uid, :team_uid, :im, :text,
+                  :relax_bot_uid, :timestamp, :provider, :event_timestamp
+
+    def initialize(opts = {})
+      opts.each { |k,v| self.send("#{k}=", v) if self.respond_to?("#{k}=") }
+    end
+  end
+end

data/lib/relax/event_listener.rb

@@ -0,0 +1,52 @@
+module Relax
+  class EventsQueueNotSetError < StandardError; end
+
+  class EventListener < Base
+    DEFAULT_LOG_LEVEL        = 'info'
+
+    @@callback = nil
+    @@logger = nil
+
+    def self.listen!
+      if relax_events_queue.nil? || relax_events_queue == ""
+        raise EventsQueueNotSetError, "Environment Variable RELAX_EVENTS_QUEUE is not set"
+      end
+
+      self.log("Listening for Relax Events...")
+
+      while true do
+        queue_name, event_json = redis.blpop(relax_events_queue)
+
+        if queue_name == relax_events_queue
+          event = Event.new(JSON.parse(event_json))
+          callback.call(event) if callback
+        end
+      end
+    end
+
+    def self.log(text, level = DEFAULT_LOG_LEVEL)
+      return if logger.nil?
+      logger.send(level, "#{Time.now.strftime('%FT%T%z')}: #{text}")
+    end
+
+    def self.callback=(cb)
+      @@callback = cb
+    end
+
+    def self.callback
+      @@callback
+    end
+
+    def self.logger=(logger)
+      @@logger = logger
+    end
+
+    def self.logger
+      @@logger
+    end
+
+    def self.relax_events_queue
+      ENV['RELAX_EVENTS_QUEUE']
+    end
+  end
+end

data/lib/relax/railtie.rb

@@ -0,0 +1,18 @@
+require 'relax'
+require 'rails'
+
+module Relax
+  class Railtie < Rails::Railtie
+    initializer :after_initialize do
+      Relax::EventListener.logger ||= if defined?(Rails)
+        Rails.logger
+      elsif defined?(RAILS_DEFAULT_LOGGER)
+        RAILS_DEFAULT_LOGGER
+      end
+    end
+
+    rake_tasks do
+      load 'relax/tasks.rb'
+    end
+  end
+end

data/lib/relax/tasks.rb

@@ -0,0 +1,6 @@
+namespace :relax do
+  desc 'Start Listening for Events'
+  task listen_for_events: :environment do
+    Relax::EventListener.listen!
+  end
+end

data/lib/relax/version.rb

@@ -0,0 +1,3 @@
+module Relax
+  VERSION = "0.1.0"
+end

data/lib/relax.rb

@@ -0,0 +1,9 @@
+require "redis"
+require "json"
+
+require "relax/version"
+require "relax/base"
+require "relax/event"
+require "relax/event_listener"
+require "relax/bot"
+require 'relax/railtie' if defined?(Rails::Railtie)

data/relax-rb.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'relax/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "relax-rb"
+  spec.version       = Relax::VERSION
+  spec.authors       = ["arunthampi"]
+  spec.email         = ["arun@zerobotlabs.com"]
+
+  spec.summary       = %q{relax-rb is a Ruby Client for Relax, which is a message broker for Slack's Real-Time API}
+  spec.description   = %q{relax-rb is a Ruby Client for Relax, which is a message broker for Slack's Real-Time API}
+  spec.homepage      = "http://relax.zerobotlabs.com"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency             "redis",   "~> 3.2.1"
+  spec.add_dependency             "json",    "~> 1.8.3"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.3.0"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: relax-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- arunthampi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: relax-rb is a Ruby Client for Relax, which is a message broker for Slack's
+  Real-Time API
+email:
+- arun@zerobotlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/relax.rb
+- lib/relax/base.rb
+- lib/relax/bot.rb
+- lib/relax/event.rb
+- lib/relax/event_listener.rb
+- lib/relax/railtie.rb
+- lib/relax/tasks.rb
+- lib/relax/version.rb
+- relax-rb.gemspec
+homepage: http://relax.zerobotlabs.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.8
+signing_key: 
+specification_version: 4
+summary: relax-rb is a Ruby Client for Relax, which is a message broker for Slack's
+  Real-Time API
+test_files: []