zulip-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2156d1fd144e2ea7808de4108f0973e638a28db4
+  data.tar.gz: 72a36e82a6d60df942a29424ae9b8c4bd863049b
+SHA512:
+  metadata.gz: 0cd3179c5dfe9505d1a47b58154e290fcb91998d43664de65e7f185a6451edf881e89701b7b757f05ef0f54033427309da8ebfe28cc42681c94888fe6cb6593c
+  data.tar.gz: d41cfdf494f5f40b9773feee043d3848ffb2cae8ee22471cd114952bc536805129aa6d108fef973902dc88991977021b1d853590dcfd2a9fd42256fd1f253f2e

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 okkez
+
+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,63 @@
+# Zulip::Client
+
+[Zulip](https://zulip.org/) client for [Ruby](https://www.ruby-lang.org/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zulip-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zulip-client
+
+## Usage
+
+Send message to stream:
+
+```ruby
+client = Zulip::Client.new(site: "https://zulip.example.com/",
+                           username: "test-bot@zulip.example.com",
+                           api_token: "xxxxxxxxxxxxx")
+client.send_message(type: :stream, to: "general", subject: "projects", content: "Hello, Zulip!")
+```
+
+Send private message to users:
+
+```ruby
+client.send_message(type: :stream, to: "user@zulip.example.com", content: "Hello, Zulip!")
+client.send_message(type: :stream, to: ["user1@zulip.example.com", "user2@zulip.example.com"], content: "Hello, Zulip!")
+```
+
+Receive all events:
+
+```ruby
+client.each_event do |event|
+  p event
+end
+```
+
+Receive message event:
+
+```ruby
+client.each_message do |event|
+  p event
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/okkez/zulip-client.
+
+
+## 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,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/test_*.rb"
+  t.verbose = true
+  t.warning = true
+end
+
+task :default => :test

data/lib/zulip/client.rb

@@ -0,0 +1,139 @@
+require "json"
+require "uri"
+require "faraday"
+require "typhoeus"
+require "typhoeus/adapters/faraday"
+
+require "zulip/error"
+
+Faraday.default_adapter = :typhoeus
+
+module Zulip
+  class Client
+    attr_accessor :debug
+
+    def initialize(site:, username:, api_key:, **options)
+      @site = URI.parse(site)
+      @connection = Faraday.new(@site.to_s, options) do |faraday|
+        faraday.adapter Faraday.default_adapter
+        yield faraday if block_given?
+      end
+      @connection.basic_auth(username, api_key)
+      @running = false
+      @debug = false
+    end
+
+    def send_message(type: :stream, to: "general", subject: "", content: "")
+      @connection.post do |request|
+        request.url("/api/v1/messages")
+        params = { "type" => type.to_s }
+        case type
+        when :private
+          params["to"] = JSON.generate(Array(to))
+        when :stream
+          params["to"] = to
+          params["subject"] = subject
+        end
+        params["content"] = content
+        request.body = params
+      end
+    end
+
+    def register(event_types: [], narrow: [])
+      response = @connection.post do |request|
+        request.url("/api/v1/register")
+        params = {}
+        params["event_types"] = JSON.generate(event_types) unless event_types.empty?
+        params["narrow"] = JSON.generate(narrow) unless narrow.empty?
+        request.body = params
+      end
+      if response.success?
+        res = JSON.parse(response.body, symbolize_names: true)
+        [res[:queue_id], res[:last_event_id]]
+      else
+        raise Zulip::ResponseError, reqponse.reason_phrase
+      end
+    end
+
+    def unregister(queue_id)
+      response = @connection.delete do |request|
+        request.url("/api/v1/events")
+        request.body = { "queue_id" => queue_id }
+      end
+      if response.success?
+        JSON.parse(response.body, symbolize_names: true)[:result] == "success"
+      else
+        raise Zulip::ResponseError, reqponse.reason_phrase
+      end
+    end
+
+    def stream_event(event_types: [], narrow: [])
+      queue_id, last_event_id = register(event_types: event_types, narrow: narrow)
+      response_reader, response_writer = IO.pipe
+      command_reader, @command_writer = IO.pipe
+      @running = true
+      t = Thread.new do
+        loop do
+          break unless @running
+          response = get_events(queue_id: queue_id, last_event_id: last_event_id)
+          response_writer.write(response)
+        end
+      end
+      buf = ""
+      loop do
+        reader, _writer, _exception = IO.select([response_reader, command_reader])
+        case reader.first
+        when response_reader
+          buf << response_reader.readpartial(1024)
+          begin
+            res = JSON.parse(buf, symbolize_names: true)
+          rescue JSON::ParserError => ex
+            warn("#{ex.class}:#{ex.message}")
+            next
+          end
+          buf = ""
+          if res[:result] == "success"
+            res[:events].each do |event|
+              last_event_id = event[:id]
+              if event_types.empty? || event_types.include?(event[:type])
+                yield event
+              end
+            end
+          else
+            raise Zulip::ResponseError, res[:msg]
+          end
+        when command_reader
+          break
+        end
+      end
+      unregister(queue_id)
+      t.join
+    end
+
+    def stream_message(narrow: [])
+      stream_event(event_types: ["message"], narrow: narrow) do |event|
+        yield event[:message]
+      end
+    end
+
+    def close_stream
+      @running = false
+      @command_writer.write("q") if @command_writer
+    end
+
+    private
+
+    def get_events(queue_id:, last_event_id:)
+      response = @connection.get do |request|
+        request.url("/api/v1/events")
+        request.params["queue_id"] = queue_id
+        request.params["last_event_id"] = last_event_id
+      end
+      if response.success?
+        response.body
+      else
+        raise Zulip::ResponseError, response.reason_phrase
+      end
+    end
+  end
+end

data/lib/zulip/client/version.rb

@@ -0,0 +1,5 @@
+module Zulip
+  class Client
+    VERSION = "0.1.0"
+  end
+end

data/lib/zulip/error.rb

@@ -0,0 +1,4 @@
+module Zulip
+  class ResponseError < StandardError
+  end
+end

data/zulip-client.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "zulip/client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "zulip-client"
+  spec.version       = Zulip::Client::VERSION
+  spec.authors       = ["okkez"]
+  spec.email         = ["okkez000@gmail.com"]
+
+  spec.summary       = "Zulip client for Ruby"
+  spec.description   = "Zulip client for Ruby"
+  spec.homepage      = "https://github.com/okkez/zulip-client-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "faraday", ">= 0.11.0"
+  spec.add_runtime_dependency "typhoeus", "~> 1.1.0"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "test-unit", ">= 3.2.0"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: zulip-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- okkez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Zulip client for Ruby
+email:
+- okkez000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zulip/client.rb
+- lib/zulip/client/version.rb
+- lib/zulip/error.rb
+- zulip-client.gemspec
+homepage: https://github.com/okkez/zulip-client-ruby
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Zulip client for Ruby
+test_files: []