Added Dynamic IP creation by using API method /addresses/first_free/{subnetId}/

README.md

@@ -1,4 +1,4 @@
-[![GoDoc](https://godoc.org/github.com/paybyphone/phpipam-sdk-go?status.svg)](https://godoc.org/github.com/paybyphone/phpipam-sdk-go)
+[![GoDoc](https://godoc.org/github.com/pavel-z1/phpipam-sdk-go?status.svg)](https://godoc.org/github.com/pavel-z1/phpipam-sdk-go)
 
 # phpipam-sdk-go - Partial SDK for PHPIPAM
 
@@ -15,7 +15,7 @@ provider to help insert data gathered from AWS and beyond.
 
 See the [GoDoc][2] for the SDK usage details.
 
-[2]: https://godoc.org/github.com/paybyphone/phpipam-sdk-go
+[2]: https://godoc.org/github.com/pavel-z1/phpipam-sdk-go
 
 ## A Note on Custom Fields
 
@@ -35,6 +35,15 @@ fields, enable the nested functionality - otherwise, ensure that your fields are
 not required and choose sane defaults if it's absolutely necessary for data to
 be present.
 
+## A Note on Logging
+
+This software uses apex library to handle logging. You can control verbosity by
+setting environment variable PHPIPAMSDK_LOGLEVEL to one of supported value:
+* debug
+* info
+* warn
+* error
+* fatal
 
 ## License
 

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-leap-day

controllers/addresses/addresses.go

@@ -5,9 +5,9 @@ package addresses
 import (
 	"fmt"
 
-	"github.com/paybyphone/phpipam-sdk-go/phpipam"
-	"github.com/paybyphone/phpipam-sdk-go/phpipam/client"
-	"github.com/paybyphone/phpipam-sdk-go/phpipam/session"
+	"github.com/pavel-z1/phpipam-sdk-go/phpipam"
+	"github.com/pavel-z1/phpipam-sdk-go/phpipam/client"
+	"github.com/pavel-z1/phpipam-sdk-go/phpipam/session"
 )
 
 // Address represents an IP address resource within PHPIPAM.
@@ -91,6 +91,12 @@ func (c *Controller) CreateAddress(in Address) (message string, err error) {
 	return
 }
 
+// CreateAddress creates a first free in subnet address by sending a POST request.
+func (c *Controller) CreateFirstFreeAddress(id int, in Address) (out string, err error) {
+        err = c.SendRequest("POST", fmt.Sprintf("/addresses/first_free/%d/", id), &in, &out)
+        return
+}
+
 // GetAddressByID GETs an address via its ID.
 func (c *Controller) GetAddressByID(id int) (out Address, err error) {
 	err = c.SendRequest("GET", fmt.Sprintf("/addresses/%d/", id), &struct{}{}, &out)
@@ -106,6 +112,14 @@ func (c *Controller) GetAddressesByIP(ipaddr string) (out []Address, err error)
 	return
 }
 
+// GetAddressesByIP searches for an address by its IP with in given subnet
+// When having multiple subnets with same ip range this will return the address in the given subnet
+// Those subnet may not talk to each other but still exist under on phpIPAM instance especially on ones migrated from previous versions 
+func (c *Controller) GetAddressesByIpInSubnet(ipaddr string,subnetID int) (out Address, err error) {
+	err = c.SendRequest("GET", fmt.Sprintf("/addresses/%s/%d", ipaddr,subnetID), &struct{}{}, &out)
+	return
+}
+
 // GetAddressCustomFieldsSchema GETs the custom fields for the addresses controller via
 // client.GetCustomFieldsSchema.
 func (c *Controller) GetAddressCustomFieldsSchema() (out map[string]phpipam.CustomField, err error) {

controllers/addresses/addresses_test.go

@@ -8,9 +8,9 @@ import (
 	"reflect"
 	"testing"
 
-	"github.com/paybyphone/phpipam-sdk-go/phpipam"
-	"github.com/paybyphone/phpipam-sdk-go/phpipam/session"
-	"github.com/paybyphone/phpipam-sdk-go/testacc"
+	"github.com/pavel-z1/phpipam-sdk-go/phpipam"
+	"github.com/pavel-z1/phpipam-sdk-go/phpipam/session"
+	"github.com/pavel-z1/phpipam-sdk-go/testacc"
 )
 
 var testCreateAddressInput = Address{
@@ -127,6 +127,46 @@ const testGetAddressesByIPOutputJSON = `
 }
 `
 
+var testGetAddressesByIpInSubnetOutputExpected = Address{
+	ID:          11,
+	SubnetID:    3,
+	IPAddress:   "10.10.1.10",
+	Description: "foobar",
+
+}
+
+const testGetAddressesByIpInSubnetOutputJSON = `
+{
+  "code": 200,
+  "success": true,
+  "data": 
+	{
+		"id": "11",
+		"subnetId": "3",
+		"ip": "10.10.1.10",
+		"is_gateway": null,
+		"description": "foobar",
+		"hostname": null,
+		"mac": null,
+		"owner": null,
+		"port": null,
+		"note": null,
+		"lastSeen": null,
+		"excludePing": null,
+		"PTRignore": null,
+		"PTR": "0",
+		"firewallAddressObject": null,
+		"editDate": null,
+		"links": [
+			{
+				"rel": "self",
+				"href": "/api/test/addresses/11/"
+			}
+		]
+    }
+}
+`
+
 var testGetAddressCustomFieldsSchemaExpected = map[string]phpipam.CustomField{
 	"CustomTestAddresses": phpipam.CustomField{
 		Name:    "CustomTestAddresses",
@@ -277,6 +317,25 @@ func TestGetAddressesByIP(t *testing.T) {
 	}
 }
 
+func TestGetAddressesByIpInSubnet(t *testing.T) {
+	ts := httpOKTestServer(testGetAddressesByIpInSubnetOutputJSON)
+	defer ts.Close()
+	sess := fullSessionConfig()
+	sess.Config.Endpoint = ts.URL
+	client := NewController(sess)
+
+	expected := testGetAddressesByIpInSubnetOutputExpected
+	actual, err := client.GetAddressesByIpInSubnet("10.10.1.10/24",3)
+	if err != nil {
+		t.Fatalf("Bad: %s", err)
+	}
+
+	if !reflect.DeepEqual(expected, actual) {
+		t.Fatalf("Expected %#v, got %#v", expected, actual)
+	}
+}
+
+
 func TestGetAddressCustomFieldsSchema(t *testing.T) {
 	ts := httpOKTestServer(testGetAddressCustomFieldsSchemaJSON)
 	defer ts.Close()

controllers/l2domains/l2domains.go

@@ -0,0 +1,82 @@
+// Package l2domains provides types and methods for working with the l2domains
+// controller.
+package l2domains
+
+import (
+	"fmt"
+
+	"github.com/pavel-z1/phpipam-sdk-go/controllers/vlans"
+	//"github.com/pavel-z1/phpipam-sdk-go/phpipam"
+	"github.com/pavel-z1/phpipam-sdk-go/phpipam/client"
+	"github.com/pavel-z1/phpipam-sdk-go/phpipam/session"
+)
+
+// L2Domain represents a PHPIPAM l2domain.
+type L2Domain struct {
+	// The L2 domain ID.
+	ID int `json:"id,string,omitempty"`
+
+	// The L2 domains name.
+	Name string `json:"name,omitempty"`
+
+	// The l2domain's description.
+	Description string `json:"description,omitempty"`
+
+	// The ID of the section's parent, if nested.
+	Sections string `json:"sections,omitempty"`
+}
+
+// Controller is the base client for the L2Domains controller.
+type Controller struct {
+	client.Client
+}
+
+// NewController returns a new instance of the client for the L2Domains controller.
+func NewController(sess *session.Session) *Controller {
+	c := &Controller{
+		Client: *client.NewClient(sess),
+	}
+	return c
+}
+
+// ListL2Domains lists all l2domains.
+func (c *Controller) ListL2Domains() (out []L2Domain, err error) {
+	err = c.SendRequest("GET", "/l2domains/", &struct{}{}, &out)
+	return
+}
+
+// CreateL2Domain creates a l2domain by sending a POST request.
+func (c *Controller) CreateL2Domain(in L2Domain) (message string, err error) {
+	err = c.SendRequest("POST", "/l2domains/", &in, &message)
+	return
+}
+
+// GetL2DomainByID GETs a l2domain via its ID.
+func (c *Controller) GetL2DomainByID(id int) (out L2Domain, err error) {
+	err = c.SendRequest("GET", fmt.Sprintf("/l2domains/%d/", id), &struct{}{}, &out)
+	return
+}
+
+// GetL2DomainByName GETs a l2domain via its name.
+func (c *Controller) GetL2DomainByName(name string) (out []L2Domain, err error) {
+	err = c.SendRequest("GET", fmt.Sprintf("/l2domains/?filter_by=name&filter_value=%s", name), &struct{}{}, &out)
+	return
+}
+
+// GetVlansInL2Domain GETs the vlans in a l2domains by l2domain ID.
+func (c *Controller) GetVlansInl2Domain(id int) (out []vlans.VLAN, err error) {
+	err = c.SendRequest("GET", fmt.Sprintf("/l2domains/%d/vlans/", id), &struct{}{}, &out)
+	return
+}
+
+// UpdateL2Domain updates a l2domain by sending a PATCH request.
+func (c *Controller) UpdateL2Domain(in L2Domain) (err error) {
+	err = c.SendRequest("PATCH", "/l2domains/", &in, &struct{}{})
+	return
+}
+
+// DeleteL2Domain deletes a l2domain by sending a DELETE request. All subnets and
+func (c *Controller) DeleteL2Domain(id int) (err error) {
+	err = c.SendRequest("DELETE", fmt.Sprintf("/l2domains/%d/", id), &struct{}{}, &struct{}{})
+	return
+}

controllers/sections/sections.go

@@ -5,10 +5,10 @@ package sections
 import (
 	"fmt"
 
-	"github.com/paybyphone/phpipam-sdk-go/controllers/subnets"
-	"github.com/paybyphone/phpipam-sdk-go/phpipam"
-	"github.com/paybyphone/phpipam-sdk-go/phpipam/client"
-	"github.com/paybyphone/phpipam-sdk-go/phpipam/session"
+	"github.com/pavel-z1/phpipam-sdk-go/controllers/subnets"
+	"github.com/pavel-z1/phpipam-sdk-go/phpipam"
+	"github.com/pavel-z1/phpipam-sdk-go/phpipam/client"
+	"github.com/pavel-z1/phpipam-sdk-go/phpipam/session"
 )
 
 // Section represents a PHPIPAM section.

controllers/sections/sections_test.go

@@ -9,10 +9,10 @@ import (
 	"testing"
 
 	"github.com/davecgh/go-spew/spew"
-	"github.com/paybyphone/phpipam-sdk-go/controllers/subnets"
-	"github.com/paybyphone/phpipam-sdk-go/phpipam"
-	"github.com/paybyphone/phpipam-sdk-go/phpipam/session"
-	"github.com/paybyphone/phpipam-sdk-go/testacc"
+	"github.com/pavel-z1/phpipam-sdk-go/controllers/subnets"
+	"github.com/pavel-z1/phpipam-sdk-go/phpipam"
+	"github.com/pavel-z1/phpipam-sdk-go/phpipam/session"
+	"github.com/pavel-z1/phpipam-sdk-go/testacc"
 )
 
 var testListSectionsOutputExpected = []Section{

controllers/subnets/subnets.go

@@ -5,10 +5,10 @@ package subnets
 import (
 	"fmt"
 
-	"github.com/paybyphone/phpipam-sdk-go/controllers/addresses"
-	"github.com/paybyphone/phpipam-sdk-go/phpipam"
-	"github.com/paybyphone/phpipam-sdk-go/phpipam/client"
-	"github.com/paybyphone/phpipam-sdk-go/phpipam/session"
+	"github.com/pavel-z1/phpipam-sdk-go/controllers/addresses"
+	"github.com/pavel-z1/phpipam-sdk-go/phpipam"
+	"github.com/pavel-z1/phpipam-sdk-go/phpipam/client"
+	"github.com/pavel-z1/phpipam-sdk-go/phpipam/session"
 )
 
 // Subnet represents a PHPIPAM subnet.
@@ -43,6 +43,9 @@ type Subnet struct {
 	// The ID of the nameserver to attache the subnet to.
 	NameserverID int `json:"nameserverId,string,omitempty"`
 
+	// The ID and IPs of the nameservers for the subnet
+	Nameservers map[string]interface{} `json:"nameservers,omitempty"`
+
 	// true if the name should be displayed in listing instead of the subnet
 	// address.
 	ShowName phpipam.BoolIntString `json:"showName,omitempty"`
@@ -72,6 +75,9 @@ type Subnet struct {
 	// Controls if we are adding a subnet or folder.
 	IsFolder phpipam.BoolIntString `json:"isFolder,omitempty"`
 
+	// Marks the subnet as permitting allocation of the network and broadcast addresses.
+	IsPool phpipam.BoolIntString `json:"isPool,omitempty"`
+
 	// Marks the subnet as used.
 	IsFull phpipam.BoolIntString `json:"isFull,omitempty"`
 
@@ -84,12 +90,21 @@ type Subnet struct {
 	// The date of the last edit to this resource.
 	EditDate string `json:"editDate,omitempty"`
 
+	// Gateway IP and ID of Gateway IP
+	Gateway map[string]interface{} `json:"gateway,omitempty"`
+
+	// Gateway IP ID
+	GatewayID string `json:"gatewayId,omitempty"`
+
 	// A map[string]interface{} of custom fields to set on the resource. Note
 	// that this functionality requires PHPIPAM 1.3 or higher with the "Nest
 	// custom fields" flag set on the specific API integration. If this is not
 	// enabled, this map will be nil on GETs and POSTs and PATCHes with this
 	// field set will fail. Use the explicit custom field functions instead.
 	CustomFields map[string]interface{} `json:"custom_fields,omitempty"`
+
+	// Controls enabling resolve DNS function.
+	ResolveDNS phpipam.BoolIntString `json:"resolveDNS,omitempty"`
 }
 
 // Controller is the base client for the Subnets controller.
@@ -111,6 +126,12 @@ func (c *Controller) CreateSubnet(in Subnet) (message string, err error) {
 	return
 }
 
+// CreateFirstFreeSubnet creates a first free child subnet inside subnet with specified mask by sending a POST request.
+func (c *Controller) CreateFirstFreeSubnet(id int, mask int, in Subnet) (message string, err error) {
+	err = c.SendRequest("POST", fmt.Sprintf("/subnets/%d/first_subnet/%d/", id, mask), &in, &message)
+	return
+}
+
 // GetSubnetByID GETs a subnet via its ID.
 func (c *Controller) GetSubnetByID(id int) (out Subnet, err error) {
 	err = c.SendRequest("GET", fmt.Sprintf("/subnets/%d/", id), &struct{}{}, &out)
@@ -129,6 +150,17 @@ func (c *Controller) GetSubnetsByCIDR(cidr string) (out []Subnet, err error) {
 	return
 }
 
+func (c *Controller) GetSubnetsByCIDRAndSection(cidr string, section_id int) (out []Subnet, err error) {
+	err = c.SendRequest("GET", fmt.Sprintf("/subnets/cidr/%s/?filter_by=sectionId&filter_value=%d", cidr, section_id), &struct{}{}, &out)
+	return
+}
+
+// GetFirstFreeSubnet GETs the first free child subnet inside subnet with specified mask
+func (c *Controller) GetFirstFreeSubnet(id int, mask int) (message string, err error) {
+	err = c.SendRequest("GET", fmt.Sprintf("/subnets/%d/first_subnet/%d/", id, mask), &struct{}{}, &message)
+	return
+}
+
 // GetFirstFreeAddress GETs the first free IP address in a subnet and returns
 // it as a string. This can be used to automatically determine the next address
 // you should use. If there are no more available addresses, the string will be