weechat-relay-helper 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c187a206f928f03e18d479e405791914e2132ebe
+  data.tar.gz: e21cffba12ef157aa5edc15814b21d0051493ac9
+SHA512:
+  metadata.gz: afce2a81fd0df1ef3df0af86b87f5ca2b7771293437a69c3d697cb39f13d8c0a47b988924a71a50c0e2c0658ec0c2a093dce7cc9aa575278b34df34e96f89950
+  data.tar.gz: 015d94bebb0b7ae157fca8b3b0e69b495f241038d17f5ddf6b3e13952fbc069f4621d9e36a289a6312c510cf725aac1bce8618cadc7953d516d64fb0d8586d19

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Rylee Fowler
+
+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,11 @@
+weechat-relay-helper
+====================
+
+Simple utility to assist in the creation of applications that interface with the Weechat relay protocol, such as mobile apps or web-apps.
+
+##[Demo run (on asciinema)](https://asciinema.org/a/10649)
+
+TODO
+----
+- [ ] hdata support
+- [ ] Less awful asynchronous networking

data/bin/weechat-relay-helper

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# License details in LICENSE.
+require 'readline'
+require 'awesome_print'
+require 'weechat-relay-helper'
+
+opts = RelayHelper::Options.new ARGV
+conn = RelayHelper::Weechat.new opts.host, opts.port, opts.ssl, opts.compression, opts.password
+
+Thread.new do
+  loop do #until conn.connection.closed?
+    begin
+      r, _, _ = IO.select [conn.connection.socket]
+      unless r.empty?
+        len = conn.connection.read(4)
+        rest = conn.connection.read(len.unpack('L>')[0] - 4)
+        r = RelayHelper::Response.new(len + rest)
+        ap({ id: r.id, data: r.data })
+      end
+    rescue OpenSSL::SSL::SSLErrorWaitReadable, IO::EAGAINWaitReadable => e
+      pass
+    rescue Exception => e
+      puts e.backtrace
+    end
+  end
+end
+
+puts "Go ahead and type your commands."
+puts "Relay reference is located at http://www.weechat.org/files/doc/devel/weechat_relay_protocol.en.html"
+
+while line = Readline.readline('', true)
+  conn.connection.puts line
+  puts "--> #{line}"
+end

data/lib/weechat-relay-helper.rb

@@ -0,0 +1,10 @@
+# License details in LICENSE
+require 'zlib'
+require 'optparse'
+require 'openssl'
+require 'socket'
+
+require 'weechat-relay-helper/response'
+require 'weechat-relay-helper/options'
+require 'weechat-relay-helper/connection'
+require 'weechat-relay-helper/weechat'

data/lib/weechat-relay-helper/connection.rb

@@ -0,0 +1,59 @@
+# License details in LICENSE
+module RelayHelper
+  class Connection
+    attr_reader :socket
+    def initialize host, port, ssl
+      @host = host
+      @port = port
+      @ssl = ssl
+    end
+    def establish_plaintext_connection host, port
+      TCPSocket.open(host, port)
+    end
+    def establish_ssl_connection host, port
+      sock = TCPSocket.new host, port
+      ssl_ctx = OpenSSL::SSL::SSLContext.new
+      ssl_ctx.ssl_version = :SSLv23
+      OpenSSL::SSL::SSLSocket.new(sock, ssl_ctx).tap do |sock|
+        sock.sync_close = true
+        sock.connect
+      end
+    end
+    def close_plaintext_connection socket
+      socket.close
+    end
+    def close_ssl_connection socket
+      socket.close
+    end
+    def read num_bytes
+      @socket.read num_bytes
+    end
+    def read_nonblock num_bytes
+      @socket.read_nonblock num_bytes
+    end
+    def puts string
+      @socket.puts string
+    end
+    def write string
+      @socket.write string
+    end
+    def closed?
+      @socket.closed?
+    end
+    def close
+      if @ssl
+        close_ssl_connection @socket
+      else
+        close_plaintext_connection @socket
+      end
+    end
+    def open
+      if @ssl
+        @socket = establish_ssl_connection @host, @port
+      else
+        @socket = establish_plaintext_connection @host, @port
+      end
+    end
+    public :read, :read_nonblock, :select, :puts, :write, :closed?, :close, :open
+  end
+end

data/lib/weechat-relay-helper/options.rb

@@ -0,0 +1,30 @@
+# License details in LICENSE.
+module RelayHelper
+  class Options
+    attr_reader :host, :password, :ssl, :port, :compression
+    def initialize args
+      OptionParser.new do |opts|
+        opts.banner = "Usage: weelayhelper [options]"
+        opts.on('-H', '--host hostname', String, 'Hostname of the Weechat instance') do |hn|
+          @host = hn
+        end
+        opts.on('-P', '--password pass', String, 'Password (if needed) of the Weechat relay instance') do |pass|
+          @password = pass
+        end
+        opts.on('-p', '--port port', Integer, 'Port that the Weechat instance is listening on') do |port|
+          @port = port
+        end
+        opts.on('-s', '--[no-]ssl', 'Use SSL when connecting') do |ssl|
+          @ssl = ssl
+        end
+        opts.on('-c', '--[no-]compression', 'Use Zlib to compress communication') do |compression|
+          @compression = compression
+        end
+        opts.on_tail('-h', '--help', 'Shows this help message') do
+          puts opts
+          exit
+        end
+      end.parse! args
+    end
+  end
+end

data/lib/weechat-relay-helper/response.rb

@@ -0,0 +1,169 @@
+# License details in LICENSE.
+module RelayHelper
+  class Response
+    attr_accessor :text, :data, :id
+    def initialize response
+      @text = response.force_encoding('ASCII-8BIT')
+      @length = 0
+      @index = 0
+      @compressed = false
+      @data = []
+      @id = ''
+      read_length
+      read_compressed
+      decompress! if @compressed
+      read_id
+      while @index < @length
+        @data << read_part
+      end
+    end
+    def read num_bytes
+      ret = @text[@index, num_bytes]
+      @index += num_bytes
+      ret
+    end
+    def read_type
+      read(3)
+    end
+    def read_part type=nil
+      type ||= read_type
+      case type
+      when 'chr'
+        read_char
+      when 'int'
+        read_int
+      when 'lon'
+        read_long
+      when 'str'
+        read_string
+      when 'buf'
+        read_buffer_of_bytes
+      when 'ptr'
+        read_pointer
+      when 'tim'
+        read_time
+      when 'htb'
+        read_hashtable
+      when 'hda'
+        read_hdata
+      when 'arr'
+        read_array
+      when 'inf'
+        read_info
+      when 'inl'
+        read_infolist
+      end
+    end
+    def read_length
+      @length = read(4).unpack('L>')[0]
+    end
+    def read_compressed
+      @compressed = true unless read_char.zero?
+    end
+    def decompress!
+      unenc = Zlib.inflate(@text[5, @length])
+      @text[5, @length] = unenc
+    end
+    def read_id
+      @id = read_string
+    end
+    def read_char
+      read(1).unpack('c')[0]
+    end
+    def read_int
+      read(4).unpack('l>')[0]
+    end
+    def read_long
+      len = read(1).unpack('c')[0]
+      read(len).to_i
+    end
+    def read_string
+      len = read(4).unpack('l>')[0]
+      if len == -1
+        nil
+      else
+        read(len)
+      end
+    end
+    def read_buffer_of_bytes
+      len = read(4).unpack('l>')[0]
+      if len == -1
+        nil
+      else
+        read(len)
+      end
+    end
+    def read_pointer
+      len = read(1).unpack('c')[0]
+      ret = read(len).to_i
+      if len == 1 && ret == 0
+        nil
+      else
+        ret
+      end
+    end
+    def read_time
+      len = read(1).unpack('c')[0]
+      Time.at(read(len).to_i)
+    end
+    def read_hashtable
+      key_type = read_type
+      val_type = read_type
+      count = read_int
+      hsh = {}
+      count.times do
+        hsh[read_part(key_type)] = read_part(val_type)
+      end
+      hsh
+    end
+    def read_hdata
+      hpath = read_string
+      keys = read_string.split(',').map { |k| k.split(':') }
+      count = read_int
+      paths = hpath.split('/')
+      objects = []
+      count.times do
+        hsh = {}
+        pointers = paths.map do
+          read_pointer
+        end
+        hsh[:pointers] = pointers
+        keys.each do |objdef|
+          hsh.update({ objdef[0] => read_part(objdef[1])})
+        end
+
+        objects << hsh
+      end
+      objects
+    end
+    def read_array
+      type = read_type
+      count = read_int
+      arr = []
+      count.times do
+        arr << read_part(type)
+      end
+      arr
+    end
+    def read_infolist
+      name = read_string
+      count = read_int
+      info = []
+      count.times do
+        info << read_infolist_item
+      end
+      { name: name, data: info }
+    end
+    def read_infolist_item
+      count = read_int
+      ret = {}
+      count.times do
+        name = read_string
+        type = read_type
+        value = read_part(type)
+        ret[name] = value
+      end
+      ret
+    end
+  end
+end

data/lib/weechat-relay-helper/version.rb

@@ -0,0 +1,3 @@
+module RelayHelper
+  VERSION = '1.0'
+end

data/lib/weechat-relay-helper/weechat.rb

@@ -0,0 +1,11 @@
+# License details in LICENSE.
+module RelayHelper
+  class Weechat
+    attr_reader :connection
+    def initialize host, port, ssl, compression, password
+      @connection = Connection.new(host, port, ssl)
+      @connection.open
+      @connection.puts "init#{" password=#{password}," if password}compression=#{compression ? 'zlib' : 'off'}"
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: weechat-relay-helper
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Rylee Fowler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: An interactive tool to assist in the development of Weechat-protocol
+  applications
+email:
+- rylee@rylee.me
+executables:
+- weechat-relay-helper
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/weechat-relay-helper
+- lib/weechat-relay-helper.rb
+- lib/weechat-relay-helper/connection.rb
+- lib/weechat-relay-helper/options.rb
+- lib/weechat-relay-helper/response.rb
+- lib/weechat-relay-helper/version.rb
+- lib/weechat-relay-helper/weechat.rb
+homepage: https://github.com/rylai-/weechat-relay-helper
+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.2.2
+signing_key: 
+specification_version: 4
+summary: This gem provides an executable and a simple library to parse and visualize
+  the Weechat protocol through interactively allowing the user to input raw protocol
+  messages and see the messages that Weechat sends back in real time.
+test_files: []
+has_rdoc: