lita-tox 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91236f6acf23d6db25acc452a0de0e1426abf5c4
-  data.tar.gz: 07e2890f818d7865861a1044be77a3fa1fdecca7
+  metadata.gz: 7594dc6e702a18b828fe46e1b8b64d9ad508690b
+  data.tar.gz: 53a3a8abf586220ae055867fbbb7608fe432072b
 SHA512:
-  metadata.gz: 5fef9b677b83c02c1b65d0fa3a8d29c97734c18968c886e0ca9c9bc6f5c043a21863a5547b97d46dbd6857520ab8e19e12e36b1489d92765a9ea33cf8cacba35
-  data.tar.gz: a31101312fce11274b71815770028ad35c8d4d1ec0ba632930b5d7837e81e1f09134bb9ac75b613bf126d0350454635a28f8535392d4cc1dfbf9fd09b3f6ac42
+  metadata.gz: 89053fb6c2db27721f1e51d8a5cccea01f5cdc2604b89ad499ea00b6b733bd16690aee497f9ab24d98994656baeec7a1ffd2b963cfff5333ebd960c7425c82d9
+  data.tar.gz: 45f399f7696d54b47c19815da80716cdc9140ce4b4c030f16ff412d821c31fbf1799d979d2267d9626cf45a04208cf0ab13446a55d059768e6f6579ee32d44af

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## [v0.2.0](https://github.com/braiden-vasco/lita-tox/tree/v0.2.0) (2015-09-14)
+[Full Changelog](https://github.com/braiden-vasco/lita-tox/compare/v0.1.0...v0.2.0)
+
+**Merged pull requests:**
+
+- Implement group chats [\#20](https://github.com/braiden-vasco/lita-tox/pull/20) ([braiden-vasco](https://github.com/braiden-vasco))
+- Save Tox state [\#19](https://github.com/braiden-vasco/lita-tox/pull/19) ([braiden-vasco](https://github.com/braiden-vasco))
+
 ## [v0.1.0](https://github.com/braiden-vasco/lita-tox/tree/v0.1.0) (2015-09-13)
 **Merged pull requests:**
 

data/README.md

@@ -18,18 +18,16 @@ TODO
 Current development version have some limitations
 which should be fixed in first release:
 
-* Adapter doesn't save Tox state, so you have to send friendship
-  request again after each run. Current Tox ID is shown at start
-  as Lita's information message
+* [\[issue #16\]](https://github.com/braiden-vasco/lita-tox/issues/16)
+  **libtoxcore** is not included in the gem. It should be compiled manually
+  to build the gem native extension successfully. Follow the instructions in
+  [that file](https://github.com/irungentoo/toxcore/blob/2ab3b14731061cc04d3ccc50a35093c11d018298/INSTALL.md)
 
-* Only private chats are supported. Adapter will not respond to group invite
+* [\[issue #17\]](https://github.com/braiden-vasco/lita-tox/issues/17)
+  JRuby is not supported. Only C extension for Tox is implemented
 
-* **libtoxcore** is not included in the gem. It should be compiled manually
-  to build the gem native extension successfully (see the instructions below)
-
-* JRuby is not supported. Only C extension for Tox is implemented
-
-* Message length is limited to value of `TOX_MAX_MESSAGE_LENGTH`
+* [\[issue #18\]](https://github.com/braiden-vasco/lita-tox/issues/18)
+  Message length is limited to value of `TOX_MAX_MESSAGE_LENGTH`
   (see [source code of **libtoxcore**](https://github.com/irungentoo/toxcore/blob/2ab3b14731061cc04d3ccc50a35093c11d018298/toxcore/tox.h#L252-L255))
 
 * Adapter has incomplete API for Lita. Only basic methods are implemented
@@ -43,19 +41,21 @@ At first, see the documentation for Lita: http://docs.lita.io/
 ### Installation
 
 **libtoxcore** should be compiled manually at your computer or server.
-Follow the instructions at
+Follow the instructions in
 [that file](https://github.com/irungentoo/toxcore/blob/2ab3b14731061cc04d3ccc50a35093c11d018298/INSTALL.md)
 
 When **libtoxcore** is installed, add **lita-tox**
 to your Lita instance's Gemfile:
 
 ```ruby
-gem 'lita-tox', '~> 0.1.0'
+gem 'lita-tox', '~> 0.2.0'
 ```
 
 ### Configuration
 
-No configuration is needed. You only have to specify adapter as `:tox`
+#### Optional attributes
+
+- `savedata_filename` (String) - Path to file where Tox state will be stored (if provided)
 
 #### Example
 
@@ -67,5 +67,7 @@ Lita.configure do |config|
   config.robot.mention_name = 'lita'
 
   config.robot.adapter = :tox
+
+  config.savedata_filename = 'savedata'
 end
 ```

data/ext/tox/extconf.rb

@@ -8,6 +8,7 @@ LIBTOXCORE = 'toxcore'
 
 have_header 'time.h' and
 have_header 'tox/tox.h' and
+have_header 'tox/tox_old.h' and
 
 have_func 'sprintf' and
 have_func 'sscanf' and
@@ -27,5 +28,10 @@ have_library LIBTOXCORE, 'tox_friend_add_norequest' and
 have_library LIBTOXCORE, 'tox_friend_send_message' and
 have_library LIBTOXCORE, 'tox_callback_friend_request' and
 have_library LIBTOXCORE, 'tox_callback_friend_message' and
+have_library LIBTOXCORE, 'tox_join_groupchat' and
+have_library LIBTOXCORE, 'tox_group_message_send' and
+have_library LIBTOXCORE, 'tox_callback_group_invite' and
+have_library LIBTOXCORE, 'tox_callback_group_message' and
+have_library LIBTOXCORE, 'tox_group_peernumber_is_ours' and
 
 create_makefile "#{NAME}/#{NAME}" or exit(1)

data/ext/tox/tox.c

@@ -40,6 +40,9 @@ static VALUE cTox_kill(VALUE self);
 static VALUE cTox_loop(VALUE self);
 static VALUE cTox_friend_add_norequest(VALUE self, VALUE key);
 static VALUE cTox_friend_send_message(VALUE self, VALUE friend_number, VALUE text);
+static VALUE cTox_join_groupchat(VALUE self, VALUE friend_number, VALUE data);
+static VALUE cTox_group_message_send(VALUE self, VALUE group_number, VALUE text);
+static VALUE cTox_group_peernumber_is_ours(VALUE self, VALUE group_number, VALUE peer_number);
 
 static void on_friend_request(
   Tox *tox,
@@ -56,6 +59,24 @@ static void on_friend_message(
   size_t length,
   VALUE self);
 
+static void on_group_invite(
+    Tox *tox,
+    int32_t friend_number,
+    uint8_t type,
+    const uint8_t *data,
+    uint16_t length,
+    VALUE self
+  );
+
+static void on_group_message(
+    Tox *tox,
+    int group_number,
+    int peer_number,
+    const uint8_t *text,
+    uint16_t length,
+    VALUE self
+  );
+
 typedef struct Tox_Options cTox_cOptions_;
 
 static VALUE cTox_cOptions;
@@ -80,6 +101,9 @@ void Init_tox()
   rb_define_method(cTox, "loop", cTox_loop, 0);
   rb_define_method(cTox, "friend_add_norequest", cTox_friend_add_norequest, 1);
   rb_define_method(cTox, "friend_send_message", cTox_friend_send_message, 2);
+  rb_define_method(cTox, "join_groupchat", cTox_join_groupchat, 2);
+  rb_define_method(cTox, "group_message_send", cTox_group_message_send, 2);
+  rb_define_method(cTox, "group_peernumber_is_ours", cTox_group_peernumber_is_ours, 2);
 
   cTox_cOptions = rb_define_class_under(cTox, "Options", rb_cObject);
   rb_define_alloc_func(cTox_cOptions, cTox_cOptions_alloc);
@@ -138,6 +162,14 @@ VALUE cTox_initialize_with(const VALUE self, const VALUE options)
 
   tox_callback_friend_request(tox->tox, (tox_friend_request_cb*)on_friend_request, (void*)self);
   tox_callback_friend_message(tox->tox, (tox_friend_message_cb*)on_friend_message, (void*)self);
+  tox_callback_group_invite(
+    tox->tox,
+    (void (*)(struct Tox *, int32_t, uint8_t, const uint8_t *, uint16_t, void *))on_group_invite,
+    (void*)self);
+  tox_callback_group_message(
+    tox->tox,
+    (void (*)(struct Tox *, int, int, const uint8_t *, uint16_t, void *))on_group_message,
+    (void*)self);
 
   return self;
 }
@@ -281,6 +313,65 @@ VALUE cTox_friend_send_message(const VALUE self, const VALUE friend_number, cons
   ));
 }
 
+VALUE cTox_join_groupchat(const VALUE self, const VALUE friend_number, const VALUE data)
+{
+  cTox_ *tox;
+
+  // Don't know yet how to check for integers
+  // Check_Type(friend_number, T_INTEGER);
+  Check_Type(data, T_STRING);
+
+  Data_Get_Struct(self, cTox_, tox);
+
+  return INT2FIX(tox_join_groupchat(
+    tox->tox,
+    NUM2LONG(friend_number),
+    (uint8_t*)RSTRING_PTR(data),
+    RSTRING_LEN(data)
+  ));
+}
+
+VALUE cTox_group_message_send(const VALUE self, const VALUE group_number, const VALUE text)
+{
+  cTox_ *tox;
+
+  // Don't know yet how to check for integers
+  // Check_Type(group_number, T_INTEGER);
+  Check_Type(text, T_STRING);
+
+  Data_Get_Struct(self, cTox_, tox);
+
+  return INT2FIX(tox_group_message_send(
+    tox->tox,
+    NUM2LONG(group_number),
+    (uint8_t*)RSTRING_PTR(text),
+    RSTRING_LEN(text)
+  ));
+}
+
+VALUE cTox_group_peernumber_is_ours(
+  const VALUE self,
+  const VALUE group_number,
+  const VALUE peer_number)
+{
+  cTox_ *tox;
+
+  // Don't know yet how to check for integers
+  // Check_Type(group_number, T_INTEGER);
+  // Check_Type(peer_number, T_INTEGER);
+
+  Data_Get_Struct(self, cTox_, tox);
+
+  if (tox_group_peernumber_is_ours(
+    tox->tox,
+    NUM2INT(group_number),
+    NUM2INT(peer_number))
+  )
+    return Qtrue;
+  else
+    return Qfalse;
+}
+
 void on_friend_request(
   Tox *const tox,
   const uint8_t *const key,
@@ -327,6 +418,51 @@ void on_friend_message(
     );
 }
 
+static void on_group_invite(
+    Tox *const tox,
+    const int32_t friend_number,
+    const uint8_t type,
+    const uint8_t *const data,
+    const uint16_t length,
+    const VALUE self)
+{
+  VALUE rb_on_group_invite;
+
+  rb_on_group_invite = rb_iv_get(self, "@on_group_invite");
+
+  if (Qnil != rb_on_group_invite)
+    rb_funcall(
+      rb_on_group_invite,
+      rb_intern("call"),
+      2,
+      LONG2FIX(friend_number),
+      rb_str_new((char*)data, length)
+    );
+}
+
+static void on_group_message(
+    Tox *const tox,
+    const int group_number,
+    const int peer_number,
+    const uint8_t *const text,
+    const uint16_t length,
+    const VALUE self)
+{
+  VALUE rb_on_group_message;
+
+  rb_on_group_message = rb_iv_get(self, "@on_group_message");
+
+  if (Qnil != rb_on_group_message)
+    rb_funcall(
+      rb_on_group_message,
+      rb_intern("call"),
+      3,
+      LONG2FIX(group_number),
+      LONG2FIX(peer_number),
+      rb_str_new((char*)text, length)
+    );
+}
+
 /******************************************************************************
  * Tox::Options
  ******************************************************************************/

data/lib/lita/adapters/tox.rb

@@ -12,8 +12,20 @@ module Lita
     # Tox adapter for the Lita chat bot.
     #
     class Tox < Adapter
+      config :savedata_filename, type: String
+
       def initialize(robot)
-        @tox = ::Tox.new
+        super
+
+        options = ::Tox::Options.new
+
+        if config.savedata_filename && File.exist?(config.savedata_filename)
+          savedata_file = open(config.savedata_filename)
+          options.data = savedata_file.read
+          savedata_file.close
+        end
+
+        @tox = ::Tox.new(options)
 
         log.info("ID: #{@tox.id}")
 
@@ -29,15 +41,43 @@ module Lita
           message.command!
           robot.receive(message)
         end
+
+        @tox.on_group_invite do |friend_number, data|
+          @tox.join_groupchat(friend_number, data)
+        end
+
+        @tox.on_group_message do |group_number, peer_number, text|
+          unless @tox.group_peernumber_is_ours(group_number, peer_number)
+            user = User.new(-1 - peer_number) # TODO
+            source = Source.new(user: user, room: group_number)
+            message = Message.new(robot, text, source)
+
+            robot.receive(message)
+          end
+        end
       end
 
       def run
         @tox.loop
       end
 
+      def shut_down
+        if config.savedata_filename
+          savedata_file = open(config.savedata_filename, 'w')
+          savedata_file.write(@tox.savedata)
+          savedata_file.close
+        end
+
+        @tox.kill
+      end
+
       def send_messages(target, messages)
         messages.reject(&:empty?).each do |message|
-          @tox.friend_send_message(target.user.id.to_i, message)
+          if target.user.id.to_i >= 0
+            @tox.friend_send_message(target.user.id.to_i, message)
+          else
+            @tox.group_message_send(target.room.to_i, message)
+          end
         end
       end
     end

data/lib/tox.rb

@@ -50,4 +50,12 @@ class Tox
   def on_friend_message(&block)
     @on_friend_message = block
   end
+
+  def on_group_invite(&block)
+    @on_group_invite = block
+  end
+
+  def on_group_message(&block)
+    @on_group_message = block
+  end
 end

data/lita-tox.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'lita-tox'
-  spec.version       = '0.1.0'
+  spec.version       = '0.2.0'
   spec.authors       = ['Braiden Vasco']
   spec.email         = ['braiden-vasco@mailtor.net']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-tox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Braiden Vasco
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-13 00:00:00.000000000 Z
+date: 2015-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler