dsx-dml 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 985e1ae81c22db93542c4c73d9d889c6e859f40a
+  data.tar.gz: 912e303900bc2b98fb45c97ac3b7af5bd32f1333
+SHA512:
+  metadata.gz: 3aea101507cd4b8bea450195093618bbd9a9c7cf8e89bf9f174d9bbfd3c36f84012670ddea1795783c3780d1447883dc597e7687fb8feabe1ed49b1b1ff2f2a5
+  data.tar.gz: 0b65ced27ae8560f9780f3bb8938476cc7ad19b41457cd170943ce508b06c9df47ded046928441811e2d4af0bad8fa5591b78834a3de372b9a56c1d0d3366f5b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in amerx-dml.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 dgsan
+
+MIT License
+
+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,79 @@
+# DSX::Dml
+
+Provides tools to ease working with the DSX DML command syntax, an archaic and obnoxious format used by DSX Access systems' SFTP APIs for making changes to records in their access control system's database(s).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dsx-dml'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dsx-dml
+
+## Usage
+
+```ruby
+require 'dsx/dml'
+
+
+# Declare what Location Number (zone) to make changes in and set the UDF field for UID string
+
+zone = Dsx::Dml::Zone.new(1111, 2)
+
+
+# Use a unique identifier to create a changeset for that unique identifier
+
+changeset_0 = zone.use('123456789100')
+
+
+# Chain together changes for tables related to that unique identifier
+
+changeset_0.table('Names').write({
+            FName: 'Harry', 
+            LName: 'Bird',
+            Company: 'Harry Bird Co',
+            Visitor: '',
+            Trace: '',
+            Notes: 'Often wears bowties'
+        }).table('UDF').write({
+            UdfNum: 2,
+            UdfText: number
+        }).table('Cards').write({
+            Code: '123456789100',
+            PIN: 1234,
+            StartDate: '01/01/2001',
+            StopDate: '11/11/2111',
+            NumUses: 9999
+        })
+
+
+# create another changeset for a different unique identifier
+
+changeset_1 = zone.use('123456789101')
+
+changeset_1.table('Cards').add_acl('Parking Garage')
+
+
+# Push changesets to SFTP receiver
+
+changeset_0.net_sftp({address: '127.0.0.1', user: 'dsx_user', password: 'dsx_password' })
+changeset_1.curl({address: '127.0.0.1', user: 'dsx_user', password: 'dsx_password' })
+
+
+```
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/dsx-dml.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dsx/dml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dsx-dml"
+  spec.version       = Dsx::Dml::VERSION
+  spec.authors       = ["dgsan"]
+  spec.email         = ["dgsan@server.fake"]
+  spec.description   = "Provides tools to ease working with the DSX Access Systems DML command syntax, an archaic and obnoxious format used by DSX Access Systems' SFTP APIs for making changes to records in their WinDSX SQL access control system's database(s)."
+  spec.summary       = "Ease communication with DSX Access Systems' SFTP 'API.'"
+  spec.homepage      = "https://github.com/dgsan/dsx-dml"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  
+  spec.add_runtime_dependency "net-sftp", "~> 2.1"
+
+end

data/lib/dsx/dml.rb

@@ -0,0 +1,208 @@
+require 'dsx/dml/version'
+require 'net/sftp'
+require 'securerandom'
+require 'tmpdir'
+require 'tempfile'
+
+module Dsx
+  module Dml
+    
+    class Zone
+
+      def initialize(location_num, udf_field_num)
+        @location_num = location_num
+        @udf_field_num = udf_field_num
+      end
+      
+      def use(id_num)
+        return Changeset.new(self, id_num)
+      end
+      
+      def location_num
+        @location_num
+      end
+      
+      def udf_field_num
+        @udf_field_num
+      end
+      
+    end
+    
+    
+    class Changeset
+    
+      def initialize(zone, id_num)
+        @id_num = id_num
+        @zone = zone
+        @stack = []
+        start_command
+      end
+    
+      def table(table_name)
+        case table_name
+        when 'Cards' 
+            return Cards.new(self, table_name)
+        when 'Names'
+            return Names.new(self, table_name)
+        else
+            return Table.new(self, table_name)
+        end
+      end
+        
+      # Their system won't work correctly with \n, but will with \r. 
+      # It'd also be possible to change the record separator, but that seems like a worse idea.
+      def to_string
+        @stack.join("\r")
+      end
+        
+      # params: {address: server_address, user: user, password: password}
+      def net_sftp(params)
+        Net::SFTP::start(params[:address], params[:user], :password => params[:password]) do |sftp|
+          sftp.file.open("/^Imp_Bio5_#{Time.now.utc.to_i}_#{SecureRandom::hex(4)}.txt", 'w') do |file|
+            file.write to_string
+            
+          end
+        end
+        return self
+      end
+      
+      # Alternative to Net::SFTP.
+      def curl(params)
+        Dir.mktmpdir do |tmpdir|
+          file = Tempfile.new(["^Imp_Bio5_#{Time.now.utc.to_i}_", '.txt'], tmpdir)
+          file.write to_string
+          file.close()
+          result = `curl -s -S -u #{params[:user]}:#{params[:password]} -T #{file.path} -w "okay\n" sftp://#{params[:address]}/`
+          file.unlink()
+        end
+        return self
+      end
+        
+      def stack
+        @stack
+      end
+        
+      private
+        
+      def start_command
+        @stack << "I L#{@zone.location_num} U#{@zone.udf_field_num} ^#{@id_num}^^^"
+      end
+      
+    end
+    
+    
+    class Table
+    
+      def initialize(changeset, table_name)
+        @changeset = changeset
+        @table_name = table_name
+        @changeset.stack << "T #{@table_name}"
+      end
+        
+      def table(table_name)
+        @changeset.table(table_name)
+      end
+        
+      def done
+        @changeset
+      end
+        
+      def batch
+        @changeset
+      end
+      
+      def net_sftp(params)
+        @changeset.net_sftp(params)
+      end
+      
+      def curl(params)
+        @changeset.curl(params)
+      end
+        
+      def write(data)
+        fields(data)
+        @changeset.stack << 'W'
+        return self
+      end
+        
+      def update(data)
+        fields(data)
+        @changeset.stack << 'U'
+        return self
+      end
+        
+      def delete
+        fields(data)
+        @changeset.stack << 'D'
+        return self
+      end
+      
+      private
+      
+      def fields(hash)
+        hash.each { |k,v| single(k,v) }
+      end
+      
+      def blank(command)
+        single(command, '')
+      end
+      
+      def single(command, val)
+        @changeset.stack << "F #{command} ^#{val}^^^"
+        return self
+      end
+        
+    end
+    
+    
+    class Cards < Table
+      
+      def relace_code(code)
+        single('ReplaceCode', code)
+      end
+  
+      def copy_to_code(code)
+        single('Copy2Code', code)
+      end
+  
+      def add_acl(acl)
+        single('AddAcl', acl)
+      end
+  
+      def add_tmp_acl(acl)
+        single('AddTempAcl', acl)
+      end
+  
+      def del_acl(acl)
+        single('DelAcl', acl)
+      end
+  
+      def del_tmp_acl(acl)
+        single('DelTempAcl', acl)
+      end
+  
+      def clear_all_acl
+        blank('ClearTempAcl')
+      end
+  
+      def clear_all_tmp_acl
+        blank('ClearTempAcl')
+      end
+  
+      def copy_perm_to_tmp
+        blank('CopyPerm2Temp')
+      end
+  
+    end
+  
+
+    class Names < Table
+      
+      def dc
+        @changeset.stack << 'DC'
+      end
+      
+    end
+    
+  end
+end

data/lib/dsx/dml/version.rb

@@ -0,0 +1,5 @@
+module Dsx
+  module Dml
+    VERSION = "0.0.1"
+  end
+end

data/spec/dsx/dml_spec.rb

@@ -0,0 +1,45 @@
+require 'dsx/dml'
+require 'securerandom'
+
+describe Dsx::Dml do
+    describe "Creating a changset string" do
+        
+        name = 'test_' + SecureRandom::hex(4)
+        number = rand(10000000000..99999999999)
+        zone = Dsx::Dml::Zone.new(130, 2)
+        
+        changeset = zone.use(number)
+        
+        changeset.table('Names').write({
+            FName: name, 
+            LName: name + "_L",
+            Company: 'Bio5',
+            Visitor: '',
+            Trace: '',
+            Notes: ''
+        }).table('UDF').write({
+            UdfNum: 2,
+            UdfText: number
+        }).table('Cards').write({
+            Code: number,
+            PIN: 1234,
+            StartDate: '09/15/2013',
+            StopDate: '04/11/2023',
+            NumUses: 9999
+        })
+        
+        changeset_string = changeset.to_string
+        
+        it "Should use DML compatible newlines" do
+            changeset_string.should include("\r")
+            changeset_string.should_not include("\n")
+        end
+        
+        it "Should have some properly formatted fields and values" do
+            changeset_string.should include("^#{name}^^^")
+            changeset_string.should include("^#{number}^^^")
+            changeset_string.should include("\rF UdfNum ^2^^^\r")
+        end
+        
+    end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: dsx-dml
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- dgsan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Provides tools to ease working with the DSX Access Systems DML command
+  syntax, an archaic and obnoxious format used by DSX Access Systems' SFTP APIs for
+  making changes to records in their WinDSX SQL access control system's database(s).
+email:
+- dgsan@server.fake
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dsx-dml.gemspec
+- lib/dsx/dml.rb
+- lib/dsx/dml/version.rb
+- spec/dsx/dml_spec.rb
+homepage: https://github.com/dgsan/dsx-dml
+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.0.7
+signing_key: 
+specification_version: 4
+summary: Ease communication with DSX Access Systems' SFTP 'API.'
+test_files:
+- spec/dsx/dml_spec.rb