infoblox 0.2.18 → 0.2.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f41953b29600256bd6e3df5bb164888cf4c0318b
-  data.tar.gz: 2c5b677294f5c3da0cdf560c1982533694b4d2ef
+  metadata.gz: 508ca735479d7b411af21c7ce8550d4ef25c975c
+  data.tar.gz: 4f03b3a3aea91f5e4c550d421c4275c408e2b815
 SHA512:
-  metadata.gz: 3f6dc1c7c73a1a6cca82a07e961248e606bf2e0397a9b0e438006a21832dd05c72b60ffb611116f1a2a52dde69d77e2717baccfa4a6be7d277b0935b8d86fb74
-  data.tar.gz: bbb0145361e01576f3ab226a4db8a796a95a32dc77ba3f9e7c00ba7ee87b82b0d533d8ec9ec919589eeea8d4688a80d8c94f199e5cb40fe13f6d70aee49841b6
+  metadata.gz: 68601ca1df42b361dcef26994e0d593a9fb109999be9b1c4619e96b40872041676eb4852da3136c93caf6beeaa8ac2ef29879438b5d9559cbcb290696af209bc
+  data.tar.gz: 30207ba646bcaff6a93fdce90c6772444352f74f837d8eb6ffc1ddf1e5891267b7213ede175da772a019662c4bf51fcfd3a27919bfa1e3e3bd9de57aef6d06c5

data/README.md

@@ -22,33 +22,36 @@ Or install it yourself as:
 ## Connecting
 An instance of the `Infoblox::Connection` class is necessary:
 
-    connection = Infoblox::Connection.new(:username => '', :password => '', :host => '')
+    connection = Infoblox::Connection.new(username: '', password: '', host: '')
 
-## Querying
-Once a connection is made, one can use the resource class methods to query records.  You can use the `_max_results` and `_return_fields` parameters for both `find` and `all`. See the Infoblox WAPI documentation on how to use these parameters. 
+## Reading
+Each resource class implements `all` and `find`.  You can use the `_max_results` and `_return_fields` parameters for both of these methods. See the Infoblox WAPI documentation on how to use these parameters. 
 
     # Find all networks. Note that this is limited to 1000 objects, as per the 
     # Infoblox WAPI documentation. 
     Infoblox::Network.all(connection)
     # => [...]
     
-    # Find the first 7890 hosts
-    Infoblox::Network.all(connection, :_max_results => 7890)
+    # If you want more than 1,000 records, use `_max_results`:
+    Infoblox::Network.all(connection, _max_results: 7890)
    
-    # Find hosts that match a regular expression
+    # You can find hosts that match a regular expression:
     Infoblox::Host.find(connection, {"name~" => "demo[0-9]{1,}-web.domain"})
     # => [...]
 
+The usage of search parameters is well-documented in the Infoblox WAPI documentation, and this client supports them fully.
+
+## Searching
 You can also search across the Infoblox cluster using the `Infoblox::Search` resource. The response will contain any number of `Infoblox::Resource` subclass instances. 
 
     result = Infoblox::Search.find(connection, "search_string~" => "webserver-")
     # => [#<Infoblox::Host>, #<Infoblox::Ptr>, ...]
     
-## Creating a network
-The resource class instances support `get`, `post`, `put`, and `delete`.  For example, creating a network is pretty straightforward: 
+## Writing and deleting
+The resource class instances implement `get`, `post`, `put`, and `delete` methods, which correspond to the REST verbs supported by the WAPI.  For example, here is how to create, update, and delete a network:
  
     # create
-    network = Infoblox::Network.new(:connection => connection)
+    network = Infoblox::Network.new(connection: connection)
     network.network = "10.20.30.0/24"
     network.extensible_attributes = {"VLAN" => "my_vlan"}
     network.auto_create_reversezone = true
@@ -58,6 +61,27 @@ The resource class instances support `get`, `post`, `put`, and `delete`.  For ex
     network.network = "10.20.31.0/24"
     network.put
 
+    # delete
+    network.delete
+
+This pattern applies for interacting with every resource.  Supported resources include:
+    
+    Infoblox::Arecord
+    Infoblox::Cname
+    Infoblox::FixedAddress
+    Infoblox::Host
+    Infoblox::HostIpv4addr
+    Infoblox::Ipv4address
+    Infoblox::Mx
+    Infoblox::Network
+    Infoblox::NetworkContainer
+    Infoblox::Ptr
+    Infoblox::Search
+    Infoblox::Srv
+    Infoblox::Txt
+
+The specific attributes supported by each resource are listed in the source code.
+
 ## Changing IP on an existing host
 To change the IP of an existing host, you have to poke around in the ipv4addrs collection to find the one you are looking for.  The example below assumes that there is only one ipv4 address and just overwrites it. 
 
@@ -71,21 +95,34 @@ To do basic create/update/delete operations on an a_record/ptr_record set:
 
 Create:
 
-    a_record = Infoblox::Arecord.new(:connection => connection, :name => <fqdn>, :ipv4addr => <ip_address>)
+    a_record = Infoblox::Arecord.new(
+      connection: connection, 
+      name:       <fqdn>, 
+      ipv4addr:   <ip_address>)
     a_record.post
     
-    ptr_record = Infoblox::Ptr.new(:connection => connection, :ptrdname => <fqdn>, :ipv4addr => <ip_address>)
+    ptr_record = Infoblox::Ptr.new(
+      connection: connection, 
+      ptrdname:   <fqdn>, 
+      ipv4addr:   <ip_address>)
     ptr_record.post
 
 Update:
 
-    a_record = Infoblox::Arecord.find(connection, {:name => <fqdn>, :ipv4addr => resource_version_last_published.ip_address}).first
-    a_record.name = <fqdn>
+    a_record = Infoblox::Arecord.find(connection, {
+      name:     <fqdn>, 
+      ipv4addr: <ip_address>
+    }).first
+    a_record.name     = <fqdn>
     a_record.ipv4addr = <ip_address>
-    a_record.view = nil
+    a_record.view     = nil
     a_record.put
 
-    ptr_record = Infoblox::Ptr.find(connection, {:ptrdname => <fqdn>, :ipv4addr => resource_version_last_published.ip_address}).first
+    ptr_record = Infoblox::Ptr.find(connection, {
+      ptrdname: <fqdn>, 
+      ipv4addr: <ip_address>
+    }).first
+
     ptr_record.ptrdname = <fqdn>
     ptr_record.ipv4addr = <ip_address>
     ptr_record.view = nil
@@ -93,12 +130,29 @@ Update:
 
 Delete:
 
-    a_record = Infoblox::Arecord.find(connection, {:name => <fqdn>, :ipv4addr => <ip_address>}).first
+    a_record = Infoblox::Arecord.find(connection, {
+      name:     <fqdn>, 
+      ipv4addr: <ip_address>
+    }).first
     a_record.delete
     
-    ptr_record = Infoblox::Ptr.find(connection, {:ptrdname => <fqdn>, :ipv4addr => <ip_address>}).first
+    ptr_record = Infoblox::Ptr.find(connection, {
+      ptrdname: <fqdn>, 
+      ipv4addr: <ip_address>
+    }).first
     ptr_record.delete
 
+## Next Available IP
+
+The `Infoblox::Network` object supports the `next_available_ip` WAPI function: 
+
+    network    = Infoblox::Network.find(connection, 
+                                   network: '10.21.0.0/24').first
+    puts network.next_available_ip.inspect
+    #=> ["10.21.0.22"]
+
+Note that this function does not work on a `Network` that has not been created.  In other words, if you want to get the next available IP for a given network segment, you have to create that segment beforehand.  See the CRUD examples above. 
+
 ## Contributing
 
 1. Fork it

data/lib/infoblox/resource/range.rb

@@ -0,0 +1,22 @@
+module Infoblox
+  class Range < Resource
+    remote_attr_accessor :start_addr, :end_addr, :network_view, :extattrs
+
+    wapi_object "range"
+    
+    ## 
+    # Invoke the same-named function on the range resource in WAPI, 
+    # returning an array of available IP addresses. 
+    # You may optionally specify how many IPs you want (num) and which ones to 
+    # exclude from consideration (array of IPv4 addrdess strings).
+    #
+    def next_available_ip(num=1, exclude=[])
+      post_body = {
+        num:     num.to_i,
+        exclude: exclude
+      }
+      JSON.parse(connection.post(resource_uri + "?_function=next_available_ip", post_body).body)["ips"]
+    end
+
+  end
+end

data/lib/infoblox/version.rb

@@ -1,3 +1,3 @@
 module Infoblox
-  VERSION = "0.2.18"
+  VERSION = "0.2.19"
 end

data/spec/range_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RangeResponse = Struct.new(:body)
+
+describe Infoblox::Host, "#next_available_ip" do  
+  it "returns empty array when no IP is available." do
+    connection = double
+    uri = Infoblox::BASE_PATH + Infoblox::Range.wapi_object
+    return_json = RangeResponse.new('{"ips": "[]"}')
+    allow(connection).to receive(:post).with(uri + "?_function=next_available_ip" , {:num=>1, :exclude=>[]}).and_return(return_json)
+    response = Infoblox::Range.new(:connection => connection)
+    expect(response.next_available_ip).to eq '[]'
+  end
+
+  it "gets next available ip from range" do
+    connection = double
+    uri = Infoblox::BASE_PATH + Infoblox::Range.wapi_object
+    return_json = RangeResponse.new('
+      {
+        "ips": "[\"1.1.1.1\", \"1.1.1.2\"]"
+      }')
+    allow(connection).to receive(:post).with(uri + "?_function=next_available_ip" , {:num=>1, :exclude=>[]}).and_return(return_json)
+    response = Infoblox::Range.new(:connection => connection)
+    expect(response.next_available_ip).to eq '["1.1.1.1", "1.1.1.2"]'
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: infoblox
 version: !ruby/object:Gem::Version
-  version: 0.2.18
+  version: 0.2.19
 platform: ruby
 authors:
 - Billy Reisinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-01 00:00:00.000000000 Z
+date: 2015-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -122,6 +122,7 @@ files:
 - lib/infoblox/resource/network.rb
 - lib/infoblox/resource/network_container.rb
 - lib/infoblox/resource/ptr.rb
+- lib/infoblox/resource/range.rb
 - lib/infoblox/resource/search.rb
 - lib/infoblox/resource/srv.rb
 - lib/infoblox/resource/txt.rb
@@ -129,6 +130,7 @@ files:
 - spec/connection_spec.rb
 - spec/host_ipv4addr_spec.rb
 - spec/host_spec.rb
+- spec/range_spec.rb
 - spec/resource_spec.rb
 - spec/search_spec.rb
 - spec/spec_helper.rb
@@ -161,6 +163,7 @@ test_files:
 - spec/connection_spec.rb
 - spec/host_ipv4addr_spec.rb
 - spec/host_spec.rb
+- spec/range_spec.rb
 - spec/resource_spec.rb
 - spec/search_spec.rb
 - spec/spec_helper.rb