dsx-dml 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c0267af52f6079d2061168946dfbfedf3fdb5d5
-  data.tar.gz: b667fcf06038eba5823c6d5c3fb27c226f4448ba
+  metadata.gz: ee65d248642ebe915e7779d3890c2ee7a626d7f7
+  data.tar.gz: 7c56bd0ae94de68ab040f80f22e4c02f43684bf1
 SHA512:
-  metadata.gz: 30f256ae7964fb6409af0741443c40f567e6db6aa54672d297e851159aa65190f8976cb1869e5e8196c05ed8d044bf1ef2772c6793f63f943864a0448a218d13
-  data.tar.gz: 0f1c0aae389746b2d12f1eb7af8d761ca8c8c4a67df21924a8decbb369b60cdbc3913d54a0efd94d467b983498c7c26bbffe3b36452b268e1bf2e500bbddf8d1
+  metadata.gz: 997a72a1e468cc4b62716699dfc6a30d6a62107cd6829f94ccbc9bec18c0b21a9ad20e53ee127a98e7073f365cd06897a6a303c14a18ce48845f9f2d7d9411c5
+  data.tar.gz: 7a77e00e412a7ced0c56edae4ea3689ddc70f98a04829960b24948933924e49653cd5efb66395143dfdc711568a3996e8b70a66de38f75872739527634847dc6

data/README.md

@@ -18,13 +18,17 @@ Or install it yourself as:
 
 ## Usage
 
+
+### Zones (Locations) and Changesets (Batches of commands)
+
 ```ruby
 require 'dsx/dml'
 
 
-# Declare what Location Number (zone) to make changes in and set the UDF field for UID string
+# Declare what Location Number (zone) to make changes in and set the UDF field for UID string. 
+# Optionally include sftp credentials.
 
-zone = Dsx::Dml::Zone.new(1111, 2)
+zone = Dsx::Dml::Zone.new(1111, 2, {address: '127.0.0.1', user: 'dsx_user', password: 'dsx_password'})
 
 
 # Use a unique identifier to create a changeset for that unique identifier
@@ -43,7 +47,7 @@ changeset_0.table('Names').write({
             Notes: 'Often wears bowties'
         }).table('UDF').write({
             UdfNum: 2,
-            UdfText: number
+            UdfText: '123456789100'
         }).table('Cards').write({
             Code: '123456789100',
             PIN: 1234,
@@ -57,17 +61,68 @@ changeset_0.table('Names').write({
 
 changeset_1 = zone.use('123456789101')
 
-changeset_1.table('Cards').add_acl('Parking Garage')
+changeset_1.table('Cards').add_acl('Parking Garage').write()
 
 
-# Push changesets to SFTP receiver
+# Push changesets to SFTP receiver (using the credentials passed to Zone.new)
 
-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' })
+changeset_0.net_sftp() # Uses ruby Net::SFTP library
+changeset_1.curl() # requires system curl with SFTP support
 
 
 ```
 
+### Operations
+
+`Dsx::Dml::Operation` is a wraper intended to make it easier to set up and use certain DML operations.
+
+```ruby
+    require 'dsx/operation'
+
+    op = Dsx::Dml::Operation.new({ location_num:  1111, 
+                                   udf_num:       2, 
+                                   first_name:    'Harry', 
+                                   last_name:     'Bird', 
+                                   company:       'Harry Bird Co', 
+                                   identifier:    '123456789100' },
+                                 { address: '127.0.0.1', 
+                                   user: 'dsx_user',
+                                   password: 'dsx_password' })
+    op.access_levels += ['Top Secret Lab 1', 'Top Secret Lab 2']
+    op.access_levels -= ['Super Secret Lab 0']
+    op.linking_level = 3
+    
+    op.net_sftp()
+
+```
+
+### Writer
+
+`Dsx::Dml::Writer` is used to push commands to DSX SFTP endpoints. Supports `Net::SFTP` and `curl`.
+
+While writer credentials can be passed through to `Dsx::Dml::Operation` and `Dsx::Dml::Zone`, writers 
+can also be instantiated separately and passed at write time.
+
+```ruby
+    
+    require 'dsx/operation'
+    require 'dsx/writer'
+
+    writer = Dsx::Dml::Writer.new({ address: '127.0.0.1', 
+                                   user: 'dsx_user',
+                                   password: 'dsx_password' })
+
+    op = Dsx::Dml::Operation.new({ location_num:  1111, 
+                                   udf_num:       2, 
+                                   first_name:    'Harry', 
+                                   last_name:     'Bird', 
+                                   company:       'Harry Bird Co', 
+                                   identifier:    '123456789100' })
+    op.access_levels += ['Top Secret Lab 3']
+
+    op.net_sftp(writer)
+    
+```
 
 
 ## Contributing

data/lib/dsx/dml.rb

@@ -5,11 +5,11 @@ module Dsx
     
     class Zone
 
-      def initialize(location_num, udf_field_num, writer = false)
+      def initialize(location_num, udf_field_num, writer_options=false)
         @location_num = location_num
         @udf_field_num = udf_field_num
-        if(writer)
-          @writer = writer
+        if(writer_options)
+          @writer = Dsx::Dml::Writer.new(writer_options)
         end
       end
       

data/lib/dsx/dml/version.rb

@@ -1,5 +1,5 @@
 module Dsx
   module Dml
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/dsx/operation.rb

@@ -9,9 +9,9 @@ module Dsx
   
     class Operation
     
-        def initialize(details, writer = false)
+        def initialize(details, writer_options = false)
           initialize_details(details)
-          initialize_command(writer)
+          initialize_command(writer_options)
           
         end
         
@@ -60,10 +60,18 @@ module Dsx
           @changeset.to_s
         end
         
+        def net_sftp(writer=false)
+          @changeset.net_sftp(writer)
+        end
+        
+        def curl(writer=false)
+          @changeset.curl(writer)
+        end
+        
         private
         
-        def initialize_command(writer=false)
-          @zone = (writer) ? Zone.new(@location_num, @udf_num, writer) : Zone.new(@location_num, @udf_num)
+        def initialize_command(writer_options=false)
+          @zone = (writer_options) ? Zone.new(@location_num, @udf_num, writer_options) : Zone.new(@location_num, @udf_num)
           changeset = @zone.use(@identifier)
           changeset.table(:Names).write(FName: @first_name, 
                                          LName: @last_name, 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsx-dml
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - dgsan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2013-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler