extface 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36f9d70cc32fe36b5ed65874e2f4fa2b77e1266e
-  data.tar.gz: 1d3ab540044049237f9f132ffee4724e9bef397e
+  metadata.gz: 916e0a9bc414ba59d91de7a4e05c507d893225de
+  data.tar.gz: f7f130b480235e7c53d7b60b0e3cc19949eed2d9
 SHA512:
-  metadata.gz: 38e4217a2cb50ca418eda7e302cd6efb2f31ddcf2aedb3f7fa5b149854114b44b966b897f598ac418e46b75aa1787d54adf1a6664ce06d0725ad3a1f49ee60e4
-  data.tar.gz: df47ff4efadae51d7d283a1c00183b6dffae6d1f93008425cc97740d266873b71d878efe769d9d30bc6800e4e3c2047c18e92f5554f1e9cb86f9b5a6e4cddf14
+  metadata.gz: 1bf0e91791f22ec88193acd2e7d4cf7d7f0c1394a63d7741d551bb09e0f7529a26f982e4ecd6232cfc0928a3dd00d2a46cd068b450ec727125726b4d3110d442
+  data.tar.gz: 80bd3c0f44e7f428928e40abf8b8ed6015a4601e5978c3cd8f6a0c2d6f8970ed0e1e9ca41c931e347f083279608770f7299f35a6a37d277537feb18cc2f49195

data/Rakefile

@@ -4,16 +4,6 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Extface'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
 APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 

data/app/controllers/extface/devices_controller.rb

@@ -51,7 +51,7 @@ module Extface
 
     def test_page
       set_device
-      @job = @device.driveable.print_test_page if params[:test_page]
+      @job = @device.driver.print_test_page if params[:test_page]
       render action: :show
     end
 
@@ -63,7 +63,7 @@ module Extface
 
       # Only allow a trusted parameter "white list" through.
       def device_params
-        params.require(:device).permit(:uuid, :name, :driver, :driveable_id, :driveable_type)
+        params.require(:device).permit(:uuid, :name, :driver_class, :driver_id)
       end
   end
 end

data/app/helpers/extface/devices_helper.rb

@@ -1,21 +1,23 @@
 module Extface
   module DevicesHelper
     
-    def subdrivers(options, object)
-      object.subclasses.each do |s|
-        options << [s::NAME, s.name]
-        subdrivers(options, s) if s.subclasses.any?
+    def subdrivers(object)
+      [].tap do |drivers|
+        object.subclasses.each do |s|
+          drivers << s
+          drivers << subdrivers(s) if s.subclasses.any?
+        end
       end
-      return options
     end
     
     def options_for_drivers
-      Extface::Engine.eager_load!
-      {}.tap do |drivers|
-        Extface::DriverBase.subclasses.collect{ |type|
-          drivers[type::GROUP] = subdrivers(Array.new, type)
-        }
-      end
+      Extface::Engine.eager_load! if Rails.env.development?
+      [].tap do |drivers|
+        Extface::Driver.subclasses.each do |s|
+          drivers << s
+          drivers << subdrivers(s)
+        end
+      end.flatten.group_by{ |x| x::GROUP }.sort.collect{ |group, drivers| [group, drivers.collect{ |d| [d::NAME, d.to_s] }.sort ] }
     end
   end
 end

data/app/models/extface/device.rb

@@ -1,37 +1,43 @@
 module Extface
   class Device < ActiveRecord::Base
-    attr_writer :driver
+    attr_writer :driver_class
     belongs_to :extfaceable, polymorphic: true
-    belongs_to :driveable, polymorphic: true
+    belongs_to :driver, inverse_of: :device
     has_many :jobs, inverse_of: :device
     
-    accepts_nested_attributes_for :driveable
+    accepts_nested_attributes_for :driver
     
-    delegate :print?, :fiscal?, :raw?, :cdr?, to: :driveable, allow_nil: true
+    delegate :print?, :fiscal?, :raw?, :report?, to: :driver, allow_nil: true
     
     validates_uniqueness_of :name, :uuid, scope: [:extfaceable_id, :extfaceable_type]
     
     before_create do
       self.uuid = SecureRandom.hex
       self.name = uuid unless name.present?
-      self.driveable = @driver.constantize.create if @driver.present?
     end
     
-    def driver
-      driveable.try(:class)
+    before_save do
+      if @driver_class.present? and @driver_class != driver_class.try(:to_s)
+        driver.try(:destroy)
+        self.driver = @driver_class.constantize.create if @driver_class.present?
+      end
+    end
+    
+    def driver_class
+      driver.try(:class)
     end
     
     def driver_name
-      driver::NAME if driver
+      driver_class::NAME if driver_class
     end
 
     def session(description = nil)
       job = jobs.create!(description: description)
       Thread.new do
         begin
-          raise 'No driver configured' unless driveable.present?
-          driveable.set_job(job)
-          yield driveable
+          raise 'No driver configured' unless driver.present?
+          driver.set_job(job)
+          yield driver
           job.complete!
         rescue => e
           STDERR.puts e.message

data/app/models/extface/{driver_base.rb → driver.rb}

@@ -1,19 +1,34 @@
 require'timeout'
 module Extface
-  class DriverBase < ActiveRecord::Base
-    self.abstract_class = true
+  class Driver < ActiveRecord::Base
     
-    has_one :device, :as => :driveable
+    NAME = 'Extface Driver Base' #human driver name
+    GROUP = Extface::RAW_DRIVER
     
-    [:raw?, :print?, :fiscal?, :cdr?].each do |driver_type|
-      define_method driver_type do
-        false
+    DEVELOPMENT = true #driver is not ready for production (not passing all tests or has major bugs)
+
+    CAN_RECEСVE_DATA = true #pull from server
+    CAN_TRANSMIT_DATA = true #push to server
+    
+    # Select driver features
+    RAW = true  #responds to #push(data) and #pull
+    PRINT = false #POS, slip printers
+    FISCAL = false #cash registers, fiscal printers
+    REPORT = false #only transmit data that must be parsed by handler, CDR, report devices
+
+    DRIVER_TYPES = ['RAW', 'PRINT', 'FISCAL', 'REPORT'].freeze
+    
+    has_one :device, inverse_of: :driver
+    
+    DRIVER_TYPES.each do |driver_type|
+      define_method "#{driver_type.downcase}?" do
+        self.class.const_get driver_type
       end
     end
 
     class << self
-      def has_serial_config
-        has_one :serial_config, as: :s_configureable
+      def has_serial_config #helper for serial devices, provides config for speed, boud rate, parity etc..
+        has_one :serial_config, inverse_of: :driver
         accepts_nested_attributes_for :serial_config
         define_method :serial? do
           true

data/app/models/extface/driver/generic_pos.rb

@@ -1,7 +1,52 @@
 module Extface
-  class Driver::GenericPos < Extface::PosPrintDriver
+  class Driver::GenericPos < Extface::Driver
     NAME = 'Generic Pos Printer (Serial)'.freeze
+    GROUP = Extface::PRINT_DRIVER
+    
+    DEVELOPMENT = true #driver is not ready for production (not passing all tests or has major bugs)
+
+    CAN_RECEСVE_DATA = true #pull from server
+    CAN_TRANSMIT_DATA = true #push to server
+    
+    # Select driver features
+    RAW = true  #responds to #push(data) and #pull
+    PRINT = true #POS, slip printers
+    FISCAL = false #cash registers, fiscal printers
+    REPORT = false #only transmit data that must be parsed by handler, CDR, report devices    
+    
     has_serial_config
     alias_method :print, :push
+    
+    def print_test_page(times = 1)
+      device.session("Print Test Page") do |s|
+        times.times do |t|
+        s.notify "Printing Test Page #{t}"
+        s.print "******************************\r\n*"
+        s.print "Extface Print Test #{t}".center(28)
+        s.print "*\r\n******************************\r\n"
+
+        s.notify "Printing driver information"
+        s.print "\r\nDriver:\r\n"
+        s.print "------------------------------\r\n"
+        s.print "#{self.class::NAME}".truncate(30)
+        s.print "\r\n"
+
+        if try(:serial?)
+          s.notify "Printing serial settings"
+          s.print "\r\nSerial Port Settings:\r\n"
+          s.print "------------------------------\r\n"
+        end
+
+        s.print "\r\n"
+        s.print "------------------------------\r\n"
+        s.print Time.now.strftime("Printed on %m/%d/%Y %T\r\n").rjust(32)
+        s.print "\r\n\r\n"
+        s.notify "Printing finished"
+        
+        s.try :autocut
+        end
+      end
+    end
+    
   end
 end

data/app/models/extface/driver/star_scp700.rb

@@ -1,16 +1,22 @@
 module Extface
   class Driver::StarScp700 < Extface::Driver::StarTsp200
     NAME = 'Star SCP700 (Receipt only)'.freeze
+    GROUP = Extface::PRINT_DRIVER
     
-    alias_method :print, :push
+    DEVELOPMENT = true #driver is not ready for production (not passing all tests or has major bugs)
+
+    CAN_RECEСVE_DATA = true #pull from server
+    CAN_TRANSMIT_DATA = true #push to server
+    
+    # Select driver features
+    RAW = true  #responds to #push(data) and #pull
+    PRINT = true #POS, slip printers
+    FISCAL = false #cash registers, fiscal printers
+    REPORT = false #only transmit data that must be parsed by handler, CDR, report devices    
     
     def autocut(partial = true)
       print "\r\n\r\n\r\n"
       print partial ? "\x1B\x64\x31" : "\x1B\x64\x30"
     end
-    
-    def autocutter?
-      true
-    end
   end
 end

data/app/models/extface/driver/star_tsp200.rb

@@ -1,6 +1,19 @@
 module Extface
-  class Driver::StarTsp200 < Extface::PosPrintDriver
+  class Driver::StarTsp200 < Driver::GenericPos
     NAME = 'Star TSP200 (Base Receipt Protocol)'.freeze
+    GROUP = Extface::PRINT_DRIVER
+    
+    DEVELOPMENT = true #driver is not ready for production (not passing all tests or has major bugs)
+
+    CAN_RECEСVE_DATA = true #pull from server
+    CAN_TRANSMIT_DATA = true #push to server
+    
+    # Select driver features
+    RAW = true  #responds to #push(data) and #pull
+    PRINT = true #POS, slip printers
+    FISCAL = false #cash registers, fiscal printers
+    REPORT = false #only transmit data that must be parsed by handler, CDR, report devices
+
     has_serial_config
   end
 end

data/app/models/extface/serial_config.rb

@@ -1,10 +1,10 @@
 module Extface
   class SerialConfig < ActiveRecord::Base
-    BOUD_RATES = [2400, 4800, 9600, 19200].freeze
+    BOUD_RATES = [2400, 4800, 9600, 19200, 38400].freeze
     DATA_LENGTHS = [7, 8].freeze
     PARITY_CHECKS = [0, 1, 2].freeze
     STOP_BITS = [1, 2].freeze
     HANDSHAKE = [0, 1, 2].freeze
-    belongs_to :s_configureable, polymorphic: true
+    belongs_to :driver, inverse_of: :serial_config
   end
 end

data/app/views/extface/devices/form.html.erb

@@ -21,26 +21,29 @@
   <div class="form-group">
     <%= f.label :driver, class: 'col-sm-2 control-label' %>
     <div class='col-sm-10 col-md-8'>
-      <% if @device.driveable.present? %>
+      <% unless @device.driver.blank? || params[:driver_change] %>
         <p class="form-control-static">
-          <%= link_to '#', class: 'btn btn-danger btn-sm pull-right' do %>
+          <%= link_to edit_device_path(@device, driver_change: true), class: 'btn btn-danger btn-sm pull-right' do %>
             <%= t('.change_driver') %>
           <% end %>
-          <%= @device.driveable.class::NAME %>
+          <%= @device.driver.class::NAME %>
         </p>
       <% else %>
-        <%= f.select :driver, options_for_drivers, { include_blank: true }, class: 'form-control' %>
+        <%= f.select :driver_class, options_for_drivers, { include_blank: true }, class: 'form-control' %>
+        <% if @device.driver.present? %>
+          <span class='text-danger'>Driver change will destroy current driver configuration!</span>
+        <% end %>
       <% end %>
     </div>
   </div>
-  <%= fields_for :driveable do |fd| %>
-    <%= driver_settings fd, @device.driveable %>
+  <%= fields_for :driver do |fd| %>
+    <%= driver_settings fd, @device.driver %>
     <%= fields_for :serial_config do |fds| %>
       <div class="form-group">
         <div class='col-sm-offset-2 col-sm-10 col-md-8'>
           <%= render 'extface/serial_configs/settings',  f: fds %>
         </div>
       </div>
-    <% end if @device.driveable.serial? %>
-  <% end if @device.driveable.present? %>
+    <% end if @device.driver.serial? %>
+  <% end if @device.driver.present? %>
 <% end %>

data/app/views/extface/devices/index.html.erb

@@ -26,7 +26,7 @@
       <tr>
         <td><%= link_to device.name, device %></td>
         <td><%= device.extfaceable.composite_id %></td>
-        <td><%= device.driveable ? device.driveable.class::NAME : 'N/A' %></td>
+        <td><%= device.driver ? device.driver.class::NAME : 'N/A' %></td>
         <td class='text-right'><%= link_to 'Edit', edit_device_path(device), class: 'btn btn-primary btn-sm' %></td>
         <td class='text-right'><%= button_to 'Delete', device, method: :delete, class: 'btn btn-danger btn-sm', data: { confirm: 'Are you sure?' } %></td>
       </tr>

data/app/views/extface/driver/star_tsp200/_settings.html.erb

@@ -0,0 +1 @@
+<%= __FILE__.gsub(Rails.root.to_s, "") %>

data/db/migrate/20140303112124_create_extface_drivers.rb

@@ -0,0 +1,9 @@
+class CreateExtfaceDrivers < ActiveRecord::Migration
+  def change
+    create_table :extface_drivers do |t|
+      t.string :type
+      t.text :settings
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140303113217_drop_separate_driver_type_tables.rb

@@ -0,0 +1,12 @@
+class DropSeparateDriverTypeTables < ActiveRecord::Migration
+  def up
+    drop_table :extface_pos_print_drivers
+    drop_table :extface_raw_drivers
+    drop_table :extface_fiscal_print_drivers
+    drop_table :extface_pbx_cdr_drivers
+  end
+  
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/db/migrate/20140303122506_change_driver_polymorphic_to_belongs_to_extface_devices.rb

@@ -0,0 +1,13 @@
+class ChangeDriverPolymorphicToBelongsToExtfaceDevices < ActiveRecord::Migration
+  def up
+    remove_index :extface_devices, [:driveable_id, :driveable_type]
+    remove_column :extface_devices, :driveable_type
+    rename_column :extface_devices, :driveable_id, :driver_id
+  end
+  
+  def down
+    rename_column :extface_devices, :driver_id, :driveable_id
+    add_column :extface_devices, :driveable_type, :string
+    add_index :extface_devices, [:driveable_id, :driveable_type]
+  end
+end

data/db/migrate/20140303123022_change_polymorphic_to_has_one_to_extface_serial_configs.rb

@@ -0,0 +1,11 @@
+class ChangePolymorphicToHasOneToExtfaceSerialConfigs < ActiveRecord::Migration
+  def up
+    remove_column :extface_serial_configs, :s_configureable_type
+    rename_column :extface_serial_configs, :s_configureable_id, :driver_id
+  end
+  
+  def down
+    add_column :extface_serial_configs, :s_configureable_type, :string
+    rename_column :extface_serial_configs, :driver_id, :s_configureable_id
+  end
+end

data/lib/extface.rb

@@ -5,6 +5,11 @@ require "extface/extfaceable"
 require "extface/extfaceable"
 require "redis-namespace"
 module Extface
+  RAW_DRIVER = "Raw Communication Devices"
+  PRINT_DRIVER = "Print Devices"
+  FISCAL_DRIVER = "Fiscal Printers & Cash Registers"
+  REPORT_DRIVER = "CDR Loggers, Report Devices"
+    
   mattr_accessor :redis_connection_string
   
   mattr_reader :mappings

data/lib/extface/mapping.rb

@@ -13,8 +13,9 @@ module Extface
       # :shop_uuid then find_by! :uuid => params[:shop_uuid]
       # :shop_id then find_by! :id => params[:shop_id]
       @i_find_key = @i_param[/^(#{@name}_|)(\w+)/,2]
-      raise "#{@i_klass.name} has no method #{@i_find_key}" unless @i_klass.new.respond_to? @i_find_key
-      raise "Did you forget to add 'has_extface_devices' in #{@i_klass.name} ?" unless @i_klass.new.respond_to? :extface_devices
+      # FIXME not before schema load
+      #raise "#{@i_klass.name} has no method #{@i_find_key}" unless @i_klass.new.respond_to? @i_find_key
+      #raise "Did you forget to add 'has_extface_devices' in #{@i_klass.name} ?" unless @i_klass.new.respond_to? :extface_devices
       @i_extra_module = options[:controller_include].to_s.constantize if options[:controller_include].present?
     end
     

data/lib/extface/version.rb

@@ -1,3 +1,3 @@
 module Extface
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/controllers/extface/devices_controller_test.rb

@@ -19,7 +19,7 @@ module Extface
 
     test "should create device" do
       assert_difference('Device.count') do
-        post :create, shop_id: @device.extfaceable, use_route: :extface, device: { driver: 'Extface::Driver::RawSerial' }
+        post :create, shop_id: @device.extfaceable, use_route: :extface, device: { driver_class: 'Extface::Driver::GenericPos' }
       end
 
       assert_redirected_to device_path(assigns(:device))

data/test/dummy/config/routes.rb

@@ -2,6 +2,8 @@ Rails.application.routes.draw do
 
   mount Extface::Engine => "/shop_extface"
   resources :shops do
-    extface_for :shop
+    unless Rails.env.development?
+      extface_for :shop
+    end
   end
 end