ruby_phpipam 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94e627b29e7624df9d6f1a3a72705269be8e0cca
-  data.tar.gz: 1b6c9101339c6a0b2dca39a53ecc6525b5c21b61
+  metadata.gz: 4e682b180b4cb525a1bdf91eed61ce5a3a79085d
+  data.tar.gz: 62240b166a6df6f72af3e8223754330c9e0060fa
 SHA512:
-  metadata.gz: f0cc58c782851327e7d7c9cbed7eb710c588742d8f8f4874a6ef95c37f09649e76ce5f04b0e7143bac3f54f5070734d1a8ce274ce15392a5bfbf480e03869684
-  data.tar.gz: '0867ee83accf8146b7cb6b6c8118a72b17aed9759a26c94b6492b6495b27c9ae38b50935d3e7bb7f16882f69c880cc2aca3f41945ce610da8f8cd406830c5781'
+  metadata.gz: db2f880f2d45121c1acb528406f75593b44f2d7f772eb6162148a7edf3b7fe357260b8506a1162c41a4795ee82cead9acc36cac64046c093c345a1243a861dd7
+  data.tar.gz: a6d4c8bafb66f400f44161dea65c022b40fe36de4f0fa8e2132e699392fc5ad3c5826fac20c32cffd0d8bb3e19fe371ab8f242c3d9477959d3c8cf933bed8776

data/README.md

@@ -13,9 +13,9 @@ gem 'ruby_phpipam'
 
 ```
 
-And then execute:
+Or execute:
 
-    $ bundle install
+    $ gem install ruby_phpipam
 
 
 ## Usage
@@ -65,9 +65,14 @@ all_subnets(mask)     Get all posible subnets (CIDR)      Array of strings
 
 #### Address
 ```
-self.get(id)      Get address by ID           Address object
-self.ping(id)     Check status of address     Boolean telling if address is reachable
-online?           Check status of address     Boolean telling if address is reachable
+self.get(id)                          Get address by ID             Address object
+self.get_by_tag(tagId)                Get addresses by tagId        Array of address objects
+self.ping(id)                         Check status of address       Boolean telling if address is reachable
+self.search(id, hostname, subnetId)   Searches for addresses by     Address object or array of address objects
+                                        IP (in a specific subnet
+                                        if given) or hostname
+self.first_free(subnetId)             Get first usable IP           String
+online?                               Check status of address       Boolean telling if address is reachable
 ```
 
 ## Pending API endpoints
@@ -98,14 +103,9 @@ DELETE  /api/my_app/subnets/{id}/permissions/             Removes all permission
 
 ### Addresses Endpoints
 ```
-GET     /api/my_app/addresses/{ip}/{subnetId}/              Returns address from subnet by ip address
-GET     /api/my_app/addresses/search/{ip}/                  Searches for addresses in database, returns multiple if found
-GET     /api/my_app/addresses/search_hostname/{hostname}/   Searches for addresses in database by hostname, returns multiple if found
-GET     /api/my_app/addresses/first_free/{subnetId}/        Returns first available address (subnetId can be provided with parameters)
 GET     /api/my_app/addresses/custom_fields/                Returns custom fields
 GET     /api/my_app/addresses/tags/                         Returns all tags
 GET     /api/my_app/addresses/tags/{id}/                    Returns specific tag
-GET     /api/my_app/addresses/tags/{id}/addresses/          Returns addresses for specific tag
 POST    /api/my_app/addresses/                              Creates new address
 POST    /api/my_app/addresses/first_free/{subnetId}/        Creates new address in subnets – first available (subnetId can be provided with parameters)
 PATCH   /api/my_app/addresses/{id}/                         Updates address

data/lib/ruby_phpipam/address.rb

@@ -28,6 +28,13 @@ module RubyPhpipam
       Address.new(RubyPhpipam::Query.get("/addresses/#{id}/"))
     end
 
+    def self.get_by_tag(tagId)
+      addresses = RubyPhpipam::Query.get_array("/addresses/tags/#{tagId}/addresses/")
+      addresses.map do |address|
+        self.new(address)
+      end
+    end
+
     def self.ping(id)
       response = RubyPhpipam::Query.get("/addresses/#{id}/ping/")
 
@@ -38,6 +45,28 @@ module RubyPhpipam
       end
     end
 
+    def self.search(ip:nil, hostname:nil, subnetId:nil)
+      if !ip.nil?
+        if subnetId.nil?
+          addresses = RubyPhpipam::Query.get_array("/addresses/search/#{ip}/")
+        else
+          address = RubyPhpipam::Query.get("/addresses/#{ip}/#{subnetId}/")
+        end
+      else
+        addresses = RubyPhpipam::Query.get_array("/addresses/search_hostname/#{hostname}/")
+      end
+
+      return (address ? self.new(address) : nil) if subnetId
+
+      addresses.map do |address|
+        self.new(address)
+      end
+    end
+
+    def self.first_free(subnetId)
+      RubyPhpipam::Query.get("/addresses/first_free/#{subnetId}/")
+    end
+
     def online?
       RubyPhpipam::Address.ping(@id)
     end

data/lib/ruby_phpipam/version.rb

@@ -1,3 +1,3 @@
 module RubyPhpipam
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/ruby_phpipam.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "Ruby wrapper for the phpipam API"
   spec.description   = "Ruby wrapper for the phpipam API"
-  spec.homepage      = "https://github.com/AminArria/ruby-phpipam"
+  spec.homepage      = "https://github.com/AminArria/ruby_phpipam"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_phpipam
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Amin Arria
@@ -135,7 +135,7 @@ files:
 - lib/ruby_phpipam/subnet.rb
 - lib/ruby_phpipam/version.rb
 - ruby_phpipam.gemspec
-homepage: https://github.com/AminArria/ruby-phpipam
+homepage: https://github.com/AminArria/ruby_phpipam
 licenses:
 - MIT
 metadata: {}