ruby_phpipam 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03afbcf591d332ec1cb73fb534bff63ad7438162
+  data.tar.gz: f4cc8ad1794c73ae546b6328db10f5012552d82d
+SHA512:
+  metadata.gz: 2ec050a20f449e859a366d4d854317a8676561c90a2a3691847d285e18b7aa9a326d55ac42784a9d61d0730e5fbdbaac17b1c3ef8e79c473ce781a4b6400e579
+  data.tar.gz: 4b74f2c12a427ce363e5a162b504b3b64c3a350a092471955693a6d93b6a1bd35fd878d8755bd96ce18105e50e363186927409b930ebd66c8806fa7aa21485c3

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# RVM and others
+.ruby-version
+.ruby-gemset
+
+# dotenv file
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-phpipam.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Amin Arria
+
+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,173 @@
+# ruby_phpipam
+
+**Important Note**: GET actions have highest priority for development, but feel free to make a PR for the others.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_phpipam', git: 'git://github.com/AminArria/ruby-phpipam'
+
+```
+
+And then execute:
+
+    $ bundle install
+
+
+## Usage
+
+### Configuration
+```ruby
+Phpipam.configure do |config|
+  config.base_url = "http://my.phpipam.server/api/my_app"
+  config.username = "username"
+  config.password = "password"
+end
+```
+
+### Authenticating
+```ruby
+Phpipam.authenticate
+```
+
+### API Calls
+In here you'll see the following:
+```
+method_name()     What it does      What it returns
+```
+
+#### Section
+```
+self.get(id_or_name)   Get section by ID or name           Section object
+self.get_all()         Get all sections                    Array of section objects
+subnets()              Get all subnets from the section    Array of subnet objects
+```
+
+#### Subnet
+```
+self.get(id)          Get subnet by ID                    Subnet object
+self.search(cidr)     Search for subnet by CIDR           Subnet object
+usage()               Get usage statistics for subnets    Subnet object with usage statistics
+addresses()           Get all addresses from the subnet   Array of address objects
+first_free_ip()       Get first usable IP                 String
+slaves()              Get inmediate slave subnets         Array of subnet objects
+slaves_recursive()    Get all slave subnets               Array of subnet objects (Includes self)
+first_subnet(mask)    Get first available subnet (CIDR)   String
+                        for given mask
+all_subnets(mask)     Get all posible subnets (CIDR)      Array of strings
+                        for given mask
+```
+
+#### Address
+```
+self.get(id)      Get address by ID     Address object
+```
+
+## Pending API endpoints
+This are endpoints that aren't standarized into a method and a parsed response. You can still call them through ```Phpipam::Query.get(...)``` and get the raw response.
+
+### Sections Endpoints
+```
+GET     /api/my_app/sections/custom_fields/   Returns custom section fields
+POST    /api/my_app/sections/                 Creates new section
+PATCH   /api/my_app/sections/                 Updates section
+DELETE  /api/my_app/sections/                 Deletes section with all belonging subnets and addresses
+```
+
+### Subnets Endpoints
+```
+GET     /api/my_app/subnets/{id}/addresses/{ip}/          Returns IP address from subnet
+GET     /api/my_app/subnets/custom_fields/                Returns all subnet custom fields
+POST    /api/my_app/subnets/                              Creates new subnet
+POST    /api/my_app/subnets/{id}/first_subnet/{mask}/     Creates new child subnet inside subnet with specified mask
+PATCH   /api/my_app/subnets/                              Updates Subnet
+PATCH   /api/my_app/subnets/{id}/resize/                  Resizes subnet to new mask
+PATCH   /api/my_app/subnets/{id}/split/                   Splits subnet to smaller subnets
+PATCH   /api/my_app/subnets/{id}/permissions/             Sets subnet permissions (?grouname1=ro&groupname2=3&43=1)
+DELETE  /api/my_app/subnets/{id}/                         Deletes Subnet
+DELETE  /api/my_app/subnets/{id}/truncate/                Removes all addresses from subnet
+DELETE  /api/my_app/subnets/{id}/permissions/             Removes all permissions
+```
+
+### Addresses Endpoints
+```
+GET     /api/my_app/addresses/{id}/ping/                    Checks address status
+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
+DELETE  /api/my_app/addresses/{id}/                         Deletes address (use 'remove_dns=1' parameter to remove all related DNS records)
+DELETE  /api/my_app/addresses/{ip}/{subnetId}/              Deletes address by IP in specific subnet
+```
+
+### VLAN Endpoints
+```
+GET     /api/my_app/vlan/                                 Returns all Vlans
+GET     /api/my_app/vlan/{id}/                            Returns specific Vlan
+GET     /api/my_app/vlan/{id}/subnets/                    Returns all subnets attached tovlan
+GET     /api/my_app/vlan/{id}/subnets/{sectionId}/        Returns all subnets attached to vlan in specific section
+GET     /api/my_app/vlan/{id}/custom_fields/              Returns custom VLAN fields
+GET     /api/my_app/vlan/{id}/search/{number}/            Searches for VLAN
+POST    /api/my_app/vlan/                                 Creates new VLAN
+PATCH   /api/my_app/vlan/                                 Updates VLAN
+DELETE  /api/my_app/vlan/                                 Deletes VLAN
+```
+
+### VLAN Domains (L2 domains) Endpoints
+```
+GET     /api/my_app/l2domains/                    Returns all L2 domains
+GET     /api/my_app/l2domains/{id}/               Returns specific L2 domain
+GET     /api/my_app/l2domains/{id}/vlans/         Returns all VLANs within L2 domain
+GET     /api/my_app/l2domains/custom_fields/      Returns all custom fields
+POST    /api/my_app/l2domains/                    Creates new L2 domain
+PATCH   /api/my_app/l2domains/                    Updates L2 domain
+DELETE  /api/my_app/l2domains/                    Deletes L2 domain
+```
+
+### VRF Endpoints
+```
+GET     /api/my_app/vrf/                    Returns all VRFs
+GET     /api/my_app/vrf/{id}/               Returns specific VRF
+GET     /api/my_app/vrf/{id}/subnets/       Returns all subnets within VRF
+GET     /api/my_app/vrf/custom_fields/      Returns all custom fields
+POST    /api/my_app/vrf/                    Creates new VRF
+PATCH   /api/my_app/vrf/                    Updates VRF
+DELETE  /api/my_app/vrf/                    Deletes VRF
+```
+
+### Devices Endpoints
+```
+GET     /api/my_app/devices/                            Returns all devices
+GET     /api/my_app/devices/{id}/                       Returns specific device
+GET     /api/my_app/devices/{id}/subnets/               Returns all subnets within device
+GET     /api/my_app/devices/{id}/addresses/             Returns all addresses within device
+GET     /api/my_app/devices/search/{search_string}/     Searches for devices with {search_string} in any belonging field
+POST    /api/my_app/devices/                            Creates new device
+PATCH   /api/my_app/devices/                            Updates device
+DELETE  /api/my_app/devices/                            Deletes device
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/AminArria/ruby-phpipam.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+require "dotenv"
+Dotenv.load
+
+require "ruby_phpipam"
+
+RubyPhpipam.configure do |config|
+  config.base_url = ENV["base_url"]
+  config.username = ENV["username"]
+  config.password = ENV["password"]
+end
+RubyPhpipam.authenticate
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ruby_phpipam.rb

@@ -0,0 +1,35 @@
+# External gems
+require 'httparty'
+
+# Support Libraries
+require "ruby_phpipam/version"
+require "ruby_phpipam/configuration"
+require "ruby_phpipam/authentication"
+require "ruby_phpipam/exceptions"
+require "ruby_phpipam/query"
+require "ruby_phpipam/helper"
+
+# API Libraries
+require "ruby_phpipam/address"
+require "ruby_phpipam/subnet"
+require "ruby_phpipam/section"
+
+module RubyPhpipam
+  class << self
+    attr_accessor :configuration
+    attr_accessor :auth
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.authenticate
+    self.auth ||= Authentication.new
+  end
+
+  def self.gen_url(url)
+    "#{RubyPhpipam.configuration.base_url}#{url}"
+  end
+end

data/lib/ruby_phpipam/address.rb

@@ -0,0 +1,31 @@
+module RubyPhpipam
+  class Address
+    attr_reader :id, :subnetId, :ip, :is_gateway, :description, :hostname,
+                :mac, :owner, :tag, :PTRignore, :PTR, :deviceId, :port, :note,
+                :lastSeen, :excludePing, :editDate
+
+    def initialize(json)
+      @id = RubyPhpipam::Helper.to_type(json[:id], :int)
+      @subnetId = RubyPhpipam::Helper.to_type(json[:subnetId], :int)
+      @ip = json[:ip]
+      @is_gateway = RubyPhpipam::Helper.to_type(json[:is_gateway], :binary)
+      @description = json[:description]
+      @hostname = json[:hostname]
+      @mac = json[:mac]
+      @owner = json[:owner]
+      @tag = RubyPhpipam::Helper.to_type(json[:tag], :int)
+      @PTRignore = RubyPhpipam::Helper.to_type(json[:PTRignore], :binary)
+      @PTR = RubyPhpipam::Helper.to_type(json[:PTR], :int)
+      @deviceId = RubyPhpipam::Helper.to_type(json[:deviceId], :int)
+      @port = json[:port]
+      @note = json[:note]
+      @lastSeen = RubyPhpipam::Helper.to_type(json[:lastSeen], :date)
+      @excludePing = RubyPhpipam::Helper.to_type(json[:excludePing], :binary)
+      @editDate = RubyPhpipam::Helper.to_type(json[:editDate], :date)
+    end
+
+    def self.get(id)
+      Address.new(RubyPhpipam::Query.get("/addresses/#{id}/"))
+    end
+  end
+end

data/lib/ruby_phpipam/authentication.rb

@@ -0,0 +1,38 @@
+module RubyPhpipam
+  class Authentication
+    attr_reader :token, :expires
+
+    def initialize
+      response = HTTParty.post(RubyPhpipam.gen_url("/user/"),
+          { basic_auth: { username: RubyPhpipam.configuration.username,
+                         password: RubyPhpipam.configuration.password
+                        }
+          }
+        )
+
+      body = JSON.parse(response.body, symbolize_names: true)
+      unless body[:message].nil?
+        raise AuthenticationFailed, body[:message]
+      end
+
+      unless body[:success]
+        raise RequestFailed.new(body[:code], body[:message])
+      end
+
+      @token = body[:data][:token]
+      @expires = Time.strptime(body[:data][:expires], '%Y-%m-%d %H:%M:%S')
+    end
+
+    def validate_token!
+      if @expires <= Time.now
+        data = RubyPhpipam::Query.get("/user/")
+
+        if data[:expires] <= Time.now
+          # Pending re authentication
+        else
+          @expires = data[:expires]
+        end
+      end
+    end
+  end
+end

data/lib/ruby_phpipam/configuration.rb

@@ -0,0 +1,11 @@
+module RubyPhpipam
+  class Configuration
+    attr_accessor :base_url, :username, :password
+
+    def initialize
+      @base_url = nil
+      @username = nil
+      @password = nil
+    end
+  end
+end

data/lib/ruby_phpipam/exceptions.rb

@@ -0,0 +1,27 @@
+module RubyPhpipam
+  # Abstract exception
+  class Error < StandardError; end
+
+  # Raised when authentication fails.
+  class AuthenticationFailed < Error; end
+
+  # Raised when trying to convert to a type that is not defined
+  class UndefinedType < Error; end
+
+  # Raised when cidr is not in cidr format
+  class WrongFormatSearch < Error; end
+
+  # Raised when response success is false.
+  class RequestFailed < Error
+    attr_reader :code, :message
+
+    def initialize(code = nil, message = nil)
+      @code = code
+      @message = message
+    end
+
+    def to_s
+      "Error code: #{code}, message: #{message}"
+    end
+  end
+end

data/lib/ruby_phpipam/helper.rb

@@ -0,0 +1,30 @@
+module RubyPhpipam
+  class Helper
+    def self.to_type(value, type)
+      return nil if value.nil?
+
+      case type
+      when :int
+        value.to_i
+      when :binary
+        value != "0"
+      when :json
+        JSON.parse(value)
+      when :date
+        if value == "0000-00-00 00:00:00"
+          nil
+        else
+          Time.strptime(value, '%Y-%m-%d %H:%M:%S')
+        end
+      else
+        raise UndefinedType, 'given type is not defined'
+      end
+    end
+
+    def self.validate_cidr(cidr)
+      cidr_regex = /^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$/
+
+      not cidr_regex.match(cidr).nil?
+    end
+  end
+end

data/lib/ruby_phpipam/query.rb

@@ -0,0 +1,26 @@
+module RubyPhpipam
+  class Query
+    def self.get(url)
+      RubyPhpipam.auth.validate_token!
+
+      response = HTTParty.get(RubyPhpipam.gen_url(url),
+          headers: {token: RubyPhpipam.auth.token}
+        )
+
+      body = JSON.parse(response.body, symbolize_names: true)
+
+      unless body[:success]
+        raise RequestFailed.new(body[:code], body[:message])
+      end
+
+      body[:data]
+    end
+
+    def self.get_array(url)
+      data = self.get(url)
+
+      return [] if data.nil?
+      return data
+    end
+  end
+end

data/lib/ruby_phpipam/section.rb

@@ -0,0 +1,46 @@
+module RubyPhpipam
+  class Section
+    attr_reader :id, :name, :description, :masterSection, :permissions,
+                :strictMode, :subnetOrdering, :order, :editDate, :showVLAN,
+                :showVRF, :showSupernetOnly, :DNS
+
+    def initialize(json)
+      @id = RubyPhpipam::Helper.to_type(json[:id], :int)
+      @name = json[:name]
+      @description = json[:description]
+      @masterSection = RubyPhpipam::Helper.to_type(json[:masterSection], :int)
+      @permissions = RubyPhpipam::Helper.to_type(json[:permissions], :json)
+      @strictMode = RubyPhpipam::Helper.to_type(json[:strictMode], :binary)
+      @subnetOrdering = json[:subnetOrdering]
+      @order = RubyPhpipam::Helper.to_type(json[:order], :int)
+      @editDate = RubyPhpipam::Helper.to_type(json[:editDate], :date)
+      @showVLAN = RubyPhpipam::Helper.to_type(json[:showVLAN], :binary)
+      @showVRF = RubyPhpipam::Helper.to_type(json[:showVRF], :binary)
+      @showSupernetOnly = RubyPhpipam::Helper.to_type(json[:showSupernetOnly], :binary)
+      @DNS = json[:DNS]
+    end
+
+    def self.get(id_or_name)
+      Section.new(RubyPhpipam::Query.get("/sections/#{id_or_name}/"))
+    end
+
+    def self.get_all
+      data = RubyPhpipam::Query.get("/sections/")
+
+      sections = []
+      data.each do |section|
+        sections << Section.new(section)
+      end
+
+      return sections
+    end
+
+    def subnets
+      data = RubyPhpipam::Query.get_array("/sections/#{@id}/subnets/")
+
+      data.map do |subnet|
+        RubyPhpipam::Subnet.new(subnet)
+      end
+    end
+  end
+end

data/lib/ruby_phpipam/subnet.rb

@@ -0,0 +1,115 @@
+module RubyPhpipam
+  class Subnet
+    # Subnet attributes
+    attr_reader :id, :subnet, :mask, :description, :sectionId, :linked_subnet,
+                :vlanId, :vrfId, :masterSubnetId, :namerServerId, :showName,
+                :permissions, :DNSrecursive, :DNSrecords, :allowResquests,
+                :scanAgent, :pingSubnet, :discoverSubnet, :isFolder, :isFull,
+                :state, :threshold, :location, :editDate
+
+    # Subnet usage attributes
+    attr_reader :used, :maxhosts, :freehosts, :freehosts_percent
+
+    def initialize(json)
+      @id = RubyPhpipam::Helper.to_type(json[:id], :int)
+      @subnet = json[:subnet]
+      @mask = RubyPhpipam::Helper.to_type(json[:mask], :int)
+      @description = json[:description]
+      @sectionId = RubyPhpipam::Helper.to_type(json[:sectionId], :int)
+      @linked_subnet = RubyPhpipam::Helper.to_type(json[:linked_subnet], :int)
+      @vlanId = RubyPhpipam::Helper.to_type(json[:vlanId], :int)
+      @vrfId = RubyPhpipam::Helper.to_type(json[:vrfId], :int)
+      @masterSubnetId = RubyPhpipam::Helper.to_type(json[:masterSubnetId], :int)
+      @namerServerId = RubyPhpipam::Helper.to_type(json[:namerServerId], :int)
+      @showName = RubyPhpipam::Helper.to_type(json[:showName], :binary)
+      @permissions = RubyPhpipam::Helper.to_type(json[:permissions], :json)
+      @DNSrecursive = RubyPhpipam::Helper.to_type(json[:DNSrecursive], :binary)
+      @DNSrecords = RubyPhpipam::Helper.to_type(json[:DNSrecords], :binary)
+      @allowResquests = RubyPhpipam::Helper.to_type(json[:allowResquests], :binary)
+      @scanAgent = RubyPhpipam::Helper.to_type(json[:scanAgent], :binary)
+      @pingSubnet = RubyPhpipam::Helper.to_type(json[:pingSubnet], :binary)
+      @discoverSubnet = RubyPhpipam::Helper.to_type(json[:discoverSubnet], :binary)
+      @isFolder = RubyPhpipam::Helper.to_type(json[:isFolder], :binary)
+      @isFull = RubyPhpipam::Helper.to_type(json[:isFull], :binary)
+      @state = RubyPhpipam::Helper.to_type(json[:state], :int)
+      @threshold = RubyPhpipam::Helper.to_type(json[:threshold], :int)
+      @location = RubyPhpipam::Helper.to_type(json[:location], :int)
+      @editDate = RubyPhpipam::Helper.to_type(json[:editDate], :date)
+    end
+
+    def self.get(id)
+      Subnet.new(RubyPhpipam::Query.get("/subnets/#{id}/"))
+    end
+
+    def self.search(cidr)
+      unless RubyPhpipam::Helper.validate_cidr(cidr)
+        raise WrongFormatSearch, "CIDR doesn't match CIDR format x.x.x.x/y"
+      end
+
+      base, mask = cidr.split("/")
+
+      data = RubyPhpipam::Query.get("/subnets/cidr/#{base}/#{mask}/")
+
+      # Currently Rubyphpipam gives the resonse to this query as an array
+      # just containing the element.
+      return Subnet.new(data[0])
+    end
+
+    def usage
+      data = RubyPhpipam::Query.get("/subnets/#{id}/usage/")
+
+      @used = RubyPhpipam::Helper.to_type(data[:used], :int)
+      @maxhosts = RubyPhpipam::Helper.to_type(data[:maxhosts], :int)
+      @freehosts = RubyPhpipam::Helper.to_type(data[:freehosts], :int)
+      @freehosts_percent = data[:freehosts_percent]
+
+      return self
+    end
+
+    def addresses
+      data = RubyPhpipam::Query.get_array("/subnets/#{id}/addresses/")
+
+      data.map do |addr|
+        RubyPhpipam::Address.new(addr)
+      end
+    end
+
+    # This will need to wait for response to the issue created
+    # https://github.com/Rubyphpipam/Rubyphpipam/issues/1217
+    # def get_address(ip)
+    #   data = RubyPhpipam::Query.get("/subnets/#{id}/addresses/#{ip}/")
+
+    #   RubyPhpipam::Address.new(data)
+    # end
+
+    def first_free_ip
+      # Should this raise an exception if no address available or return nil?
+      # Currently it returns nil
+      data = RubyPhpipam::Query.get("/subnets/#{id}/first_free/")
+    end
+
+    def slaves
+      data = RubyPhpipam::Query.get_array("/subnets/#{id}/slaves/")
+
+      data.map do |subnet|
+        RubyPhpipam::Subnet.new(subnet)
+      end
+    end
+
+    def slaves_recursive
+      data = RubyPhpipam::Query.get_array("/subnets/#{id}/slaves_recursive/")
+
+      data.map do |subnet|
+        RubyPhpipam::Subnet.new(subnet)
+      end
+    end
+
+    def first_subnet(mask)
+      RubyPhpipam::Query.get("/subnets/#{id}/first_subnet/#{mask}/")
+    end
+
+    def all_subnets(mask)
+      RubyPhpipam::Query.get_array("/subnets/#{id}/all_subnets/#{mask}/")
+    end
+  end
+end

data/lib/ruby_phpipam/version.rb

@@ -0,0 +1,3 @@
+module RubyPhpipam
+  VERSION = "0.1.0"
+end

data/ruby_phpipam.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_phpipam/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_phpipam"
+  spec.version       = RubyPhpipam::VERSION
+  spec.authors       = ["Amin Arria"]
+  spec.email         = ["arria.amin@gmail.com"]
+
+  spec.summary       = "Ruby wrapper for the phpipam API"
+  spec.description   = "Ruby client for the phpipam API"
+  spec.homepage      = "https://github.com/AminArria/ruby-phpipam"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: ruby_phpipam
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Amin Arria
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for the phpipam API
+email:
+- arria.amin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby_phpipam.rb
+- lib/ruby_phpipam/address.rb
+- lib/ruby_phpipam/authentication.rb
+- lib/ruby_phpipam/configuration.rb
+- lib/ruby_phpipam/exceptions.rb
+- lib/ruby_phpipam/helper.rb
+- lib/ruby_phpipam/query.rb
+- lib/ruby_phpipam/section.rb
+- lib/ruby_phpipam/subnet.rb
+- lib/ruby_phpipam/version.rb
+- ruby_phpipam.gemspec
+homepage: https://github.com/AminArria/ruby-phpipam
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the phpipam API
+test_files: []