zklib 1.0.0

data/lib/zklib/user_management.rb

@@ -0,0 +1,199 @@
+class Zklib
+  module UserManagement
+    # Clear admins
+    def clear_admins
+      execute_cmd(
+        command:        CMD_CLEAR_ADMIN,
+        command_string: ''
+      ) do |opts|
+        return puts "ERROR: #{options[:error]}" unless opts[:valid]
+
+        data = opts[:data]
+        if data.length > 7
+          data.split("\u0000").pop
+        else
+          puts 'ERROR: Invalid clear admins response'
+        end
+      end
+    end
+
+    # Clear users
+    def clear_users
+      execute_cmd(
+        command:        CMD_CLEAR_DATA,
+        command_string: ''
+      ) do |opts|
+        return puts "ERROR: #{options[:error]}" unless opts[:valid]
+
+        data = opts[:data]
+        if data.length > 7
+          data.split("\u0000").pop
+        else
+          puts 'ERROR: Invalid clear users response'
+        end
+      end
+    end
+
+    # Create user
+    # param  options
+    #        |_ uid       UID
+    #        |_ user_id   User ID
+    #        |_ name      Name
+    #        |_ password  Password
+    #        |_ role      Role
+    def create_user(options)
+      # command_string  = (options[:uid] % 256).chr
+      # command_string += (options[:uid] >> 8).chr
+      command_string  = options[:uid].chr.ljust(2, 0.chr)
+      command_string += options[:role].chr
+      command_string += options[:password].ljust(8, 0.chr)
+      command_string += options[:name].ljust(28, 0.chr)
+      command_string += 1.chr
+      command_string += 0.chr * 8
+      command_string += options[:user_id].ljust(8, 0.chr)
+      command_string += 0.chr * 16
+
+      execute_cmd(
+        command:        CMD_SET_USER,
+        command_string: command_string
+      ) do |opts|
+        return puts "ERROR: #{options[:error]}" unless opts[:valid]
+
+        data = opts[:data]
+        if data.length > 7
+          data.split("\u0000").pop
+        else
+          puts 'ERROR: Invalid set user response'
+        end
+      end
+    end
+
+    # Decode user data
+    # param  options
+    #        |_ data  User data to decode
+    def decode_user_data(options)
+      data = options[:data]
+
+      {
+        uid:      BinData::Uint16be.read(data[0..1]).snapshot,
+        role:     BinData::Uint16be.read(data[2..3]).snapshot,
+        password: data[4..11].split("\0").pop,
+        name:     data[12..35].split("\0").pop,
+        card_no:  BinData::Uint32le.read(data[36..39]).snapshot,
+        user_id:  data[49..71].split("\0").pop
+      }
+    end
+
+    # Delete user
+    # param  options
+    #        |_ uid  UID
+    def delete_user(options)
+      command_buffer = StringIO.new
+      binary_writer  = BinData::Uint16le.new
+
+      binary_writer.value = options[:uid]
+      command_buffer.pos  = 0
+      binary_writer.write(command_buffer)
+
+      command_string = command_buffer.string
+
+      execute_cmd(
+        command:        CMD_DELETE_USER,
+        command_string: command_string
+      ) do |opts|
+        return puts "ERROR: #{options[:error]}" unless opts[:valid]
+
+        data = opts[:data]
+        if data.length > 7
+          data.split("\u0000").pop
+        else
+          puts 'ERROR: Invalid clear admins response'
+        end
+      end
+    end
+
+    # Get user list size
+    def get_user_count
+      return 0 if BinData::Uint16le.read(data_recv).snapshot != CMD_PREPARE_DATA
+
+      BinData::Uint32le.read(data_recv[8..-1]).snapshot
+    end
+
+    # Get users
+    def get_users
+      header = create_header(
+        command:        CMD_USERTEMP_RRQ,
+        command_string: 5.chr,
+        checksum:       0,
+        session_id:     session_id,
+        reply_id:       BinData::Uint16le.read(data_recv[6..-1]).snapshot
+      )
+
+      # Send command
+      socket = UDPSocket.new
+      socket.bind('0.0.0.0', inport)
+      socket.send(header, 0, ip, port)
+
+      ### START Get response size ###
+      self.data_recv = receive_nonblock(socket: socket)[0]
+
+      return puts 'ERROR: Empty response' unless data_recv && data_recv.length > 0
+
+      self.session_id = BinData::Uint16le.read(data_recv[4..-1]).snapshot
+      total_bytes     = get_user_count
+
+      # Stop if user list is empty
+      if total_bytes <= 0
+        socket.close
+
+        return []
+      end
+      ### END Get response size ###
+
+      ### START Get user list ###
+      bytes_recv     = 0
+      rem            = nil
+      offset         = 0
+      user_data_size = 72
+      trim_first     = 11
+      trim_others    = 8
+      users          = []
+
+      while true
+        data = receive_nonblock(socket: socket)[0]
+
+        if bytes_recv == 0
+          offset     = trim_first
+          bytes_recv = 4
+        else
+          offset = trim_others
+        end
+
+        while(data.length - offset >= user_data_size)
+          user_data  = data[offset..-1]
+          offset    += user_data_size
+
+          if rem && rem.length > 0
+            user_data.prepend(rem)
+            offset -= rem.length
+            rem     = nil
+          end
+
+          users << decode_user_data(data: user_data)
+          bytes_recv += user_data_size
+
+          if bytes_recv == total_bytes
+            socket.close
+
+            return users
+          end
+        end
+
+        rem = data[offset..-1]
+      end
+      ### END Get user list ###
+
+      socket.close
+    end
+  end
+end

data/lib/zklib/version.rb

@@ -0,0 +1,3 @@
+class Zklib
+  VERSION = "1.0.0"
+end

data/lib/zklib/version_management.rb

@@ -0,0 +1,58 @@
+class Zklib
+  module VersionManagement
+    OS_VERSION_KEYWORD       = '~OS'
+    PLATFORM_VERSION_KEYWORD = '~ZKFPVersion'
+    SSR_VERSION_KEYWORD      = '~SSR'
+
+    # Get firmware version
+    def get_firmware_version
+      execute_cmd(
+        command:        CMD_VERSION,
+        command_string: ''
+      ) do |opts|
+        return puts "ERROR: #{options[:error]}" unless opts[:valid]
+
+        data = opts[:data]
+        if data.length > 8
+          data.split("\u0000").pop
+        else
+          puts 'ERROR: Invalid firmware version response'
+        end
+      end
+    end
+
+    # Get OS version
+    def get_os_version
+      execute_cmd(
+        command:        CMD_DEVICE,
+        command_string: OS_VERSION_KEYWORD
+      ) do |opts|
+        return puts "ERROR: #{options[:error]}" unless opts[:valid]
+
+        data = opts[:data]
+        if data.length > 8
+          data.split("\u0000").pop.tr("#{OS_VERSION_KEYWORD}=", '')
+        else
+          puts 'ERROR: Invalid OS version response'
+        end
+      end
+    end
+
+    # Get platform version
+    def get_platform_version
+      execute_cmd(
+        command:        CMD_DEVICE,
+        command_string: PLATFORM_VERSION_KEYWORD
+      ) do |opts|
+        return puts "ERROR: #{options[:error]}" unless opts[:valid]
+
+        data = opts[:data]
+        if data.length > 8
+          data.split("\u0000").pop.tr("#{PLATFORM_VERSION_KEYWORD}=", '')
+        else
+          puts 'ERROR: Invalid platform version response'
+        end
+      end
+    end
+  end
+end

data/lib/zklib/work_code_management.rb

@@ -0,0 +1,22 @@
+class Zklib
+  module WorkCodeManagement
+    WORK_CODE_KEYWORD = 'WorkCode'
+    
+    # Get work code
+    def get_work_code
+      execute_cmd(
+        command:        CMD_DEVICE,
+        command_string: WORK_CODE_KEYWORD
+      ) do |opts|
+        return puts "ERROR: #{options[:error]}" unless opts[:valid]
+
+        data = opts[:data]
+        if data.length > 8
+          data.split("\u0000").pop.tr("#{WORK_CODE_KEYWORD}=", '')
+        else
+          puts 'ERROR: Invalid work code response'
+        end
+      end
+    end
+  end
+end

data/zklib.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zklib/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'zklib'
+  spec.version  = Zklib::VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.license  = 'MIT'
+
+  spec.summary     = 'Attendance machine client in Ruby'
+  spec.email       = 'anhtrantuan.hcmc@gmail.com'
+  spec.homepage    = 'https://github.com/anhtrantuan/zklib-ruby'
+  spec.description = 'Attendance machine client in Ruby'
+  spec.authors     = ['Anh Tran']
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'bindata', '~> 2.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'byebug', '~> 9.0'
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: zklib
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Anh Tran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: Attendance machine client in Ruby
+email: anhtrantuan.hcmc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zklib.rb
+- lib/zklib/attendance_management.rb
+- lib/zklib/connection_management.rb
+- lib/zklib/data_management.rb
+- lib/zklib/device_management.rb
+- lib/zklib/face_management.rb
+- lib/zklib/helper.rb
+- lib/zklib/pin_management.rb
+- lib/zklib/platform_management.rb
+- lib/zklib/serial_management.rb
+- lib/zklib/ssr_management.rb
+- lib/zklib/time_management.rb
+- lib/zklib/user_management.rb
+- lib/zklib/version.rb
+- lib/zklib/version_management.rb
+- lib/zklib/work_code_management.rb
+- zklib.gemspec
+homepage: https://github.com/anhtrantuan/zklib-ruby
+licenses:
+- MIT
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Attendance machine client in Ruby
+test_files: []