ultrasoap 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba939da1c7f279494a0088b419718a9b7f15982e
+  data.tar.gz: ef70972332257c84824a87fd2f0e3cb9ee47eeaa
+SHA512:
+  metadata.gz: 0a6e5a79638ff07d3855c7b63d42cf3985c55a94d868696a48b07f19422af0134dbce15fdf2aa699bfac7939704a8af72300f985fd15d56f85a6f479484ad381
+  data.tar.gz: 97c4eab1a249951a82787855eea743a934d322fe23de6df551e59f4bef3103a8ccf17aa74af4bf160c4c0f39d792a3f2aca2be9e055b524be784dfa593e8a052

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'savon'
+gem 'settingslogic'
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 chrean
+
+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,90 @@
+ultrasoap-ruby
+==============
+
+Ruby gem to interact with UltraDNS SOAP API.
+This gem is still in a very early version, so don't expect it to do miracles.
+It just works, basically.
+I plan to extend it, in the future, adding wrappers for the most important UltraDNS functions.
+
+Install
+-------
+
+Just run:
+
+```
+gem install ultrasoap
+```
+
+Add it to your Gemfile:
+
+```
+gem 'ultrasoap'
+```
+
+Finally, require it into your source code:
+
+```
+require 'ultrasoap'
+```
+
+Then create the file ~/.ultrasoap, which has to be in **YAML format**.
+Fill the file with your Neustar credentials, like this:
+
+```yaml
+username: johndoe
+password: secret
+```
+
+You can tune other settings as well, though only credentials are mandatory.
+
+Example:
+
+```yaml
+log_file    : 'ultrasoap.log'
+log         : false
+log_level   : 'error'
+test_wsdl   : 'https://testapi.ultradns.com/UltraDNS_WS/v01?wsdl'
+prod_wsdl   : 'https://ultra-api.ultradns.com/UltraDNS_WS/v01?wsdl'
+transactions: false
+```
+
+So basically you can tune log_file's path, logging level, test and production WSDL, and whether or not your client will use transactions.
+
+Usage
+-----
+
+First off, instantiate UltraSOAP::Client:
+
+```ruby
+dl = UltraSOAP::Client.new()
+```
+
+Secondly, form the message and send it to the API server:
+
+```ruby
+# See SOAP API reference for explanations on parameters and calls
+probes_message = {
+  :pool_record_ID => pool_record_id.to_s,
+  :sort_by        => 'PROBEDATA'
+}
+```
+
+Now you are ready to send the call:
+
+```ruby
+probes_response = dl.send_request :get_probes_of_pool_record, probes_message
+```
+
+For those who didn't get it, the method *send_request* takes 2 parameters:
+1) The symbol of the function to call.
+2) The message containing the parameters for the function, as stated in the reference.
+
+The response is an XML Nodeset, therefore you can perform XPath queries and everything:
+
+```ruby
+probes_response.xpath("//ProbeData").each |probe|
+# Put your loop code here
+...
+...
+end
+```

data/lib/constants.rb

@@ -0,0 +1,19 @@
+require 'singleton'
+
+module UltraSOAP
+  class Constants
+    include Singleton
+    
+    attr_accessor :lb_pool_modes
+
+    def initialize()
+      @lb_pool_modes = { 
+        "force_active_test"   => "ForceActive-Test",
+        "force_active_notest" => "ForceActive-NoTest",
+        "force_fail_test"     => "ForceFail-Test",
+        "force_fail_notest"   => "ForceFail-NoTest",
+        "normal"              => "Normal"
+      }
+    end
+  end
+end

data/lib/settings.rb

@@ -0,0 +1,7 @@
+require 'settingslogic'
+
+module UltraSOAP
+  class Settings < Settingslogic
+    source "#{ENV['HOME']}/.ultrasoap"
+  end
+end

data/lib/ultrasoap.rb

@@ -0,0 +1,199 @@
+require 'savon'
+require 'logger'
+
+module UltraSOAP
+
+  class Client
+
+    # Class variables
+    @logger
+
+    @logdest            = './ultrasoap.log'
+    @logging            = false
+    @log_level          = 'error'
+    @test_wsdl          = 'https://testapi.ultradns.com/UltraDNS_WS/v01?wsdl'
+    @prod_wsdl          = 'https://ultra-api.ultradns.com/UltraDNS_WS/v01?wsdl'
+    @environment        = 'production'
+    @transaction_id     = nil
+    @use_transactions   = false
+
+    class << self
+      attr_accessor :logdest
+      attr_accessor :logging
+      attr_accessor :log_level
+      attr_accessor :transaction_id
+      attr_accessor :test_wsdl
+      attr_accessor :prod_wsdl
+      attr_accessor :environment
+      attr_accessor :use_transactions
+    end
+
+    # Instance variables
+    attr_accessor :logging
+    attr_accessor :loglevel
+
+    # Constructor
+    def initialize()
+      # Exits if username or password aren't specified.
+      return nil unless !(Settings.username.nil? or Settings.password.nil?)
+
+      username = Settings.username
+      password = Settings.password
+
+      @environment = Settings['environment'] || Client.environment
+
+      # We don't need the following to be instance variables
+      ultra_wsdl = (@environment == 'test' ? (Settings['test_wsdl'] || Client.test_wsdl) : (Settings['prod_wsdl'] || Client.prod_wsdl))
+
+      # Setting up parameter values, if provided. If not, defaults are assumed
+
+      @use_transactions = Settings['use_transactions'] || Client.use_transactions
+      @logdest = Settings['logfile'] || Client.logdest
+
+      @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'
+          wsse_auth(username, password)
+          element_form_default :unqualified
+          log logging
+          log_level log_lev.to_sym
+          pretty_print_xml true
+        end
+      rescue Exception => e  
+        @logger.error("Error in ultrasoap.initialize: " + e.message)
+        raise 'Error in ultrasoap initialization, check log file'
+      end
+    end
+
+    # Main method to send SOAP requests
+    #
+    # Parameters:
+    # * method: the SOAP send_request
+    # * message: the message hash
+    def send_request(method, message, strip_namespaces=true)
+      # If the client is using transactions, append the transaction id to the message hash
+      if @use_transactions == true
+        transaction_hash = { :transaction_id => @transaction_id }
+        message.merge(transaction_hash)
+      end
+
+      begin
+        @response = @client.call method, message: message
+        return Nokogiri::XML(@response.to_xml).remove_namespaces!
+      rescue Exception => e
+        @logger.error("Error in ultrasoap.send_request: " + e.message)
+        return nil
+      end
+    end
+
+    # Starts a transaction and sets the @transaction_id variable
+    def transaction_start
+      begin
+        response = self.send_request :start_transaction
+        xml_response = Nokogiri::XML(response.to_xml).remove_namespaces!
+        @transaction_id = xml_response.xpath("//transactionId/text()")
+      rescue Exception => e
+        @logger.error("Error in ultrasoap.transaction_start: " + e.message)
+      end
+    end
+
+    # Rolls back the current transaction
+    def transaction_rollback
+      return nil unless @transaction_id != nil
+
+      message = {
+        :transaction_id => @transaction_id.to_s
+      }
+
+      begin
+        trans_rollback = self.send_request :rollback_transaction, message
+      rescue Exception => e
+        @logger.error("Error in ultrasoap.transaction_rollback: " + e.message)
+      end
+    end
+
+    # Commit the current transaction
+    def transaction_commit
+      return nil unless @transaction_id != nil
+      
+      message = {
+        :transaction_id => @transaction_id.to_s
+      }
+
+      begin
+        trans_commit = self.send_request :commit_transaction, message
+      rescue Exception => e
+        @logger.error("Error in ultrasoap.transaction_commit: " + e.message)
+      end
+    end
+
+    # Helper method to retrieve load balancing pools data
+    # Parameters:
+    # - zone (don't forget the trailing dot)
+    def get_lb_pools(zone)
+      message = {
+        :zone_name    => zone,
+        :lb_pool_type => 'SB'
+      }
+
+      begin
+        response = self.send_request :get_load_balancing_pools_by_zone, message
+        return response
+      rescue Exception => e
+        @logger.error("Error in retrieving SB pools for the zone #{zone}: #{e.message}")
+        return nil
+      end
+    end
+
+    # Helper method to retrieve Pool's records
+    # Parameters:
+    # - poolID
+    def get_pool_records(pool_id)
+      message = {
+        :pool_id => pool_id.to_s
+      }
+
+      begin
+        return self.send_request :get_pool_records, message
+      rescue Exception => e
+        @logger.error("Error while retrieving Pool Records for the Pool ID #{pool_id.to_s}: #{e.message}")
+      end
+    end
+
+    # LOOKUP methods
+
+    def lookup_pool_type(pt_code)
+      case pt_code.to_s
+      when 'SB'
+        'SiteBacker'
+      when 'RD'
+        'Resource Distribution'
+      when 'TC'
+        'Traffic Controller'
+      else
+        'Other'
+      end
+    end
+
+    def lookup_response_method(rm_code)
+      case rm_code.to_s
+      when 'FX'
+        'Fixed'
+      when 'RR'
+        'Round Robin'
+      when 'RD'
+        'Random'
+      end
+    end
+
+  end
+end

data/support/ultrasoap.yaml.sample

@@ -0,0 +1,11 @@
+# Copy this file into ~/.ultrasoap
+# Edit credentials and debug options accordingly to your needs
+# Default values are commented out
+username    : 'johndoe'
+password    : 'secret'
+#log_file    : 'ultrasoap.log'
+#log         : false
+#log_level   : 'error'
+#test_wsdl   : 'https://testapi.ultradns.com/UltraDNS_WS/v01?wsdl'
+#prod_wsdl   : 'https://ultra-api.ultradns.com/UltraDNS_WS/v01?wsdl'
+#transactions: false

data/ultrasoap-ruby.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name          = 'ultrasoap'
+  s.version       = '0.0.5'
+  s.summary       = "Simple Ruby client library for UltraDNS SOAP API"
+  s.description   = "Connect to Neustar's UltraDNS SOAP API. FKA ultrasoap-ruby"
+  s.authors       = ["Gabriel Sambarino"]
+  s.email         = 'gabriel.sambarino@gmail.com'
+  s.files         = `git ls-files`.split("\n")
+  s.homepage      = 'https://github.com/chrean/ultrasoap-ruby'
+  s.license       = "MIT"
+  s.require_paths = ["lib"]
+  s.required_ruby_version = '~> 2.0'
+
+  s.rubyforge_project = s.name
+  s.license = 'MIT'
+
+  s.add_dependency "savon", "~> 2.0"
+  s.add_dependency "settingslogic", "~> 2.0"
+
+  s.add_development_dependency "rspec", "~> 2.10"
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: ultrasoap
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Gabriel Sambarino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: settingslogic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+description: Connect to Neustar's UltraDNS SOAP API. FKA ultrasoap-ruby
+email: gabriel.sambarino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- lib/constants.rb
+- lib/settings.rb
+- lib/ultrasoap.rb
+- support/ultrasoap.yaml.sample
+- ultrasoap-ruby.gemspec
+homepage: https://github.com/chrean/ultrasoap-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ultrasoap
+rubygems_version: 2.3.0
+signing_key: 
+specification_version: 4
+summary: Simple Ruby client library for UltraDNS SOAP API
+test_files: []