da_funk 0.28.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c887fe92fba65392534eb8a45739e53b1a7933e
-  data.tar.gz: b2ef0569959b2c769527b43eedae47a939dc4da1
+  metadata.gz: 0ab3d59d322760738472c5869fb98b1871fcdddc
+  data.tar.gz: 69bd61eb6d8e6467081cc1b69f05c94ea65f3055
 SHA512:
-  metadata.gz: b009cc3a5b57cd7f5268a40ea1f85839499fddf7ad7c3150a13c4e247666328d7dcd2613ffc802705eb0acf5b8341be11c7f3676eb5d66f43e6aa473ba5651b6
-  data.tar.gz: 2dcd7f1a3b0047dc070e863cc77e36fc7336142d52dd7f3d3e673c52d20fe853fcb6bf6d93a8b4c482c7b9bd7fd4da8aa494005bbcd2d08c614161cfdedff236
+  metadata.gz: d6c6d7458d9f343bfec57b017e6f7fee57b876e1b9d49fdb90f61af4b1847794afb168104a52a74dd23895716993e2670c20a8d5b8f48fbfda6ca2dfa1de3f5a
+  data.tar.gz: 01ec1bd70cefda9331de4e2b5d2f582f56a9fdf770a3c747f6d6557530442a972eb588fb47aaadf5a513172ebe7716b90e8a9e9fdfe646224578db6060ac74a8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    da_funk (0.28.0)
+    da_funk (1.0.0)
       archive-zip (~> 0.5)
       bundler (~> 1.7)
       cloudwalk_handshake (~> 0.6)
@@ -20,7 +20,7 @@ GEM
     funky-simplehttp (0.4.4)
     funky-tlv (0.2.3)
     io-like (0.3.0)
-    posxml_parser (0.29.0)
+    posxml_parser (0.30.0)
       funky-emv (~> 0.3)
     rake (12.3.0)
     yard (0.9.12)

data/RELEASE_NOTES.md

@@ -1,5 +1,22 @@
 # DaFunk
 
+
+### 1.0.0 - 2018-01-04
+
+- Remove serfs interface and implement notification
+interface via web socket.
+- Adopt ContextLog to store error on file download.
+- Implement force parameter to application, params dat and file download.
+- Unzip ruby application after download instead of execution call.
+- Move Application, Notification*, ParamsDat and Transaction from Device to Dafunk scope.
+- Remove transaction/emv.rb and refactor loads.
+- Remove Device:Helper.
+- Check if application file exists before return local crc.
+- Adopt custom exception for Application download.
+- Force unzip ruby application if file is the same.
+- Do not cache local crc on DaFunk::Application.
+- Adopt DaDunk::Application CRC check strategy in DaFunk::FileParameter
+
 ### 0.28.0 - 2017-12-07
 
 - Support to interrupt file download if KEY CANCEL pressed.

data/Rakefile

@@ -9,15 +9,30 @@ DA_FUNK_ROOT = File.dirname(File.expand_path(__FILE__))
 FileUtils.cd DA_FUNK_ROOT
 
 FILES = FileList[
+  "lib/file_db.rb",
+  "lib/zip.rb",
+  "lib/da_funk/helper.rb",
+
   "lib/ext/kernel.rb",
   "lib/ext/nil.rb",
   "lib/ext/string.rb",
   "lib/ext/array.rb",
   "lib/ext/hash.rb",
   "lib/ext/float.rb",
+
+  "lib/iso8583/bitmap.rb",
+  "lib/iso8583/codec.rb",
+  "lib/iso8583/exception.rb",
+  "lib/iso8583/field.rb",
+  "lib/iso8583/fields.rb",
+  "lib/iso8583/message.rb",
+  "lib/iso8583/util.rb",
+  "lib/iso8583/version.rb",
+  "lib/iso8583/file_parser.rb",
+
   "lib/device/version.rb",
   "lib/da_funk/version.rb",
-  "lib/da_funk/helper.rb",
+
   "lib/da_funk.rb",
   "lib/da_funk/test.rb",
   "lib/da_funk/screen.rb",
@@ -31,42 +46,26 @@ FILES = FileList[
   "lib/da_funk/event_handler.rb",
   "lib/da_funk/engine.rb",
   "lib/da_funk/struct.rb",
+
+  "lib/da_funk/params_dat.rb",
+  "lib/da_funk/application.rb",
+  "lib/da_funk/transaction/iso.rb",
+  "lib/da_funk/transaction/download.rb",
+  "lib/da_funk/notification_event.rb",
+  "lib/da_funk/notification_callback.rb",
+  "lib/da_funk/notification.rb",
+
   "lib/device.rb",
   "lib/device/audio.rb",
   "lib/device/crypto.rb",
   "lib/device/display.rb",
-  "lib/device/helper.rb",
   "lib/device/io.rb",
   "lib/device/network.rb",
-  "lib/device/params_dat.rb",
   "lib/device/printer.rb",
   "lib/device/runtime.rb",
   "lib/device/setting.rb",
   "lib/device/support.rb",
   "lib/device/system.rb",
-  "lib/device/transaction/download.rb",
-  "lib/device/transaction/emv.rb",
-  "lib/file_db.rb",
-  "lib/iso8583/bitmap.rb",
-  "lib/iso8583/codec.rb",
-  "lib/iso8583/exception.rb",
-  "lib/iso8583/field.rb",
-  "lib/iso8583/fields.rb",
-  "lib/iso8583/message.rb",
-  "lib/iso8583/util.rb",
-  "lib/iso8583/version.rb",
-  "lib/iso8583/file_parser.rb",
-  "lib/device/transaction/iso.rb",
-  "lib/serfx.rb",
-  "lib/serfx/commands.rb",
-  "lib/serfx/connection.rb",
-  "lib/serfx/response.rb",
-  "lib/serfx/exceptions.rb",
-  "lib/device/notification_event.rb",
-  "lib/device/notification_callback.rb",
-  "lib/device/notification.rb",
-  "lib/device/application.rb",
-  "lib/zip.rb",
   "lib/device/magnetic.rb"
 ]
 

data/lib/{device → da_funk}/application.rb

@@ -6,10 +6,13 @@
 # - No crc update
 # - With crc update
 
-class Device
+module DaFunk
   class Application
-    attr_accessor  :crc
-    attr_reader :label, :file, :type, :order, :name, :remote, :original, :crc_local
+    class ApplicationError < StandardError; end
+    class FileNotFoundError < StandardError; end
+
+    attr_accessor :crc
+    attr_reader :label, :file, :type, :order, :name, :remote, :original
 
     def self.delete(collection)
       collection.each do |app|
@@ -29,25 +32,40 @@ class Device
       @remote    = remote.sub("#{company}_", "")
       @name      = remote.sub("#{company}_", "").split(".")[0]
       @file      = check_path(@remote)
-      @crc_local = @crc if File.exists?(@file)
+    end
+
+    def crc_local
+      self.exists? ? @crc_local : nil
     end
 
     def download(force = false)
       if force || self.outdated?
-        ret = Device::Transaction::Download.request_file(remote, file, crc_local)
-      else
-        ret = Device::Transaction::Download::FILE_NOT_CHANGE
-      end
-      if ret == Device::Transaction::Download::SUCCESS
-        @crc_local = calculate_crc
-        if @crc_local != @crc
-          return Device::Transaction::Download::COMMUNICATION_ERROR
+        ret = DaFunk::Transaction::Download.request_file(remote, file, self.crc_local)
+        if ret == DaFunk::Transaction::Download::SUCCESS
+          if ((@crc_local = calculate_crc) == @crc)
+            unzip
+          else
+            ret = DaFunk::Transaction::Download::COMMUNICATION_ERROR
+          end
+        elsif ret == DaFunk::Transaction::Download::FILE_NOT_CHANGE
+          unzip
         end
+      else
+        ret = DaFunk::Transaction::Download::FILE_NOT_CHANGE
       end
       ret
     rescue => e
-      puts "ERROR #{e.message}"
-      Device::Transaction::Download::IO_ERROR
+      ContextLog.exception(e, e.backtrace, "Error downloading #{self.name}")
+      DaFunk::Transaction::Download::IO_ERROR
+    end
+
+    def unzip
+      if self.ruby?
+        zip = self.file
+        message = "Problem to unzip #{zip}[#{name}]"
+        raise FileNotFoundError.new(message) unless self.exists?
+        raise ApplicationError.new(message) unless Zip.uncompress(zip)
+      end
     end
 
     def dir
@@ -55,7 +73,7 @@ class Device
     end
 
     def exists?
-      File.exists? file
+      File.exists?(file)
     end
 
     def delete
@@ -65,10 +83,12 @@ class Device
       end
     end
 
-    def outdated?
-      return true unless File.exists?(file)
-      @crc_local = calculate_crc unless @crc_local
-      @crc_local != @crc
+    def outdated?(force = false)
+      return true unless self.exists?
+      if !self.crc_local || force
+        @crc_local = calculate_crc
+      end
+      self.crc_local != @crc
     rescue
       true
     end

data/lib/da_funk/engine.rb

@@ -2,7 +2,6 @@ module DaFunk
   class Engine
     def self.check
       DaFunk::EventListener.check
-      Device::Notification.check
       DaFunk::Helper::StatusBar.check
     end
 

data/lib/da_funk/file_parameter.rb

@@ -2,7 +2,7 @@ module DaFunk
   class FileParameter
     FILEPATH = "./shared"
     attr_accessor :crc
-    attr_reader :name, :file, :crc_local, :original, :remote
+    attr_reader :name, :file, :original, :remote
 
     def self.delete(collection)
       collection.each do |file_|
@@ -20,7 +20,10 @@ module DaFunk
       @remote   = @original.sub("#{company}_", "")
       @name     = @original.sub("#{company}_", "").split(".").first
       @file     = "#{FILEPATH}/#{@remote}"
-      @crc_local = @crc if File.exists?(@file)
+    end
+
+    def crc_local
+      self.exists? ? @crc_local : nil
     end
 
     def zip?
@@ -38,31 +41,46 @@ module DaFunk
     end
 
     def download(force = false)
-      if force || outdated?
-        ret = Device::Transaction::Download.request_file(remote, file, crc_local)
+      if force || self.outdated?
+        ret = DaFunk::Transaction::Download.request_file(remote, file, self.crc_local)
+        if ret == DaFunk::Transaction::Download::SUCCESS
+          unless ((@crc_local = calculate_crc) == @crc)
+            ret = DaFunk::Transaction::Download::COMMUNICATION_ERROR
+          end
+        end
       else
-        ret = Device::Transaction::Download::FILE_NOT_CHANGE
+        ret = DaFunk::Transaction::Download::FILE_NOT_CHANGE
       end
-      @crc_local = @crc if ret == Device::Transaction::Download::SUCCESS
       ret
+    rescue => e
+      ContextLog.exception(e, e.backtrace, "Error downloading #{self.name}")
+      DaFunk::Transaction::Download::IO_ERROR
     end
 
     def delete
       File.delete(self.file) if exists?
     end
 
-    def outdated?
-      return true unless exists?
-      unless @crc_local
+    def outdated?(force = false)
+      return true unless self.exists?
+      if !self.crc_local || force
+        @crc_local = calculate_crc
+      end
+      self.crc_local != @crc
+    rescue
+      true
+    end
+
+    private
+    def calculate_crc
+      if exists?
         handle = File.open(file)
-        @crc_local = Device::Crypto.crc16_hex(handle.read)
+        Device::Crypto.crc16_hex(handle.read)
       end
-      @crc_local != @crc
     ensure
       handle.close if handle
     end
 
-    private
     def check_company(name)
       name.split("_", 2)[0]
     end

data/lib/da_funk/helper.rb

@@ -33,7 +33,7 @@ module DaFunk
             Device::Setting.network_configured = 1
             print_attach(:attach_connected, options)
           else
-            Device::Setting.network_configured = 0 if Device::ParamsDat.file["connection_management"] == "0"
+            Device::Setting.network_configured = 0 if DaFunk::ParamsDat.file["connection_management"] == "0"
             print_attach(:attach_fail, options.merge(:args => [Device::Network.code.to_s]))
             getc(4000)
             return false
@@ -52,23 +52,23 @@ module DaFunk
     def check_download_error(ret)
       value = true
       case ret
-      when Device::Transaction::Download::SERIAL_NUMBER_NOT_FOUND
+      when DaFunk::Transaction::Download::SERIAL_NUMBER_NOT_FOUND
         I18n.pt(:download_serial_number_not_found, :args => [ret])
         value =  false
-      when Device::Transaction::Download::FILE_NOT_FOUND
+      when DaFunk::Transaction::Download::FILE_NOT_FOUND
         I18n.pt(:download_file_not_found, :args => [ret])
         value = false
-      when Device::Transaction::Download::FILE_NOT_CHANGE
+      when DaFunk::Transaction::Download::FILE_NOT_CHANGE
         I18n.pt(:download_file_is_the_same, :args => [ret])
-      when Device::Transaction::Download::SUCCESS
+      when DaFunk::Transaction::Download::SUCCESS
         I18n.pt(:download_success, :args => [ret])
-      when Device::Transaction::Download::COMMUNICATION_ERROR
+      when DaFunk::Transaction::Download::COMMUNICATION_ERROR
         I18n.pt(:download_communication_failure, :args => [ret])
         value = false
-      when Device::Transaction::Download::MAPREDUCE_RESPONSE_ERROR
+      when DaFunk::Transaction::Download::MAPREDUCE_RESPONSE_ERROR
         I18n.pt(:download_encoding_error, :args => [ret])
         value = false
-      when Device::Transaction::Download::IO_ERROR
+      when DaFunk::Transaction::Download::IO_ERROR
         I18n.pt(:download_io_error, :args => [ret])
         value = false
       else

data/lib/da_funk/notification.rb

@@ -0,0 +1,38 @@
+
+module DaFunk
+  class Notification
+    class << self
+      attr_accessor :callbacks
+    end
+
+    self.callbacks = Hash.new
+
+    def self.check(msg)
+      if msg.is_a?(String) && msg.include?("\"event\"") && msg.include?("\"id\"")
+        [:notification, self.parse(JSON.parse(msg))]
+      end
+    rescue ArgumentError => e
+      raise unless e.message == "invalid json"
+    end
+
+    def self.parse(hash)
+      NotificationEvent.new(hash["id"], hash["event"], hash["acronym"], hash["logical_number"])
+    end
+
+    def self.execute(event)
+      calls = self.callbacks[event.callback]
+      return unless calls
+      [:before, :on, :after].each do |moment|
+        calls.each do |callback|
+          callback.call(event, moment)
+        end
+      end
+    end
+
+    def self.schedule(callback)
+      self.callbacks[callback.description] ||= []
+      self.callbacks[callback.description] << callback
+    end
+  end
+end
+

data/lib/{device → da_funk}/notification_callback.rb

@@ -1,4 +1,4 @@
-class Device
+module DaFunk
   class NotificationCallback
     attr_reader :on, :before, :after, :description
     attr_accessor :results

data/lib/da_funk/notification_event.rb

@@ -0,0 +1,27 @@
+module DaFunk
+  class NotificationEvent
+    attr_reader :id, :event, :acronym, :logical_number, :parameters, :callback
+
+    def perform
+      Notification.execute(self)
+    end
+
+    def initialize(id, event, acronym, logical_number)
+      @id             = id
+      @acronym        = acronym
+      @logical_number = logical_number
+      parse(event)
+    end
+
+    private
+
+    #{"id":3,"event":"3|SHOW_MESSAGE|TEST1|12-20-2017 18:23","acronym":"pc1","logical_number":"5A179615"}
+    #"3|SHOW_MESSAGE|TEST1|12-20-2017 18:23"
+    def parse(event)
+      values = event.to_s.split("|")
+      values.shift # id
+      @callback, *@parameters = values
+    end
+  end
+end
+

data/lib/{device → da_funk}/params_dat.rb

@@ -1,8 +1,8 @@
-class Device
+module DaFunk
   class ParamsDat
     FILE_NAME = "./main/params.dat"
 
-    include Device::Helper
+    include DaFunk::Helper
 
     class << self
       attr_accessor :file, :apps, :valid, :files
@@ -34,12 +34,12 @@ class Device
       true
     end
 
-    def self.outdated_apps
-      self.apps.select{|app| app.outdated? }
+    def self.outdated_apps(force_crc = false, force = false)
+      self.apps.select{|app| app.outdated?(force_crc) || force }
     end
 
-    def self.outdated_files
-      self.files.select{|f| f.outdated? }
+    def self.outdated_files(force_crc = false, force = false)
+      self.files.select{|f| f.outdated?(force_crc) || force }
     end
 
     def self.parse_apps
@@ -49,11 +49,11 @@ class Device
         if application = get_app(name)
           application.crc = crc
         else
-          application = Device::Application.new(label, name, type, crc)
+          application = DaFunk::Application.new(label, name, type, crc)
         end
         new_apps << application
       end
-      Device::Application.delete(@apps - new_apps)
+      DaFunk::Application.delete(@apps - new_apps)
       @apps = new_apps
     end
 
@@ -68,7 +68,7 @@ class Device
         end
         new_files << file_
       end
-      Device::Application.delete(@files - new_files)
+      DaFunk::Application.delete(@files - new_files)
       @files = new_files
     end
 
@@ -108,7 +108,7 @@ class Device
         ret = try(3) do |attempt|
           Device::Display.clear
           I18n.pt(:downloading_content, :args => ["PARAMS", 1, 1])
-          ret = Device::Transaction::Download.request_param_file(FILE_NAME)
+          ret = DaFunk::Transaction::Download.request_param_file(FILE_NAME)
           unless check_download_error(ret)
             sleep(2)
             false
@@ -121,25 +121,25 @@ class Device
       end
     end
 
-    def self.update_apps(force = false)
-      self.download if force || ! self.valid
+    def self.update_apps(force_params = false, force_crc = false, force = false)
+      self.download if force_params || ! self.valid
       if self.valid
-        apps_to_update = self.outdated_apps
+        apps_to_update = self.outdated_apps(force_crc, force)
         size_apps = apps_to_update.size
         apps_to_update.each_with_index do |app, index|
-          self.update_app(app, index+1, size_apps)
+          self.update_app(app, index+1, size_apps, force_crc || force)
         end
 
-        files_to_update = self.outdated_files
+        files_to_update = self.outdated_files(force_crc, force)
         size_files = files_to_update.size
         files_to_update.each_with_index do |file_, index|
-          self.update_file(file_, index+1, size_files)
+          self.update_file(file_, index+1, size_files, force_crc || force)
         end
       end
     end
 
     def self.format!(keep_config_files = false, keep_files = [])
-      Device::Application.delete(self.apps)
+      DaFunk::Application.delete(self.apps)
       DaFunk::FileParameter.delete(self.files)
       File.delete(FILE_NAME) if exists?
       @apps, @files = [], []

data/lib/{device → da_funk}/transaction/download.rb

@@ -1,5 +1,5 @@
 
-class Device
+module DaFunk
   class Transaction
     class Download
       ERL_VERSION_MAGIC        = 131
@@ -36,7 +36,7 @@ class Device
       end
 
       def self.request_file(remote_path, local_path, crc = nil)
-        download = Device::Transaction::Download.new(Device::System.serial, "", DaFunk::VERSION)
+        download = DaFunk::Transaction::Download.new(Device::System.serial, "", DaFunk::VERSION)
         download.perform(Device::Network.socket,
                          Device::Setting.company_name,
                          remote_path, local_path, Device::System.app,

data/lib/{device → da_funk}/transaction/iso.rb

@@ -1,5 +1,5 @@
 
-class Device
+module DaFunk
   class Transaction
     # Object responsible to create ISO8583 message
     #

data/lib/da_funk/version.rb

@@ -1,4 +1,4 @@
 module DaFunk
-  VERSION="0.28.0"
+  VERSION="1.0.0"
 end
 

data/lib/da_funk.rb

@@ -1,35 +1,50 @@
 unless Object.const_defined?(:MTest)
   file_path = File.dirname(File.realpath(__FILE__))
-  require file_path + "/da_funk/version.rb"
+  require file_path + "/file_db.rb"
   require file_path + "/da_funk/helper.rb"
-  require file_path + "/da_funk/iso8583.rb"
   require file_path + "/da_funk/rake_task.rb"
+  require file_path + "/iso8583/bitmap.rb"
+  require file_path + "/iso8583/codec.rb"
+  require file_path + "/iso8583/exception.rb"
+  require file_path + "/iso8583/field.rb"
+  require file_path + "/iso8583/fields.rb"
+  require file_path + "/iso8583/message.rb"
+  require file_path + "/iso8583/util.rb"
+  require file_path + "/iso8583/version.rb"
+  require file_path + "/iso8583/file_parser.rb"
+  require file_path + "/device/version.rb"
+  require file_path + "/da_funk/version.rb"
   require file_path + "/da_funk/test.rb"
   require file_path + "/da_funk/screen.rb"
-  require file_path + "/device/support.rb"
-  require file_path + "/device/helper.rb"
+  require file_path + "/da_funk/callback_flow.rb"
+  require file_path + "/da_funk/screen_flow.rb"
+  require file_path + "/da_funk/i18n_error.rb"
+  require file_path + "/da_funk/i18n.rb"
+  require file_path + "/da_funk/file_parameter.rb"
+  require file_path + "/da_funk/helper/status_bar.rb"
+  require file_path + "/da_funk/event_listener.rb"
+  require file_path + "/da_funk/event_handler.rb"
+  require file_path + "/da_funk/engine.rb"
+  require file_path + "/da_funk/struct.rb"
+  require file_path + "/da_funk/application.rb"
+  require file_path + "/da_funk/transaction/iso.rb"
+  require file_path + "/da_funk/transaction/download.rb"
+  require file_path + "/da_funk/notification_event.rb"
+  require file_path + "/da_funk/notification_callback.rb"
+  require file_path + "/da_funk/notification.rb"
+  require file_path + "/da_funk/params_dat.rb"
+  require file_path + "/device.rb"
+  require file_path + "/device/audio.rb"
   require file_path + "/device/crypto.rb"
   require file_path + "/device/display.rb"
   require file_path + "/device/io.rb"
   require file_path + "/device/network.rb"
   require file_path + "/device/printer.rb"
+  require file_path + "/device/runtime.rb"
   require file_path + "/device/setting.rb"
+  require file_path + "/device/support.rb"
   require file_path + "/device/system.rb"
-  require file_path + "/device/version.rb"
-  require file_path + "/device/params_dat.rb"
-  require file_path + "/device.rb"
-  require file_path + "/file_db.rb"
-  require file_path + "/iso8583/bitmap.rb"
-  require file_path + "/iso8583/codec.rb"
-  require file_path + "/iso8583/exception.rb"
-  require file_path + "/iso8583/field.rb"
-  require file_path + "/iso8583/fields.rb"
-  require file_path + "/iso8583/message.rb"
-  require file_path + "/iso8583/util.rb"
-  require file_path + "/iso8583/version.rb"
-  require file_path + "/device/transaction/download.rb"
-  require file_path + "/device/transaction/emv.rb"
-  require file_path + "/device/transaction/iso.rb"
+  require file_path + "/device/magnetic.rb"
 end
 
 module DaFunk

data/lib/device/io.rb

@@ -1,6 +1,6 @@
 class Device
   class IO < ::IO
-    include Device::Helper
+    include DaFunk::Helper
 
     F1               = "\001"
     F2               = "\002"

data/lib/device/runtime.rb

@@ -12,12 +12,6 @@ class Device
     # @param json [String] Parameters to confifure new aplication.
     # @return [Object] From the new runtime instance.
     def self.execute(app, json = nil)
-      unless app.include?(".")
-        zip = "./#{app}.zip"
-        Device::Display.clear
-        raise File::FileError, zip unless File.exists?(zip)
-        raise "Problem to unzip #{zip}" unless Zip.uncompress(zip, app)
-      end
       execution_ret = mrb_eval("Context.start('#{app}', '#{Device.adapter}', '#{json}')")
       self.system_reaload
       return execution_ret
@@ -27,7 +21,7 @@ class Device
     # @return [NilClass] From the new runtime instance.
     def self.system_reaload
       Device::Setting.setup
-      Device::ParamsDat.setup
+      DaFunk::ParamsDat.setup
       Device::Network.setup
       nil
     end