ruby_phpipam 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03afbcf591d332ec1cb73fb534bff63ad7438162
-  data.tar.gz: f4cc8ad1794c73ae546b6328db10f5012552d82d
+  metadata.gz: 94e627b29e7624df9d6f1a3a72705269be8e0cca
+  data.tar.gz: 1b6c9101339c6a0b2dca39a53ecc6525b5c21b61
 SHA512:
-  metadata.gz: 2ec050a20f449e859a366d4d854317a8676561c90a2a3691847d285e18b7aa9a326d55ac42784a9d61d0730e5fbdbaac17b1c3ef8e79c473ce781a4b6400e579
-  data.tar.gz: 4b74f2c12a427ce363e5a162b504b3b64c3a350a092471955693a6d93b6a1bd35fd878d8755bd96ce18105e50e363186927409b930ebd66c8806fa7aa21485c3
+  metadata.gz: f0cc58c782851327e7d7c9cbed7eb710c588742d8f8f4874a6ef95c37f09649e76ce5f04b0e7143bac3f54f5070734d1a8ce274ce15392a5bfbf480e03869684
+  data.tar.gz: '0867ee83accf8146b7cb6b6c8118a72b17aed9759a26c94b6492b6495b27c9ae38b50935d3e7bb7f16882f69c880cc2aca3f41945ce610da8f8cd406830c5781'

data/README.md

@@ -1,4 +1,6 @@
 # ruby_phpipam
+[![Gem Version](https://badge.fury.io/rb/ruby_phpipam.svg)](https://badge.fury.io/rb/ruby_phpipam)
+[![Build Status](https://travis-ci.org/AminArria/ruby-phpipam.svg?branch=master)](https://travis-ci.org/AminArria/ruby-phpipam)
 
 **Important Note**: GET actions have highest priority for development, but feel free to make a PR for the others.
 
@@ -7,7 +9,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ruby_phpipam', git: 'git://github.com/AminArria/ruby-phpipam'
+gem 'ruby_phpipam'
 
 ```
 
@@ -35,7 +37,8 @@ Phpipam.authenticate
 ### API Calls
 In here you'll see the following:
 ```
-method_name()     What it does      What it returns
+instance_method()       What it does      What it returns
+self.class_method()     What it does      What it returns
 ```
 
 #### Section
@@ -62,7 +65,9 @@ all_subnets(mask)     Get all posible subnets (CIDR)      Array of strings
 
 #### Address
 ```
-self.get(id)      Get address by ID     Address object
+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
 ```
 
 ## Pending API endpoints
@@ -93,7 +98,6 @@ DELETE  /api/my_app/subnets/{id}/permissions/             Removes all permission
 
 ### 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

data/lib/ruby_phpipam/address.rb

@@ -27,5 +27,19 @@ module RubyPhpipam
     def self.get(id)
       Address.new(RubyPhpipam::Query.get("/addresses/#{id}/"))
     end
+
+    def self.ping(id)
+      response = RubyPhpipam::Query.get("/addresses/#{id}/ping/")
+
+      if response[:exit_code] == 0
+        return true
+      else
+        return false
+      end
+    end
+
+    def online?
+      RubyPhpipam::Address.ping(@id)
+    end
   end
 end

data/lib/ruby_phpipam/authentication.rb

@@ -25,12 +25,23 @@ module RubyPhpipam
 
     def validate_token!
       if @expires <= Time.now
-        data = RubyPhpipam::Query.get("/user/")
+        header = {
+          "token" => @token
+        }
 
-        if data[:expires] <= Time.now
+        response = HTTParty.get(RubyPhpipam.gen_url("/user/"), headers: header)
+
+        body = JSON.parse(response.body, symbolize_names: true)
+
+        unless body[:success] && body[:code] >= 200 && body[:code] < 400
+          raise RequestFailed.new(body[:code], body[:message])
+        end
+
+
+        if body[:data][:expires] <= Time.now
           # Pending re authentication
         else
-          @expires = data[:expires]
+          @expires = body[:ñdata][:expires]
         end
       end
     end

data/lib/ruby_phpipam/query.rb

@@ -9,7 +9,7 @@ module RubyPhpipam
 
       body = JSON.parse(response.body, symbolize_names: true)
 
-      unless body[:success]
+      unless body[:success] && body[:code] >= 200 && body[:code] < 400
         raise RequestFailed.new(body[:code], body[:message])
       end
 

data/lib/ruby_phpipam/subnet.rb

@@ -50,12 +50,16 @@ module RubyPhpipam
 
       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])
+      if data.nil?
+        return nil
+      else
+        # Currently Rubyphpipam gives the resonse to this query as an array
+        # just containing the element.
+        return Subnet.new(data[0])
+      end
     end
 
-    def usage
+    def usage!
       data = RubyPhpipam::Query.get("/subnets/#{id}/usage/")
 
       @used = RubyPhpipam::Helper.to_type(data[:used], :int)
@@ -85,7 +89,7 @@ module RubyPhpipam
     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/")
+      RubyPhpipam::Query.get("/subnets/#{id}/first_free/")
     end
 
     def slaves
@@ -104,12 +108,13 @@ module RubyPhpipam
       end
     end
 
-    def first_subnet(mask)
-      RubyPhpipam::Query.get("/subnets/#{id}/first_subnet/#{mask}/")
+    def first_subnet(slave_mask)
+      # nil when no available subnet exists
+      RubyPhpipam::Query.get("/subnets/#{id}/first_subnet/#{slave_mask}/")
     end
 
-    def all_subnets(mask)
-      RubyPhpipam::Query.get_array("/subnets/#{id}/all_subnets/#{mask}/")
+    def all_subnets(slave_mask)
+      RubyPhpipam::Query.get_array("/subnets/#{id}/all_subnets/#{slave_mask}/")
     end
   end
 end

data/lib/ruby_phpipam/version.rb

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

data/ruby_phpipam.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["arria.amin@gmail.com"]
 
   spec.summary       = "Ruby wrapper for the phpipam API"
-  spec.description   = "Ruby client for the phpipam API"
+  spec.description   = "Ruby wrapper for the phpipam API"
   spec.homepage      = "https://github.com/AminArria/ruby-phpipam"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_phpipam
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Amin Arria
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -108,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby client for the phpipam API
+description: Ruby wrapper for the phpipam API
 email:
 - arria.amin@gmail.com
 executables: []