tox 0.0.1 → 0.0.2

data/ext/tox/options.c

@@ -17,10 +17,6 @@
  */
 
 #include "tox.h"
-#include "options.h"
-
-// Instance
-VALUE mTox_cOptions;
 
 // Memory management
 static VALUE mTox_cOptions_alloc(VALUE klass);
@@ -37,9 +33,6 @@ static VALUE mTox_cOptions_savedata_EQUALS(VALUE self, VALUE savedata);
 
 void mTox_cOptions_INIT()
 {
-  // Instance
-  mTox_cOptions = rb_define_class_under(mTox, "Options", rb_cObject);
-
   // Memory management
   rb_define_alloc_func(mTox_cOptions, mTox_cOptions_alloc);
 

data/ext/tox/tox.c

@@ -17,18 +17,47 @@
  */
 
 #include "tox.h"
-#include "options.h"
-#include "node.h"
-#include "client.h"
-#include "friend.h"
 
-#if !(TOX_VERSION_IS_API_COMPATIBLE(0, 1, 9))
+#if !(TOX_VERSION_IS_API_COMPATIBLE(0, 2, 1))
   #error "Tox API version is not compatible"
 #endif
 
-// Instance
+// Instances
+
 VALUE mTox;
 
+VALUE mTox_eNullError;
+VALUE mTox_eUnknownError;
+VALUE mTox_eUnknownSecurityError;
+
+VALUE mTox_mVersion;
+VALUE mTox_mUserStatus;
+VALUE mTox_cOptions;
+VALUE mTox_cClient;
+VALUE mTox_cNode;
+VALUE mTox_cFriend;
+VALUE mTox_cAddress;
+VALUE mTox_cPublicKey;
+VALUE mTox_mOutMessage;
+
+VALUE mTox_mUserStatus_NONE;
+VALUE mTox_mUserStatus_AWAY;
+VALUE mTox_mUserStatus_BUSY;
+
+VALUE mTox_cClient_eBadSavedataError;
+
+VALUE mTox_cFriend_eNotFoundError;
+VALUE mTox_cFriend_eNotConnectedError;
+VALUE mTox_cFriend_cOutMessage;
+
+VALUE mTox_mOutMessage_eSendQueueAllocError;
+VALUE mTox_mOutMessage_eTooLongError;
+VALUE mTox_mOutMessage_eEmptyError;
+
+// Singleton methods
+
+static VALUE mTox_hash(VALUE self, VALUE data);
+
 /*************************************************************
  * Initialization
  *************************************************************/
@@ -39,11 +68,62 @@ void Init_tox()
     rb_raise(rb_eLoadError, "incompatible Tox ABI version");
   }
 
-  // Instance
-  mTox = rb_define_module("Tox");
+  // Instances
+
+  mTox = rb_const_get(rb_cObject, rb_intern("Tox"));
+
+  mTox_eNullError            = rb_const_get(mTox, rb_intern("NullError"));
+  mTox_eUnknownError         = rb_const_get(mTox, rb_intern("UnknownError"));
+  mTox_eUnknownSecurityError = rb_const_get(mTox, rb_intern("UnknownSecurityError"));
+
+  mTox_mVersion    = rb_const_get(mTox, rb_intern("Version"));
+  mTox_mUserStatus = rb_const_get(mTox, rb_intern("UserStatus"));
+  mTox_cOptions    = rb_const_get(mTox, rb_intern("Options"));
+  mTox_cClient     = rb_const_get(mTox, rb_intern("Client"));
+  mTox_cNode       = rb_const_get(mTox, rb_intern("Node"));
+  mTox_cFriend     = rb_const_get(mTox, rb_intern("Friend"));
+  mTox_cAddress    = rb_const_get(mTox, rb_intern("Address"));
+  mTox_cPublicKey  = rb_const_get(mTox, rb_intern("PublicKey"));
+  mTox_mOutMessage = rb_const_get(mTox, rb_intern("OutMessage"));
+
+  mTox_mUserStatus_NONE = rb_const_get(mTox_mUserStatus, rb_intern("NONE"));
+  mTox_mUserStatus_AWAY = rb_const_get(mTox_mUserStatus, rb_intern("AWAY"));
+  mTox_mUserStatus_BUSY = rb_const_get(mTox_mUserStatus, rb_intern("BUSY"));
+
+  mTox_cClient_eBadSavedataError = rb_const_get(mTox_cClient, rb_intern("BadSavedataError"));
 
+  mTox_cFriend_eNotFoundError     = rb_const_get(mTox_cFriend, rb_intern("NotFoundError"));
+  mTox_cFriend_eNotConnectedError = rb_const_get(mTox_cFriend, rb_intern("NotConnectedError"));
+  mTox_cFriend_cOutMessage        = rb_const_get(mTox_cFriend, rb_intern("OutMessage"));
+
+  mTox_mOutMessage_eSendQueueAllocError = rb_const_get(mTox_mOutMessage, rb_intern("SendQueueAllocError"));
+  mTox_mOutMessage_eTooLongError        = rb_const_get(mTox_mOutMessage, rb_intern("TooLongError"));
+  mTox_mOutMessage_eEmptyError          = rb_const_get(mTox_mOutMessage, rb_intern("EmptyError"));
+
+  // Singleton methods
+
+  rb_define_singleton_method(mTox, "hash", mTox_hash, 1);
+
+  mTox_mVersion_INIT();
   mTox_cOptions_INIT();
-  mTox_cNode_INIT();
   mTox_cClient_INIT();
   mTox_cFriend_INIT();
 }
+
+/*************************************************************
+ * Singleton methods
+ *************************************************************/
+
+// Tox.hash
+VALUE mTox_hash(const VALUE self, const VALUE data)
+{
+  Check_Type(data, T_STRING);
+
+  const uint8_t result[TOX_HASH_LENGTH];
+
+  if (true != tox_hash(result, (const uint8_t*)RSTRING_PTR(data), RSTRING_LEN(data))) {
+    rb_raise(mTox_eUnknownSecurityError, "tox_hash() failed");
+  }
+
+  return rb_str_new(result, TOX_HASH_LENGTH);
+}

data/ext/tox/tox.h

@@ -20,6 +20,50 @@
 
 #include <tox/tox.h>
 
+// C extension initialization
+
 void Init_tox();
+void mTox_mVersion_INIT();
+void mTox_cOptions_INIT();
+void mTox_cClient_INIT();
+void mTox_cFriend_INIT();
+
+// C data
+
+typedef struct Tox_Options mTox_cOptions_CDATA;
+
+typedef struct {
+  Tox *tox;
+} mTox_cClient_CDATA;
+
+// Instances
 
 extern VALUE mTox;
+
+extern VALUE mTox_eNullError;
+extern VALUE mTox_eUnknownError;
+extern VALUE mTox_eUnknownSecurityError;
+
+extern VALUE mTox_mVersion;
+extern VALUE mTox_mUserStatus;
+extern VALUE mTox_cOptions;
+extern VALUE mTox_cClient;
+extern VALUE mTox_cNode;
+extern VALUE mTox_cFriend;
+extern VALUE mTox_cAddress;
+extern VALUE mTox_cPublicKey;
+extern VALUE mTox_mOutMessage;
+
+extern VALUE mTox_mUserStatus_NONE;
+extern VALUE mTox_mUserStatus_AWAY;
+extern VALUE mTox_mUserStatus_BUSY;
+
+extern VALUE mTox_cClient_eBadSavedataError;
+
+extern VALUE mTox_cFriend_eNotFoundError;
+extern VALUE mTox_cFriend_eNotConnectedError;
+extern VALUE mTox_cFriend_cOutMessage;
+
+extern VALUE mTox_mOutMessage_eSendQueueAllocError;
+extern VALUE mTox_mOutMessage_eTooLongError;
+extern VALUE mTox_mOutMessage_eEmptyError;

data/ext/tox/version.c

@@ -0,0 +1,62 @@
+/*
+ * 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 "tox.h"
+
+// Singleton methods
+
+static VALUE mTox_mVersion_abi_major(VALUE self);
+static VALUE mTox_mVersion_abi_minor(VALUE self);
+static VALUE mTox_mVersion_abi_patch(VALUE self);
+
+/*************************************************************
+ * Initialization
+ *************************************************************/
+
+void mTox_mVersion_INIT()
+{
+  // Constants
+
+  rb_define_const(mTox_mVersion, "API_MAJOR", LONG2FIX(TOX_VERSION_MAJOR));
+  rb_define_const(mTox_mVersion, "API_MINOR", LONG2FIX(TOX_VERSION_MINOR));
+  rb_define_const(mTox_mVersion, "API_PATCH", LONG2FIX(TOX_VERSION_PATCH));
+
+  // Singleton methods
+
+  rb_define_singleton_method(mTox_mVersion, "abi_major", mTox_mVersion_abi_major, 0);
+  rb_define_singleton_method(mTox_mVersion, "abi_minor", mTox_mVersion_abi_minor, 0);
+  rb_define_singleton_method(mTox_mVersion, "abi_patch", mTox_mVersion_abi_patch, 0);
+}
+
+// Tox::Version.abi_major
+VALUE mTox_mVersion_abi_major(const VALUE self)
+{
+  return LONG2FIX(tox_version_major());
+}
+
+// Tox::Version.abi_minor
+VALUE mTox_mVersion_abi_minor(const VALUE self)
+{
+  return LONG2FIX(tox_version_minor());
+}
+
+// Tox::Version.abi_patch
+VALUE mTox_mVersion_abi_patch(const VALUE self)
+{
+  return LONG2FIX(tox_version_patch());
+}

data/lib/tox.rb

@@ -23,21 +23,54 @@ require 'json'
 require 'resolv'
 
 require 'tox/version'
+require 'tox/user_status'
+require 'tox/options'
+require 'tox/client'
 require 'tox/status'
 require 'tox/node'
-require 'tox/tox'
-require 'tox/client'
+require 'tox/out_message'
 require 'tox/friend'
+require 'tox/friend/out_message'
 
 # Primitives
 require 'tox/binary'
 require 'tox/public_key'
+require 'tox/nospam'
 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
+# 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
+  ##
+  # Exception of this type is raised when Tox function failed with error code
+  # represented in Tox headers with a constant which name ends with "_NULL".
+  # This happens when one of the arguments to the function was NULL when it was
+  # not expected. It can indicate that usage of the Tox function is invalid,
+  # so if you got exception of this type please create an issue:
+  # https://github.com/toxon/tox.rb/issues
+  # Please describe the situation, version of libtoxcore, version of the gem.
+  #
+  class NullError < RuntimeError; end
+
+  ##
+  # Exception of this type is raised when Tox function failed with unknown
+  # error code or returned false success status. It can indicate minor version
+  # upgrade of libtoxcore. Specific handling is not needed for the time beeing.
+  #
+  class UnknownError < RuntimeError; end
+
+  ##
+  # Exception of this type is raised in similar cases to {Tox::UnknownError}
+  # when it can have security implications. This should happen rarely after
+  # the gem release. However, for now it can be raised when key-related
+  # functions fail because of unknown reason for better feedback
+  # during development.
+  #
+  class UnknownSecurityError < SecurityError; end
 end
+
+# C extension
+require 'tox/tox'

data/lib/tox/binary.rb

@@ -29,13 +29,17 @@ module Tox
       /\A[\da-fA-F]{#{2 * bytesize}}\z/
     end
 
-    def initialize(value)
-      raise TypeError, "expected value to be a #{String}" unless value.is_a? String
+    def initialize(value) # rubocop:disable Metrics/MethodLength
+      unless value.is_a? String
+        raise TypeError, "expected value to be a #{String}"
+      end
 
       if value.bytesize == self.class.bytesize
         super value
       else
-        raise ArgumentError, 'expected value to be a hex string' unless value =~ self.class.hex_re
+        unless value =~ self.class.hex_re
+          raise ArgumentError, 'expected value to be a hex string'
+        end
         super [value].pack('H*')
       end
 

data/lib/tox/client.rb

@@ -27,7 +27,7 @@ module Tox
     end
 
     def bootstrap_official
-      Status.new.nodes.each do |node|
+      Status.new.udp_nodes.each do |node|
         bootstrap node
       end
     end
@@ -43,20 +43,33 @@ module Tox
     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
+      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
+      end
+    end
+
+    def friend(number)
+      Friend.new self, number
+    end
+
+    def friend!(number)
+      Friend.new(self, number).exist!
+    end
+
+    def on_iteration(&block)
+      @on_iteration = block
+    end
+
     def on_friend_request(&block)
       @on_friend_request = block
     end
@@ -65,6 +78,18 @@ module Tox
       @on_friend_message = block
     end
 
+    def on_friend_name_change(&block)
+      @on_friend_name_change = block
+    end
+
+    def on_friend_status_message_change(&block)
+      @on_friend_status_message_change = block
+    end
+
+    def on_friend_status_change(&block)
+      @on_friend_status_change = block
+    end
+
   private
 
     attr_accessor :thread
@@ -77,6 +102,15 @@ module Tox
       @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

data/lib/tox/friend.rb

@@ -28,17 +28,34 @@ module Tox
       self.number = number
     end
 
+    def exist!
+      raise NotFoundError, "friend #{number} not found" unless exist?
+      self
+    end
+
+    alias exists! exist!
+
   private
 
     def client=(value)
-      raise TypeError, "expected client to be a #{Client}" unless value.is_a? Client
+      unless value.is_a? Client
+        raise TypeError, "expected client to be a #{Client}"
+      end
       @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
+      unless value.is_a? Integer
+        raise TypeError, "expected number to be a #{Integer}"
+      end
+      unless value >= 0
+        raise ArgumentError,
+              'expected number to be greater than or equal to zero'
+      end
       @number = value
     end
+
+    class NotFoundError     < RuntimeError; end
+    class NotConnectedError < RuntimeError; end
   end
 end