tox 0.0.2 → 0.0.3

data/lib/tox/address.rb

@@ -1,21 +1,5 @@
 # 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.
@@ -24,5 +8,17 @@ module Tox
     def self.bytesize
       38
     end
+
+    def public_key
+      @public_key ||= PublicKey.new value[0...32]
+    end
+
+    def nospam
+      @nospam ||= Nospam.new value[32...36]
+    end
+
+    def checksum
+      @checksum ||= AddressChecksum.new value[36...38]
+    end
   end
 end

data/lib/tox/address_checksum.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Tox
+  ##
+  # Address checksum primitive.
+  #
+  class AddressChecksum < Binary
+    def self.bytesize
+      2
+    end
+  end
+end

data/lib/tox/binary.rb

@@ -1,26 +1,10 @@
 # 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
+  class Binary
     def self.bytesize
       raise NotImplementedError, "#{self}.bytesize"
     end
@@ -29,30 +13,43 @@ module Tox
       /\A[\da-fA-F]{#{2 * bytesize}}\z/
     end
 
-    def initialize(value) # rubocop:disable Metrics/MethodLength
+    attr_reader :value
+
+    def initialize(value)
       unless value.is_a? String
         raise TypeError, "expected value to be a #{String}"
       end
 
       if value.bytesize == self.class.bytesize
-        super value
+        self.value = value
+      elsif value =~ self.class.hex_re
+        self.hex_value = value
       else
-        unless value =~ self.class.hex_re
-          raise ArgumentError, 'expected value to be a hex string'
-        end
-        super [value].pack('H*')
+        raise ArgumentError, 'expected value to be a hex or binary string'
       end
-
-      to_hex
-      freeze
     end
 
-    def to_hex
-      @to_hex ||= unpack('H*').first.upcase.freeze
+    def to_s
+      @to_s ||= value.unpack('H*').first.upcase.freeze
     end
 
     def inspect
-      "#<#{self.class}: \"#{to_hex}\">"
+      "#<#{self.class}: \"#{self}\">"
+    end
+
+    def ==(other)
+      return false unless self.class == other.class
+      value == other.value
+    end
+
+  private
+
+    def value=(value)
+      @value = value.frozen? ? value : value.dup.freeze
+    end
+
+    def hex_value=(value)
+      @value = [value].pack('H*').freeze
     end
   end
 end

data/lib/tox/client.rb

@@ -1,57 +1,26 @@
 # 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)
+      @on_friend_request = nil
+      @on_friend_message = nil
+      @on_friend_name_change = nil
+      @on_friend_status_message_change = nil
+      @on_friend_status_change = nil
+
       initialize_with options
-      self.running = false
     end
 
     def bootstrap_official
       Status.new.udp_nodes.each do |node|
-        bootstrap node
+        bootstrap node.resolv_ipv4, node.port, node.public_key
       end
     end
 
-    def running?
-      @running
-    end
-
-    def stop
-      return false unless running?
-      self.running = false
-      true
-    end
-
-    def run
-      unless mutex.try_lock
-        raise AlreadyRunningError, "already running in #{thread}"
-      end
-
-      run_internal
-
-      mutex.unlock
-    end
-
     def friends
       friend_numbers.map do |friend_number|
         friend friend_number
@@ -66,10 +35,6 @@ module Tox
       Friend.new(self, number).exist!
     end
 
-    def on_iteration(&block)
-      @on_iteration = block
-    end
-
     def on_friend_request(&block)
       @on_friend_request = block
     end
@@ -90,29 +55,7 @@ module Tox
       @on_friend_status_change = block
     end
 
-  private
-
-    attr_accessor :thread
-
-    def mutex
-      @mutex ||= Mutex.new
-    end
-
-    def running=(value)
-      @running = !!value
-    end
-
-    def run_internal
-      self.running = true
-      self.thread = Thread.current
-      run_loop
-    ensure
-      self.running = false
-      self.thread = nil
-    end
-
     class Error < RuntimeError; end
     class BadSavedataError < Error; end
-    class AlreadyRunningError < Error; end
   end
 end

data/lib/tox/connection_status.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Tox
+  ##
+  # Protocols that can be used to connect to the network or friends.
+  #
+  module ConnectionStatus
+    # There is no connection. This instance, or the friend the state change
+    # is about, is now offline.
+    NONE = :none
+
+    # A TCP connection has been established. For the own instance, this means
+    # it is connected through a TCP relay, only. For a friend, this means that
+    # the connection to that particular friend goes through a TCP relay.
+    TCP = :tcp
+
+    # A UDP connection has been established. For the own instance, this means
+    # it is able to send UDP packets to DHT nodes, but may still be connected
+    # to a TCP relay. For a friend, this means that the connection
+    # to that particular friend was built using direct UDP packets.
+    UDP = :udp
+  end
+end

data/lib/tox/friend.rb

@@ -1,21 +1,5 @@
 # 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.
@@ -35,22 +19,27 @@ module Tox
 
     alias exists! exist!
 
+    def ==(other)
+      return false unless self.class == other.class
+      client == other.client &&
+        number == other.number
+    end
+
   private
 
     def client=(value)
       unless value.is_a? Client
-        raise TypeError, "expected client to be a #{Client}"
+        raise TypeError, "Expected #{Client}, got #{value.class}"
       end
       @client = value
     end
 
     def number=(value)
       unless value.is_a? Integer
-        raise TypeError, "expected number to be a #{Integer}"
+        raise TypeError, "Expected #{Integer}, got #{value.class}"
       end
       unless value >= 0
-        raise ArgumentError,
-              'expected number to be greater than or equal to zero'
+        raise 'Expected friend number to be greater than or equal to zero'
       end
       @number = value
     end

data/lib/tox/node.rb

@@ -1,28 +1,12 @@
 # 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
+    PORT_RANGE = 1..65_535
 
     def initialize(data)
       @data = data.map { |k, v| [k.to_sym, v] }.to_h.freeze

data/lib/tox/nospam.rb

@@ -1,21 +1,5 @@
 # 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
   ##
   # Nospam primitive.
@@ -24,5 +8,14 @@ module Tox
     def self.bytesize
       4
     end
+
+    def initialize(value)
+      return @value = [value].pack('L').reverse.freeze if value.is_a? Integer
+      super
+    end
+
+    def to_i
+      @to_i ||= value.reverse.unpack('L').first
+    end
   end
 end

data/lib/tox/options.rb

@@ -1,25 +1,63 @@
 # 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
   ##
   # Startup options for Tox client.
   #
   class Options
+    BIND_PORT_RANGE = 0..65_535
+
+    attr_reader :proxy
+
+    def proxy=(value)
+      if value.nil?
+        @proxy = nil
+        set_proxy_params ProxyType::NONE, nil, 0
+        return
+      end
+      unless value.is_a? Proxies::Base
+        raise TypeError, "Expected #{Proxies::Base}, got #{value.class}"
+      end
+      @proxy = value
+      set_proxy_params value.type, value.host, value.port
+    end
+
+    def start_port=(value)
+      unless value.is_a? Integer
+        raise TypeError, "Expected #{Integer}, got #{value.class}"
+      end
+      unless BIND_PORT_RANGE.include? value
+        raise "Expected value to be from range #{BIND_PORT_RANGE}"
+      end
+      self.start_port_internal = value
+    end
+
+    def end_port=(value)
+      unless value.is_a? Integer
+        raise TypeError, "Expected #{Integer}, got #{value.class}"
+      end
+      unless BIND_PORT_RANGE.include? value
+        raise "Expected value to be from range #{BIND_PORT_RANGE}"
+      end
+      self.end_port_internal = value
+    end
+
+    def tcp_port=(value)
+      unless value.is_a? Integer
+        raise TypeError, "Expected #{Integer}, got #{value.class}"
+      end
+      unless BIND_PORT_RANGE.include? value
+        raise "Expected value to be from range #{BIND_PORT_RANGE}"
+      end
+      self.tcp_port_internal = value
+    end
+
+  private
+
+    def set_proxy_params(type, host, port)
+      self.proxy_type = type
+      self.proxy_host = host
+      self.proxy_port = port
+    end
   end
 end