codin_rep 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e40b5d66a9adcd57d0cd46e384142079590cfb38
+  data.tar.gz: 9e87fa8364e105e6c8487796127c4a8a135badcd
+SHA512:
+  metadata.gz: f34acf2a831190d23c59c4e61761987c9f60dff714c0736f3828c52aebe628a118d47bb17f276041f4b73bfa32fb204e0d41355216d1f366e0ee1daf8c529630
+  data.tar.gz: fb37f568f897ee7bf934db130c8727563bcac1990b54aeb7f3cb7131f407add9cdb3d8065b9c14e853d056378b6f065c7bd6d0444170eb1b126d8514606e2847

data/lib/codin_rep.rb

@@ -0,0 +1,86 @@
+# -*- coding: utf-8 -*-
+# codinrep - Gem para acesso de REPs da Telebyte
+# Copyright (C) 2016  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 "codin_rep/add_employee"
+require "codin_rep/employee_command"
+require "codin_rep/get_time"
+require "codin_rep/set_time"
+require "codin_rep/get_records"
+require "codin_rep/del_employee"
+
+module CodinRep
+  class << self
+    def included(base)
+      return if base.included_modules.include?(InstanceMethods)
+      base.send(:include, InstanceMethods)
+    end
+  end
+
+  module InstanceMethods
+    def get_time
+      command = CodinRep::GetTime.new(self.ip, self.tcp_port)
+      response = command.execute
+      return response
+    end
+
+    def set_time(time)
+      command = CodinRep::SetTime.new(time, self.ip, self.tcp_port)
+      response = command.execute
+      return response
+    end
+
+    def get_employer
+      command = CodinRep::GetAfdHeader.new(self.ip, self.tcp_port)
+      response = command.execute
+
+      hash = {}
+      hash[:document_type] = response.employer_type
+      hash[:document_number] = response.employer_document
+      hash[:cei_document] = response.employer_cei
+      hash[:company_name] = response.employer_name
+
+      return hash
+    end
+
+    def get_serial_number
+      command = CodinRep::GetAfdHeader.new(self.ip, self.tcp_port)
+      response = command.execute
+      response.rep_serial_number
+    end
+
+    def get_records(first_id=nil)
+      command = CodinRep::GetRecords.new(first_id, self.ip, self.tcp_port)
+      response = command.execute
+      response
+    end
+
+    def set_employee(operation_type, registration, pis_number, name)
+      if [:add, :edit].include? operation_type
+        command = CodinRep::AddEmployee.new(registration, pis_number, name, self.ip, self.tcp_port)
+      elsif operation_type == :remove
+        command = CodinRep::DelEmployee.new(registration, self.ip, self.tcp_port)
+      else
+        raise EmployeeCommand::UnknownEmployeeOperation.new(operation_type)
+      end
+      response = command.execute
+      response
+    end
+  end
+end

data/lib/codin_rep/add_employee.rb

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+# codin_rep - Gem para acesso de REPs da Telebyte
+# Copyright (C) 2016  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 "codin_rep/employee_command"
+
+module CodinRep
+  class AddEmployee < EmployeeCommand
+    NAME_MAX_SIZE = 53
+    COMMAND_CODE = "075h1".freeze
+    EXPECTED_HEADER = "REP003h1\0".freeze
+    REGISTRATION_COMPLETED_HEADER = 'PGREP010h1'.freeze
+
+    def initialize(registration, pis_number, name, *args)
+      super(*args)
+      @registration = convert_integer_to_byte_string(registration)
+      @pis_number = convert_integer_to_byte_string(pis_number)
+      @name = convert_employee_name(name)
+    end
+
+    def generate_command_payload
+      "#{@registration}#{@pis_number}#{@name}"
+    end
+
+    private
+    def convert_employee_name(name)
+      name = name.strip[0..(NAME_MAX_SIZE-1)].strip + "\0"
+      name.ljust(NAME_MAX_SIZE, "\x20")
+    end
+  end
+end

data/lib/codin_rep/command.rb

@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+# codin_rep - Gem para acesso de REPs da Telebyte
+# Copyright (C) 2016  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 'codin_rep/communication'
+
+module CodinRep
+  class Command
+    class UnknownHeader < StandardError
+      def initialize(header, command_executed, expected_header=nil)
+        @header = header
+        @command_executed = command_executed
+        @expected_header = expected_header
+      end
+
+      def message
+        message = "The REP returned an unknown header '#{@header}' for the command '#{@command_executed}'."
+        message += " Expected header was '#{@expected_header}'." if @expected_header
+      end
+    end
+
+    class MalformedResponsePayload < StandardError
+      def initialize(command_executed)
+        @command_executed = command_executed
+      end
+
+      def message
+        "Payload response from '#{@command_executed}' command is malformed."
+      end
+    end
+
+    COMMAND_PREFIX = "PGREP".freeze
+
+    def initialize(host_address, tcp_port)
+      @host_address = host_address
+      @tcp_port = tcp_port
+      @communication = Communication.new(@host_address, @tcp_port, get_timeout_time, get_max_attempts)
+    end
+
+    def execute
+      @command_data = generate_header
+      @command_data += generate_command_payload
+      @response = communicate!
+      check_response_header
+      @payload = get_response_payload
+      return get_data_from_response_payload
+    rescue
+      @communication.close
+      raise
+    ensure
+      @communication.close if should_close_connection?
+    end
+
+    def get_timeout_time
+      3
+    end
+
+    def get_max_attempts
+      3
+    end
+
+    def generate_header
+      # COMMAND_CODE should be set on the specific command class:
+      COMMAND_PREFIX.dup + self.class::COMMAND_CODE.dup
+    end
+
+    def generate_command_payload
+      raise_not_implemented_error
+    end
+
+    def check_response_header
+      raise_not_implemented_error
+    end
+
+    def get_data_from_response_payload
+      raise_not_implemented_error
+    end
+
+    def get_expected_response_size
+      raise_not_implemented_error
+    end
+
+    def should_close_connection?
+      !!@response
+    end
+
+    private
+    def raise_not_implemented_error
+      calling_method = caller[0][/`.*'/][1..-2]
+      raise NotImplementedError.new "The method '#{calling_method}' must be overriden by the class #{self.class.to_s}."
+    end
+
+    def communicate!
+      @communication.communicate(@command_data, get_expected_response_size)
+    end
+  end
+end

data/lib/codin_rep/communication.rb

@@ -0,0 +1,124 @@
+# -*- coding: utf-8 -*-
+# codin_rep - Gem para acesso de REPs da Telebyte
+# Copyright (C) 2016  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 'socket'
+require 'timeout'
+
+module CodinRep
+  class Communication
+    READ_SIZE = 4096
+
+    include Timeout
+
+    def self.finalize(socket)
+      proc { socket.close }
+    end
+
+    def initialize(host_address, port, timeout_time=60, max_attempts=3)
+      @host_address = host_address
+      @port = port
+      @timeout_time = timeout_time
+      @max_attempts = max_attempts
+      @socket = nil
+    end
+
+    def open_socket
+      if @socket
+        @socket.close
+        @socket = nil
+      end
+
+      @attempt = 0
+      while @attempt < @max_attempts do
+        begin
+          timeout(@timeout_time) {
+            @socket = TCPSocket.open(@host_address, @port)
+          }
+          # Use a finalizer to close the socket if "self" is going to be
+          # destroyed.
+          ObjectSpace.define_finalizer( self, self.class.finalize(@socket) )
+        rescue Timeout::Error
+          @socket = nil
+        end
+        break if @socket
+
+        @attempt += 1
+      end
+
+      raise "Timeout error" if @attempt >= @max_attempts
+      @socket
+    end
+
+    def communicate(payload, expected_response_size)
+      open_socket if @socket.nil?
+
+      @payload = payload
+      @expected_response_size = expected_response_size
+
+      while @attempt < @max_attempts do
+        @received_data = nil
+
+        @received_data = send_receive_data(@payload)
+
+        break unless @received_data.nil?
+        @attempt += 1
+      end
+
+      raise "Timeout error" if @attempt >= @max_attempts
+      @received_data
+    end
+
+    def close
+      if @socket
+        @socket.close
+        @socket = nil
+      end
+    end
+
+    private
+
+    def send_receive_data(data_to_send)
+      @socket.write(data_to_send)
+      @socket.flush
+      data_to_receive = ""
+
+      # expected_response_size can be a Fixnum, for fixed responses sizes, or
+      # a proc, where the response size comes inside the response itself.
+      if @expected_response_size.is_a?(Proc)
+        expected_size = @expected_response_size.call(data_to_receive)
+      else
+        expected_size = @expected_response_size
+      end
+
+      while data_to_receive.size < expected_size
+        bytes_to_be_read = expected_size - data_to_receive.size
+        bytes_to_be_read = READ_SIZE if bytes_to_be_read > READ_SIZE
+
+        timeout(@timeout_time) {
+          data_to_receive += @socket.readpartial( bytes_to_be_read )
+        }
+        if @expected_response_size.is_a?(Proc)
+          expected_size = @expected_response_size.call(data_to_receive)
+        end
+      end
+      data_to_receive
+    end
+  end
+end

data/lib/codin_rep/del_employee.rb

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+# codin_rep - Gem para acesso de REPs da Telebyte
+# Copyright (C) 2016  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 "codin_rep/employee_command"
+
+module CodinRep
+  class DelEmployee < EmployeeCommand
+    COMMAND_CODE = "016j1".freeze
+    EXPECTED_HEADER = "REP003j1\0".freeze
+    REGISTRATION_COMPLETED_HEADER = 'PGREP010j1'.freeze
+
+    def initialize(registration, *args)
+      super(*args)
+      @registration = convert_integer_to_byte_string(registration)
+    end
+
+    def generate_command_payload
+      @registration
+    end
+  end
+end

data/lib/codin_rep/employee_command.rb

@@ -0,0 +1,93 @@
+# -*- coding: utf-8 -*-
+# codin_rep - Gem para acesso de REPs da Telebyte
+# Copyright (C) 2016  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 "codin_rep/command"
+
+module CodinRep
+  class EmployeeCommand < Command
+    CODE_MAX_SIZE = 12
+
+    class UnknownEmployeeOperation < StandardError
+      def initialize(operation_type)
+        @operation_type = operation_type
+      end
+
+      def message
+        message = "Unknown employee operation type '#{@operation_type}'."
+      end
+    end
+
+    class InvalidInteger < StandardError
+      def initialize(invalid_integer)
+        @invalid_integer = invalid_integer
+      end
+
+      def message
+        message = "Invalid integer for employee operation '#{@invalid_integer}'. Integer must be only numbers and at most #{CodinRep::EmployeeCommand::CODE_MAX_SIZE} digits."
+      end
+    end
+
+    def initialize(*args)
+      super(*args)
+      @sent_registration = false
+    end
+
+    def execute
+      @command_data = generate_header
+      @command_data += generate_command_payload
+      @response = communicate!
+      check_response_header
+      @sent_registration = true
+      @command_data = self.class::REGISTRATION_COMPLETED_HEADER
+      @response = communicate!
+      return get_data_from_response_payload
+    rescue
+      @communication.close
+      raise
+    ensure
+      @communication.close if should_close_connection?
+    end
+
+    def get_expected_response_size
+      @sent_registration ? 0 : 9
+    end
+
+    def check_response_header
+      unless @response.match(/^#{self.class::EXPECTED_HEADER}/)
+        raise UnknownHeader.new @response[0..6], 'get time', self.class::EXPECTED_HEADER
+      end
+    end
+
+    def get_response_payload
+      @sent_employee_data = true
+    end
+
+    def get_data_from_response_payload
+      true
+    end
+
+    private
+    def convert_integer_to_byte_string(original_integer)
+      integer = original_integer.to_s
+      raise InvalidInteger.new(original_integer) if integer.size > CODE_MAX_SIZE
+      [integer.to_s.rjust(CODE_MAX_SIZE, '0')].pack('H*')
+    end
+  end
+end