zulip_machine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 843bdc57ae27bf5f5d607c88b90141299eac93c8
+  data.tar.gz: b50e48ec36809e32043833af1a2421053c64df7b
+SHA512:
+  metadata.gz: ced5c67c9e4778484dc9307edd7d9e6323a44a750a15ca50f82ccf534172257de71e785c713948a3458664565d7dbcc605c99524a9159b95ab1136b97d12a3c9
+  data.tar.gz: 2ae1667d2ee2977f1195a93205e19a4bb0d6ad5691e79f2b7b23fb866b436bc06550783e5ac18c4aa2c8d23fb2ba40212e136ca785f6114ba4b852e90056ea76

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alan O'Donnell
+
+MIT License
+
+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,29 @@
+# ZulipMachine
+
+EventMachine bindings for Zulip's API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zulip_machine'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zulip_machine
+
+## Usage
+
+Take a look at the `examples` directory.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/annoying_bot.rb

@@ -0,0 +1,19 @@
+require 'zulip_machine'
+
+EM.run do
+  email = ENV['EMAIL']
+  api_key = ENV['API_KEY']
+
+  bot = ZulipMachine::Bot.new(email, api_key)
+  bot.start!
+
+  bot.subscribe!(["test-bot"])
+
+  bot.on_private_msg do |from, msg|
+    from.send(msg.upcase)
+  end
+
+  bot.on_stream_msg do |from, convo, msg|
+    convo.send("cool story bro")
+  end
+end

data/lib/zulip_machine.rb

@@ -0,0 +1,158 @@
+require "zulip_machine/version"
+
+require 'em-http'
+require 'json'
+
+module EM::Deferrable
+  def bind(&f)
+    d = EM::DefaultDeferrable.new
+    callback do |a|
+      f.call(a).callback { |b| d.succeed(b) }.errback { |e| d.fail(e) }
+    end
+    errback { |e| d.fail(e) }
+    d
+  end
+  def map(&f)
+    d = EM::DefaultDeferrable.new
+    callback { |a| d.succeed(f.call(a)) }
+    errback  { |e| d.fail(e) }
+    d
+  end
+end
+
+module ZulipMachine
+  ENDPOINT = "https://api.zulip.com/v1"
+
+  User = Struct.new(:bot, :deets) do
+    def email
+      deets["email"] || deets["sender_email"] # yuck :/
+    end
+    def send(msg)
+      bot.send_private_msg(email, msg)
+    end
+  end
+
+  Conversation = Struct.new(:bot, :stream, :subject) do
+    def send(msg)
+      bot.send_stream_msg(stream, subject, msg)
+    end
+  end
+
+  class Bot
+    def initialize(email, api_key)
+      @email = email
+      @api_key = api_key
+      @private_cbs = []
+      @stream_cbs = []
+      @presence_cbs = []
+    end
+
+    def start!
+      post("/register").callback do |r|
+        fetch_events(r["queue_id"], r["last_event_id"])
+      end
+    end
+
+    def send_private_msg(to_whom, msg)
+      post("/messages", type: "private", to: to_whom, content: msg)
+    end
+
+    def send_stream_msg(to, subject, msg)
+      post("/messages", type: "stream", to: to, subject: subject, content: msg)
+    end
+
+    def get_subscriptions
+      get("/users/me/subscriptions")
+    end
+
+    def subscribe!(streams)
+      streams = streams.map { |name| { name: name } }
+      patch("/users/me/subscriptions", add: JSON.unparse(streams))
+    end
+
+    def unsubscribe!(streams)
+      patch("/users/me/subscriptions", subscriptions: JSON.unparse(streams))
+    end
+
+    def on_private_msg(&cb)
+      @private_cbs << cb
+    end
+    def on_stream_msg(&cb)
+      @stream_cbs << cb
+    end
+    def on_presence(&cb)
+      @presence_cbs << cb
+    end
+
+    def fetch_events(q_id, event_id)
+      get("/events", queue_id: q_id, last_event_id: event_id).callback do |r|
+        r["events"].each { |e| handle_event(e) }
+        event_id = r["events"].map { |e| e["id"] }.max
+        fetch_events(q_id, event_id)
+      end.errback do |c|
+        fetch_events(q_id, event_id)
+      end
+    end
+
+    def handle_event(e)
+      case e["type"]
+      when "message"
+        deets = e["message"]
+        case deets["type"]
+        when "private"
+          unless deets["sender_email"] == @email
+            from = User.new(self, deets)
+            msg = deets["content"]
+            @private_cbs.each { |cb| cb.call(from, msg) }
+          end
+        when "stream"
+          unless deets["sender_email"] == @email
+            from = User.new(self, deets)
+            stream = deets["display_recipient"]
+            subject = deets["subject"]
+            convo = Conversation.new(self, stream, subject)
+            msg = deets["content"]
+            @stream_cbs.each { |cb| cb.call(from, convo, msg) }
+          end
+        end
+      when "presence"
+        who = User.new(self, e)
+        presence = e["presence"]
+        @presence_cbs.each { |cb| cb.call(who, presence) }
+      end
+    end
+
+    def get(path, params = nil)
+      req(path).get(
+        query: params, 
+        head: auth,
+        inactivity_timeout: 0
+      ).map { |c| JSON.parse(c.response) }
+    end
+
+    def post(path, params = nil)
+      req(path).post(
+        body: params, 
+        head: auth,
+        inactivity_timeout: 0
+      ).map { |c| JSON.parse(c.response) }
+    end
+
+    def patch(path, params = nil)
+      req(path).patch(
+        body: params,
+        head: auth,
+        inactivity_timeout: 0
+      ).map { |c| JSON.parse(c.response) }
+    end
+
+    def req(path)
+      EM::HttpRequest.new(ENDPOINT + path)
+    end
+
+    def auth
+      { authorization: [@email, @api_key] }
+    end
+  end
+end
+

data/lib/zulip_machine/version.rb

@@ -0,0 +1,3 @@
+module ZulipMachine
+  VERSION = "0.0.1"
+end

data/zulip_machine.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zulip_machine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zulip_machine"
+  spec.version       = ZulipMachine::VERSION
+  spec.authors       = ["Alan O'Donnell"]
+  spec.email         = ["alan.m.odonnell@gmail.com"]
+  spec.description   = "EventMachine bindings for Zulip's API."
+  spec.summary       = "EventMachine bindings for Zulip's API."
+  spec.homepage      = "https://github.com/happy4crazy/zulip_machine"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "em-http-request", "~> 1.1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: zulip_machine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alan O'Donnell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: EventMachine bindings for Zulip's API.
+email:
+- alan.m.odonnell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/annoying_bot.rb
+- lib/zulip_machine.rb
+- lib/zulip_machine/version.rb
+- zulip_machine.gemspec
+homepage: https://github.com/happy4crazy/zulip_machine
+licenses:
+- MIT
+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.1.3
+signing_key: 
+specification_version: 4
+summary: EventMachine bindings for Zulip's API.
+test_files: []