thecore_dataentry_commons 1.2.14

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8009c4b390ff3364b0acc7dee626eacb3425f23
+  data.tar.gz: 11327a748ab56f7b01a279e5c00282ff28525dec
+SHA512:
+  metadata.gz: b1f8f0757cdc25170c80f651298e42e15d576fb5b8d5af9db1cbe28277cdcf83a64ca9cd1888f0c5875e404423273ab915f540560696f2b442c3b98c56917cf3
+  data.tar.gz: f99e88bfaa223f8557c12e1e6644e772ea67e66c69c8910bf89e935594e6432694800a38e08b6ac8c5dde3eb8cbf918453b62614b5643b961c037598e8df0d41

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Gabriele Tassoni
+
+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,28 @@
+# ThecoreDatawedgeWebsocketHelpers
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thecore_dataentry_commons'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install thecore_datawedge_websocket_helpers
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/views/higher_level/_barcode_simple_scan.html.erb

@@ -0,0 +1,115 @@
+<%= breadcrumb %>
+
+<%= render "barcode_scan_mode_detection"%>
+<%= render "dataentry_commons_input_group" %>
+
+<div class="container" style="margin-top: 1em;">
+  <div class="row">
+    <div id="data-info" class="alert alert-warning col-lg-12"></div>
+  </div>
+  <div class="row">
+    <div id="data-content" class="alert alert-warning col-lg-12"></div>
+  </div>
+  <%-unless (hide_action rescue true)%>
+  <div class="row">
+    <button id="data-action" class="btn btn-danger col-lg-12" data-loading-text="<i class='fa fa-spinner fa-spin '></i> <%=t :loading %>"><%=t "barcode.action.name"%></button>
+  </div>
+  <%-end%>
+</div>
+
+<script>
+    var code;
+    var returnedData;
+
+    // These functions can be overridden in the containing file
+    function setAll() {
+        $("#data-info").show();
+        $("#data-content").show();
+        <%-unless (hide_action rescue true)%>
+        $("#data-action").show();
+        <%-end%>
+    }
+
+    function resetInfo() {
+        returnedData = code = undefined;
+        $("#barcode").empty();
+        $("#data-info").empty().hide();
+        $("#data-content").empty().hide();
+        <%-unless (hide_action rescue true)%>
+        $("#data-action").hide();
+        <%-end%>
+    }
+
+    function contentHtmlString(data){
+        return data.barcode;
+    }
+
+    function barcodeScannedSuccess(data, status) {
+        returnedData = data;
+        // Cleaning up
+        $("#data-content").empty().hide();
+        // Setting info already formatted from the controller
+        $("#data-info").html(data.info);
+        // Setting returned content
+        var appended = contentHtmlString(data).appendTo("#data-content");
+        // $("#data-content").switchClass("alert-warning", "alert-success", 800).switchClass("alert-success", "alert-warning",800);
+        setAll();
+        resetCurrentBtn();
+        return appended;
+    }
+
+    function barcodeScannedThen(appended){}
+
+    function barcodeScannedFailure(errorObj) {
+        // Resetting all to the starting condition
+        resetCurrentBtn();
+        resetInfo();
+        // Showing modal error
+        openModal("<%=t :error %>", errorObj.responseJSON.error);
+    }
+
+    <%-unless (hide_action rescue true)%>
+    function dataActionSuccess(data, status) {
+        openModal("<%=t :success %>", data.message);
+        setAll();
+        resetCurrentBtn();
+        return data;
+    }
+
+    function dataActionThen(data){}
+
+    function dataActionFailure(errorObj) {
+        barcodeScannedFailure(errorObj);
+    }
+    <%-end%>
+    // END of overridable functions
+
+    // Operation on barcode scan
+    $('#send').on('click', function () {
+        code = $('#barcode');
+        code.prop('disabled', true);
+        $(this).button('loading');
+        $.get('<%=rails_admin.send("#{action_name}_path")%>', {
+            barcode: code.val()
+        }).then(barcodeScannedSuccess).done(barcodeScannedThen).fail(barcodeScannedFailure);
+    });
+
+    <%-unless (hide_action rescue true)%>
+    // Operation on button click
+    $("#data-action").click(function () {
+        code = $('#barcode');
+        code.prop('disabled', true);
+        $(this).button('loading');
+        $.get('<%=rails_admin.send("#{action_name}_path")%>', {
+            barcode: code.val(),
+            action: "data-action",
+            data: returnedData
+        }).then(dataActionSuccess).done(dataActionThen).fail(dataActionFailure);
+    });
+    <%-end%>
+
+    // Starting with a clean interface
+    resetInfo();
+</script>
+
+<%= render "dataentry_commons_input_group_logic" %>

data/app/views/rails_admin/main/_barcode_scan_mode_detection.html.erb

@@ -0,0 +1,11 @@
+<!-- Automatically manage kp or ws mode, based on the auto setting and detection of mobile or not browser -->
+<%-@type = "kp"%>
+<%-if Settings.datawedge_scan_mode == "auto"%>
+  <%-Rails.logger.debug "META #{browser.meta.inspect}\n - includes mobile? #{browser.meta.include?("mobile")}\n - includes android? #{browser.meta.include?("android")}"%>
+  <%-if browser.meta.include?("mobile") && browser.meta.include?("android")%>
+    <%-@type = "ws"%>
+  <%-end%>
+<%-else%>
+  <%-@type = Settings.datawedge_scan_mode%>
+<%-end%>
+<%-Rails.logger.debug "Computed type: #{@type}"%>

data/app/views/rails_admin/main/_dataentry_commons_input_group.html.erb

@@ -0,0 +1,45 @@
+<%-if @type == "ws" %>
+<style type="text/css">
+  .input-group-addon.primary {
+    color: rgb(255, 255, 255);
+    background-color: rgb(50, 118, 177);
+    border-color: rgb(40, 94, 142);
+  }
+  .input-group-addon.success {
+    color: rgb(255, 255, 255);
+    background-color: rgb(92, 184, 92);
+    border-color: rgb(76, 174, 76);
+  }
+  .input-group-addon.info {
+    color: rgb(255, 255, 255);
+    background-color: rgb(57, 179, 215);
+    border-color: rgb(38, 154, 188);
+  }
+  .input-group-addon.warning {
+    color: rgb(255, 255, 255);
+    background-color: rgb(240, 173, 78);
+    border-color: rgb(238, 162, 54);
+  }
+  .input-group-addon.danger {
+    color: rgb(255, 255, 255);
+    background-color: rgb(217, 83, 79);
+    border-color: rgb(212, 63, 58);
+  }
+</style>
+<%-end%>
+
+<div class="row" id="barcode-container">
+  <div class="col-lg-12">
+    <div class="input-group input-group-lg">
+      <%-if @type == "ws" %>
+      <span id="connection" class="input-group-addon danger">
+        <i class='fa fa-plug'></i>
+      </span>
+      <%-end%>
+      <input type="text" name="barcode" class="form-control input-lg" id="barcode" placeholder="<%= I18n.t :manual_barcode %>"/>
+      <span class="input-group-btn">
+        <button id="send" type="button" class="btn btn-default btn-lg" data-loading-text="<i class='fa fa-spinner fa-spin '></i> <%=t :loading %>"><%= I18n.t :send %></button>
+      </span>
+    </div>
+  </div>
+</div>

data/app/views/rails_admin/main/_dataentry_commons_input_group_logic.html.erb

@@ -0,0 +1 @@
+<%=render(@type) rescue render("kp")%>

data/app/views/rails_admin/main/_kp.html.erb

@@ -0,0 +1,54 @@
+<script>
+  function keypressAndReturn(event) {
+    // Capture all the keypresses and if they are a return, 
+    // then "click" the send button
+    event.stopPropagation();
+    var keycode = (event.keyCode ? event.keyCode : event.which);
+    //console.log(keycode);
+    if (keycode == '13') {
+      $("#send").click();
+      return true;
+    }
+    return false;
+  }
+  var kpMode = "<%= Settings.datawedge_kp_mode %>";
+  // var clickedBtn; var code; Gestisco il keypress sull'input
+  $("input[name=barcode]").on(kpMode, keypressAndReturn);
+
+  function resetCurrentBtn() {
+    $("#send").button('reset');
+    $("#barcode").prop('disabled', false);
+    $("#barcode").val('');
+    // sendMessageToServer(msg_input_plugin_enable); clickedBtn = code = null;
+  }
+  // var clickedBtn; var code; Gestisco il keypress sull'input
+  function manageScannedKeystrokes(event) {
+    if(!keypressAndReturn(event)) {
+      $("#send").focus();
+      // Scrivilo nell'input field (accumulando)
+      $("input[name=barcode]").val(function (index, val) {
+        // Scrivo
+        return val + event.key;
+      });
+    }
+  }
+  function enableKSCapture(){
+    $(document).on(kpMode, manageScannedKeystrokes);
+  }
+  function disableKSCapture(){
+    $(document).off(kpMode, manageScannedKeystrokes);
+  }
+
+  // Init
+  enableKSCapture();
+  // Se $("#barcode") si becca il focus, elimino il keypress
+  $("#barcode").focusin(function () {
+    // Blocco il keypress del document
+    disableKSCapture();
+  });
+  $("#barcode").focusout(function () {
+    // Blocco il keypress del document
+    enableKSCapture();
+  });
+  $("#send").focus();
+</script>

data/app/views/rails_admin/main/_ws.html.erb

@@ -0,0 +1,80 @@
+<input id="label-type" name="label-type" type="hidden"/>
+<script>
+  //  Proof of concept to control DataWedge via Web Sockets
+  var msg_input_plugin_enable = {
+    "action": "com.symbol.datawedge.api.ACTION_SCANNERINPUTPLUGIN",
+    "extra_key": "com.symbol.datawedge.api.EXTRA_PARAMETER",
+    "extra_value": "ENABLE_PLUGIN"
+  };
+  var msg_input_plugin_disable = {
+    "action": "com.symbol.datawedge.api.ACTION_SCANNERINPUTPLUGIN",
+    "extra_key": "com.symbol.datawedge.api.EXTRA_PARAMETER",
+    "extra_value": "DISABLE_PLUGIN"
+  };
+
+  // WEBSOCKET ----------------------------------------------------------------------------------
+  var socketClosed = true;
+  var address = "127.0.0.1";
+  var port = "12345";
+
+  function socketOnError() {
+    console.log("Error");
+    if (!socketClosed) {
+      socketClosed = true;
+      ws.close();
+    }
+  }
+
+  var barcodeScanRegExp = /Barcode \((.*)\) \[(.*)\]/;
+
+  function init() {
+    ws = new WebSocket("ws://" + address + ":" + port + "/");
+    ws.onmessage = function (event) {
+      // event.data ha forma: Barcode (8273878337383) [LABEL-TYPE-EAN13]
+      // il barcode è event.extras["com.symbol.datawedge.data_string"]: String contains the output data as a String. In the case of concatenated barcodes, the decode data is concatenated and sent out as a single string. In the example above: 8273878337383
+      // il label_type è event.extras["com.symbol.datawedge.label_type"]: String contains the barcode label type. In the example above: LABEL-TYPE-EAN13
+      // il decode_data è event.extras["com.symbol.datawedge.decode_data"]: Decode data is returned as a list of byte arrays. In most cases there will be one byte array per decode. For barcode symbologies that support concatenation (i.e. Codabar, Code128, MicroPDF, etc.) the decoded data is stored in multiple byte arrays (one byte array per bar code). Clients can get data in each byte array by passing an index.
+      var results = barcodeScanRegExp.exec(event.data);
+      $('input[name=barcode]').val(results[1]);
+      $('input[name=label-type]').val(results[2]);
+      $("#send").click();
+    };
+    //  In production you would want this to be resiliant against the server being killed by Android, by the user navigating between pages or any other unexpected error related to connection.
+    ws.onclose = function () {
+      setSocketStatus("success", "danger");
+      socketClosed = true;
+    };
+    ws.onopen = function () {
+      setSocketStatus("danger", "success");
+      socketClosed = false;
+    };
+    ws.onerror = function (event) {
+      socketOnError();
+    };
+  }
+  function setSocketStatus(origin, to) {
+    $('#connection').removeClass(origin).addClass(to);
+  }
+  // function sendMessageToServer(json_msg) {
+  //   if (socketClosed) {
+  //     init();
+  //   } else {
+  //     ws.send(JSON.stringify(json_msg), function (error) {
+  //       socketOnError();
+  //     });
+  //   }
+  // }
+
+  function tryInit() {
+    // Solo se la socket è chiusa e siamo in ambiente android
+    if (socketClosed) {
+      init();
+    }
+  }
+  // Creating the websocket
+  var ua = navigator.userAgent.toLowerCase();
+  var isAndroid = ua.indexOf("android") > -1; //&& ua.indexOf("mobile");
+  if (isAndroid) {
+    setInterval(tryInit, 1500);
+  }
+</script>

data/config/locales/en.thecore_datawedge_websocket_helpers.yml

@@ -0,0 +1,14 @@
+en:
+  ask_yes: Yes
+  ask_no: Cancel
+  error: Error
+  success: Successo
+  question: Question
+  manual_barcode: Manual input
+  barcode_cannot_be_empty: Barcode cannot be empty
+  send: Send
+  loading: Loading
+  barcode:
+    action:
+      name:
+        Send

data/config/locales/it.thecore_datawedge_websocket_helpers.yml

@@ -0,0 +1,14 @@
+it:
+  ask_yes: Si
+  ask_no: Annulla
+  error: Errore
+  success: Successo
+  question: Domanda
+  manual_barcode: Inserimento Manuale
+  barcode_cannot_be_empty: Il codice a barre letto non può essere vuoto
+  send: Invia
+  loading: Caricamento
+  barcode:
+    action:
+      name:
+        Invia

data/db/migrate/20170913192906_add_keymode_to_settings.rb

@@ -0,0 +1,7 @@
+class AddKeymodeToSettings < ActiveRecord::Migration[5.1]
+  def change
+    # keyup
+    # keypress
+    Settings.datawedge_kp_mode = "keypress"
+  end
+end

data/db/migrate/20171005162605_replace_with_auto_to_settings.rb

@@ -0,0 +1,7 @@
+class ReplaceWithAutoToSettings < ActiveRecord::Migration[5.1]
+  def change
+    # ws: WebSocket
+    # kp: KeyPress
+    Settings.datawedge_scan_mode = "auto" # or "kp"
+  end
+end

data/lib/thecore_dataentry_commons.rb

@@ -0,0 +1,7 @@
+require "thecore_settings"
+require "thecore_dataentry_commons/engine"
+require "browser"
+
+module ThecoreDataentryCommons
+  # Your code goes here...
+end

data/lib/thecore_dataentry_commons/engine.rb

@@ -0,0 +1,13 @@
+module ThecoreDataentryCommons
+  class Engine < ::Rails::Engine
+
+    initializer 'thecore_dataentry_commons.add_to_migrations' do |app|
+      unless app.root.to_s == root.to_s
+        # APPEND TO MAIN APP MIGRATIONS FROM THIS GEM
+        config.paths['db/migrate'].expanded.each do |expanded_path|
+          app.config.paths['db/migrate'] << expanded_path
+        end
+      end
+    end
+  end
+end

data/lib/thecore_dataentry_commons/version.rb

@@ -0,0 +1,3 @@
+module ThecoreDataentryCommons
+  VERSION = '1.2.14'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: thecore_dataentry_commons
+version: !ruby/object:Gem::Version
+  version: 1.2.14
+platform: ruby
+authors:
+- Gabriele Tassoni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thecore_settings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: browser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: This plugin adds some partials to deal with DataWedge WebSocket.
+email:
+- gabriele.tassoni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- app/views/higher_level/_barcode_simple_scan.html.erb
+- app/views/rails_admin/main/_barcode_scan_mode_detection.html.erb
+- app/views/rails_admin/main/_dataentry_commons_input_group.html.erb
+- app/views/rails_admin/main/_dataentry_commons_input_group_logic.html.erb
+- app/views/rails_admin/main/_kp.html.erb
+- app/views/rails_admin/main/_ws.html.erb
+- config/locales/en.thecore_datawedge_websocket_helpers.yml
+- config/locales/it.thecore_datawedge_websocket_helpers.yml
+- db/migrate/20170913192906_add_keymode_to_settings.rb
+- db/migrate/20171005162605_replace_with_auto_to_settings.rb
+- lib/thecore_dataentry_commons.rb
+- lib/thecore_dataentry_commons/engine.rb
+- lib/thecore_dataentry_commons/version.rb
+homepage: https://www.taris.it
+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.14
+signing_key: 
+specification_version: 4
+summary: Some javascripts and partials to handle DW WS.
+test_files: []