xfiredb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9bd830b09b250371533632ecf4aa70b9f9d40a7d
+  data.tar.gz: 63c8d424676a7b44b615a7be898c66e5248ffed7
+SHA512:
+  metadata.gz: 3ac853af16c4d8341f9d7e8076adc4e9f3c836ac8cfd1b7270c65ebea89ea08706e1f183bfb12673da199a1080d4d69fd942c02afd2bbb08a28d904a01032897
+  data.tar.gz: baef7b08a54e305e05040b95f14f9ce118ab85c958086e05b7a3af8063d9fcf44027aca048ee5a98537e6401c35dfb408e3676c5a8476d4b6b6b787017345cfa

data/lib/xfiredb/client.rb

@@ -0,0 +1,107 @@
+#
+#   XFireDB client library
+#   Copyright (C) 2016  Michel Megens <dev@michelmegens.net>
+#
+#    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 XFireDB
+  # Representation of the connecting client.
+  class Client
+    # Create a new client.
+    def initialize
+      @connected = false
+      @ssl = false
+      @authenticated = false
+    end
+
+    # Connect to an XFireDB server
+    #
+    # @param [String] host Server host.
+    # @param [Fixnum] port Server port.
+    # @param [Fixnum] flags Connection flags.
+    # @param [String] user Username.
+    # @param [String] pass Password.
+    # @return [Boolean] True if the connection was succesful, false otherwise.
+    def connect(host, port, flags = nil, user = nil, pass = nil)
+      @socket = XFireDB::Socket.connect(host, port, flags & XFireDB::SSL)
+      @ssl = true if @socket.class == XFireDB::SSLSocket
+      @stream = true if flags & XFireDB::STREAM == XFireDB::STREAM
+
+      if flags & XFireDB::AUTH == XFireDB::AUTH
+        @socket.puts "AUTH #{user} #{pass}"
+        result = @socket.gets.chomp
+
+        if result == "OK"
+          @authenticated = true
+        else
+          return false
+        end
+
+        @socket.puts "STREAM" if @stream
+      elsif @stream
+        @socket.puts "STREAM"
+      end
+
+      @connected = true
+      return true
+    end
+
+    # Query a client.
+    # @param [String] q Query to send to the server.
+    # @return [true]
+    def query(q)
+      return false unless @connected
+
+      @socket.puts q
+      reply = @socket.gets
+      reply.chomp! if reply
+      num = reply.scan(/\ /).count + 1
+
+      puts num
+
+      num.times do
+        data = @socket.gets
+        data.chomp! if data
+        puts data
+        res = XFireDB::Result.new data
+        res.process
+        yield res
+      end
+
+      true
+    end
+
+    # Close a connection.
+    def close
+      @connected = false
+      @authenticated = false
+      @stream = false
+
+      @socket.puts "QUIT" if @connected
+      @socket.close
+    end
+
+    # Check if a client is connected.
+    def connected?
+      @connected
+    end
+
+    # Check if the client is using SSL.
+    def ssl?
+      @ssl
+    end
+  end
+end
+

data/lib/xfiredb/result.rb

@@ -0,0 +1,90 @@
+#
+#   XFireDB client library
+#   Copyright (C) 2016  Michel Megens <dev@michelmegens.net>
+#
+#    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 XFireDB
+  # Query result class
+  class Result
+    attr_reader :data, :status
+
+    # Status OK
+    OK = 0x1
+    # Status SUCCESS
+    SUCCESS = 0x2
+    # Status NULL
+    NULL = 0x4
+    # Status MESSAGE
+    MSG = 0x8
+
+    # Query success status codes
+    ACK = XFireDB::Result::OK | XFireDB::Result::SUCCESS
+
+    # Create a new result object
+    #
+    # @param [String] dat Raw query data.
+    def initialize(dat)
+      @data = dat
+      @status = nil
+    end
+
+    # Process the data.
+    def process
+      case @data[0,1]
+      when '+' # String reply
+        @data.slice!(0)
+        @status = XFireDB::Result::SUCCESS
+      when '&' # Boolean result
+        @status = XFireDB::Result::SUCCESS
+        @data = true if @data == "&true"
+        @data = false if @data == "&false"
+      when '%' # Numeral result
+        @status = XFireDB::Result::SUCCESS
+        @data.slice!(0)
+        @data = @data.to_i
+      when '-'
+        process_default
+      else
+        process_default
+      end
+    end
+
+    # Check whether the query was succesfull or not.
+    def success?
+      @status & XFireDB::Result::SUCCESS == XFireDB::Result::SUCCESS
+    end
+
+    # Check if the result is NULL.
+    def null?
+      @status & XFireDB::Result::NULL == XFireDB::Result::NULL
+    end
+
+    private
+    # Process status codes.
+    def process_default
+      @data.slice!(0) if @data[0,1] == '-'
+
+      if @data == "OK"
+        @status = ACK
+      elsif @data == "nil"
+        @status = NULL
+      else
+        @status = MSG
+      end
+    end
+  end
+end
+

data/lib/xfiredb/socket.rb

@@ -0,0 +1,48 @@
+#
+#   XFireDB client library
+#   Copyright (C) 2016  Michel Megens <dev@michelmegens.net>
+#
+#    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 XFireDB
+  # Socket helper class
+  class Socket
+    # Connect a socket.
+    # @param [String] addr Server address.
+    # @param [Fixnum] port Server port.
+    # @param [Boolean] ssl Set to true to enable SSL.
+    def self.connect(addr, port, ssl)
+      sock = TCPSocket.new addr, port
+
+      return sock unless ssl
+      return XFireDB::SSLSocket.new sock
+    end
+  end
+
+  # Connect SSL version of the TCPSocket class.
+  class SSLSocket < OpenSSL::SSL::SSLSocket
+    @sock = nil
+
+    # Create a new SSL socket.
+    # @param [TCPSocket] sock Base socket.
+    def initialize(sock)
+      super(sock)
+
+      @sock = sock
+      self.sync_close = true
+      self.connect
+    end
+  end
+end

data/lib/xfiredb/version.rb

@@ -0,0 +1,4 @@
+module XFireDB
+  # XFireDB ruby client version number.
+  VERSION = "1.0.0"
+end

data/lib/xfiredb.rb

@@ -0,0 +1,58 @@
+#
+#   XFireDB client library
+#   Copyright (C) 2016  Michel Megens <dev@michelmegens.net>
+#
+#    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 'socket'
+require 'openssl'
+
+require 'xfiredb/socket'
+require 'xfiredb/version'
+require 'xfiredb/client'
+require 'xfiredb/result'
+
+# XFireDB client module.
+module XFireDB
+  # SSL connection flag.
+  SSL    = 0x1
+  # Authentication required flag.
+  AUTH   = 0x2
+  # Command stream flag.
+  STREAM = 0x4
+
+  class << self
+    # Create a new client.
+    # @return [Client] A new client object.
+    def new
+      Client.new
+    end
+
+    # Connect to an XFireDB server
+    #
+    # @param [String] host Server host.
+    # @param [Fixnum] port Server port.
+    # @param [Fixnum] flags Connection flags.
+    # @param [String] user Username.
+    # @param [String] pass Password.
+    # @return [Client] A client object.
+    def connect(host, port, flags = nil, user = nil, pass = nil)
+      client = Client.new
+      client.connect(host, port, flags, user, pass)
+      return client
+    end
+  end
+end
+

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: xfiredb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michel Megens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: XFireDB ruby client library
+email:
+- dev@michelmegens.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/xfiredb.rb
+- lib/xfiredb/client.rb
+- lib/xfiredb/result.rb
+- lib/xfiredb/socket.rb
+- lib/xfiredb/version.rb
+homepage: http://xfiredb.bietje.net
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: XFireDB connector
+test_files: []