orion6_rep 0.2.6

data/lib/orion6_rep/mockup.rb

@@ -0,0 +1,118 @@
+require 'orion6_rep'
+
+module Orion6Rep
+  module Mockup
+    [:mock_detect_reps, :mock_time, :mock_employer, :mock_employees, :mock_ip,
+     :mock_serial_number, :mock_records, :mock_detection_data].each do |sym|
+      class_eval("@@#{sym} = nil unless defined? @@#{sym}; def self.#{sym}; @@#{sym}; end; def self.#{sym}=(obj); @@#{sym} = obj; end", __FILE__, __LINE__ + 1)
+    end
+
+    self.mock_employees = {}
+    self.mock_detection_data = {}
+
+    Orion6Rep::ClassMethods.module_eval do
+      def detect_reps
+        Orion6Rep::Mockup.mock_detection_data
+      end
+    end
+
+    Orion6Rep::InstanceMethods.module_eval do
+      def get_time
+        on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+        Orion6Rep::Mockup.mock_time
+      end
+
+      def set_time(time, start_dst = nil, end_dst = nil)
+        Orion6Rep::Mockup.mock_time = [time, start_dst, end_dst]
+        on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+        Orion6Rep::Mockup.mock_time
+      end
+
+      def get_employer
+        on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+        Orion6Rep::Mockup.mock_employer
+      end
+
+      def set_employer(employer_name, employer_location, document_type, document_number, cei_number)
+        Orion6Rep::Mockup.mock_employer = {:company_name => employer_name, :company_location => employer_location, :document_type => document_type, :document_number => document_number, :cei_number => cei_number}
+        on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+        Orion6Rep::Mockup.mock_employer
+      end
+
+      def get_employees_quantity
+        employees = Orion6Rep::Mockup.mock_employees
+        on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+        (employees.nil? || employees.empty?) ? 0 : employees.size
+      end
+
+      def get_employees(quantity = get_employees_quantity)
+        Orion6Rep::Mockup.mock_employees.keys.sort[0..quantity].collect do |registration|
+          employee = Orion6Rep::Mockup.mock_employees[registration]
+          on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+          {:registration => registration, :pis_number => employee[:pis_number], :name => employee[:name]}
+        end
+      end
+
+      def set_employee(operation_type, registration, pis_number, name)
+        case operation_type
+        when :add, :edit
+          data = Orion6Rep::Mockup.mock_employees[registration.to_i] = {:pis_number => pis_number, :name => name}
+        when :remove
+          data = Orion6Rep::Mockup.mock_employees.delete registration.to_i
+        else
+          raise "Unknown employee operation type received: #{operation_type.to_s}"
+        end
+        on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+        data
+      end
+
+      def change_ip(new_ip, interface = nil, rep_data = nil)
+        Orion6Rep::Mockup.mock_ip = new_ip
+        on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+        Orion6Rep::Mockup.mock_ip
+      end
+
+      def get_serial_number
+        on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+        Orion6Rep::Mockup.mock_serial_number
+      end
+
+      def get_record_id(datetime)
+        record = Orion6Rep::Mockup.mock_records.records.detect do |record|
+          record.respond_to?(:creation_time) && record.creation_time >= datetime
+        end
+        on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+        record ? record.line_id : nil
+      end
+
+      def get_records(first_id = nil)
+        (first_id = 1) if first_id.nil?
+        requested_id = first_id
+        parser = AfdParser.new(false)
+
+        Orion6Rep::Mockup.mock_records.records.each do |record|
+          next if(record.line_id < requested_id ||
+                  record.class == AfdParser::Header ||
+                  record.class == AfdParser::Trailer)
+          parser.parse_line(record.export, record.line_id)
+        end
+
+        afd_start_date = parser.first_creation_date
+        afd_end_date = parser.last_creation_date
+        employer = get_employer
+        serial_number = get_serial_number
+        parser.create_header(employer[:document_type], employer[:document_number],
+                             employer[:cei_document], employer[:company_name],
+                             serial_number, afd_start_date, afd_end_date, Time.now)
+        parser.create_trailer
+        return parser
+      end
+
+      def set_records(parser)
+        Orion6Rep::Mockup.mock_records = parser
+        on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+        Orion6Rep::Mockup.mock_records
+      end
+    end
+  end
+end

data/lib/orion6_rep/multi_message_command.rb

@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+module Orion6Rep
+  class MultiMessageCommand < Command
+    def execute
+      # calculate how many messages will be needed:
+      messages_quantity = get_field_quantity / get_field_size
+      message_remainder = get_field_quantity % get_field_size
+
+      payload = ""
+
+      @messages_sent = 0
+      messages_quantity.times do
+        command_data = generate_partial_message_header
+        payload += get_and_process_message(command_data)
+
+        # For some very obscure reason, on each received message the next
+        # command must increased by the size of the received payload.
+        # Go figure...
+        @command += payload.size
+        @messages_sent += 1
+      end
+
+      if message_remainder > 0
+        command_data = generate_remainder_header(message_remainder)
+        payload += get_and_process_message(command_data)
+      end
+
+      return get_data_from_response(payload)
+    end
+
+    private
+    MULTI_MESSAGE_COMMAND = 151
+
+    def get_equipment_number
+      @equipment_number
+    end
+
+    def get_host_address
+      @host_address
+    end
+
+    def get_tcp_port
+      @tcp_port
+    end
+
+    def get_tcp_port
+      @tcp_port
+    end
+
+    def generate_partial_message_header
+      header = [get_equipment_number^255] # TODO: find why this is needed
+      header << MULTI_MESSAGE_COMMAND
+      header << 0 # TODO: find why this is needed
+      header << 1 # TODO: find why this is needed
+      header << get_field_size
+      header << (get_command & 255) # first byte of command
+      header << divide_by_256(get_command)  # second byte of command
+      header << crc_check(header)
+      header
+    end
+
+    def generate_remainder_header(message_remainder)
+      header = [get_equipment_number^255] # TODO: find why this is needed
+      header << MULTI_MESSAGE_COMMAND
+      header << 0 # TODO: find why this is needed
+      header << message_remainder
+      header << 1 # TODO: find why this is needed
+      header << (get_command & 255)
+      header << divide_by_256(get_command)
+      header << crc_check(header)
+      header
+    end
+
+    def generate_command_data
+      []
+    end
+
+    def first_message_sent?
+      @messages_sent && @messages_sent > 0
+    end
+
+    def get_and_process_message(command_data)
+      # now send it!
+      response = Communication.communicate(get_host_address, get_tcp_port, command_data, get_expected_response_size, get_timeout_time, get_max_attempts)
+
+      # check everything:
+      check_response_header(response)
+      check_response_payload(response)
+
+      # and then get and process the response payload:
+      get_response_payload(response)
+    end
+  end
+end

data/lib/orion6_rep/record_id_get.rb

@@ -0,0 +1,79 @@
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require "orion6_rep/command"
+
+module Orion6Rep
+  class RecordIdGet < Command
+    def initialize(record_start_date_time, equipment_number, host_address, tcp_port = 3000)
+      @record_start_date_time = record_start_date_time
+      @equipment_number = equipment_number
+      @host_address = host_address
+      @tcp_port = tcp_port
+      @reponse_size = 16
+    end
+
+    private
+    GET_RECORD_ID_COMMAND    = 0x86
+    UNKNOWN_CONSTANT         = 0x72
+    RECORD_FIELD_SIZE        = 0x01
+    RECORD_ID_FIELD_QUANTITY = 0x12
+
+    def get_command
+      GET_RECORD_ID_COMMAND
+    end
+
+    def get_unknown_constant
+      UNKNOWN_CONSTANT
+    end
+
+    def get_field_size
+      RECORD_FIELD_SIZE
+    end
+
+    def get_field_quantity
+      RECORD_ID_FIELD_QUANTITY
+    end
+
+    def generate_command_data
+      # TODO: find out what is the meaning of the data in the array below:
+      data = [0x02, 0x00, 0x0d, 0x93]
+
+      data += get_record_start_date_time
+      # unknown
+      data += [0x00, 0x03]
+      data << crc_check(data)
+    end
+
+    def get_record_start_date_time
+      @record_start_date_time.strftime("%d%m%Y%H%M").unpack("C*")
+    end
+
+    def get_data_from_response(payload)
+      # first byte is unknown, and the next two bytes are the size of the data,
+      # in big-endian:
+      data_size_raw = payload.unpack("xCC")
+      data_size = convert_to_integer_as_big_endian(data_size_raw)
+
+      # minus the crc check position:
+      data_size = data_size - crc_size
+      payload.unpack("x4A#{data_size}")[0].to_i
+    end
+  end
+end

data/lib/orion6_rep/records_get.rb

@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require "orion6_rep/command"
+
+module Orion6Rep
+  class RecordsGet < Command
+    def initialize(record_id, equipment_number, host_address, tcp_port = 3000)
+      @record_id = record_id
+      @equipment_number = equipment_number
+      @host_address = host_address
+      @tcp_port = tcp_port
+    end
+
+    private
+    GET_RECORDS_COMMAND     = 0x86
+    UNKNOWN_CONSTANT        = 0x72
+    RECORDS_FIELD_SIZE      = 0x01
+    RECORDS_FIELD_QUANTITY  = 0x0F
+    DATA_SIZE_LAST_POSITION = 11
+
+    def get_command
+      GET_RECORDS_COMMAND
+    end
+
+    def get_unknown_constant
+      UNKNOWN_CONSTANT
+    end
+
+    def get_field_size
+      RECORDS_FIELD_SIZE
+    end
+
+    def get_field_quantity
+      RECORDS_FIELD_QUANTITY
+    end
+
+    def get_expected_response_size
+      proc do |partial_data|
+        if partial_data.size >= DATA_SIZE_LAST_POSITION
+          data_size_array = partial_data[9..10]
+          detected_size = (data_size_array[0].ord*256 + data_size_array[1].ord) + 14
+          detected_size
+        else
+          DATA_SIZE_LAST_POSITION
+        end
+      end
+    end
+
+    def generate_command_data
+      internal_data = get_record_id
+      internal_data << crc_check(internal_data)
+      internal_data_size = internal_data.size
+
+      data = [0x02] # TODO: find out what this byte does
+      data << divide_by_256(internal_data_size)
+      data << (internal_data_size & 255)
+      data << 0x99 # TODO: find out what this byte does
+      data += internal_data
+      data << 0x03 # TODO: find out what this byte does
+      data << crc_check(data)
+    end
+
+    def get_record_id
+      @record_id.to_s.rjust(9, "0").unpack("C*")
+    end
+
+    def get_data_from_response(payload)
+      payload[6..-3]
+    end
+  end
+end

data/lib/orion6_rep/version.rb

@@ -0,0 +1,3 @@
+module Orion6Rep
+  VERSION = "0.2.6"
+end

data/lib/orion6_rep.rb

@@ -0,0 +1,199 @@
+# -*- coding: utf-8 -*-
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require "orion6_rep/clock_time/get"
+require "orion6_rep/clock_time/set"
+require "orion6_rep/employer_get"
+require "orion6_rep/employer_set"
+require "orion6_rep/employee_get"
+require "orion6_rep/employee_quantity_get"
+require "orion6_rep/employee_set"
+require "orion6_rep/get_serial_number"
+require "orion6_rep/record_id_get"
+require "orion6_rep/records_get"
+require "orion6_rep/detect_reps"
+require "orion6_rep/change_ip"
+require "afd_parser"
+
+module Orion6Rep
+  class << self
+    def included(base)
+      return if base.included_modules.include?(InstanceMethods)
+      base.extend(ClassMethods)
+      base.send(:include, InstanceMethods)
+    end
+  end
+
+  module ClassMethods
+    def detect_reps
+      command = Orion6Rep::DetectReps.new
+      command.execute
+      runtime = Time.now
+      previous_response = nil
+      response = {}
+      while runtime + 5 > Time.now do
+        response = command.pool
+        sleep(0.2) if previous_response == response
+        previous_response = response
+      end
+      return response
+    end
+  end
+
+  module InstanceMethods
+    def get_time
+      command = Orion6Rep::ClockTime::Get.new(self.number, self.ip, self.tcp_port)
+      response = command.execute
+      on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+      return response
+    end
+
+    def set_time(time, start_dst = nil, end_dst = nil)
+      command = Orion6Rep::ClockTime::Set.new(time, start_dst, end_dst, self.number, self.ip, self.tcp_port)
+      response = command.execute
+      on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+      return response
+    end
+
+    def get_employer
+      command = Orion6Rep::EmployerGet.new(self.number, self.ip, self.tcp_port)
+      response = command.execute
+      on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+      return response
+    end
+
+    def set_employer(employer_name, employer_location, document_type, document_number, cei_number)
+      command = Orion6Rep::EmployerSet.new(employer_name, employer_location, document_type, document_number, cei_number, self.number, self.ip, self.tcp_port)
+      response = command.execute
+      on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+      return response
+    end
+
+    def get_employees_quantity
+      command = Orion6Rep::EmployeeQuantityGet.new(self.number, self.ip, self.tcp_port)
+      response = command.execute
+      on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+      return response
+    end
+
+    def get_employees(quantity = nil)
+      employees_quantity = quantity.nil? ? get_employees_quantity : quantity
+      employees = []
+      call_id = 1
+      while employees_quantity > 0
+        # 11 is the max number of employees retrieved in one call
+        call_quantity = employees_quantity > 11 ? 11 : employees_quantity
+        command = Orion6Rep::EmployeeGet.new(call_id, call_quantity, self.number, self.ip, self.tcp_port)
+        employees += command.execute
+        employees_quantity -= call_quantity
+        call_id += call_quantity
+      end
+      on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+      return employees
+    end
+
+    def set_employee(operation_type, registration, pis_number, name)
+      command = Orion6Rep::EmployeeSet.new(operation_type, registration, pis_number, name, self.number, self.ip, self.tcp_port)
+      response = command.execute
+      on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+      return response
+    end
+
+    def change_ip(new_ip, interface = nil, rep_data = nil)
+      if interface.nil? or rep_data.nil?
+        data = get_data_from_detection(self.ip)
+        interface = data.first if interface.nil?
+        rep_data = data.last if rep_data.nil?
+      end
+      if interface.nil? || rep_data.nil?
+        raise "The specified IP address is not an Orion6 REP"
+      end
+      command = Orion6Rep::ChangeIp.new(interface, new_ip, rep_data)
+      response = command.execute
+      if response
+        on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+        return new_ip
+      end
+    end
+
+    def get_serial_number
+      command = Orion6Rep::GetSerialNumber.new(self.number, self.ip, self.tcp_port)
+      response = command.execute
+      on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+      return response
+    end
+
+    def get_record_id(datetime)
+      command = Orion6Rep::RecordIdGet.new(datetime, self.number, self.ip, self.tcp_port)
+      response = command.execute
+      on_communication_success(__method__.to_sym) if respond_to?(:on_communication_success)
+      return response
+    end
+
+    def get_records(first_id = nil)
+      if first_id.nil?
+        first_id = 1 # get all the records
+      end
+
+      id = first_id
+      parser = AfdParser.new(false)
+      records = []
+      while !id.nil?
+        command = Orion6Rep::RecordsGet.new(id, self.number, self.ip, self.tcp_port)
+        data = command.execute
+        record = nil
+        while data.size > 0
+          record = parser.parse_line(data, id)
+          size = record.class.size
+          data.slice!(0..(size-1))
+          records << record
+          id += 1
+        end
+
+        id = record.nil? ? nil : (record.line_id + 1)
+      end
+
+      afd_start_date = parser.first_creation_date
+      afd_end_date = parser.last_creation_date
+      employer = get_employer
+      serial_number = get_serial_number
+      parser.create_header(employer[:document_type], employer[:document_number],
+                           employer[:cei_document], employer[:company_name],
+                           serial_number, afd_start_date, afd_end_date, Time.now)
+      parser.create_trailer
+      return parser
+    end
+
+    private
+    def get_data_from_detection(ip)
+      response_data = self.class.detect_reps
+      response_data.each do |collected_interface, interface_data|
+        interface_data.each do |collected_ip, data|
+          if collected_ip == self.ip
+            interface = collected_interface
+            rep_data = data[:rep_data]
+            return [interface, rep_data]
+          end
+        end
+      end
+      return []
+    end
+  end
+end

data/test/afd_file

@@ -0,0 +1,11 @@
+0000000001100000000067890000000009876RAZAO_SOCIAL                                                                                                                                          000040000700044032001201122022011210220111048
+0000000014280120111112280120111113
+0000000022270120111756108682040000172000000000000O.S. SYSTEMS SOFTWARES LTDA.                                                                                                                          PELOTAS - RS                                                                                        
+0000000035270120111759I111111111111TESTE 1 2 3                                         
+0000000045080220111709I222222222222TESTE 2                                             
+0000000055110220111719A222222222222TESTE 2                                             
+0000000065110220111723E222222222222TESTE 2                                             
+0000000073190220111814111111111111
+0000000083210220111133111111111111
+0000000093210220111134111111111111
+9999999990000000010000000030000000010000000049

data/test/external/detect_reps_test.rb

@@ -0,0 +1,28 @@
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require File.dirname(__FILE__) + '/../test_helper'
+
+class DetectRepsTest < Test::Unit::TestCase
+  def test_detect_rep
+    puts "Detecting REPs in the network..."
+    detected_reps = TimeClock.detect_reps
+    puts "Received: " + detected_reps.inspect
+  end
+end