enfcli 3.3.4 → 3.4.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a10444bb93e50613f8abf51af8bdd29a8826cda137584d3d15739f403eb9e79
-  data.tar.gz: 694813e216f1598a2b1f51103cd945454f8a5ac36646f590b3924842ab42f52b
+  metadata.gz: ed23993cf8999c35cb290c1c5a694cb4b4ccdd2c4b9d55094c1ba80994eadc0c
+  data.tar.gz: 1ee8c5491dcab964f307832b18cff6def37feb6e04b528a3e0829b7572ad69a6
 SHA512:
-  metadata.gz: c6df9b291970f011c428d5136181743eb9de937977ebd79ea486aefd9cc31d9983bb84cc73f713fc091c59795ac1eb31f0b266e8a67ab946ecd1f421a6528057
-  data.tar.gz: f613ae6586e86e0125e28a6644be92b5bb61b634f0fb8e55a10942b2f13847f3ff1e0d07ddf77751e3b5192011495db120a6d2e7f738cd5166389c8cd94a9145
+  metadata.gz: 7c3dd1750b398ae9b37b7161bf8839df7f788a1c383e706b9087a0330b9fc3f8d0c606c93cf558470a8035e4f35a5c7e007aecb4b739baca146950900c438cf8
+  data.tar.gz: 78a255e25b8048bc813cc9a026ce051857d483ff0779352f7b2b81c6e0e3d9427678630b26fe3b9c350a99b5e1d39670f39711fd05289ce68c5fe0fa8c0ebf04

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    enfcli (3.3.4)
+    enfcli (3.4.0.pre.alpha)
       rest-client (~> 2.0)
       terminal-table
       thor (~> 0.20.0)
@@ -55,8 +55,8 @@ GEM
     thor (0.20.3)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.5)
-    unicode-display_width (1.5.0)
+    unf_ext (0.0.7.6)
+    unicode-display_width (1.6.0)
     vcr (4.0.0)
     webmock (3.4.2)
       addressable (>= 2.3.6)

data/lib/enfapi.rb

@@ -18,6 +18,7 @@ require 'singleton'
 require 'json'
 require 'date'
 require 'base64'
+require 'cgi'
 
 #
 # NOTE: When api's are refactored into individual classes
@@ -30,25 +31,109 @@ module EnfApi
   def self.to_json(hash)
     JSON.generate(hash)
   end
-  
+
+  def self.url_encode(str)
+    CGI.escape( str ).gsub("+", "%20")
+  end
+
   class ERROR < StandardError
     def initialize(msg = "ENF Api Error")
       super
     end
   end
 
+  class Dns
+    include Singleton
+
+    def initialize
+      @version = "2019-05-27"
+      @xdns_base_url = "/api/xdns/#{@version}"
+    end
+
+    def list_zones(domain)
+      EnfApi::API.instance.get "#{@xdns_base_url}/zones?enf_domain=#{domain}"
+    end
+
+    def create_dns_zone(new_zone)
+      json = EnfApi::to_json(new_zone)
+      EnfApi::API.instance.post "#{@xdns_base_url}/zones", json
+    end
+
+    def update_dns_zone(zone_id, updated_zone)
+      json = EnfApi::to_json(updated_zone)
+      EnfApi::API.instance.put "#{@xdns_base_url}/zones/#{zone_id}", json
+    end
+
+    def delete_dns_zone(zone_id)
+      EnfApi::API.instance.delete "#{@xdns_base_url}/zones/#{zone_id}"
+    end
+
+    def add_networks_to_zone(zone_id, add_networks)
+      json = EnfApi::to_json(add_networks)
+      EnfApi::API.instance.post "#{@xdns_base_url}/zones/#{zone_id}/networks", json
+    end
+
+    def replace_networks_in_zone(zone_id, replace_networks)
+      json = EnfApi::to_json(replace_networks)
+      EnfApi::API.instance.put "#{@xdns_base_url}/zones/#{zone_id}/networks", json
+    end
+
+    def list_networks_in_zone(zone_id)
+      EnfApi::API.instance.get "#{@xdns_base_url}/zones/#{zone_id}/networks"
+    end
+
+    def delete_networks_from_zone(zone_id, delete_networks)
+      EnfApi::API.instance.delete "#{@xdns_base_url}/zones/#{zone_id}/networks?delete=#{delete_networks}"
+    end
+
+    def list_zones_in_network(network)
+      EnfApi::API.instance.get "#{@xdns_base_url}/networks/#{network}/zones"
+    end
+
+    def provision_server(network, new_server)
+      json = EnfApi::to_json(new_server)
+      EnfApi::API.instance.post "#{@xdns_base_url}/networks/#{network}/servers", json
+    end
+
+    def list_servers(network)
+      EnfApi::API.instance.get "#{@xdns_base_url}/networks/#{network}/servers"
+    end
+
+    def delete_server(network, server_ipv6)
+      EnfApi::API.instance.delete "#{@xdns_base_url}/networks/#{network}/servers/#{server_ipv6}"
+    end
+
+    def create_dns_record(zone_id, new_record)
+      json = EnfApi::to_json(new_record)
+      EnfApi::API.instance.post "#{@xdns_base_url}/zones/#{zone_id}/records", json
+    end
+
+    def list_dns_records(zone_id)
+      EnfApi::API.instance.get "#{@xdns_base_url}/zones/#{zone_id}/records"
+    end
+
+    def query(network, type, name)
+      EnfApi::API.instance.get "#{@xdns_base_url}/networks/#{network}/query/#{type}/#{name}"
+    end
+
+    def delete_dns_record(record_id)
+      EnfApi::API.instance.delete "#{@xdns_base_url}/records/#{record_id}"
+    end
+
+  end
+
   class Firewall
     include Singleton
-    
+
     def list_firewall_rules(network)
       EnfApi::API.instance.get "/api/xfw/v1/#{network}/rule"
     end
-    
-    def add_firewall_rule(network, rule)      
+
+    def add_firewall_rule(network, rule)
       rule_json = EnfApi::to_json(rule)
       EnfApi::API.instance.post "/api/xfw/v1/#{network}/rule", rule_json
     end
-    
+
     def delete_firewall_rules(network, id = nil)
       # Same method to call to delete all firewall rules in a network. if id is nil
       EnfApi::API.instance.delete "/api/xfw/v1/#{network}/rule/#{id}"
@@ -59,7 +144,7 @@ module EnfApi
     include Singleton
 
     ## NO_TEST
-    def provision_group(new_group)      
+    def provision_group(new_group)
       json = EnfApi::to_json(new_group)
       EnfApi::API.instance.post "/api/xiam/v1/groups", json
     end
@@ -71,7 +156,7 @@ module EnfApi
     end
 
     ## NO_TEST
-    def add_group_to_network(gid, ipv6_network)      
+    def add_group_to_network(gid, ipv6_network)
       json = EnfApi::to_json(ipv6_network)
       EnfApi::API.instance.post "/api/xiam/v1/groups/#{gid}/networks", json
     end
@@ -87,23 +172,110 @@ module EnfApi
     end
 
     ## NO_TEST
-    def provision_endpoint(new_endpoint)      
+    def provision_endpoint(new_endpoint)
       json = EnfApi::to_json(new_endpoint)
       EnfApi::API.instance.post "/api/xiam/v1/endpoints", json
     end
 
     ## NO_TEST
-    def update_endpoint_key(ipv6, credentials)         
+    def update_endpoint_key(ipv6, credentials)
       json = EnfApi::to_json(credentials)
       EnfApi::API.instance.post "/api/xiam/v1/endpoints/#{ipv6}/credentials", json
     end
-        
+
+  end
+
+  ##############################################################################
+  #
+  # Captive 
+  #
+  ##############################################################################
+  class Captive
+    include Singleton
+
+    ## NO_TEST
+    def list_wifi_configurations
+      EnfApi::API.instance.get "/api/captive/v1/wifi"
+    end
+
+    ## NO_TEST
+    def create_wifi_configuration(new_wifi_config)
+      json = EnfApi::to_json(new_wifi_config)
+      EnfApi::API.instance.post "/api/captive/v1/wifi", json
+    end
+
+    # Get the wifi configuration using the wifi id
+    ## NO_TEST
+    def get_wifi_configuration(wifi_id, version = nil)
+      url = "/api/captive/v1/wifi/#{wifi_id}"
+      url = "#{url}?version=#{version}" if version
+      EnfApi::API.instance.get url
+    end
+
+    # Update an existing wifi configuration 
+    ## NO_TEST
+    def update_wifi_configuration(wifi_id, updated_wifi_config)
+      json = EnfApi::to_json(updated_wifi_config)
+      EnfApi::API.instance.put "/api/captive/v1/wifi/#{wifi_id}", json
+    end
+
+
+    # Post the new device
+    ## NO_TEST
+    def create_device(new_dev_hash)
+        json = EnfApi.to_json(new_dev_hash)
+        EnfApi::API.instance.post "/api/captive/v1/device", json
+    end
+
+    # Get the list of devices
+    ## NO_TEST
+    def list_devices(network)
+      url = "/api/captive/v1/device"
+      url = "#{url}?#{network}" if network
+      EnfApi::API.instance.get url
+    end
+
+    # Get a specific device detail
+    ## NO_TEST
+    def get_device(dev_id)
+        EnfApi::API.instance.get "/api/captive/v1/device/#{dev_id}"
+    end
+
+    # Post the new profile
+    ## NO_TEST
+    def create_profile(new_profile_hash)
+      json = EnfApi.to_json(new_profile_hash)
+      EnfApi::API.instance.post "/api/captive/v1/profile", json
+    end
+
+
+    # Get the list of profiles
+    # name is a substring of the profile names to be returned
+    ## NO_TEST
+    def list_profiles(name = nil)
+      url = "/api/captive/v1/profile"
+      url = "#{url}?#{name}" if name
+      EnfApi::API.instance.get url
+    end
+
+    # Get detail on a specific profile
+    ## NO_TEST
+    def get_profile (profile_id)
+      EnfApi::API.instance.get "/api/captive/v1/profile/#{profile_id}"
+    end
+
+    # Send update PUT request for profile
+    ## NO_TEST
+    def update_profile (id, profile_updates)
+      json = EnfApi.to_json(profile_updates)
+      EnfApi::API.instance.put "/api/captive/v1/profile/#{id}", json
+    end
   end
   
   class NetworkManager
     include Singleton
   end
-  
+
   class API
     include Singleton
 
@@ -128,7 +300,7 @@ module EnfApi
         case response.code
         when 200
           # get resp from json
-          resp = from_json(response.body)          
+          resp = from_json(response.body)
 
           # set request headers for subsequent api calls
           token = resp[:data][0][:token]
@@ -144,28 +316,28 @@ module EnfApi
 
     def get(request_uri)
       @api[request_uri].get(@headers) {|response, request, result|
-        process_api_response response, request, result       
+        process_api_response response, request, result
       }
     end
 
     def post(request_uri, request_body = '')
       @api[request_uri].post(request_body, @headers) {|response, request, result|
-        process_api_response response, request, result       
+        process_api_response response, request, result
       }
     end
 
     def put(request_uri, request_body = '')
       @api[request_uri].put(request_body, @headers) {|response, request, result|
-        process_api_response response, request, result       
+        process_api_response response, request, result
       }
-    end    
+    end
 
     def delete(request_uri)
       @api[request_uri].delete(@headers) {|response, request, result|
-        process_api_response response, request, result       
+        process_api_response response, request, result
       }
-    end    
-  
+    end
+
 ############################################################################################################################
 # NOT READY API. MOVE ABOVE THIS LINE AFTER RSPEC OR INTO OWN CLASS
 ############################################################################################################################
@@ -175,47 +347,47 @@ module EnfApi
       }
     end
 
-    def list_enfnws      
+    def list_enfnws
       @api["/api/xcr/v2/enfnws"].get( @headers) {|response, request, result|
         process_api_response response, request, result
       }
     end
-    
-    def list_domains  
+
+    def list_domains
       @api["/api/xcr/v2/domains"].get( @headers) {|response, request, result|
         process_api_response response, request, result
       }
     end
-    
-    def get_domain(domain_id)      
+
+    def get_domain(domain_id)
       @api["/api/xcr/v2/domains/#{domain_id}"].get( @headers) {|response, request, result|
         process_api_response response, request, result
       }
     end
 
     def create_domain(domain_hash)
-      json = to_json( domain_hash )      
+      json = to_json( domain_hash )
       @api["/api/xcr/v2/domains"].post( json, @headers) {|response, request, result|
         process_api_response response, request, result
       }
     end
 
     def update_domain_rate_limits(domain_network, limit, limits_hash)
-      json = to_json( limits_hash )      
+      json = to_json( limits_hash )
       @api["/api/xcr/v2/domains/#{domain_network}/ep_rate_limits/#{limit}"].put( json, @headers) {|response, request, result|
         process_api_response response, request, result
       }
     end
 
     def update_network_rate_limits(network, limit, limits_hash)
-      json = to_json( limits_hash )      
+      json = to_json( limits_hash )
       @api["/api/xcr/v2/nws/#{network}/ep_rate_limits/#{limit}"].put( json, @headers) {|response, request, result|
         process_api_response response, request, result
       }
     end
 
     def update_ep_rate_limits(ipv6, limit, limits_hash)
-      json = to_json( limits_hash )      
+      json = to_json( limits_hash )
       @api["/api/xcr/v2/cxns/#{ipv6}/ep_rate_limits/#{limit}"].put( json, @headers) {|response, request, result|
         process_api_response response, request, result
       }
@@ -224,7 +396,7 @@ module EnfApi
     def get_domain_rate_limits(domain_network, filter = nil)
       api_url = "/api/xcr/v2/domains/#{domain_network}/ep_rate_limits"
       api_url = "#{api_url}/#{filter}" if filter
-      
+
       @api[api_url].get( @headers) {|response, request, result|
         process_api_response response, request, result
       }
@@ -233,7 +405,7 @@ module EnfApi
     def get_network_rate_limits(network, filter = nil)
       api_url = "/api/xcr/v2/nws/#{network}/ep_rate_limits"
       api_url = "#{api_url}/#{filter}" if filter
-      
+
       @api[api_url].get( @headers) {|response, request, result|
         process_api_response response, request, result
       }
@@ -242,7 +414,7 @@ module EnfApi
     def get_ep_rate_limits(ipv6, filter = nil)
       api_url = "/api/xcr/v2/cxns/#{ipv6}/ep_rate_limits"
       api_url = "#{api_url}/#{filter}" if filter
-      
+
       @api[api_url].get( @headers) {|response, request, result|
         process_api_response response, request, result
       }
@@ -258,35 +430,35 @@ module EnfApi
       @api["/api/xcr/v2/domains/#{domain_network}/status"].delete( @headers) {|response, request, result|
         process_api_response response, request, result
       }
-    end 
+    end
 
     def create_nw(nw_hash)
       json = to_json(nw_hash)
-      domain_id = nw_hash[:domain_id]      
+      domain_id = nw_hash[:domain_id]
       @api["/api/xcr/v2/domains/#{domain_id}/nws"].post(json, @headers) {|response, request, result|
         process_api_response response, request, result
       }
     end
-    
-    def list_nw_connections(domain_id, network_cidr, file = nil)      
+
+    def list_nw_connections(domain_id, network_cidr, file = nil)
       @api["/api/xcr/v2/domains/#{domain_id}/nws/#{network_cidr}/cxns"].get(@headers) {|response, request, result|
         process_api_response response, request, result
       }
     end
 
-    def list_endpoint_events(ipv6)            
+    def list_endpoint_events(ipv6)
       @api["/api/xcr/v2/cxns/#{ipv6}/events"].get(@headers) {|response, request, result|
         process_api_response response, request, result
       }
     end
 
-    def list_network_events(network_cidr)            
+    def list_network_events(network_cidr)
       @api["/api/xcr/v2/nws/#{network_cidr}/events"].get(@headers) {|response, request, result|
         process_api_response response, request, result
       }
     end
 
-    def get_endpoint(ipv6)            
+    def get_endpoint(ipv6)
       @api["/api/xcr/v2/cxns/#{ipv6}"].get(@headers) {|response, request, result|
         process_api_response response, request, result
       }
@@ -295,19 +467,19 @@ module EnfApi
     def update_endpoint(ipv6, name)
       hash = { :ipv6 => ipv6, :name => name }
       json = to_json( hash )
-      
+
       @api["/api/xcr/v2/cxns/#{ipv6}"].put( json, @headers) {|response, request, result|
-        process_api_response response, request, result                
+        process_api_response response, request, result
       }
     end
 
-    def activate_enfnw(subnet)            
+    def activate_enfnw(subnet)
       @api["/api/xcr/v2/enfnws/#{subnet}"].put( '', @headers) {|response, request, result|
-        process_api_response response, request, result                
+        process_api_response response, request, result
       }
     end
 
-    def list_domain_users(domain_network)      
+    def list_domain_users(domain_network)
       @api["/api/xcr/v2/domains/#{domain_network}/users"].get( @headers) {|response, request, result|
         puts response.code
         process_api_response response, request, result
@@ -324,10 +496,10 @@ module EnfApi
       json = to_json( hash )
       @api["/api/xcr/v2/domains/#{domain_network}/invites"].post( json, @headers) { |response, request, result|
         process_api_response response, request, result
-      }      
+      }
     end
 
-    def cancel_invite(email)      
+    def cancel_invite(email)
       @api["/api/xcr/v2/invites/#{email}"].delete( @headers) {|response, request, result|
         process_api_response response, request, result
       }
@@ -336,7 +508,7 @@ module EnfApi
     def resend_invite(email)
       @api["/api/xcr/v2/invites/#{email}"].put( "{}", @headers) {|response, request, result|
         process_api_response response, request, result
-      }      
+      }
     end
 
 ############################################################################################################################
@@ -351,7 +523,7 @@ module EnfApi
         when 201
           # return response body
           from_json(response.body)
-          
+
         when 400
           # api returns and error
           raise EnfApi::ERROR, api_error_msg(from_json(response.body))
@@ -363,12 +535,12 @@ module EnfApi
         when 403
           # api returns and error
           raise EnfApi::ERROR, "AUTHORIZATION_ERROR: User is not authorized to perform this operation!"
-          
+
         else
           raise EnfApi::ERROR, "Unexpected error! Please try again!"
         end
     end
-    
+
     def from_json(string)
       begin
         JSON.parse(string, {:symbolize_names => true})
@@ -386,10 +558,12 @@ module EnfApi
         reason = err[:reason]
         reason = Base64.decode64(reason)
         "#{reason}"
-      else
+      elsif err.key?(:error)
         code = err[:error][:code]
         text = err[:error][:text]
         "#{code.upcase}: #{text}"
+      else
+        "UNKNOWN_ERROR: server did not respond with properly formatted error message."
       end
     end