mumble-ruby 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82cf74ba07e716f77a42f8d00a1c2c7a006ab1ee
-  data.tar.gz: b1de6531791664de94bbb57c54ef4cefcab49bea
+  metadata.gz: e46d3df87918f5012997b654c5f47a78ed4e19e3
+  data.tar.gz: 345f9359d29321c10a4a69cceec83c9468d1d8af
 SHA512:
-  metadata.gz: 5be9ba342fc77edc1636966f36716f05b2f96ac50302162167223e140e33e034699b2d5dfd5bee5ba8006acc17bd2a196a5dae6fe7a9fdcd2a4ed4d2bb602e4f
-  data.tar.gz: 0f1c1849a77d0557270709d704dd252b8f8398b1fe9cae9415e5a77d77753f6fe1d40bed8c26a3736d77788e3145ef04304e651ec1068e45148d5cb0d7cb4546
+  metadata.gz: c3f904facc7c604f718701924fa1b5809e1268eb442b55906800efcfb78c13dea30c324bc3ff432435ac2343c4e7d7a54d573cd70e419538c3e72ec35e1abf5e
+  data.tar.gz: 0628cfddb4b8e04c2bb34f18e9c17de8a29d151c7371af35918b022346f793a9e23fe5d38decd448160a18f6abe59ce2a9fe930dacb7e37bf9312ff3b4fb703c

data/README.rdoc

@@ -16,12 +16,38 @@ There is huge room for improvement in this library and I am willing to accept al
 
 * Ruby >= 2.1.0
 * OPUS Audio Codec
-* Murur server > 1.2.4
+* Murmur server > 1.2.4
+
+== RECENT CHANGES:
+
+* Added OPUS support
+* Added more configuration options
+* Added image text messages
+* Added ssl cert auth
+* Fixed several bugs
 
 == BASIC USAGE:
 
+    # Configure all clients globally
+    Mumble.configure do |conf|
+        # sample rate of sound (48 khz recommended)
+        conf.sample_rate = 48000
+
+        # bitrate of sound (32 kbit/s recommended)
+        conf.bitrate = 32000
+
+        # directory to store user's ssl certs
+        conf.ssl_cert_opts[:cert_dir] = File.expand_path("./")
+    end
+
     # Create client instance for your server
-    cli = Mumble::Client.new('localhost', 64738, 'Mumble Bot', 'password123')
+    cli = Mumble::Client.new('localhost') do |conf|
+        conf.username = 'Mumble Bot'
+        conf.password = 'password123'
+
+        # Overwrite global config
+        conf.bitrate = 48000
+    end
     # => #<Mumble::Client:0x00000003064fe8 @host="localhost", @port=64738, @username="Mumble Bot", @password="password123", @channels={}, @users={}, @callbacks={}>
 
     # Set up some callbacks for when you recieve text messages
@@ -62,6 +88,9 @@ There is huge room for improvement in this library and I am willing to accept al
     cli.text_user('perrym5', "Hello there, I'm a robot!")
     # => 35
 
+    # Text an image to a channel
+    cli.text_channel_img('Chillen', '/path/to/image.jpg')
+
     # Start streaming from a FIFO queue of raw PCM data
     cli.stream_raw_audio('/tmp/mpd.fifo')
     # => #<Mumble::AudioStream ...>

data/lib/mumble-ruby.rb

@@ -6,3 +6,28 @@ require 'mumble-ruby/connection.rb'
 require 'mumble-ruby/client.rb'
 require 'mumble-ruby/audio_stream.rb'
 require 'mumble-ruby/packet_data_stream.rb'
+require 'mumble-ruby/img_reader.rb'
+require 'mumble-ruby/cert_manager.rb'
+
+module Mumble
+  DEFAULTS = {
+    sample_rate: 48000,
+    bitrate: 32000,
+    ssl_cert_opts: {
+      cert_dir: File.expand_path("./"),
+      country_code: "US",
+      organization: "github.com",
+      organization_unit: "Engineering"
+    }
+  }
+
+  def self.configuration
+    @configuration ||= Hashie::Mash.new(DEFAULTS)
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  Thread.abort_on_exception = true
+end

data/lib/mumble-ruby/cert_manager.rb

@@ -0,0 +1,67 @@
+require 'openssl'
+require 'fileutils'
+
+module Mumble
+  class CertManager
+    attr_reader :key, :cert
+
+    CERT_STRING = "/C=%s/O=%s/OU=%s/CN=%s"
+
+    def initialize(username, opts)
+      @cert_dir = File.join(opts[:cert_dir], "#{username.downcase}_cert")
+      @username = username
+      @opts = opts
+
+      FileUtils.mkdir_p @cert_dir
+      setup_key
+      setup_cert
+    end
+
+    [:private_key, :public_key, :cert].each do |sym|
+      define_method "#{sym}_path" do
+        File.join(@cert_dir, "#{sym}.pem")
+      end
+    end
+
+    private
+    def setup_key
+      if File.exists?(private_key_path)
+        @key ||= OpenSSL::PKey::RSA.new File.read(private_key_path)
+      else
+        @key ||= OpenSSL::PKey::RSA.new 2048
+        File.write private_key_path, key.to_pem
+        File.write public_key_path, key.public_key.to_pem
+      end
+    end
+
+    def setup_cert
+      if File.exists?(cert_path)
+        @cert ||= OpenSSL::X509::Certificate.new File.read(cert_path)
+      else
+        @cert ||= OpenSSL::X509::Certificate.new
+
+        subject = CERT_STRING % [@opts[:country_code], @opts[:organization], @opts[:organization_unit], @username]
+
+        cert.subject = cert.issuer = OpenSSL::X509::Name.parse(subject)
+        cert.not_before = Time.now
+        cert.not_after = Time.new + 365 * 24 * 60 * 60 * 5
+        cert.public_key = key.public_key
+        cert.serial = rand(65535) + 1
+        cert.version = 2
+
+        ef = OpenSSL::X509::ExtensionFactory.new
+        ef.subject_certificate = cert
+        ef.issuer_certificate = cert
+
+        cert.add_extension(ef.create_extension("basicConstraints", "CA:TRUE", true))
+        cert.add_extension(ef.create_extension("keyUsage", "keyCertSign, cRLSign", true))
+        cert.add_extension(ef.create_extension("subjectKeyIdentifier", "hash", false))
+        cert.add_extension(ef.create_extension("authorityKeyIdentifier", "keyid:always", false))
+
+        cert.sign key, OpenSSL::Digest::SHA256.new
+
+        File.write cert_path, cert.to_pem
+      end
+    end
+  end
+end

data/lib/mumble-ruby/client.rb

@@ -7,21 +7,27 @@ module Mumble
   class NoSupportedCodec < StandardError; end
 
   class Client
-    attr_reader :host, :port, :username, :password, :users, :channels
+    attr_reader :users, :channels, :connected
 
     CODEC_OPUS = 4
 
     def initialize(host, port=64738, username="RubyClient", password="")
-      @host = host
-      @port = port
-      @username = username
-      @password = password
       @users, @channels = {}, {}
       @callbacks = Hash.new { |h, k| h[k] = [] }
+      @connected = false
+
+      @config = Mumble.configuration.dup.tap do |c|
+        c.host = host
+        c.port = port
+        c.username = username
+        c.password = password
+      end
+      yield(@config) if block_given?
     end
 
     def connect
-      @conn = Connection.new @host, @port
+      cert_manager = CertManager.new(@config.username, @config.ssl_cert_opts)
+      @conn = Connection.new @config.host, @config.port, cert_manager
       @conn.connect
 
       create_encoder
@@ -38,6 +44,7 @@ module Mumble
       @read_thread.kill
       @ping_thread.kill
       @conn.disconnect
+      @connected = false
     end
 
     def me
@@ -85,6 +92,11 @@ module Mumble
       })
     end
 
+    def text_user_img(user, file)
+      img = ImgReader.new file
+      text_user(user, img.to_msg)
+    end
+
     def text_channel(channel, string)
       send_text_message({
         channel_id: [channel_id(channel)],
@@ -92,6 +104,11 @@ module Mumble
       })
     end
 
+    def text_channel_img(channel, file)
+      img = ImgReader.new file
+      text_channel(channel, img.to_msg)
+    end
+
     def user_stats(user)
       send_user_stats session: user_session(user)
     end
@@ -104,16 +121,19 @@ module Mumble
       channels.values.find { |c| c.name == name }
     end
 
+    def on_connected(&block)
+      @callbacks[:connected] << block
+    end
+
     private
     def spawn_thread(sym)
-      Thread.abort_on_exception = true
       Thread.new { loop { send sym } }
     end
 
     def read
       message = @conn.read_message
       sym = message.class.to_s.demodulize.underscore.to_sym
-      run_callbacks sym, message
+      run_callbacks sym, Hashie::Mash.new(message.to_hash)
     end
 
     def ping
@@ -128,6 +148,8 @@ module Mumble
     def init_callbacks
       on_server_sync do |message|
         @session = message.session
+        @connected = true
+        @callbacks[:connected].each { |c| c.call }
       end
       on_channel_state do |message|
         if channel = channels[message.channel_id]
@@ -155,24 +177,24 @@ module Mumble
     end
 
     def create_encoder
-      @encoder = Opus::Encoder.new 48000, 480, 1
+      @encoder = Opus::Encoder.new @config.sample_rate, @config.sample_rate / 100, 1
       @encoder.vbr_rate = 0 # CBR
-      @encoder.bitrate = 32000 # 32 kbit/s
+      @encoder.bitrate = @config.bitrate
     end
 
     def version_exchange
       send_version({
         version: encode_version(1, 2, 5),
         release: "mumble-ruby #{Mumble::VERSION}",
-        os: %x{uname -o}.strip,
+        os: %x{uname -s}.strip,
         os_version: %x{uname -v}.strip
       })
     end
 
     def authenticate
       send_authenticate({
-        username: @username,
-        password: @password,
+        username: @config.username,
+        password: @config.password,
         opus: true
       })
     end
@@ -182,28 +204,16 @@ module Mumble
     end
 
     def channel_id(channel)
-      id = case channel
-           when Messages::ChannelState
-             channel.channel_id
-           when Fixnum
-             channel
-           when String
-             find_channel(channel).channel_id
-           end
+      channel = find_channel(channel) if channel.is_a? String
+      id = channel.respond_to?(:channel_id) ? channel.channel_id : channel
 
       raise ChannelNotFound unless @channels.has_key? id
       id
     end
 
     def user_session(user)
-      id = case user
-           when Messages::UserState
-             user.session
-           when Fixnum
-             user
-           when String
-             find_user(user).session
-           end
+      user = find_user(user) if user.is_a? String
+      id = user.respond_to?(:session) ? user.session : user
 
       raise UserNotFound unless @users.has_key? id
       id

data/lib/mumble-ruby/connection.rb

@@ -4,22 +4,24 @@ require 'thread'
 
 module Mumble
   class Connection
-    def initialize(host, port)
+    def initialize(host, port, cert_manager)
       @host = host
       @port = port
+      @cert_manager = cert_manager
       @write_lock = Mutex.new
     end
 
     def connect
       context = OpenSSL::SSL::SSLContext.new(:TLSv1)
       context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      [:key, :cert].each { |s| context.send("#{s}=", @cert_manager.send(s)) }
       tcp_sock = TCPSocket.new @host, @port
       @sock = OpenSSL::SSL::SSLSocket.new tcp_sock, context
       @sock.connect
     end
 
     def disconnect
-      @sock.sysclose
+      @sock.close
     end
 
     def read_message

data/lib/mumble-ruby/img_reader.rb

@@ -0,0 +1,39 @@
+require 'base64'
+
+module Mumble
+  class UnsupportedImgFormat < StandardError
+    def initialize
+      super "Image format must be one of the following: #{ImgReader::FORMATS}"
+    end
+  end
+
+  class ImgTooLarge < StandardError
+    def initialize
+      super "Image must be smaller than 128 kB"
+    end
+  end
+
+  class ImgReader
+    attr_reader :file
+    FORMATS = %w(png jpg jpeg svg)
+
+    def initialize(file)
+      @file = file
+      raise LoadError.new("#{file} not found") unless File.exists? file
+      raise UnsupportedImgFormat unless FORMATS.include? ext
+      raise ImgTooLarge unless File.size(file) <= 128 * 1024
+    end
+
+    def ext
+      @ext ||= File.extname(@file)[1..-1]
+    end
+
+    def data
+      @data ||= File.read @file
+    end
+
+    def to_msg
+      "<img src='data:image/#{ext};base64,#{Base64.encode64(data)}'/>"
+    end
+  end
+end

data/lib/mumble-ruby/version.rb

@@ -1,3 +1,3 @@
 module Mumble
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumble-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Matthew Perry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-23 00:00:00.000000000 Z
+date: 2014-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -82,8 +82,10 @@ files:
 - Rakefile
 - lib/mumble-ruby.rb
 - lib/mumble-ruby/audio_stream.rb
+- lib/mumble-ruby/cert_manager.rb
 - lib/mumble-ruby/client.rb
 - lib/mumble-ruby/connection.rb
+- lib/mumble-ruby/img_reader.rb
 - lib/mumble-ruby/messages.rb
 - lib/mumble-ruby/mumble.proto
 - lib/mumble-ruby/packet_data_stream.rb