libfchat 1.2 → 1.3

data/lib/libfchat/fchat.rb

@@ -13,6 +13,7 @@ module Libfchat
   require 'libfchat/webapi'
   
   class Fchat
+    attr_accessor :spam
     attr_reader :ticket
     attr_accessor :websocket
 
@@ -41,6 +42,7 @@ module Libfchat
       @version = version
       @users = Hash.new
       @rooms = Hash.new
+      @spam = true
     end
 
     ##
@@ -50,12 +52,33 @@ module Libfchat
     def method_missing(method_name, *args, &block)
       # Try to handle all three-letter strings
       if method_name.to_s[4,7] =~ /[A-Z]{3}/
-        #puts "Dunno how to handle #{method_name.to_s}"
+        return nil
       else
         super(method_name,*args,&block)
       end
     end
 
+    ##
+    # Parse message received from server
+    def parse_message(msg)
+      type = msg[0,3]
+      begin
+        data = MultiJson.load(msg[4..-1])
+      rescue
+        data = MultiJson.load('{}')
+      end
+
+      # Output if spamminess is enabled
+      if @spam
+        puts "<< #{msg}"
+      end
+
+      begin
+        self.send("got_#{type}",data)
+      rescue
+      end
+    end
+
     ##
     # Login to fchat as a specific user, and start the event machine
 
@@ -68,7 +91,7 @@ module Libfchat
 
         @websocket.onopen = lambda do |event|
           #When we connect, log in
-          self.send('IDN',account,character,ticket)
+          self.IDN(account, character, ticket)
         end
 
         @websocket.onclose = lambda do |event|
@@ -76,27 +99,23 @@ module Libfchat
         end
 
         @websocket.onmessage = lambda do |event|
-          type = event.data[0,3]
-          begin
-            data = MultiJson.load(event.data[4..-1])
-          rescue
-            data = MultiJson.load('{}')
-          end
-          puts "<< [#{type}] #{MultiJson.dump(data)}"
-          begin
-            self.send("got_#{type}",data)
-          rescue
-          end
+          self.parse_message(event.data)
         end
       }
     end
 
     ##
     # Generic message sender
-    def send_message(type,json)
+    def send_message(type, json)
       jsonstr = ::MultiJson.dump(json)
       msg = "#{type} #{jsonstr}"
-      puts ">> #{msg}"
+      if @spam
+        if type == 'IDN'
+          json[:ticket] = '[REDACTED]'
+        end
+        filteredjsonstr = ::MultiJson.dump(json)
+        puts ">> #{type} #{filteredjsonstr}"
+      end
       @websocket.send(msg)
     end
 
@@ -122,11 +141,11 @@ module Libfchat
       elsif message['variable'] == 'lfrp_flood'
         @lfrp_flood = message['value']
       elsif message['variable'] == 'msg_flood'
-        @msg_max = message['value']
+        @msg_flood = message['value']
       elsif message['variable'] == 'permissions'
         @permissions = message['value']
       else
-        puts "ERROR: Do not know how to handle VAR #{message}"
+        raise "ERROR: Do not know how to handle VAR #{message}"
       end
     end
     
@@ -194,7 +213,6 @@ module Libfchat
     def got_JCH(message)
       begin
         @rooms[message['channel']]['characters'].push(message['character']['identity'])
-        puts "Someone else joined a room"
       rescue
         @rooms[message['channel']] = {
           'title'       => message['title'],
@@ -202,7 +220,6 @@ module Libfchat
           'characters'  => [],
           'ops'         => [],
         }
-        puts "I joined a new room"
       end
     end
 
@@ -220,12 +237,6 @@ module Libfchat
       end
     end
 
-    ##
-    # Handle user joining chatroom
-    def got_LCH(message)
-      @rooms[message['channel']]['characters'].delete(message['character'])
-    end
-
     ##
     # Handle user leaving chatroom
     def got_LCH(message)
@@ -250,7 +261,7 @@ module Libfchat
     # *This command requires chat op or higher.*
     def ACB(character)
       json = {:character => character}
-      self.send('send_message','ACB',json)
+      self.send_message('ACB',json)
     end
 
     ##
@@ -259,7 +270,7 @@ module Libfchat
     # *This command is admin only.*
     def AOP(character)
       json = {:character => character}
-      self.send('send_message','AOP',json)
+      self.send_message('AOP',json)
     end
 
     ##
@@ -268,7 +279,7 @@ module Libfchat
     # *This command requires chat op or higher.*
     def AWC(character)
       json = {:character => character}
-      self.send('send_message','AWC',json)
+      self.send_message('AWC',json)
     end
 
     ##
@@ -276,7 +287,7 @@ module Libfchat
     # *This command is admin only.*
     def BRO(message)
       json = {:message => message}
-      self.send('send_message','AWC',json)
+      self.send_message('AWC',json)
     end
 
     ##
@@ -285,7 +296,7 @@ module Libfchat
     # *This command requires channel op or higher.*
     def CBL(channel)
       json = {:channel => channel}
-      self.send('send_message','CBL',json)
+      self.send_message('CBL',json)
     end
 
     ##
@@ -295,14 +306,14 @@ module Libfchat
     def CBU(channel,character)
       json = {:channel   => channel,
               :character => character}
-      self.send('send_message','CBU',json)
+      self.send_message('CBU',json)
     end
 
     ##
     # Create an Ad-hoc Channel
     def CCR(channel)
       json = {:channel => channel}
-      self.send('send_message','CCR',json)
+      self.send_message('CCR',json)
     end
 
     ##
@@ -310,15 +321,16 @@ module Libfchat
     # channel description.
     #
     # *This command requires channel op or higher.*
-    def CCR(channel)
-      json = {:channel => channel}
-      self.send('send_message','CCR',json)
+    def CDS(channel, description)
+      json = {:channel => channel,
+              :description => description}
+      self.send_message('CDS',json)
     end
 
     ##
     # Request a list of all public channels
     def CHA()
-      self.send('send_message','CHA',{})
+      self.send_message('CHA',{})
     end
 
     ##
@@ -326,7 +338,7 @@ module Libfchat
     def CIU(channel,character)
       json = {:channel   => channel,
               :character => character }
-      self.send('send_message','CIU',json)
+      self.send_message('CIU',json)
     end
 
     ##
@@ -336,7 +348,7 @@ module Libfchat
     def CKU(channel,character)
       json = {:channel   => channel,
               :character => character }
-      self.send('send_message','CKU',json)
+      self.send_message('CKU',json)
     end
 
     ##
@@ -346,14 +358,14 @@ module Libfchat
     def COA(channel,character)
       json = {:channel   => channel,
               :character => character }
-      self.send('send_message','COA',json)
+      self.send_message('COA',json)
     end
 
     ##
     # Request a list of channel ops
-    def COA(channel)
+    def COL(channel)
       json = {:channel => channel }
-      self.send('send_message','CKU',json)
+      self.send_message('COL',json)
     end
 
     ##
@@ -362,7 +374,7 @@ module Libfchat
     # *This command is admin only*
     def CRC(channel)
       json = {:channel => channel }
-      self.send('send_message','CRC',json)
+      self.send_message('CRC',json)
     end
 
     ##
@@ -372,7 +384,7 @@ module Libfchat
     def CUB(channel,character)
       json = {:channel   => channel,
               :character => character }
-      self.send('send_message','CUB',json)
+      self.send_message('CUB',json)
     end
 
     ##
@@ -381,7 +393,7 @@ module Libfchat
     # *This command is admin only*
     def DOP(character)
       json = { :character => character }
-      self.send('send_message','DOP',json)
+      self.send_message('DOP',json)
     end
 
     ##
@@ -389,7 +401,7 @@ module Libfchat
     def FKS(kink,genders)
       json = { :kink    => kink,
                :genders => genders }
-      self.send('send_message','FKS',json)
+      self.send_message('FKS',json)
     end
 
     ##
@@ -409,7 +421,7 @@ module Libfchat
               :cname     => cname,
               :cversion  => cversion,
               :method    => 'ticket'}
-      self.send('send_message','IDN',json)
+      self.send_message('IDN', json)
     end
 
     ##
@@ -422,7 +434,7 @@ module Libfchat
     def IGN(action,character)
       json = { :action    => action,
                :character => character }
-      self.send('send_message','IGN',json)
+      self.send_message('IGN',json)
     end
 
     ##
@@ -431,14 +443,14 @@ module Libfchat
     # *This command is admin only*
     def IPB(character)
       json = { :character => character }
-      self.send('send_message','IPB',json)
+      self.send_message('IPB',json)
     end
 
     ##
     # Send a channel join request
     def JCH(channel)
       json = { :channel => channel }
-      self.send('send_message','JCH',json)
+      self.send_message('JCH',json)
     end
 
     ##
@@ -447,21 +459,21 @@ module Libfchat
     # *This command requires channel op or higher*
     def KIK(character)
       json = {:character => character }
-      self.send('send_message','KIK',json)
+      self.send_message('KIK',json)
     end
 
     ##
     # Request a character's list of kinks
     def KIN(character)
       json = {:character => character }
-      self.send('send_message','KIN',json)
+      self.send_message('KIN',json)
     end
 
     ##
     # Leave a channel
     def LCH(channel)
       json = {:channel => channel }
-      self.send('send_message','LCH',json)
+      self.send_message('LCH',json)
     end
 
     ##
@@ -469,25 +481,25 @@ module Libfchat
     def MSG(channel,message)
       json = {:channel => channel,
               :message => message }
-      self.send('send_message','MSG',json)
+      self.send_message('MSG',json)
     end
 
     ##
     # List presence of ops in all rooms
     def OPP()
-      self.send('send_message','OPP',{})
+      self.send_message('OPP',{})
     end
 
     ##
     # Request a list of open private rooms
     def ORS()
-      self.send('send_message','ORS',{})
+      self.send_message('ORS',{})
     end
 
     ##
     # Respond to a ping request
     def PIN()
-      self.send('send_message','PIN',{})
+      self.send_message('PIN',{})
     end
 
     ##
@@ -495,14 +507,14 @@ module Libfchat
     def PRI(recipient,message)
       json = {:recipient => recipient,
               :message   => message }
-      self.send('send_message','PRI',json)
+      self.send_message('PRI',json)
     end
 
     ##
     # Do a profile request
     def PRO(character)
       json = {:character => character }
-      self.send('send_message','PRO',json)
+      self.send_message('PRO',json)
     end
 
     ##
@@ -510,7 +522,7 @@ module Libfchat
     # in the given channel
     def RAN(channel)
       json = {:channel => channel }
-      self.send('send_message','RAN',json)
+      self.send_message('RAN',json)
     end
 
     ##
@@ -518,7 +530,7 @@ module Libfchat
     def RLL(channel,dice)
       json = {:channel => channel,
               :dice    => dice }
-      self.send('send_message','RLL',json)
+      self.send_message('RLL',json)
     end
 
     ##
@@ -528,7 +540,7 @@ module Libfchat
     def RST(channel,status)
       json = {:channel   => channel,
               :status    => status }
-      self.send('send_message','RST',json)
+      self.send_message('RST',json)
     end
 
     ##
@@ -537,7 +549,7 @@ module Libfchat
     # *This command is admin only*
     def RWD(character)
       json = {:character => character }
-      self.send('send_message','RWD',json)
+      self.send_message('RWD',json)
     end
 
     ##
@@ -545,7 +557,7 @@ module Libfchat
     def STA(status,statusmsg)
       json = {:status    => status,
               :statusmsg => statusmsg }
-      self.send('send_message','STA',json)
+      self.send_message('STA',json)
     end
 
     ##
@@ -557,7 +569,7 @@ module Libfchat
       json = {:character => character,
               :time      => time,
               :reason    => reason }
-      self.send('send_message','TMO',json)
+      self.send_message('TMO',json)
     end
 
     ##
@@ -567,7 +579,7 @@ module Libfchat
     def TPN(character,status)
       json = {:character => character,
               :status    => status }
-      self.send('send_message','TPN',json)
+      self.send_message('TPN',json)
     end
 
     ##
@@ -576,7 +588,7 @@ module Libfchat
     # *This command requires chat op or higher*
     def UBN(character)
       json = {:character => character }
-      self.send('send_message','UBN',json)
+      self.send_message('UBN',json)
     end
 
   end #End of class

data/lib/libfchat/version.rb

@@ -2,5 +2,5 @@ module Libfchat
   # We're doing this because we might write tests that deal
   # with other versions of Libfchat and we are unsure how to
   # handle this better.
-  VERSION = "1.2" unless defined?(::Libfchat::VERSION)
+  VERSION = "1.3" unless defined?(::Libfchat::VERSION)
 end

data/lib/libfchat/webapi.rb

@@ -19,6 +19,8 @@ module Libfchat
       json = MultiJson.load(res.body)
       if json['ticket']
         @ticket = json['ticket']
+      else
+        raise json['error']
       end
       return json
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: libfchat
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.3'
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &9466340 !ruby/object:Gem::Requirement
+  requirement: &9248400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.5
   type: :development
   prerelease: false
-  version_requirements: *9466340
+  version_requirements: *9248400
 - !ruby/object:Gem::Dependency
   name: miniunit
-  requirement: &9560780 !ruby/object:Gem::Requirement
+  requirement: &9247820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.2.1
   type: :development
   prerelease: false
-  version_requirements: *9560780
+  version_requirements: *9247820
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &9560240 !ruby/object:Gem::Requirement
+  requirement: &9247220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *9560240
+  version_requirements: *9247220
 - !ruby/object:Gem::Dependency
   name: faye-websocket
-  requirement: &9559760 !ruby/object:Gem::Requirement
+  requirement: &9246660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 0.4.6
   type: :runtime
   prerelease: false
-  version_requirements: *9559760
+  version_requirements: *9246660
 description: A library for connecting to F-chat ( http://f-list.net )
 email: cheetahmorph@gmail.com
 executables: []
@@ -64,8 +64,6 @@ files:
 - lib/libfchat/version.rb
 - lib/libfchat/webapi.rb
 - lib/libfchat/fchat.rb
-- test/webapi_test.rb
-- test/fchat_test.rb
 homepage: http://github.com/jippen/libfchat-ruby
 licenses:
 - MIT
@@ -91,6 +89,4 @@ rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A library for connection to F-chat
-test_files:
-- test/webapi_test.rb
-- test/fchat_test.rb
+test_files: []

data/test/fchat_test.rb

@@ -1,14 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.unshift File.expand_path("../lib", __FILE__)
-
-require 'test_helper'
-require 'libfchat/fchat'
-
-class TestFchat < Test::Unit::TestCase
-
-  def test_can_create_object
-    j = Libfchat::Fchat.new
-    assert_equal true, j.is_a?(Object)
-  end
-
-end

data/test/webapi_test.rb

@@ -1,28 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.unshift File.expand_path("../lib", __FILE__)
-
-require 'test_helper'
-require 'libfchat/webapi'
-
-class TestWebAPI < Test::Unit::TestCase
-
-  def test_can_create_object
-    j = Libfchat::WebAPI.new
-    assert_equal true, j.is_a?(Object)
-  end
-
-  def test_no_credentials_gives_error
-    j = Libfchat::WebAPI.new
-    ticket = j.get_ticket('','')
-    assert_not_nil ticket['error']
-    assert_not_equal '', ticket['error']
-  end
-
-  def test_bad_password_gives_error
-    j = Libfchat::WebAPI.new
-    ticket = j.get_ticket('jippenbots','')
-    assert_not_nil ticket['error']
-    assert_not_equal '', ticket['error']
-  end
-
-end