junos-space-api 0.2.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Scott Ware
+
+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,41 @@
+## junos-ruby-space-api
+
+This program is used to interact with the Junos Space REST API, using Ruby. The following additional
+gems are required:
+
+- `rest-client`
+- `nokogiri`
+- `ipaddress`
+
+These can all be installed by issuing `gem install <gem>` on the command line.
+
+### Web Services Available
+
+Here are the current web services available so far in this API:
+
+*Platform*
+
+- Job Management
+- Device Management
+
+*Security Director*
+
+- Address Management
+- Service Management
+- Device Management
+
+Please see [Juniper's documentation][2] for the full release notes on the Security Director API.
+
+I will be adding more functionality/web services soon, so please keep checking back!
+
+### Documentation & Usage
+
+Check out the [Wiki][1] for documentation on the different Classes and their respective methods.
+
+### Examples
+
+Check out the `examples` directory to browse through some samples of what this API can do!
+
+
+[1]: https://github.com/scottdware/junos-ruby-space-api/wiki
+[2]: http://www.juniper.net/techpubs/en_US/junos-space13.1/information-products/topic-collections/junos-space-security-designer/security-director-api.pdf

data/examples/add_device.rb

@@ -0,0 +1,19 @@
+require 'junos-space-api/platform'
+require 'pp'
+
+user = 'me'
+pass = 'somepass'
+server = 'space.company.com'
+
+JunosSpace.open('user', 'pass', 'server')
+devices = JunosSpace::Platform::Device.new
+
+data = {
+  'host' => '10.10.10.1',
+  'snmp' => 'false',
+  'user' => 'sshuser',
+  'pass' => 'sshpass'
+}
+
+# Will return the job ID (i.e. {"status"=>"9990001"}
+pp devices.add_device(data)

data/examples/addresses.rb

@@ -0,0 +1,29 @@
+require 'junos-space-api/sd'
+require 'pp'
+
+user = 'me'
+pass = 'somepass'
+server = 'space.company.com'
+
+JunosSpace.open('user', 'pass', 'server')
+addrs = JunosSpace::SD::Address.new
+
+data = {
+  'name' => 'my-home-network',
+  'type' => 'network',
+  'ip' => '192.168.1.0/24',
+  'desc' => 'My home network',
+  'version' => 'v4'
+}
+
+# Will get a list of all of the address objects.
+pp addrs.addresses
+
+# Will add a new address object to Junos Space.
+pp addrs.add_address(data)
+
+# Will return information about the address object.
+pp addrs.address_info('my-home-network')
+
+# Will delete the address object.
+pp addrs.delete_address('my-home-network')

data/examples/jobs.rb

@@ -0,0 +1,18 @@
+require 'junos-space-api/platform'
+require 'pp'
+
+user = 'me'
+pass = 'somepass'
+server = 'space.company.com'
+
+JunosSpace.open('user', 'pass', 'server')
+jobs = JunosSpace::Platform::Job.new
+
+# Will return all jobs with a status of SUCCESS
+pp jobs.jobs('success')
+
+# Will return all jobs with a status of FAILURE
+pp jobs.jobs('failure')
+
+# Will return information about the job ID 9990001
+pp jobs.job_info('9990001')

data/examples/sec_device.rb

@@ -0,0 +1,12 @@
+require 'junos-space-api/sd'
+require 'pp'
+
+user = 'me'
+pass = 'somepass'
+server = 'space.company.com'
+
+JunosSpace.open('user', 'pass', 'server')
+secdev = JunosSpace::SD::Device.new
+
+# Will return the security device information (i.e. zones, interfaces, etc.)
+pp secdev.device_info('corporate-firewall')

data/examples/services.rb

@@ -0,0 +1,26 @@
+require 'junos-space-api/sd'
+require 'pp'
+
+user = 'me'
+pass = 'somepass'
+server = 'space.company.com'
+
+JunosSpace.open('user', 'pass', 'server')
+services = JunosSpace::SD::Service.new
+
+data = {
+  'name' => 'my-custom-service',
+  'port' => '60001'
+}
+
+# Will get a list of all of the services.
+pp services.services
+
+# Will add a new service object to Junos Space.
+pp services.add_service(data)
+
+# Will return information about the service object.
+pp services.service_info('my-custom-service')
+
+# Will delete the service object.
+pp services.delete_service('my-custom-service')

data/junos-space-api.gemspec

@@ -0,0 +1,13 @@
+require 'rake'
+
+Gem::Specification.new do |s|
+    s.license           = 'MIT'
+    s.name              = 'junos-space-api'
+    s.version           = '0.2.0'
+    s.summary           = 'Interact with the Junos Space REST API.'
+    s.description       = 'This gem is used to interact with Juniper Networks Junos Space management platform using the REST API.'
+    s.authors           = ["Scott Ware"]
+    s.email             = 'scottdware@gmail.com'
+    s.files             = FileList['*', 'lib/**/*.rb', 'examples/*.rb']
+    s.homepage          = 'https://github.com/scottdware/junos-ruby-space-api'
+end

data/lib/junos-space-api/platform.rb

@@ -0,0 +1,2 @@
+require 'junos-space-api/platform/job'
+require 'junos-space-api/platform/device'

data/lib/junos-space-api/platform/device.rb

@@ -0,0 +1,106 @@
+require 'rest-client'
+require 'nokogiri'
+require 'ipaddress'
+require 'junos-space-api/space'
+
+class JunosSpace::Platform::Device
+  @@devices_uri = '/api/space/device-management/devices'
+  @@discover_uri = '/api/space/device-management/discover-devices'
+  @@device_headers = {
+    :content_type => 'application/vnd.net.juniper.space.device-management.discover-devices+xml;version=2;charset=UTF-8'
+  }
+  @@queue_headers = {
+    :content_type => 'application/hornetq.jms.queue+xml'
+  }
+  @@ucase = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
+  @@dcase = 'abcdefghijklmnopqrstuvwxyz'
+  
+  # devices
+  #
+  # Returns a Hash of all of the devices in the Junos Space database. The
+  # device name is the key, and value is an array of the following:
+  # device id, family, Junos version, platform, serial number, 
+  # connection status, IP address, and managed status.
+  #
+  def devices
+    result = {}
+    
+    begin
+      res = RestClient.get("#{JunosSpace.base_uri}#{@@devices_uri}")
+      doc = Nokogiri::XML::Document.parse(res)
+
+      doc.xpath('//device').each do |device|
+        stats = []
+        stats << device.xpath('@key').text
+        stats << device.xpath('deviceFamily').text
+        stats << device.xpath('OSVersion').text
+        stats << device.xpath('platform').text
+        stats << device.xpath('serialNumber').text
+        stats << device.xpath('connectionStatus').text
+        stats << device.xpath('ipAddr').text
+        stats << device.xpath('managedStatus').text
+        
+        result[device.xpath('name').text] = stats
+      end
+      
+      return result
+    rescue RestClient::Unauthorized
+      result['status'] = '401 Error - Auth failure (bad username/password).'
+      
+      return result
+    end
+  end
+  
+  # add_device(data)
+  #
+  # Add a new device to the Junos Space database, with the given information
+  # in 'data'. 'data' is a Hash table with the following structure:
+  #
+  # `host => IP address or hostname of device`,
+  # `snmp => Use SNMP during discovery: 'community string' or 'false'`,
+  # `user => SSH username for device`,
+  # `pass => SSH password for device`
+  #
+  # Returns a Hash with 'status' as the key, and the job ID as the value.
+  #
+  def add_device(data)
+    result = {}
+    
+    begin
+      rand = Random.rand(999999)
+      server = JunosSpace.base_uri.split('@')[1]
+      queue_xml = "<queue name='d#{rand}'><durable>false</durable></queue>"
+      RestClient.post("#{JunosSpace.base_uri}/api/hornet-q/queues", queue_xml, @@queue_headers)
+      queue_url = "https://#{server}/api/hornet-q/queues/jms.queue.d#{rand}"
+      
+      xml = "<discover-devices>"
+      
+      if IPAddress.valid?(data['host'])
+        xml += "<ipAddressDiscoveryTarget><ipAddress>#{data['host']}</ipAddress></ipAddressDiscoveryTarget>"
+      else
+        xml += "<hostNameDiscoveryTarget><hostName>#{data['host']}</hostName></hostNameDiscoveryTarget>"
+      end
+      
+      if data['snmp'] != 'false'
+        xml += "<useSnmp>true</useSnmp><snmpV1Setting><communityName>#{data['snmp']}</communityName></snmpV1Setting>"
+      else
+        xml += "<manageDiscoveredSystemsFlag>true</manageDiscoveredSystemsFlag><sshCredential>" +
+               "<userName>#{data['user']}</userName><password>#{data['pass']}</password></sshCredential>" +
+               "</discover-devices>"
+      end
+      
+      res = RestClient.post("#{JunosSpace.base_uri}#{@@discover_uri}?queue-url=#{queue_url}", xml, @@device_headers)
+      doc = Nokogiri::XML::Document.parse(res)
+      
+      if res.code == 202
+        result['status'] = doc.xpath('//task/id').text
+      end
+      
+      return result
+    rescue RestClient::Unauthorized
+      result['status'] = '401 Error - Auth failure (bad username/password).'
+      
+      return result
+    end
+  end
+end

data/lib/junos-space-api/platform/job.rb

@@ -0,0 +1,87 @@
+require 'rest-client'
+require 'nokogiri'
+require 'junos-space-api/space'
+
+class JunosSpace::Platform::Job
+  @@job_uri = '/api/space/job-management/jobs'
+  @@ucase = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
+  @@dcase = 'abcdefghijklmnopqrstuvwxyz'
+  
+  # jobs(status)
+  #
+  # Returns a Hash of all of the jobs in Space with the status
+  # 'status'. Where 'status' can be one of: 'success', 'failure',
+  # 'inprogress', or 'cancelled'. If no status is given, then all of the jobs are
+  # returned. The name of the job is the key, and the ID is the value.
+  #
+  def jobs(status)
+    result = {}
+    
+    begin
+      res = RestClient.get("#{JunosSpace.base_uri}#{@@job_uri}")
+      doc = Nokogiri::XML::Document.parse(res)
+
+      if status
+        doc.xpath("//job[contains(translate(status, '#{@@ucase}', '#{@@dcase}'), translate('#{status}', '#{@@ucase}', '#{@@dcase}'))]").each do |job|
+          name = job.xpath('name').text
+          id = job.xpath('@key').text
+          
+          result[name] = id
+        end
+        
+        if result.size == 0
+          result['status'] = "No jobs found with status: #{status.downcase}."
+        end
+      else
+        doc.xpath("//job").each do |job|
+          name = job.xpath('name').text
+          id = job.xpath('@key').text
+          
+          result[name] = id
+        end
+      end
+      
+      return result
+    rescue RestClient::Unauthorized
+      result['status'] = '401 Error - Auth failure (bad username/password).'
+      
+      return result
+    end
+  end
+  
+  # job_info(job)
+  #
+  # Returns information about the job 'job'. This information is returned in a Hash
+  # with the job ID, name, percentage complete, status, job type, summary, user
+  # who issued the job, and the time the job was started.
+  #
+  def job_info(job)
+    result = {}
+    
+    begin
+      res = RestClient.get("#{JunosSpace.base_uri}#{@@job_uri}/#{job}")
+      doc = Nokogiri::XML::Document.parse(res)
+
+      doc.xpath('//job').each do |job|
+        result["id"] = job.xpath('id').text
+        result["name"] = job.xpath('name').text
+        result["percent"] = job.xpath('percent').text
+        result["status"] = job.xpath('status').text
+        result["job-type"] = job.xpath('jobType').text
+        result["summary"] = job.xpath('summary').text
+        result["time"] = job.xpath('scheduledStartTime').text
+        result["user"] = job.xpath('user').text
+      end
+      
+      return result
+    rescue RestClient::Unauthorized
+      result['status'] = '401 Error - Auth failure (bad username/password).'
+      
+      return result
+    rescue RestClient::ResourceNotFound
+      result['status'] = "404 Error - No job found with ID: #{job}."
+      
+      return result
+    end
+  end
+end

data/lib/junos-space-api/sd.rb

@@ -0,0 +1,3 @@
+require 'junos-space-api/sd/address'
+require 'junos-space-api/sd/service'
+require 'junos-space-api/sd/device'

data/lib/junos-space-api/sd/address.rb

@@ -0,0 +1,176 @@
+require 'rest-client'
+require 'nokogiri'
+require 'junos-space-api/space'
+
+class JunosSpace::SD::Address
+  @@address_uri = '/api/juniper/sd/address-management/addresses'
+  @@address_headers = {
+    :content_type => "application/vnd.juniper.sd.address-management.address+xml;version=1;charset=UTF-8"
+  }
+  @@ucase = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
+  @@dcase = 'abcdefghijklmnopqrstuvwxyz'
+  
+  # addresses
+  #
+  # Returns a Hash of all of the address objects in Space. The name
+  # of the object is the key, and the ID is the value.
+  #
+  def addresses
+    result = {}
+    
+    begin
+      res = RestClient.get("#{JunosSpace.base_uri}#{@@address_uri}")
+      doc = Nokogiri::XML::Document.parse(res)
+
+      doc.xpath('//address').each do |address|
+        name = address.xpath('name').text
+        id = address.xpath('id').text
+        
+        result[name] = id
+      end
+      
+      return result
+    rescue RestClient::Unauthorized
+      result['status'] = '401 Error - Auth failure (bad username/password).'
+      
+      return result
+    end
+  end
+  
+  # address_info(name)
+  #
+  # Searches for address object 'name' and returns a Hash with the address
+  # object(s) name as the key, and the IP address as the value.
+  # If the address object(s) are a group, then the value within
+  # the Hash is an array of the address object names within the group(s).
+  #
+  def address_info(name)
+    result = {}
+    
+    begin
+      res = RestClient.get("#{JunosSpace.base_uri}#{@@address_uri}", :params => {:filter => "(global eq '#{name}')"})
+      doc = Nokogiri::XML::Document.parse(res)
+      count = doc.xpath('//addresses/@total').text
+      
+      if count == "0"
+        result['status'] = 'No address object(s) found.'
+      else
+        doc.xpath("//address[contains(translate(name, '#{@@ucase}', '#{@@dcase}'), translate('#{name}', '#{@@ucase}', '#{@@dcase}'))]").each do |address|
+          name = address.xpath('name').text
+          type = address.xpath('address-type').text
+          id = address.xpath('id').text
+          
+          if type != 'GROUP'
+            address.xpath('//address').each do |info|
+              ip = info.xpath('ip-address').text
+              result[name] = ip
+            end
+          elsif type == 'GROUP'
+            res = RestClient.get("#{JunosSpace.base_uri}#{@@address_uri}/#{id}")
+            doc = Nokogiri::XML::Document.parse(res)
+            
+            group_members = []
+            doc.xpath('//member').each do |member|
+              member_name = member.xpath('name').text
+              member_ip = member.xpath('ip-address').text
+              group_members << member_name
+            end
+            result[name] = group_members
+          end
+        end
+      end
+      
+      return result
+    rescue RestClient::Unauthorized
+      result['status'] = '401 Error - Auth failure (bad username/password).'
+      
+      return result
+    end
+  end
+  
+  # add_address(data)
+  #
+  # This method will add a new address object to Space give the information
+  # in 'data'. This information is a Hash with the following structure:
+  #
+  # `name => Name of the object you want to create`, 
+  # `type => Either 'address' or 'network'`,
+  # `ip => IP address or subnet/mask`,
+  # `desc => Description (optional)`,
+  # `version => Either 'v4' or 'v6'`
+  #
+  def add_address(data)
+  result = {}
+  type = data['type'] == 'address' ? 'IPADDRESS' : 'NETWORK'
+    version = data['version'] == 'v4' ? 'IPV4' : 'IPV6'
+    if data['desc']
+      desc = data['desc']
+    else
+      desc = ''
+    end
+    
+    xml = "<address><name>#{data['name']}</name><address-type>#{type}</address-type>" +
+          "<host-name/><edit-version/><members/><address-version>#{version}</address-version>" +
+          "<definition-type>CUSTOM</definition-type><ip-address>#{data['ip']}</ip-address>" +
+          "<description>#{desc}</description></address>"
+
+    begin
+      res = RestClient.post("#{JunosSpace.base_uri}#{@@address_uri}", xml, @@address_headers)
+      
+      if res.code == 200
+        result['status'] = '200 OK - Success'
+      end
+      
+      return result
+    rescue RestClient::Unauthorized
+      result['status'] = '401 Error - Auth failure (bad username/password).'
+      
+      return result
+    rescue RestClient::InternalServerError
+      result['status'] = '500 Error - Check and see if the device already exists.'
+      
+      return result
+    end
+  end
+  
+  # delete_address(name)
+  #
+  # Deletes the object matching the name 'name'. If more than one address object
+  # is found during the search, then send a warning to refine the search (i.e.
+  # use the exact name if possible).
+  #
+  def delete_address(name)
+    result = {}
+    
+    begin
+      res = RestClient.get("#{JunosSpace.base_uri}#{@@address_uri}", :params => {:filter => "(global eq '#{name}')"})
+      doc = Nokogiri::XML::Document.parse(res)
+      headers = {
+        :content_type => 'application/vnd.juniper.sd.address-management.delete-address-response+xml;version=1;q=0.01'
+      }
+      num_results = doc.xpath('//addresses/@total').text
+      
+      if num_results == "0"
+        result['status'] = 'Address object does not exist.'
+      elsif num_results.to_i > 1
+        result['status'] = 'More than one object was found. Please refine your search (use the exact name if possible).'
+      else
+        doc.xpath("//address[contains(translate(name, '#{@@ucase}', '#{@@dcase}'), translate('#{name}', '#{@@ucase}', '#{@@dcase}'))]").each do |address|
+          id = address.xpath('id').text
+
+          res = RestClient.delete("#{JunosSpace.base_uri}#{@@address_uri}/#{id}", headers)
+          
+          if res == ''
+            result['status'] = '200 OK - Success.'
+          end
+        end
+      end
+
+      return result
+    rescue RestClient::Unauthorized
+      result['status'] = '401 Error - Auth failure (bad username/password).'
+      
+      return result
+    end
+  end
+end

data/lib/junos-space-api/sd/device.rb

@@ -0,0 +1,114 @@
+require 'rest-client'
+require 'nokogiri'
+require 'junos-space-api/space'
+
+class JunosSpace::SD::Device
+  @@device_uri = '/api/juniper/sd/device-management/devices'
+  
+  # devices
+  #
+  # Returns a Hash of all of the device objects in Space. The name
+  # of the device is the key, and the ID is the value.
+  #
+  def devices
+    result = {}
+    
+    begin
+      res = RestClient.get("#{JunosSpace.base_uri}#{@@device_uri}")
+      doc = Nokogiri::XML::Document.parse(res)
+
+      doc.xpath('//device').each do |device|
+        name = device.xpath('name').text
+        id = device.xpath('id').text
+        
+        result[name] = id
+      end
+      
+      return result
+    rescue RestClient::Unauthorized
+      result['status'] = '401 Error - Auth failure (bad username/password).'
+      
+      return result
+    end
+  end
+  
+  # device_info(name)
+  #
+  # Returns a Hash of resultrmation about the given device 'name'. For zones,
+  # it returns Hash where the zone name is the key, and an array of interfaces
+  # that are in said zone as the value.
+  #
+  # For interfaces, it returns a Hash where the interface name is the key, and
+  # the IP address of that interface is the value.
+  #
+  def device_info(name)
+    result = {}
+    devices = self.devices
+    
+    begin
+      res = RestClient.get("#{JunosSpace.base_uri}#{@@device_uri}/#{devices[name]}")
+      doc = Nokogiri::XML::Document.parse(res)
+      
+      if !devices[name]
+        result['status'] = 'No device(s) found.'
+      else
+        doc.xpath('//device').each do |device|
+          result["management-status"] = device.xpath('management-status').text,
+          result["name"] = device.xpath('name').text,
+          result["platform"] = device.xpath('platform').text,
+          result["ip"] = device.xpath('device-ip').text,
+          result["config-status"] = device.xpath('configuration-status').text,
+          result["connection-status"] = device.xpath('connection-status').text,
+          result["family"] = device.xpath('device-family').text,
+          result["version"] = device.xpath('software-release').text,
+          result["id"] = device.xpath('id').text
+          
+          zone_uri = device.xpath('Zone/@href').text
+          int_uri = device.xpath('Interfaces/@href').text
+
+          zone_res = RestClient.get("#{JunosSpace.base_uri}#{zone_uri}")
+          zone_doc = Nokogiri::XML::Document.parse(zone_res)
+          int_res = RestClient.get("#{JunosSpace.base_uri}#{int_uri}")
+          int_doc = Nokogiri::XML::Document.parse(int_res)
+          
+          zones = []
+          zone_doc.xpath('//zone').each do |zone|
+            zone_ints = []
+            zone_result = {}
+            name = zone.xpath('name').text
+            
+            zone.xpath('./interfaces').each do |int|
+              int.xpath('./interface').each do |interface|
+                zone_ints << interface.text
+              end
+            end
+            
+            zone_result[name] = zone_ints
+            zones << zone_result
+          end
+          
+          result["zones"] = zones
+
+          interfaces = []
+          int_doc.xpath('//interface').each do |int|
+            int_result = {}
+            name = int.xpath('name').text
+            ip = int.xpath('ip-addr').text
+            mask = int.xpath('ip-netmask').text
+            int_result[name] = "#{ip}/#{mask}"
+            
+            interfaces << int_result
+          end
+          
+          result["interfaces"] = interfaces
+        end
+      end
+      
+      return result
+    rescue RestClient::Unauthorized
+      result['status'] = '401 Error - Auth failure (bad username/password).'
+      
+      return result
+    end
+  end
+end

data/lib/junos-space-api/sd/service.rb

@@ -0,0 +1,175 @@
+require 'rest-client'
+require 'nokogiri'
+require 'junos-space-api/space'
+
+class JunosSpace::SD::Service
+  @@service_uri = '/api/juniper/sd/service-management/services'
+  @@service_headers = {
+    :content_type => "application/vnd.juniper.sd.service-management.service+xml;version=1;charset=UTF-8"
+  }
+  @@ucase = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
+  @@dcase = 'abcdefghijklmnopqrstuvwxyz'
+  
+  # services
+  #
+  # Returns a Hash of all of the individual service objects in Space.
+  # The name of the service is the key, and the ID is the value.
+  #
+  def services
+    result = {}
+    
+    begin
+      res = RestClient.get("#{JunosSpace.base_uri}#{@@service_uri}")
+      doc = Nokogiri::XML::Document.parse(res)
+      
+      doc.xpath('//service').each do |service|
+        name = service.xpath('name').text
+        id = service.xpath('id').text
+       
+        result[name] = id
+      end
+      
+      return result
+    rescue RestClient::Unauthorized
+      result['status'] = '401 Error - Auth failure (bad username/password).'
+      
+      return result
+    end
+  end
+
+  # service_info(name)
+  #
+  # Searches for the service 'name' and returns a Hash with the service
+  # object(s) name as the key, and the ID as the value.
+  # If the service object(s) are a group, then the value within
+  # the Hash is an array of the service object names within the group(s).
+  #
+  def service_info(name)
+    result = {}
+    
+    begin
+      res = RestClient.get("#{JunosSpace.base_uri}#{@@service_uri}", :params => {:filter => "(global eq '#{name}')"})
+      doc = Nokogiri::XML::Document.parse(res)
+      count = doc.xpath('//services/@total').text
+      
+      if count == "0"
+        result['status'] = 'No service object(s) found.'
+      else
+        doc.xpath("//service[contains(translate(name, '#{@@ucase}', '#{@@dcase}'), translate('#{name}', '#{@@ucase}', '#{@@dcase}'))]").each do |service|
+          group = service.xpath('is-group').text
+          name = service.xpath('name').text
+          id = service.xpath('id').text
+          
+          if group == 'false'
+            res = RestClient.get("#{JunosSpace.base_uri}#{@@service_uri}/#{id}")
+            doc = Nokogiri::XML::Document.parse(res)
+            
+            doc.xpath('//protocol').each do |info|
+              dst_port = info.xpath('dst-port').text
+              result[name] = dst_port
+            end
+          elsif group == 'true'
+            res = RestClient.get("#{JunosSpace.base_uri}#{@@service_uri}/#{id}")
+            doc = Nokogiri::XML::Document.parse(res)
+            
+            group_members = []
+            doc.xpath('//member').each do |member|
+              member_name = member.xpath('name').text
+              group_members << member_name
+            end
+            result[name] = group_members
+          end
+        end
+      end
+      
+      return result
+    rescue RestClient::Unauthorized
+      result['status'] = '401 Error - Auth failure (bad username/password).'
+      
+      return result
+    end
+  end
+
+  # add_service(data)
+  #
+  # This method will add a new service object to Space give the information
+  # in 'data'. This information is a Hash table, with the following structure:
+  #
+  # `name => `Name of the object you want to create`
+  # `port => Port number`
+  # `desc => Description (optional)`
+  #
+  def add_service(data)
+    result = {}
+    
+    if data['desc']
+      desc = data['desc']
+    else
+      desc = ''
+    end
+    
+    xml = "<service><name>#{data['name']}</name><is-group>false</is-group><edit-version/>" +
+          "<id/><created-by-user-name/><members/><protocols><protocol><description/>" +
+          "<sunrpc-protocol-type>6</sunrpc-protocol-type><msrpc-protocol-type>6</msrpc-protocol-type>" +
+          "<protocol-number>6</protocol-number><name>#{data['name']}</name><dst-port>#{data['port']}</dst-port>" +
+          "<disable-timeout>false</disable-timeout><protocol-type>0</protocol-type><icmp-code>0</icmp-code>" +
+          "<icmp-type>0</icmp-type><rpc-program-number>0</rpc-program-number>" +
+          "</protocol></protocols><description>#{desc}</description></service>"
+    
+    begin
+      res = RestClient.post("#{JunosSpace.base_uri}#{@@service_uri}", xml, @@service_headers)
+      
+      if res.code == 200
+        result['status'] = '200 OK - Success'
+      end
+      
+      return result
+    rescue RestClient::Unauthorized
+      result['status'] = '401 Error - Auth failure (bad username/password).'
+      
+      return result
+    rescue RestClient::InternalServerError
+      result['status'] = '500 Error - Check and see if the device already exists.'
+      
+      return result
+    end
+  end
+  
+  # delete_service(name)
+  #
+  # Deletes the object matching the name 'name'. If more than one service object
+  # is found during the search, then send a warning to refine the search (i.e.
+  # use the exact name if possible).
+  #
+  def delete_service(name)
+    result = {}
+    
+    begin
+      res = RestClient.get("#{JunosSpace.base_uri}#{@@service_uri}", :params => {:filter => "(global eq '#{name}')"})
+      doc = Nokogiri::XML::Document.parse(res)
+      num_results = doc.xpath('//services/@total').text
+      
+      if num_results == "0"
+        result['status'] = 'Service object does not exist.'
+      elsif num_results.to_i > 1
+        result['status'] = 'More than one object was found. Please refine your search (use the exact name if possible).'
+      else
+        doc.xpath("//service[contains(translate(name, '#{@@ucase}', '#{@@dcase}'), translate('#{name}', '#{@@ucase}', '#{@@dcase}'))]").each do |service|
+          id = service.xpath('id').text
+
+          res = RestClient.delete("#{JunosSpace.base_uri}#{@@service_uri}/#{id}", @@service_headers)
+          
+          if res == ''
+            result['status'] = '200 OK - Success.'
+          end
+        end
+      end
+
+      return result
+    rescue RestClient::Unauthorized
+      result['status'] = '401 Error - Auth failure (bad username/password).'
+      
+      return result
+    end      
+  end
+end

data/lib/junos-space-api/space.rb

@@ -0,0 +1,20 @@
+module JunosSpace
+  # JunosSpace.open
+  #
+  # Initiates the connection to the Junos Space server.
+  #
+  def self.open(user, pass, server)
+    @conn_str = "https://#{user}:#{pass}@#{server}"
+  end
+  
+  # JunosSpace.base_uri
+  #
+  # Returns the base URI for the API to use in our classes
+  #
+  def self.base_uri
+    @conn_str
+  end
+end
+
+module JunosSpace::Platform; end
+module JunosSpace::SD; end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: junos-space-api
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Scott Ware
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-09 00:00:00.000000000 Z
+dependencies: []
+description: This gem is used to interact with Juniper Networks Junos Space management
+  platform using the REST API.
+email: scottdware@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- junos-space-api.gemspec
+- LICENSE
+- README.md
+- lib/junos-space-api/platform/device.rb
+- lib/junos-space-api/platform/job.rb
+- lib/junos-space-api/platform.rb
+- lib/junos-space-api/sd/address.rb
+- lib/junos-space-api/sd/device.rb
+- lib/junos-space-api/sd/service.rb
+- lib/junos-space-api/sd.rb
+- lib/junos-space-api/space.rb
+- examples/addresses.rb
+- examples/add_device.rb
+- examples/jobs.rb
+- examples/sec_device.rb
+- examples/services.rb
+homepage: https://github.com/scottdware/junos-ruby-space-api
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Interact with the Junos Space REST API.
+test_files: []