ultrasoap 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 507ea593167429507f8f5a47997780f19e61ce30
-  data.tar.gz: ef8bba16c630b6f9c2460112c3adce843595cfc3
+  metadata.gz: 7d01f25bb8ce7753f612d44fa748e1d5fd75f955
+  data.tar.gz: f711d478f5ea642f86f83e7959960494d32e4765
 SHA512:
-  metadata.gz: eadaebea9c0581a8ceb5c408a607661b7f886e9f5432df058952d74b0c620a5ebd5c0f6ef48eaf608351fb66fac8ec56eec1d5a615c682404c0109d3b69f7803
-  data.tar.gz: 41e2a9e910cdc75d768b2ba134b5f58c51eaa21c3939ef96bb4e8712a4d07868e16aa9ba97a634a163322d67feed7e25f9d97488634be580bd9f05c09ea8b99b
+  metadata.gz: 4cb63cf681c0aa40fb5a48132646672545776e099fe911527c483ba74152ce527b3074f114776d7423dd0a463819efb92a4e85e4e5f4b69289b97ff2aa4655bd
+  data.tar.gz: 4b10f30d44b8a34ffd0922d0278b09d404e403afb29c00076ef86575f800cc725b744d374a6cffaca79edb5f4da99ae6bebe18d478998e3b23279f2a24c10e3b

data/README.md

@@ -91,3 +91,44 @@ probes_response.xpath("//ProbeData").each |probe|
 ...
 end
 ```
+
+There is also a rudimentary and experimental support for transactions.
+Once you have instantiated the client, you can invoke the following methods:
+
+```ruby
+dl.start_transaction
+
+dl.commit_transaction
+
+dl.rollback_transaction
+```
+
+As soon as the transactions support will be thoroughly tested and will reach a stable status, I'll update the documentation with some example.
+
+Wrapper functions
+-----------------
+
+Although is possible to call all functions via the generic *send_request* method, I've started to implement some builtin function, which wraps the API functions themselves and should facilitate their invoking.
+
+These functions require less writing and can be used without having to pre-form a message hash. They just need a couple of parameters.
+
+All functions return a Nokogiri::Nodeset, just like send_request.
+
+The current version supports the following functions:
+
+```ruby
+# Enumerate all Load Balancing pools for the required zone
+# Parameters:
+# - zone      => the name of the zone, *including* the trailing dot
+# - pool_type => the type of the pool. Defaults to SB => SiteBacker . See the reference manual to learn more.
+
+get_lb_pools(zone, pool_type='SB')
+
+# Returns all the records for a certain load balancing pool
+# Parameters:
+# - pool_id => the ID of the pool
+get_pool_records(pool_id)
+
+```
+
+More functions are on the way (lookup functions and other stuff).

data/lib/client.rb

@@ -7,6 +7,7 @@ module UltraSOAP
 
     @logger
 
+    # Would like to find a better place for defaults, rather than here
     @logdest            = './ultrasoap.log'
     @logging            = false
     @log_level          = 'error'
@@ -54,12 +55,9 @@ module UltraSOAP
       @logger = Logger.new(@logdest)
       
       logging = Settings['logging'] || Client.logging
-
       log_lev = Settings['log_level'] || Client.log_level
 
       begin
-        # For some reason, if I use the instance variable, Savon.client doesn't work properly
-
         @client = Savon.client do
           wsdl ultra_wsdl
           env_namespace 'soapenv'
@@ -92,6 +90,8 @@ module UltraSOAP
         return Nokogiri::XML(@response.to_xml).remove_namespaces!
       rescue Exception => e
         @logger.error("Error in ultrasoap.send_request: " + e.message)
+        # Rollback current transaction, if any
+        transaction_rollback unless @transaction_id == nil
         return nil
       end
     end
@@ -140,10 +140,10 @@ module UltraSOAP
     # Helper method to retrieve load balancing pools data
     # Parameters:
     # - zone (don't forget the trailing dot)
-    def get_lb_pools(zone)
+    def get_lb_pools(zone, pool_type='SB')
       message = {
         :zone_name    => zone,
-        :lb_pool_type => 'SB'
+        :lb_pool_type => pool_type
       }
 
       begin
@@ -157,7 +157,7 @@ module UltraSOAP
 
     # Helper method to retrieve Pool's records
     # Parameters:
-    # - poolID
+    # - pool_id
     def get_pool_records(pool_id)
       message = {
         :pool_id => pool_id.to_s
@@ -170,9 +170,49 @@ module UltraSOAP
       end
     end
 
+    # Returns a list of probes for the given pool record
+    # Parameters:
+    # - poolRecordID
+    # - SortBy, possible values are: 
+    #   PROBEID
+    #   PROBEDATA
+    #   PROBEFAILSPECS
+    #   ACTIVE
+    #   POOLID
+    #   AGENTFAILSPECS
+    #   PROBEWEIGHT
+    #   BLEID
+    def get_probes_of_pool_record(pool_record_id, sort_by="PROBEDATA")
+      message = {
+        :pool_record_ID => pool_record_id.to_s,
+        :sort_by        => sort_by
+      }
+
+      begin
+        return self.send_request :get_probes_of_pool_record, message
+      rescue Exception => e
+        @logger.error("Error while retrieving probes for pool record ID #{pool_record_id.to_s}: #{e.message}")
+      end
+    end
+
+    # Returns notifications for a pool
+    # Parameters:
+    # - poolID: string
+    def get_notifications_of_pool(pool_id)
+      message = {
+        :pool_id => pool_id
+      }
+
+      begin
+        return self.send_request :get_notifications_of_pool, message
+      rescue Exception => e
+        @logger.error("Error while retrieving notifications for pool ID #{pool_id}: #{e.message}")
+      end
+    end
+
     # LOOKUP methods
 
-    def lookup_pool_type(pt_code)
+    def lookup_pool_type(pt_code='SB')
       case pt_code.to_s
       when 'SB'
         'SiteBacker'
@@ -185,7 +225,7 @@ module UltraSOAP
       end
     end
 
-    def lookup_response_method(rm_code)
+    def lookup_response_method(rm_code='FX')
       case rm_code.to_s
       when 'FX'
         'Fixed'

data/ultrasoap-ruby.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name          = 'ultrasoap'
-  s.version       = '0.1.2'
+  s.version       = '0.1.3'
   s.summary       = "Simple Ruby client library for UltraDNS SOAP API"
-  s.description   = "Connect to Neustar's UltraDNS SOAP API.\nFKA ultrasoap-ruby.\nAny feedback or contribution is appreciated."
+  s.description   = "Connect to Neustar's UltraDNS SOAP API. FKA ultrasoap-ruby. Any feedback or contribution is appreciated."
   s.authors       = ["Gabriel Sambarino"]
   s.email         = 'gabriel.sambarino@gmail.com'
   s.files         = `git ls-files`.split("\n")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultrasoap
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Gabriel Sambarino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-20 00:00:00.000000000 Z
+date: 2014-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -52,10 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.10'
-description: |-
-  Connect to Neustar's UltraDNS SOAP API.
-  FKA ultrasoap-ruby.
-  Any feedback or contribution is appreciated.
+description: Connect to Neustar's UltraDNS SOAP API. FKA ultrasoap-ruby. Any feedback
+  or contribution is appreciated.
 email: gabriel.sambarino@gmail.com
 executables: []
 extensions: []