tox 0.0.1

data/ext/tox/tox.h

@@ -0,0 +1,25 @@
+/*
+ * tox.rb - Ruby interface for libtoxcore
+ * Copyright (C) 2015-2017  Braiden Vasco
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <ruby.h>
+
+#include <tox/tox.h>
+
+void Init_tox();
+
+extern VALUE mTox;

data/lib/tox.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# tox.rb - Ruby interface for libtoxcore
+# Copyright (C) 2015-2017  Braiden Vasco
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'thread'
+require 'uri'
+require 'net/http'
+require 'json'
+require 'resolv'
+
+require 'tox/version'
+require 'tox/status'
+require 'tox/node'
+require 'tox/tox'
+require 'tox/client'
+require 'tox/friend'
+
+# Primitives
+require 'tox/binary'
+require 'tox/public_key'
+require 'tox/address'
+
+##
+# Ruby interface for libtoxcore. It can be used to create Tox chat client or bot.
+# The interface is object-oriented instead of C-style (raises exceptions
+# instead of returning error codes, uses classes to represent primitives, etc.)
+#
+module Tox
+end

data/lib/tox/address.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# tox.rb - Ruby interface for libtoxcore
+# Copyright (C) 2015-2017  Braiden Vasco
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Tox
+  ##
+  # Address primitive.
+  #
+  class Address < Binary
+    def self.bytesize
+      38
+    end
+  end
+end

data/lib/tox/binary.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# tox.rb - Ruby interface for libtoxcore
+# Copyright (C) 2015-2017  Braiden Vasco
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Tox
+  ##
+  # Binary primitive representation.
+  #
+  class Binary < String
+    def self.bytesize
+      raise NotImplementedError, "#{self}.bytesize"
+    end
+
+    def self.hex_re
+      /\A[\da-fA-F]{#{2 * bytesize}}\z/
+    end
+
+    def initialize(value)
+      raise TypeError, "expected value to be a #{String}" unless value.is_a? String
+
+      if value.bytesize == self.class.bytesize
+        super value
+      else
+        raise ArgumentError, 'expected value to be a hex string' unless value =~ self.class.hex_re
+        super [value].pack('H*')
+      end
+
+      to_hex
+      freeze
+    end
+
+    def to_hex
+      @to_hex ||= unpack('H*').first.upcase.freeze
+    end
+
+    def inspect
+      "#<#{self.class}: \"#{to_hex}\">"
+    end
+  end
+end

data/lib/tox/client.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# tox.rb - Ruby interface for libtoxcore
+# Copyright (C) 2015-2017  Braiden Vasco
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Tox
+  ##
+  # Tox client.
+  #
+  class Client
+    def initialize(options = Tox::Options.new)
+      initialize_with options
+      self.running = false
+    end
+
+    def bootstrap_official
+      Status.new.nodes.each do |node|
+        bootstrap node
+      end
+    end
+
+    def running?
+      @running
+    end
+
+    def stop
+      return false unless running?
+      self.running = false
+      true
+    end
+
+    def run
+      raise AlreadyRunningError, "already running in #{thread}" unless mutex.try_lock
+
+      begin
+        self.running = true
+        self.thread = Thread.current
+        run_loop
+      ensure
+        self.running = false
+        self.thread = nil
+      end
+
+      mutex.unlock
+    end
+
+    def on_friend_request(&block)
+      @on_friend_request = block
+    end
+
+    def on_friend_message(&block)
+      @on_friend_message = block
+    end
+
+  private
+
+    attr_accessor :thread
+
+    def mutex
+      @mutex ||= Mutex.new
+    end
+
+    def running=(value)
+      @running = !!value
+    end
+
+    class Error < RuntimeError; end
+    class BadSavedataError < Error; end
+    class AlreadyRunningError < Error; end
+  end
+end

data/lib/tox/friend.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# tox.rb - Ruby interface for libtoxcore
+# Copyright (C) 2015-2017  Braiden Vasco
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Tox
+  ##
+  # Friend representation in Tox client.
+  #
+  class Friend
+    attr_reader :client, :number
+
+    def initialize(client, number)
+      self.client = client
+      self.number = number
+    end
+
+  private
+
+    def client=(value)
+      raise TypeError, "expected client to be a #{Client}" unless value.is_a? Client
+      @client = value
+    end
+
+    def number=(value)
+      raise TypeError,     "expected number to be a #{Integer}"                  unless value.is_a? Integer
+      raise ArgumentError, 'expected number to be greater than or equal to zero' unless value >= 0
+      @number = value
+    end
+  end
+end

data/lib/tox/node.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# tox.rb - Ruby interface for libtoxcore
+# Copyright (C) 2015-2017  Braiden Vasco
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Tox
+  ##
+  # Tox node credentials.
+  #
+  class Node
+    # Range of valid port numbers.
+    PORT_RANGE = 0..65_535
+
+    def initialize(data)
+      @data = data.map { |k, v| [k.to_sym, v] }.to_h.freeze
+    end
+
+    def ipv4
+      @ipv4 ||=
+        begin
+          value = @data[:ipv4]
+          raise TypeError, "expected value to be a #{String}" unless value.is_a? String
+          value.frozen? ? value : value.dup.freeze
+        end
+    end
+
+    def port
+      @port ||=
+        begin
+          value = @data[:port]
+          raise TypeError,     "expected value to be an #{Integer}"       unless value.is_a? Integer
+          raise ArgumentError, 'expected value to be between 0 and 65535' unless PORT_RANGE.cover? value
+          value
+        end
+    end
+
+    def public_key
+      @public_key ||=
+        begin
+          value = @data[:public_key]
+          PublicKey.new value
+        end
+    end
+
+    def status_udp
+      @status_udp ||= !!@data[:status_udp]
+    end
+
+    def resolv_ipv4
+      @resolv_ipv4 ||= Resolv.getaddress ipv4
+    end
+  end
+end

data/lib/tox/public_key.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# tox.rb - Ruby interface for libtoxcore
+# Copyright (C) 2015-2017  Braiden Vasco
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Tox
+  ##
+  # Public key primitive.
+  #
+  class PublicKey < Binary
+    def self.bytesize
+      32
+    end
+  end
+end

data/lib/tox/status.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# tox.rb - Ruby interface for libtoxcore
+# Copyright (C) 2015-2017  Braiden Vasco
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Tox
+  ##
+  # Tox network status received from server running https://github.com/Tox/ToxStatus
+  #
+  class Status
+    # JSON API endpoint of the official network status server.
+    OFFICIAL_URL = 'https://nodes.tox.chat/json'
+
+    attr_reader :url
+
+    def initialize(url = OFFICIAL_URL)
+      self.url = url
+    end
+
+    def inspect
+      @inspect ||= "#<#{self.class} last_refresh: #{last_refresh}, last_scan: #{last_scan}>"
+    end
+
+    def last_refresh
+      @last_refresh ||= Time.at(data['last_refresh']).utc.freeze
+    end
+
+    def last_scan
+      @last_scan ||= Time.at(data['last_scan']).utc.freeze
+    end
+
+    def nodes
+      @nodes ||= data['nodes'].map { |node_data| Node.new node_data }.select(&:status_udp).compact.freeze
+    end
+
+  private
+
+    def url=(value)
+      @url = value.frozen? ? value : value.dup.freeze
+    end
+
+    def data
+      @data ||= JSON.parse Net::HTTP.get URI.parse url
+    end
+  end
+end

data/lib/tox/version.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# tox.rb - Ruby interface for libtoxcore
+# Copyright (C) 2015-2017  Braiden Vasco
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Tox
+  # Gem version.
+  VERSION = '0.0.1'
+end