zklib 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 619040938efac5653b65136119f32ad44daa5554
+  data.tar.gz: a3cb9affaaba22587fa802dc46c5ec865c8eda14
+SHA512:
+  metadata.gz: b9a49652d4bd758ad3dff28816a4472bedfb8d49aaedbcaef553b640232049abe245428a412cb8bfa29103b6786d31de52e83474163ba68a62b86280ef5ac7d0
+  data.tar.gz: b6dc8eea2775d6b27621f5fa332c78ae36e54470a76b2142f8f22446252b60781756ca3fbefccb35de03ac311505adfd2e19ec04e4a20fdfde7ca096a66f2ad4

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+.rbenv-gemsets
+.byebug_history
+*~
+*.swp
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at anhtrantuan.hcmc@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zklib.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Anh Tran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Zklib
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/zklib`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zklib'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zklib
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zklib. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zklib"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/zklib.rb

@@ -0,0 +1,124 @@
+require 'zklib/version'
+
+# Libraries
+require 'socket'
+require 'bindata'
+
+# Mixins
+require 'zklib/helper'
+require 'zklib/attendance_management'
+require 'zklib/connection_management'
+require 'zklib/data_management'
+require 'zklib/device_management'
+require 'zklib/face_management'
+require 'zklib/pin_management'
+require 'zklib/platform_management'
+require 'zklib/serial_management'
+require 'zklib/ssr_management'
+require 'zklib/time_management'
+require 'zklib/user_management'
+require 'zklib/version_management'
+require 'zklib/work_code_management'
+
+class Zklib
+  include Helper
+  include AttendanceManagement
+  include ConnectionManagement
+  include DataManagement
+  include DeviceManagement
+  include FaceManagement
+  include PINManagement
+  include PlatformManagement
+  include SerialManagement
+  include SSRManagement
+  include TimeManagement
+  include UserManagement
+  include VersionManagement
+  include WorkCodeManagement
+
+  # Max unsigned short value
+  USHRT_MAX = 65535
+
+
+  # Data structures' size
+  ATTENDANCE_DATA_SIZE = 40
+  USER_DATA_SIZE       = 72
+
+
+  # Commands
+  CMD_CONNECT       = 1000
+  CMD_EXIT          = 1001
+  CMD_ENABLEDEVICE  = 1002
+  CMD_DISABLEDEVICE = 1003
+  CMD_RESTART       = 1004
+  CMD_POWEROFF      = 1005
+
+  CMD_ACK_OK        = 2000
+  CMD_ACK_ERROR     = 2001
+  CMD_ACK_DATA      = 2002
+
+  CMD_PREPARE_DATA  = 1500
+  CMD_DATA          = 1501
+  CMD_FREE_DATA     = 1502
+  CMD_REFRESHDATA   = 1013
+  CMD_REFRESHOPTION = 1014
+
+  CMD_USERTEMP_RRQ  = 9
+  CMD_ATTLOG_RRQ    = 13
+  CMD_CLEAR_DATA    = 14
+  CMD_CLEAR_ATTLOG  = 15
+  
+  CMD_WRITE_LCD     = 66
+
+  CMD_GET_TIME      = 201
+  CMD_SET_TIME      = 202
+
+  CMD_VERSION       = 1100
+  CMD_DEVICE        = 11
+
+  CMD_CLEAR_ADMIN   = 20
+  CMD_DELETE_USER   = 18
+  CMD_SET_USER      = 8
+
+
+  # User levels
+  LEVEL_USER  = 0
+  LEVEL_ADMIN = 14
+
+
+  # Login states
+  LOGIN_BY_PASSWORD    = 0
+  LOGIN_BY_FINGERPRINT = 1
+
+
+  # Communication states
+  STATE_FIRST_PACKET = 1
+  STATE_PACKET       = 2
+  STATE_FINISHED     = 3
+
+
+  attr_reader :inport,
+              :ip,
+              :port
+  attr_accessor :data_recv,
+                :reply_id,
+                :session_id,
+                :socket,
+                :exttrynumber,
+                :id_com
+
+
+  # param  options  Init options
+  #        |_ ip      Attendance machine IP
+  #        |_ port    Attendance machine UDP port
+  #        |_ inport  Client UDP port
+  def initialize(options)
+    @ip         = options[:ip]
+    @port       = options[:port]
+    @inport     = options[:inport]
+    @socket     = nil
+    @reply_id   = USHRT_MAX - 1
+    @data_recv  = ''
+    @session_id = 0
+  end
+end

data/lib/zklib/attendance_management.rb

@@ -0,0 +1,119 @@
+class Zklib
+  module AttendanceManagement
+    # Clear attendances
+    def clear_attendances
+      execute_cmd(
+        command:        CMD_CLEAR_ATTLOG,
+        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 attendances response'
+        end
+      end
+    end
+
+    # Decode attendance data
+    #
+    # param  options
+    #        |_ data  Attendance data to decode
+    def decode_attendance_data(options)
+      data = options[:data]
+      
+      {
+        uid:       data[0..3].split("\u0000").pop.to_i,
+        id:        data[4..7].split("\u0000").pop.to_i,
+        state:     BinData::Uint8le.read(data[28]).snapshot,
+        timestamp: decode_time(seconds: BinData::Uint32le.read(data[29..-1]).snapshot),
+      }
+    end
+
+    # Get attendance list size
+    def get_attendance_count
+      return 0 if BinData::Uint16le.read(data_recv).snapshot != CMD_PREPARE_DATA
+
+      BinData::Uint32le.read(data_recv[8..-1]).snapshot
+    end
+
+    # Get attendance list from attendance machine
+    def get_attendances
+      header = create_header(
+        command:        CMD_ATTLOG_RRQ,
+        command_string: '',
+        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[3..-1]).snapshot
+      total_bytes     = get_attendance_count
+
+      # Stop if attendance list is empty
+      if total_bytes <= 0
+        socket.close
+
+        return []
+      end
+      ### END Get response size ###
+
+      ### START Get attendance list ###
+      bytes_recv           = 0
+      rem                  = nil
+      offset               = 0
+      attendance_data_size = 40
+      trim_first           = 10
+      trim_others          = 8
+      attendances          = []
+
+      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 >= attendance_data_size)
+          attendance_data  = data[offset..-1]
+          offset          += attendance_data_size
+
+          if rem && rem.length > 0
+            attendance_data.prepend(rem)
+            offset -= rem.length
+            rem     = nil
+          end
+
+          attendances << decode_attendance_data(data: attendance_data)
+          bytes_recv += attendance_data_size
+
+          if bytes_recv == total_bytes
+            socket.close
+
+            return attendances
+          end
+        end
+
+        rem = data[offset..-1]
+      end
+      ### END Get attendance list ###
+
+      socket.close
+    end
+  end
+end

data/lib/zklib/connection_management.rb

@@ -0,0 +1,23 @@
+class Zklib
+  module ConnectionManagement
+    # Connect to attendance machine
+    def connect
+      execute_cmd(
+        command:        CMD_CONNECT,
+        command_string: ''
+      ) do |opts|
+        check_valid(data: opts[:data])
+      end
+    end
+
+    # Disconnect from attendance machine
+    def disconnect
+      execute_cmd(
+        command:        CMD_EXIT,
+        command_string: ''
+      ) do |opts|
+        check_valid(data: opts[:data])
+      end
+    end
+  end
+end