junos-space-api 0.2.0 → 0.2.1

data/README.md

@@ -36,6 +36,13 @@ Check out the [Wiki][1] for documentation on the different Classes and their res
 
 Check out the `examples` directory to browse through some samples of what this API can do!
 
+### Credits
+
+Thanks to [Jeremy Schulman][3] for inspiration and help with all the automation-goodness! And thanks
+to [Juniper Networks][4] for creating such great products :)
+
 
 [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
+[2]: http://www.juniper.net/techpubs/en_US/junos-space13.1/information-products/topic-collections/junos-space-security-designer/security-director-api.pdf
+[3]: https://github.com/jeremyschulman
+[4]: http://www.juniper.net

data/examples/add_device.rb

@@ -16,4 +16,4 @@ data = {
 }
 
 # Will return the job ID (i.e. {"status"=>"9990001"}
-pp devices.add_device(data)
+pp devices.add(data)

data/examples/addresses.rb

@@ -17,13 +17,13 @@ data = {
 }
 
 # Will get a list of all of the address objects.
-pp addrs.addresses
+pp addrs.list
 
 # Will add a new address object to Junos Space.
-pp addrs.add_address(data)
+pp addrs.add(data)
 
 # Will return information about the address object.
-pp addrs.address_info('my-home-network')
+pp addrs.info('my-home-network')
 
 # Will delete the address object.
-pp addrs.delete_address('my-home-network')
+pp addrs.delete('my-home-network')

data/examples/jobs.rb

@@ -9,10 +9,10 @@ JunosSpace.open('user', 'pass', 'server')
 jobs = JunosSpace::Platform::Job.new
 
 # Will return all jobs with a status of SUCCESS
-pp jobs.jobs('success')
+pp jobs.list('success')
 
 # Will return all jobs with a status of FAILURE
-pp jobs.jobs('failure')
+pp jobs.list('failure')
 
 # Will return information about the job ID 9990001
-pp jobs.job_info('9990001')
+pp jobs.info('9990001')

data/examples/sec_device.rb

@@ -6,7 +6,7 @@ pass = 'somepass'
 server = 'space.company.com'
 
 JunosSpace.open('user', 'pass', 'server')
-secdev = JunosSpace::SD::Device.new
+security = JunosSpace::SD::Device.new
 
 # Will return the security device information (i.e. zones, interfaces, etc.)
-pp secdev.device_info('corporate-firewall')
+pp security.info('corporate-firewall')

data/examples/services.rb

@@ -14,13 +14,13 @@ data = {
 }
 
 # Will get a list of all of the services.
-pp services.services
+pp services.list
 
 # Will add a new service object to Junos Space.
-pp services.add_service(data)
+pp services.add(data)
 
 # Will return information about the service object.
-pp services.service_info('my-custom-service')
+pp services.info('my-custom-service')
 
 # Will delete the service object.
-pp services.delete_service('my-custom-service')
+pp services.delete('my-custom-service')

data/junos-space-api.gemspec

@@ -3,7 +3,7 @@ require 'rake'
 Gem::Specification.new do |s|
     s.license           = 'MIT'
     s.name              = 'junos-space-api'
-    s.version           = '0.2.0'
+    s.version           = '0.2.1'
     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"]

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

@@ -12,17 +12,15 @@ class JunosSpace::Platform::Device
   @@queue_headers = {
     :content_type => 'application/hornetq.jms.queue+xml'
   }
-  @@ucase = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
-  @@dcase = 'abcdefghijklmnopqrstuvwxyz'
   
-  # devices
+  # list
   #
   # 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
+  def list
     result = {}
     
     begin
@@ -51,7 +49,7 @@ class JunosSpace::Platform::Device
     end
   end
   
-  # add_device(data)
+  # add(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:
@@ -63,7 +61,7 @@ class JunosSpace::Platform::Device
   #
   # Returns a Hash with 'status' as the key, and the job ID as the value.
   #
-  def add_device(data)
+  def add(data)
     result = {}
     
     begin

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

@@ -7,14 +7,14 @@ class JunosSpace::Platform::Job
   @@ucase = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
   @@dcase = 'abcdefghijklmnopqrstuvwxyz'
   
-  # jobs(status)
+  # list(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)
+  def list(status)
     result = {}
     
     begin
@@ -49,13 +49,13 @@ class JunosSpace::Platform::Job
     end
   end
   
-  # job_info(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)
+  def info(job)
     result = {}
     
     begin

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

@@ -10,12 +10,12 @@ class JunosSpace::SD::Address
   @@ucase = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
   @@dcase = 'abcdefghijklmnopqrstuvwxyz'
   
-  # addresses
+  # list
   #
   # 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
+  def list
     result = {}
     
     begin
@@ -37,14 +37,14 @@ class JunosSpace::SD::Address
     end
   end
   
-  # address_info(name)
+  # 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)
+  def info(name)
     result = {}
     
     begin
@@ -88,7 +88,7 @@ class JunosSpace::SD::Address
     end
   end
   
-  # add_address(data)
+  # add(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:
@@ -99,10 +99,11 @@ class JunosSpace::SD::Address
   # `desc => Description (optional)`,
   # `version => Either 'v4' or 'v6'`
   #
-  def add_address(data)
-  result = {}
-  type = data['type'] == 'address' ? 'IPADDRESS' : 'NETWORK'
+  def add(data)
+    result = {}
+    type = data['type'] == 'address' ? 'IPADDRESS' : 'NETWORK'
     version = data['version'] == 'v4' ? 'IPV4' : 'IPV6'
+    
     if data['desc']
       desc = data['desc']
     else
@@ -133,13 +134,13 @@ class JunosSpace::SD::Address
     end
   end
   
-  # delete_address(name)
+  # delete(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)
+  def delete(name)
     result = {}
     
     begin

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

@@ -5,12 +5,12 @@ require 'junos-space-api/space'
 class JunosSpace::SD::Device
   @@device_uri = '/api/juniper/sd/device-management/devices'
   
-  # devices
+  # list
   #
   # 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
+  def list
     result = {}
     
     begin
@@ -32,7 +32,7 @@ class JunosSpace::SD::Device
     end
   end
   
-  # device_info(name)
+  # 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
@@ -41,9 +41,9 @@ class JunosSpace::SD::Device
   # 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)
+  def info(name)
     result = {}
-    devices = self.devices
+    devices = self.list
     
     begin
       res = RestClient.get("#{JunosSpace.base_uri}#{@@device_uri}/#{devices[name]}")

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

@@ -10,12 +10,12 @@ class JunosSpace::SD::Service
   @@ucase = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
   @@dcase = 'abcdefghijklmnopqrstuvwxyz'
   
-  # services
+  # list
   #
   # 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
+  def list
     result = {}
     
     begin
@@ -37,14 +37,14 @@ class JunosSpace::SD::Service
     end
   end
 
-  # service_info(name)
+  # 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)
+  def info(name)
     result = {}
     
     begin
@@ -90,7 +90,7 @@ class JunosSpace::SD::Service
     end
   end
 
-  # add_service(data)
+  # add(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:
@@ -99,7 +99,7 @@ class JunosSpace::SD::Service
   # `port => Port number`
   # `desc => Description (optional)`
   #
-  def add_service(data)
+  def add(data)
     result = {}
     
     if data['desc']
@@ -135,13 +135,13 @@ class JunosSpace::SD::Service
     end
   end
   
-  # delete_service(name)
+  # delete(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)
+  def delete(name)
     result = {}
     
     begin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: junos-space-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-09 00:00:00.000000000 Z
+date: 2013-07-10 00:00:00.000000000 Z
 dependencies: []
 description: This gem is used to interact with Juniper Networks Junos Space management
   platform using the REST API.
@@ -18,6 +18,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- junos-space-api-0.2.0.gem
 - junos-space-api.gemspec
 - LICENSE
 - README.md