enfcli 4.0.0 → 5.0.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 255cec434b6f65e51e5736e54d47d0752a5328f88e72a2567c3b3dbd99f93873
-  data.tar.gz: 2f7d9068c55410ed289af80d1953302363cb65f4c25a2ab430bbef32126270be
+  metadata.gz: 29f4309503935f6931b068e80a850488b2f8833474734c05e8455a04f84293e0
+  data.tar.gz: 2488271b45ee7c7e5b96cc95546d2f625fb1c503d9ad6720f62649073d4a1874
 SHA512:
-  metadata.gz: 1a7e8d53f0c2f190844768ef6c74905ec6437f2ae2038150adf4f010d8e9f3890f23b518e42c00565a8f2656fb40990a7ace5be6309da4d151e127d1c3c8bfc8
-  data.tar.gz: 8f37ea162b259939302a2a36fae2ff51d93bc930ce8baae72d61ea0cfcb2cc997b8b9a076ad87c2c8c4a51a27329e54f91b2b55f574789215731a2c6eb563ca3
+  metadata.gz: 033366cb4db237f61526ddf357bbdfd57d60b482398d21eee798413b5afc91b51a6baae60526b957f07a80f01dea5b47372d72193d40b0af20a98fb88de1cd51
+  data.tar.gz: e7bd3d1c7da7a861a89f242bd5a2d2f898e5e5b4f848c2412fa9a1b5acb7ac73fb5c679979e80b9b7d1e81ba87de761f157141d49eda2d6c3c5d55b1b315c249

data/.circleci/Dockerfile

@@ -1,4 +1,4 @@
-FROM circleci/ruby
+FROM circleci/ruby:2.6.3-stretch
 MAINTAINER Xaptum
 
 
@@ -8,4 +8,4 @@ LABEL description="Base image for encli build"
 RUN gem install bundler
 RUN gem install bump
 RUN gem install geminabox
-
+RUN gem install rufo

data/.circleci/config.yml

@@ -49,6 +49,11 @@ jobs:
             - ./vendor/bundle
           key: v1-dependencies-{{ checksum "Gemfile.lock" }}
 
+      - run:
+          name: Check code format
+          command: |
+            make check-format
+
       # run tests!
       - run:
           name: run tests

data/Gemfile.lock

@@ -1,7 +1,10 @@
 PATH
   remote: .
   specs:
-    enfcli (4.0.0)
+    enfcli (5.0.0.pre.alpha)
+      clipboard
+      ffi
+      readline
       rest-client (~> 2.0)
       terminal-table
       thor (~> 0.20.0)
@@ -9,61 +12,69 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    bump (0.6.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    bump (0.8.0)
+    clipboard (1.3.3)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    fuubar (2.3.2)
+    ffi (1.12.2)
+    fuubar (2.5.0)
       rspec-core (~> 3.0)
       ruby-progressbar (~> 1.4)
-    hashdiff (0.3.7)
+    hashdiff (1.0.0)
     http-accept (1.7.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    mime-types (3.3)
+    io-console (0.5.5)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2019.1009)
     netrc (0.11.0)
-    public_suffix (3.0.3)
+    public_suffix (4.0.3)
     rake (10.5.0)
+    readline (0.0.2)
+      reline
+    reline (0.1.2)
+      io-console (~> 0.5)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    ruby-progressbar (1.10.0)
-    safe_yaml (1.0.4)
+    ruby-progressbar (1.10.1)
+    rufo (0.8.1)
+    safe_yaml (1.0.5)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thor (0.20.3)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.6)
-    unicode-display_width (1.6.0)
-    vcr (4.0.0)
-    webmock (3.4.2)
+    unicode-display_width (1.6.1)
+    vcr (5.0.0)
+    webmock (3.7.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -76,8 +87,9 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec
   rspec_junit_formatter
+  rufo
   vcr
   webmock
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/Makefile

@@ -24,5 +24,12 @@ version:
 test:
 	bundle exec rspec --format Fuubar --color spec/**/*_spec.rb
 
+format:
+	./format.sh
+
+check-format:
+	@rufo --check lib
+	@rufo --check spec
+
 clean:
 	rm -rf pkg

data/README.md

@@ -1,6 +1,6 @@
 # enfcli
 
-
+The `enfcli` - Xaptum's CLI tool - allows you to easily manage your ENF resources. Check out [the docs](https://docs.xaptum.com/api) for examples of the various `enfcli` commands available for you to use.
 
 ## Installation
 
@@ -24,16 +24,62 @@ $ gem install enfcli --pre
 
 ## Usage
 
-- Connect to ENF
+There are two ways to connect to the ENF through the `enfcli`.
+
+1. Configuration file
+
+    The recommended way to connect to the ENF through the `enfcli` is by creating a configuration file (`.xaptum_config.json`) in your home directory. The `enfcli` will read your configuration from this file whenever you attempt to connect, and will save you from entering in your `host` and `username` parameters each time. The following command creates a config file in your home directory.
+
+    ```
+    $ enfcli create-config-file --host=<HOST> --user=<USERNAME>
+    Config file created successfully at /Users/dylanirlbeck/.xaptum_config.json!
+    ```
+
+    You can view your current configuration at any time by doing the following:
+
+    ```
+    $ enfcli display-config-file
+    {"host":<HOST>,"user":<USERNAME>}
+    ```
+
+    With your configuration file created, connect to the ENF by simply doing
+    ```
+    $ enfcli
+    Connecting to <HOST>.....
+    Enter Password: <PASSWORD>
+    ```
+
+2. CLI parameters
+
+    Instead of a configuration file, you can always connect to the ENF through the `enfcli` by providing your host and username as command line parameters
+
+    ```bash
+    $ enfcli --host <host> --user <user>
+    ```
+
+Whichever way you choose, you'll be prompted for your account password as the final step of authentication. Once authenticated, type `help` in `enfcli` prompt to list all available `enfcli` commands
+
+```bash
+enfcli-user@acme> help
+```
+
+## Development
+- Clone the repository
+- Create a new branch
   ```bash
-  $ enfcli --host <host> --user <user>
+  git checkout -b <GIT_USER_NAME>/<BRANCH_NAME>
   ```
-  Once authenticated, type `help` in `enfcli` prompt to list all available `enfcli` commands
-  
+- Bump the version
   ```bash
-  enfcli-user@domain> help
+  make bump-pre
+  ```
+- Ensure code is formatted using `rufo`. The build process will fail if the code is not formatted.
+  ```bash
+  make format
   ```
 
+**NOTE: Do not fork the repository**
+
 ## Release
 `enfcli` pre-release and release versions are automatically published to [RubyGems](https://rubygems.org) by the build process. Each commit to `master` branch publishes a pre-release version of the gem.
 
@@ -64,4 +110,3 @@ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 License for the specific language governing permissions and limitations under
 the License.
-

data/enfcli.gemspec

@@ -1,16 +1,15 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'enfcli/version'
+require "enfcli/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "enfcli"
-  spec.version       = EnfCli::VERSION
-  spec.authors       = ["Venkatakumar Srinivasan"]
-  spec.email         = ["venkat@xaptum.com"]
-
-  spec.summary       = %q{Xaptum ENF CLI.}
-  spec.homepage      = "https://www.xaptum.com"
+  spec.name = "enfcli"
+  spec.version = EnfCli::VERSION
+  spec.authors = ["Venkatakumar Srinivasan"]
+  spec.email = ["venkat@xaptum.com"]
+  spec.summary = "Xaptum ENF CLI."
+  spec.homepage = "https://www.xaptum.com"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -20,27 +19,30 @@ Gem::Specification.new do |spec|
   #  raise "RubyGems 2.0 or newer is required to protect against " \
   #    "public gem pushes."
   #end
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'thor', '~> 0.20.0'
-  spec.add_dependency "rest-client", "~> 2.0"
-  spec.add_dependency "terminal-table"
+  spec.add_dependency("thor", "~> 0.20.0")
+  spec.add_dependency("rest-client", "~> 2.0")
+  spec.add_dependency("terminal-table")
+  spec.add_dependency("clipboard")
+  spec.add_dependency("ffi")
+  spec.add_dependency("readline")
+
   #spec.add_dependency "websocket-client-simple"
   #spec.add_dependency "colorize"
-  
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "bump"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rspec_junit_formatter"
-  spec.add_development_dependency "fuubar"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
-  
+  spec.add_development_dependency("bundler")
+  spec.add_development_dependency("rake", "~> 10.0")
+  spec.add_development_dependency("bump")
+  spec.add_development_dependency("rspec")
+  spec.add_development_dependency("rspec_junit_formatter")
+  spec.add_development_dependency("fuubar")
+  spec.add_development_dependency("vcr")
+  spec.add_development_dependency("webmock")
+  spec.add_development_dependency("rufo")
 end

data/format.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+## Formatting is done using rufo library
+## rufo exits with exit code 3 if it is able to
+## format the code.
+
+echo "Formatting code.."
+rufo lib spec
+echo "Formatted!"

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.
@@ -13,11 +13,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require 'rest-client'
-require 'singleton'
-require 'json'
-require 'date'
-require 'cgi'
+require "rest-client"
+require "singleton"
+require "json"
+require "date"
+require "cgi"
 
 #
 # NOTE: When api's are refactored into individual classes
@@ -26,13 +26,20 @@ require 'cgi'
 #
 
 module EnfApi
-
   def self.to_json(hash)
     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")
+    CGI.escape(str).gsub("+", "%20")
   end
 
   class ERROR < StandardError
@@ -41,104 +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
 
@@ -188,7 +97,6 @@ module EnfApi
       json = EnfApi::to_json(credentials)
       EnfApi::API.instance.post "/api/xiam/v1/endpoints/#{ipv6}/credentials", json
     end
-
   end
 
   ##############################################################################
@@ -229,13 +137,13 @@ module EnfApi
     ## NO_TEST
     def create_device(new_dev_hash)
       json = EnfApi.to_json(new_dev_hash)
-      EnfApi::API.instance.post '/api/captive/v1/device', json
+      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 = "/api/captive/v1/device"
       url = "#{url}?#{network}" if network
       EnfApi::API.instance.get url
     end
@@ -253,7 +161,6 @@ module EnfApi
       EnfApi::API.instance.put "/api/captive/v1/device/#{id}", json
     end
 
-
     # Get the status of a device
     ## NO_TEST
     def get_device_status(dev_id)
@@ -267,7 +174,6 @@ module EnfApi
       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
@@ -279,16 +185,99 @@ module EnfApi
 
     # Get detail on a specific profile
     ## NO_TEST
-    def get_profile (profile_id)
+    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)
+    def update_profile(id, profile_updates)
       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
@@ -311,11 +300,11 @@ module EnfApi
       @api = RestClient::Resource.new(host)
 
       # Create request json
-      hash = { :username => user, :token => password }
-      json = to_json( hash )
+      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
@@ -323,7 +312,7 @@ module EnfApi
 
           # set request headers for subsequent api calls
           token = resp[:data][0][:token]
-          @headers = {content_type: :json, accept: :json, "Authorization" => "Bearer #{token}"}
+          @headers = { content_type: :json, accept: :json, "Authorization" => "Bearer #{token}" }
 
           # return resp
           resp
@@ -334,267 +323,225 @@ module EnfApi
     end
 
     def get(request_uri)
-      @api[request_uri].get(@headers) {|response, request, result|
+      @api[request_uri].get(@headers) { |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|
+    def post(request_uri, request_body = "")
+      @api[request_uri].post(request_body, @headers) { |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|
+    def put(request_uri, request_body = "")
+      @api[request_uri].put(request_body, @headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
     def delete(request_uri)
-      @api[request_uri].delete(@headers) {|response, request, result|
+      @api[request_uri].delete(@headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
-############################################################################################################################
-# NOT READY API. MOVE ABOVE THIS LINE AFTER RSPEC OR INTO OWN CLASS
-############################################################################################################################
+    ############################################################################################################################
+    # 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|
+      json = to_json(domain_hash)
+      @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|
+      json = to_json(limits_hash)
+      @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|
+      json = to_json(limits_hash)
+      @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|
+      json = to_json(limits_hash)
+      @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|
+      @api[api_url].get(@headers) { |response, request, result|
         process_api_response response, request, result
       }
     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|
+      @api[api_url].get(@headers) { |response, request, result|
         process_api_response response, request, result
       }
     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|
+      @api[api_url].get(@headers) { |response, request, result|
         process_api_response response, request, result
       }
     end
 
     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 }
-      json = to_json( hash )
+      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
 
-############################################################################################################################
-# Private functions
-############################################################################################################################
+    ############################################################################################################################
+    # Private functions
+    ############################################################################################################################
     def process_api_response(response, request, result)
       case response.code
-        when 200
-          # return json
-          from_json(response.body)
-
-        when 201
-          # return response body
-          from_json(response.body)
-
-        when 400
-          # api returns and error
+      when 200
+        # return json
+        from_json(response.body)
+      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))
+      when 401
+        # api returns and error
+        raise EnfApi::ERROR, api_error_msg(from_json(response.body))
+      when 403
+        # api returns and error
+        raise EnfApi::ERROR, "AUTHORIZATION_ERROR: User is not authorized to perform this operation!"
+      when 404
+        # api returns an error
+        # for the 404, we're going to check if it is JSON before parsing the
+        # error message
+        begin
+          JSON.parse(response.body)
           raise EnfApi::ERROR, api_error_msg(from_json(response.body))
-
-        when 401
-          # api returns and error
+        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))
-
-        when 403
-          # api returns and error
-          raise EnfApi::ERROR, "AUTHORIZATION_ERROR: User is not authorized to perform this operation!"
-
-        when 404
-          # api returns an error
-          # for the 404, we're going to check if it is JSON before parsing the
-          # error message
-          begin
-            JSON.parse(response.body)
-            raise EnfApi::ERROR, api_error_msg(from_json(response.body))
-          rescue JSON::ParserError => e
-            raise EnfApi::ERROR, "Not Found"
-          end
-
-        else
-          raise EnfApi::ERROR, "Unexpected error! Please try again!"
+        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)