enfcli 4.1.0.pre.beta → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27d832f6ee49be44d9463b1b77931d15db08f79f6d382c1bc243635ef9eca137
-  data.tar.gz: 070eabadf3b810b47c948dd5ca84cc362852dde237dba5a95a7e4e90e011f8b0
+  metadata.gz: 86826b25857a616c9ce13cf6bc4f7ee929e601bc8a70cc3d2510b73259ebd5e1
+  data.tar.gz: 77d3e2ab72a9ababd8926e3fd09d6f0155cc5464677d2b4fdb0ef33196b5bb24
 SHA512:
-  metadata.gz: afc068399c4e7477a16388c3ead24346520823cb214b19befe9a4a4d58a19f14b4f45868b31c66b7841c24073970241fb81b68f54e5bc23534d547e586436de4
-  data.tar.gz: 3d9e53a84414a42d17e35c8c01852af895a149d5e906000d3e84fa7282150d49542a91c130c73b35b8a010139771adcac0267a31991686799b62346f42daf6ba
+  metadata.gz: 12b1b10048964fda4775f2408a4ead3118c10307cf267757c261e0c4d1dcf88dad4a91cb14e3e3d52c13bbaf3aada2f534647a245fc6aaaea8f2f2e810c3e905
+  data.tar.gz: 79d93340b0b3818261b2f7f90527076878ecfc8d7485a79811e8cb9edb774a0b41855bbcdfd87f72f50de1271f40912d251eaae8c7f0980d0d3307d08c9e5456

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    enfcli (4.1.0.pre.beta)
+    enfcli (5.0.1)
       clipboard
       ffi
       readline
@@ -21,7 +21,7 @@ GEM
     diff-lcs (1.3)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    ffi (1.12.2)
+    ffi (1.13.1)
     fuubar (2.5.0)
       rspec-core (~> 3.0)
       ruby-progressbar (~> 1.4)
@@ -32,13 +32,13 @@ GEM
     io-console (0.5.6)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
+    mime-types-data (3.2020.0512)
     netrc (0.11.0)
     public_suffix (4.0.3)
     rake (10.5.0)
     readline (0.0.2)
       reline
-    reline (0.1.3)
+    reline (0.1.4)
       io-console (~> 0.5)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)

data/lib/enfapi.rb

@@ -1,5 +1,5 @@
 #
-# Copyright 2018 Xaptum,Inc
+# Copyright 2020 Xaptum,Inc
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -30,6 +30,14 @@ module EnfApi
     JSON.generate(hash)
   end
 
+  def self.from_json(string)
+    begin
+      JSON.parse(string, { symbolize_names: true })
+    rescue
+      raise EnfApi::ERROR, "Unable to parse api response json!"
+    end
+  end
+
   def self.url_encode(str)
     CGI.escape(str).gsub("+", "%20")
   end
@@ -40,103 +48,6 @@ module EnfApi
     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)
-      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}"
-    end
-  end
-
   class Iam
     include Singleton
 
@@ -284,6 +195,89 @@ module EnfApi
       json = EnfApi.to_json(profile_updates)
       EnfApi::API.instance.put "/api/captive/v1/profile/#{id}", json
     end
+
+    # Get the list of devices
+    ## NO_TEST
+    def list_firmware_images()
+      url = "/api/captive/v1/firmware/release"
+      EnfApi::API.instance.get url
+    end
+
+    # Upload the firmware image
+    # Current version sends an empty body - captive server doesn't support
+    # sending the binary image yet.
+    ## NO_TEST
+    def upload_firmware_image(version, image_name)
+      url = "/api/captive/v1/firmware/release/#{version}/#{image_name}"
+      EnfApi::API.instance.put url
+    end
+
+    # gets the details for a specific firmware version
+    ## NO_TEST
+    def get_firmware_info(version)
+      url = "/api/captive/v1/firmware/release/#{version}"
+      EnfApi::API.instance.get url
+    end
+
+    # creates a new schedule object via POST
+    ## NO_TEST
+    def create_schedule(sched_hash)
+      json = EnfApi.to_json(sched_hash)
+      EnfApi::API.instance.post "/api/captive/v1/schedule", json
+    end
+
+    # GETs a list of all existing schedules
+    ## NO_TEST
+    def list_schedules
+      EnfApi::API.instance.get "/api/captive/v1/schedule"
+    end
+
+    # GETs the details of a specific schedule
+    ## NO_TEST
+    def get_schedule(id)
+      EnfApi::API.instance.get "/api/captive/v1/schedule/#{id}"
+    end
+
+    # update the details of a specific schedule
+    ## NO_TEST
+    def update_schedule(id, sched_hash)
+      json = EnfApi.to_json(sched_hash)
+      url = "/api/captive/v1/schedule/#{id}"
+      EnfApi::API.instance.put url, json
+    end
+
+    # DELETEs the specified schedule
+    ## NO_TEST
+    def delete_schedule(id)
+      EnfApi::API.instance.delete "/api/captive/v1/schedule/#{id}"
+    end
+
+    # GET the list of existing update objects
+    ## NO_TEST
+    def list_firmware_updates()
+      EnfApi::API.instance.get "/api/captive/v1/firmware/update"
+    end
+
+    # GET details of a specified firmware update task
+    ## NO_TEST
+    def get_firmware_update(update_id)
+      EnfApi::API.instance.get "/api/captive/v1/firmware/update/#{update_id}"
+    end
+
+    # POSTs a new firmware-udpate object
+    ## NO_TEST
+    def create_firmware_update(update_hash)
+      json = EnfApi.to_json(update_hash)
+      EnfApi::API.instance.post "/api/captive/v1/firmware/update", json
+    end
+
+    # uses PUT to modify an existing firmware update task
+    ## NO_TEST
+    def modify_firmware_update(update_id, update_hash)
+      url = "/api/captive/v1/firmware/update/#{update_id}"
+      json = EnfApi.to_json(update_hash)
+      EnfApi::API.instance.put url, json
+    end
   end
 
   class NetworkManager
@@ -306,11 +300,11 @@ module EnfApi
       @api = RestClient::Resource.new(host)
 
       # Create request json
-      hash = { :username => user, :token => password }
+      hash = { username: user, password: password }
       json = to_json(hash)
 
       # call api
-      @api["/api/xcr/v2/xauth"].post(json, { content_type: :json, accept: :json }) { |response, request, result|
+      @api["/api/xcr/v3/xauth"].post(json, { content_type: :json, accept: :json }) { |response, request, result|
         case response.code
         when 200
           # get resp from json
@@ -356,59 +350,59 @@ module EnfApi
     # NOT READY API. MOVE ABOVE THIS LINE AFTER RSPEC OR INTO OWN CLASS
     ############################################################################################################################
     def list_domain_nws(domain_id)
-      @api["/api/xcr/v2/domains/#{domain_id}/nws"].get(@headers) { |response, request, result|
+      @api["/api/xcr/v3/domains/#{domain_id}/nws"].get(@headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
     def list_enfnws
-      @api["/api/xcr/v2/enfnws"].get(@headers) { |response, request, result|
+      @api["/api/xcr/v3/enfnws"].get(@headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
     def list_domains
-      @api["/api/xcr/v2/domains"].get(@headers) { |response, request, result|
+      @api["/api/xcr/v3/domains"].get(@headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
     def get_domain(domain_id)
-      @api["/api/xcr/v2/domains/#{domain_id}"].get(@headers) { |response, request, result|
+      @api["/api/xcr/v3/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)
-      @api["/api/xcr/v2/domains"].post(json, @headers) { |response, request, result|
+      @api["/api/xcr/v3/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)
-      @api["/api/xcr/v2/domains/#{domain_network}/ep_rate_limits/#{limit}"].put(json, @headers) { |response, request, result|
+      @api["/api/xcr/v3/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)
-      @api["/api/xcr/v2/nws/#{network}/ep_rate_limits/#{limit}"].put(json, @headers) { |response, request, result|
+      @api["/api/xcr/v3/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)
-      @api["/api/xcr/v2/cxns/#{ipv6}/ep_rate_limits/#{limit}"].put(json, @headers) { |response, request, result|
+      @api["/api/xcr/v3/cxns/#{ipv6}/ep_rate_limits/#{limit}"].put(json, @headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
     def get_domain_rate_limits(domain_network, filter = nil)
-      api_url = "/api/xcr/v2/domains/#{domain_network}/ep_rate_limits"
+      api_url = "/api/xcr/v3/domains/#{domain_network}/ep_rate_limits"
       api_url = "#{api_url}/#{filter}" if filter
 
       @api[api_url].get(@headers) { |response, request, result|
@@ -417,7 +411,7 @@ module EnfApi
     end
 
     def get_network_rate_limits(network, filter = nil)
-      api_url = "/api/xcr/v2/nws/#{network}/ep_rate_limits"
+      api_url = "/api/xcr/v3/nws/#{network}/ep_rate_limits"
       api_url = "#{api_url}/#{filter}" if filter
 
       @api[api_url].get(@headers) { |response, request, result|
@@ -426,7 +420,7 @@ module EnfApi
     end
 
     def get_ep_rate_limits(ipv6, filter = nil)
-      api_url = "/api/xcr/v2/cxns/#{ipv6}/ep_rate_limits"
+      api_url = "/api/xcr/v3/cxns/#{ipv6}/ep_rate_limits"
       api_url = "#{api_url}/#{filter}" if filter
 
       @api[api_url].get(@headers) { |response, request, result|
@@ -436,105 +430,66 @@ module EnfApi
 
     def update_domain_status(domain_network, status)
       json = to_json(status)
-      @api["/api/xcr/v2/domains/#{domain_network}/status"].put(json, @headers) { |response, request, result|
+      @api["/api/xcr/v3/domains/#{domain_network}/status"].put(json, @headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
-    def create_nw(nw_hash)
+    def create_nw(domain, nw_hash)
       json = to_json(nw_hash)
-      domain_id = nw_hash[:domain_id]
-      @api["/api/xcr/v2/domains/#{domain_id}/nws"].post(json, @headers) { |response, request, result|
+      @api["/api/xcr/v3/domains/#{domain}/nws"].post(json, @headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
     def update_nw(network_cidr, nw_hash)
       json = to_json(nw_hash)
-      @api["/api/xcr/v2/nws/#{network_cidr}"].put(json, @headers) { |response, request, result|
+      @api["/api/xcr/v3/nws/#{network_cidr}"].put(json, @headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
     def get_nw(network_cidr)
-      @api["/api/xcr/v2/nws/#{network_cidr}"].get(@headers) { |response, request, result|
+      @api["/api/xcr/v3/nws/#{network_cidr}"].get(@headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
-    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|
+    def list_nw_connections(network_cidr, file = nil)
+      @api["/api/xcr/v3/nws/#{network_cidr}/cxns"].get(@headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
     def list_endpoint_events(ipv6)
-      @api["/api/xcr/v2/cxns/#{ipv6}/events"].get(@headers) { |response, request, result|
+      @api["/api/xcr/v3/cxns/#{ipv6}/events"].get(@headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
     def list_network_events(network_cidr)
-      @api["/api/xcr/v2/nws/#{network_cidr}/events"].get(@headers) { |response, request, result|
+      @api["/api/xcr/v3/nws/#{network_cidr}/events"].get(@headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
     def get_endpoint(ipv6)
-      @api["/api/xcr/v2/cxns/#{ipv6}"].get(@headers) { |response, request, result|
+      @api["/api/xcr/v3/cxns/#{ipv6}"].get(@headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
     def update_endpoint(ipv6, name)
-      hash = { :ipv6 => ipv6, :name => name }
+      hash = { ipv6: ipv6, name: name }
       json = to_json(hash)
 
-      @api["/api/xcr/v2/cxns/#{ipv6}"].put(json, @headers) { |response, request, result|
+      @api["/api/xcr/v3/cxns/#{ipv6}"].put(json, @headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
     def activate_enfnw(subnet)
-      @api["/api/xcr/v2/enfnws/#{subnet}"].put("", @headers) { |response, request, result|
-        process_api_response response, request, result
-      }
-    end
-
-    def list_domain_users(domain_network)
-      @api["/api/xcr/v2/domains/#{domain_network}/users"].get(@headers) { |response, request, result|
-        process_api_response response, request, result
-      }
-    end
-
-    def list_domain_invites(domain_network)
-      @api["/api/xcr/v2/domains/#{domain_network}/invites"].get(@headers) { |response, request, result|
-        process_api_response response, request, result
-      }
-    end
-
-    def invite(domain_network, hash)
-      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)
-      @api["/api/xcr/v2/invites/#{email}"].delete(@headers) { |response, request, result|
-        process_api_response response, request, result
-      }
-    end
-
-    def resend_invite(email)
-      @api["/api/xcr/v2/invites/#{email}"].put("{}", @headers) { |response, request, result|
-        process_api_response response, request, result
-      }
-    end
-
-    def update_user_status(user_id, status)
-      json = to_json(status)
-      @api["/api/xcr/v2/users/#{user_id}/status"].put(json, @headers) { |response, request, result|
+      @api["/api/xcr/v3/enfnws/#{subnet}"].put("", @headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
@@ -569,21 +524,24 @@ module EnfApi
         rescue JSON::ParserError => e
           raise EnfApi::ERROR, "Not Found"
         end
+      when 500
+        begin
+          JSON.parse(response.body)
+          raise EnfApi::ERROR, api_error_msg(from_json(response.body))
+        rescue JSON::ParserError => e
+          raise EnfApi::ERROR, "Server error was received without details."
+        end
       else
         raise EnfApi::ERROR, "Unexpected error! Please try again!"
       end
     end
 
     def from_json(string)
-      begin
-        JSON.parse(string, { :symbolize_names => true })
-      rescue
-        raise EnfApi::ERROR, "Unable to parse api response json!"
-      end
+      EnfApi::from_json(string)
     end
 
     def to_json(hash)
-      JSON.generate(hash)
+      EnfApi::to_json(hash)
     end
 
     def api_error_msg(err)