ns-1 0.3.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd79d309501f2a7050ac268294910f89adcd0460b6878c4a2e925871ec03983b
-  data.tar.gz: a18251a62183147f61fc237ce07098c435ebf60c2fc20a1ef1cbf9b72207bbc6
+  metadata.gz: 53d583c0dc699961263edfc90e1acbe5888edc5e5fd45e0eb1c233a85b3311c5
+  data.tar.gz: f1b314fe81a07341b3ed732b84bdb0d149ff08e2578f6114032589293d465d13
 SHA512:
-  metadata.gz: e951b30fe33df1be2888a6b952c8c20045b3a4960f56ae9cc915f8aa11f45d218025e2f9600330495e3c1995bcf0842d5fa098fe68be73b187a7a52b4f36dba6
-  data.tar.gz: b1b2b1a6c490da1e1ee40f9e681c22d3434c7840bc1f899b503095289b830b3a4487c2ea9cb743b7756ab63828552ddba8cc14857d98cfe4a4328953606d9612
+  metadata.gz: f3026392da94f8fc9a57e954a9d80f5c27cec58a958a59f6866db07ce961af7c454a3ea5578ae8f91f5a8d4bf9ea027c3dbd2bb4754dacf85156f80703cb45dc
+  data.tar.gz: a4bfc1757973256ef7e31198bf3b7816c71155bdd4463456acb6edcba2480f99d852a8dbf2772dc3726fe87665a001c4a8da75303dfc497c3d0d85cc3ec2b19b

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## 0.4.1 - 2019-08-26
+ - Added network call for managed/private/dedicated networks lists
+
+## 0.4.0 - 2019-08-17
+ - Added NSOne::Transport::RateLimitExceeded exception and get_rates method to add to the NSOne::Response::Base class the rate limit headers to help with exponential backoff
+ - Added billataglance and plan methods for account API
+ - Added Feeds APIs
+ - Seperated API version string from static paths to allow easy to change, versions in the future.
+
 ## 0.3.4 - 2019-08-06
 - change module name
 

data/lib/nsone/api/account.rb

@@ -10,7 +10,7 @@ module NSOne
       # @return [NSOne::Response]
       #
       def account()
-        perform_request(HTTP_GET, "/v1/account/settings")
+        perform_request(HTTP_GET, "/account/settings")
       end
 
       #
@@ -19,7 +19,15 @@ module NSOne
       # @return [NSOne::Response]
       #
       def account_overage()
-        perform_request(HTTP_GET, "/v1/account/usagewarnings")
+        perform_request(HTTP_GET, "/account/usagewarnings")
+      end
+
+      def plan
+        perform_request(HTTP_GET, "/account/plan")
+      end
+
+      def billataglance
+        perform_request(HTTP_GET, "/account/billataglance")
       end
 
     end

data/lib/nsone/api/feeds.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module NSOne
+  module API
+    module Feeds
+
+      def source_types()
+        types = perform_request(HTTP_GET, "/data/sourcetypes")
+        raise NSOne::UnexpectedResponse, "Expected a Hash but responses does not look like a Hash" if ! types.respond_to?(:keys)
+        types.keys
+      end
+
+      def data_sources()
+        perform_request(HTTP_GET, "/data/sources")
+      end
+
+      def data_source(data_source_id)
+        raise NSOne::MissingParameter, "Data Source ID cannot be blank" if blank?(data_source_id)
+        perform_request(HTTP_GET, "/data/sources/#{data_source_id}")
+      end
+
+      def create_data_source(params)
+        validate_required!(params, :sourcetype, :name, :config)
+        perform_request(HTTP_PUT, "/data/sources", params)
+      end
+
+      def feeds(data_source_id)
+        raise NSOne::MissingParameter, "Data Source ID cannot be blank" if blank?(data_source_id)
+        perform_request(HTTP_GET, "/data/feeds/#{data_source_id}")
+      end
+
+      def create_data_feed(data_source_id, params)
+        raise NSOne::MissingParameter, "Data Source ID cannot be blank" if blank?(data_source_id)
+        validate_required!(params, :name, :config)
+        perform_request(HTTP_PUT, "/data/feeds/#{data_source_id}", params)
+      end
+
+      def delete_data_feed(data_source_id, data_feed_id)
+        raise NSOne::MissingParameter, "Data Source ID cannot be blank" if blank?(data_source_id)
+        raise NSOne::MissingParameter, "Data Feed ID cannot be blank" if blank?(data_feed_id)
+        perform_request(HTTP_DELETE, "/data/feeds/#{data_source_id}/#{data_feed_id}")
+      end
+
+      def modify_feed(data_source_id, params)
+        raise NSOne::MissingParameter, "Data Source ID cannot be blank" if blank?(data_source_id)
+        perform_request(HTTP_POST, "/feed/#{data_source_id}", params)
+      end
+
+    end
+  end
+end

data/lib/nsone/api/jobs.rb

@@ -10,7 +10,7 @@ module NSOne
       # @return [NSOne::Response]
       #
       def jobs()
-        perform_request(HTTP_GET, "/v1/monitoring/jobs")
+        perform_request(HTTP_GET, "/monitoring/jobs")
       end
 
       #
@@ -22,7 +22,7 @@ module NSOne
       #
       def job(job_id)
         raise NSOne::MissingParameter, "job_id cannot be blank" if blank?(job_id)
-        perform_request(HTTP_GET, "/v1/monitoring/jobs/#{job_id}")
+        perform_request(HTTP_GET, "/monitoring/jobs/#{job_id}")
       end
 
     end

data/lib/nsone/api/networks.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module NSOne
+  module API
+    module Networks
+
+      #
+      # Returns a lists of all networks for which you may create zones and records.
+      #   By default network '0' is always returned as it the NS1 main network.
+      #   Customers with dedicated/private DNS service can have more.
+      #
+      # @example Response
+      #  [
+      #    {
+      #      "network_id"=>0, 
+      #      "name"=>"NS1 Managed DNS Network", 
+      #      "label"=>"NSONE"
+      #    }
+      #  ]
+      #
+      # @return [NSOne::Response]
+      #
+      def networks()
+        perform_request(HTTP_GET, "/networks")
+      end
+
+    end
+  end
+end

data/lib/nsone/api/records.rb

@@ -16,10 +16,9 @@ module NSOne
       #
       def record(zone, domain, type)
         raise NSOne::MissingParameter, "zone cannot be blank" if blank?(zone)
-        raise NSOne::MissingParameter, "domain cannot be blank" if blank?(domain)
         raise NSOne::MissingParameter, "type cannot be blank" if blank?(type)
         normalize_names!(zone, domain)
-        perform_request(HTTP_GET, "/v1/zones/#{zone}/#{domain}/#{type}")
+        perform_request(HTTP_GET, "/zones/#{zone}/#{domain}/#{type}")
       end
 
       #
@@ -99,7 +98,7 @@ module NSOne
         validate_required!(params, :answers)
         normalize_names!(zone, domain)
         params = params.merge(zone: zone, domain: domain, type: type)
-        perform_request(HTTP_PUT, "/v1/zones/#{zone}/#{domain}/#{type}", params)
+        perform_request(HTTP_PUT, "/zones/#{zone}/#{domain}/#{type}", params)
       end
 
       #
@@ -112,7 +111,7 @@ module NSOne
         raise NSOne::MissingParameter, "domain cannot be blank" if blank?(domain)
         raise NSOne::MissingParameter, "type cannot be blank" if blank?(type)
         normalize_names!(zone, domain)
-        perform_request(HTTP_POST, "/v1/zones/#{zone}/#{domain}/#{type}", params)
+        perform_request(HTTP_POST, "/zones/#{zone}/#{domain}/#{type}", params)
       end
 
       #
@@ -129,7 +128,7 @@ module NSOne
         raise NSOne::MissingParameter, "domain cannot be blank" if blank?(domain)
         raise NSOne::MissingParameter, "type cannot be blank" if blank?(type)
         normalize_names!(zone, domain)
-        perform_request(HTTP_DELETE, "/v1/zones/#{zone}/#{domain}/#{type}")
+        perform_request(HTTP_DELETE, "/zones/#{zone}/#{domain}/#{type}")
       end
 
     end

data/lib/nsone/api/stats.rb

@@ -10,9 +10,10 @@ module NSOne
       # @return [NSOne::Response]
       #
       def qps()
-        perform_request(HTTP_GET, "/v1/stats/qps")
+        perform_request(HTTP_GET, "/stats/qps")
       end
 
+      
       #
       # Returns current queries per second (QPS) for a specific zone
       #
@@ -23,9 +24,10 @@ module NSOne
       def zone_qps(zone)
         raise NSOne::MissingParameter, "zone cannot be blank" if blank?(zone)
         normalize_names!(zone)
-        perform_request(HTTP_GET, "/v1/stats/qps/#{zone}")
+        perform_request(HTTP_GET, "/stats/qps/#{zone}")
       end
 
+
       #
       # Returns current queries per second (QPS) for a specific record
       #
@@ -40,9 +42,10 @@ module NSOne
         raise NSOne::MissingParameter, "domain cannot be blank" if blank?(domain)
         raise NSOne::MissingParameter, "type cannot be blank" if blank?(type)
         normalize_names!(zone, domain)
-        perform_request(HTTP_GET, "/v1/stats/qps/#{zone}/#{domain}/#{type}")
+        perform_request(HTTP_GET, "/stats/qps/#{zone}/#{domain}/#{type}")
       end
 
+
       #
       # Returns statistics and graphs for the entire account over a given period
       #
@@ -63,13 +66,15 @@ module NSOne
       # @return [NSOne::Response]
       #
       def usage(params = {})
-        perform_request(HTTP_GET, "/v1/stats/usage", params)
+        perform_request(HTTP_GET, "/stats/usage", params)
       end
 
+
       #
-      # Returns statistics and graphs on `NSOne Network` level (Managed/Dedicated)
+      # Returns statistics and graphs for a given zone over a given period
       #
       # @param [Hash] params will be used as the request body
+      # @param [String] zone NSOne zone name
       #
       # @option params [String] :period one of `1h`, `24h`, or `30d`
       #
@@ -85,15 +90,20 @@ module NSOne
       #
       # @return [NSOne::Response]
       #
-      def network_usage(params = {})
-        perform_request(HTTP_GET, "/v1/stats/network/usage", params)
+      def zone_usage(zone, params = {})
+        raise NSOne::MissingParameter, "zone cannot be blank" if blank?(zone)
+        normalize_names!(zone)
+        perform_request(HTTP_GET, "/stats/usage/#{zone}", params)
       end
 
+
       #
-      # Returns total usage (Queries) during `:period` per region/Geo-Location. At the moment NSOne API return the following areas:
-      # Europe, North America, Oceania, Africa, Asia
+      # Returns statistics and graphs for a given record over a given period
       #
       # @param [Hash] params will be used as the request body
+      # @param [String] zone zone name
+      # @param [String] domain record name
+      # @param [String] type record type (A, CNAME etc)
       #
       # @option params [String] :period one of `1h`, `24h`, or `30d`
       #
@@ -109,15 +119,19 @@ module NSOne
       #
       # @return [NSOne::Response]
       #
-      def region_usage(params = {})
-        perform_request(HTTP_GET, "/v1/stats/region/usage", params)
+      def record_usage(zone, domain, type, params = {})
+        raise NSOne::MissingParameter, "zone cannot be blank" if blank?(zone)
+        raise NSOne::MissingParameter, "domain cannot be blank" if blank?(domain)
+        raise NSOne::MissingParameter, "type cannot be blank" if blank?(type)
+        normalize_names!(zone, domain)
+        perform_request(HTTP_GET, "/stats/usage/#{zone}/#{domain}/#{type}", params)
       end
 
+
       #
-      # Returns statistics and graphs for a given zone over a given period
+      # Returns statistics and graphs on `NSOne Network` level (Managed/Dedicated)
       #
       # @param [Hash] params will be used as the request body
-      # @param [String] zone NSOne zone name
       #
       # @option params [String] :period one of `1h`, `24h`, or `30d`
       #
@@ -133,19 +147,16 @@ module NSOne
       #
       # @return [NSOne::Response]
       #
-      def zone_usage(zone, params = {})
-        raise NSOne::MissingParameter, "zone cannot be blank" if blank?(zone)
-        normalize_names!(zone)
-        perform_request(HTTP_GET, "/v1/stats/usage/#{zone}", params)
+      def network_usage(params = {})
+        perform_request(HTTP_GET, "/stats/network/usage", params)
       end
 
+
       #
-      # Returns statistics and graphs for a given record over a given period
+      # Returns total usage (Queries) during `:period` per region/Geo-Location. At the moment NSOne API return the following areas:
+      # Europe, North America, Oceania, Africa, Asia
       #
       # @param [Hash] params will be used as the request body
-      # @param [String] zone zone name
-      # @param [String] domain record name
-      # @param [String] type record type (A, CNAME etc)
       #
       # @option params [String] :period one of `1h`, `24h`, or `30d`
       #
@@ -161,12 +172,8 @@ module NSOne
       #
       # @return [NSOne::Response]
       #
-      def record_usage(zone, domain, type, params = {})
-        raise NSOne::MissingParameter, "zone cannot be blank" if blank?(zone)
-        raise NSOne::MissingParameter, "domain cannot be blank" if blank?(domain)
-        raise NSOne::MissingParameter, "type cannot be blank" if blank?(type)
-        normalize_names!(zone, domain)
-        perform_request(HTTP_GET, "/v1/stats/usage/#{zone}/#{domain}/#{type}", params)
+      def region_usage(params = {})
+        perform_request(HTTP_GET, "/stats/region/usage", params)
       end
 
     end

data/lib/nsone/api/zones.rb

@@ -10,7 +10,7 @@ module NSOne
       # @return [NSOne::Response]
       #
       def zones
-        perform_request(HTTP_GET, "/v1/zones")
+        perform_request(HTTP_GET, "/zones")
       end
 
       #
@@ -22,7 +22,7 @@ module NSOne
       #
       def zone(zone)
         raise NSOne::MissingParameter, "zone cannot be blank" if blank?(zone)
-        perform_request(HTTP_GET, "/v1/zones/#{zone}")
+        perform_request(HTTP_GET, "/zones/#{zone}")
       end
 
       #
@@ -39,7 +39,7 @@ module NSOne
       def create_zone(zone, params = {})
         raise NSOne::MissingParameter, "zone cannot be blank" if blank?(zone)
         params = params.merge(zone: zone)
-        perform_request(HTTP_PUT, "/v1/zones/#{zone}", params)
+        perform_request(HTTP_PUT, "/zones/#{zone}", params)
       end
 
       #
@@ -55,7 +55,7 @@ module NSOne
       def modify_zone(zone, params = {})
         raise NSOne::MissingParameter, "zone cannot be blank" if blank?(zone)
         raise NSOne::MissingParameter, "params hash must contain valid zone settings" if !params.is_a?(Hash) || params.empty?
-        perform_request(HTTP_POST, "/v1/zones/#{zone}", params)
+        perform_request(HTTP_POST, "/zones/#{zone}", params)
       end
 
       #
@@ -67,7 +67,7 @@ module NSOne
       #
       def delete_zone(zone)
         raise NSOne::MissingParameter, "zone cannot be blank" if blank?(zone)
-        perform_request(HTTP_DELETE, "/v1/zones/#{zone}")
+        perform_request(HTTP_DELETE, "/zones/#{zone}")
       end
 
       #
@@ -86,7 +86,7 @@ module NSOne
       def search(string, params = {})
         raise NSOne::MissingParameter, "search string cannot be blank" if blank?(string)
         params = params.merge(q: string)
-        perform_request(HTTP_GET, "/v1/search", params)
+        perform_request(HTTP_GET, "/search", params)
       end
 
     end

data/lib/nsone/api.rb

@@ -15,7 +15,9 @@ module NSOne
         NSOne::API::Records,
         NSOne::API::Account,
         NSOne::API::Stats,
-        NSOne::API::Jobs
+        NSOne::API::Jobs,
+        NSOne::API::Feeds,
+        NSOne::API::Networks
     end
 
   end

data/lib/nsone/client.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "nsone/api"
 require "nsone/transport/net_http"
 require "nsone/error"
@@ -11,9 +9,10 @@ module NSOne
 
     BASE_URL = "https://api.nsone.net"
 
-    def initialize(api_key, base_url: BASE_URL, logger: nil)
+    def initialize(api_key, api_version: "v1", base_url: BASE_URL, logger: nil)
       @api_key = api_key
       @base_url = base_url
+      @api_version = api_version
       @logger = logger
     end
 
@@ -33,7 +32,10 @@ module NSOne
     end
 
     def transport
-      @transport ||= NSOne::Transport::NetHttp.new(@base_url, @api_key)
+      begin
+        @transport ||= NSOne::Transport::NetHttp.new(@base_url, @api_version, @api_key)
+      rescue NSOne::Transport::RateLimitExceeded
+      end
     end
 
     def blank?(object)
@@ -51,6 +53,7 @@ module NSOne
     # Helper to support `domain` name with or without the zone name.
     # e.g. zone: example.com domain: www will generate domain: www.example.com
     def normalize_names!(zone, domain = "")
+      domain.replace(zone) if domain.empty?
       no_dot!(zone, domain)
       domain << ".#{zone}" unless domain.empty? || domain.include?(zone)
     end
@@ -58,7 +61,6 @@ module NSOne
     # Removes trailing dot from all Strings given
     def no_dot!(*array)
       array.map {|a| a.chop! if a[/\.$/] != nil}
-      array
     end
 
   end

data/lib/nsone/error.rb

@@ -1,4 +1,5 @@
 module NSOne
   class Error < StandardError; end
   class MissingParameter < Error; end
+  class UnexpectedResponse < Error; end
 end

data/lib/nsone/response/base.rb

@@ -3,10 +3,11 @@ require 'delegate'
 module NSOne
   module Response
     class Base < SimpleDelegator
-      attr_reader :status
+      attr_reader :status, :rates
 
-      def initialize(body, status)
+      def initialize(body, status, rates)
         @status = status
+        @rates = rates
         super(body)
       end
     end

data/lib/nsone/transport/net_http.rb

@@ -10,31 +10,46 @@ require "nsone/response"
 module NSOne
   module Transport
     class NetHttp
-      def initialize(base_url, api_key)
+
+
+      def initialize(base_url, api_version, api_key)
         @base_url = base_url
+        @api_version = api_version
         @api_key = api_key
       end
 
       def request(method, path, body = nil)
-        uri = URI.join(@base_url, path)
+        uri = URI.join(@base_url, "#{@api_version}#{path}")
         Net::HTTP.start(uri.host, uri.port, opts(uri)) do |http|
           response = http.send_request(method, uri, body, headers(body))
-          process_response(response)
+          process_response(response, get_rates(response))
         end
       end
 
       private
 
-      def process_response(response)
+      def process_response(response, rates = {})
         body = JSON.parse(response.body)
         case response
+        when Net::HTTPTooManyRequests
+          raise NSOne::Transport::RateLimitExceeded, "#{response}, #{body}"
         when Net::HTTPOK
-          NSOne::Response::Success.new(body, response.code.to_i)
+          NSOne::Response::Success.new(body, response.code.to_i, rates)
         else
-          NSOne::Response::Error.new(body, response.code.to_i)
+          NSOne::Response::Error.new(body, response.code.to_i, rates)
+        end
+      rescue JSON::ParserError => e
+        raise NSOne::Transport::ResponseParseError, "#{response.code_type} #{response.code} error: #{e}"
+      end
+
+      def get_rates(response)
+        Hash.new.tap do | h |
+          h[:by] = response["x-ratelimit-by"] if response["x-ratelimit-by"]
+          h[:remaining] = response["x-ratelimit-remaining"] if response["x-ratelimit-remaining"]
+          h[:limit] = response["x-ratelimit-limit"].to_i if response["x-ratelimit-limit"]
+          h[:period] = response["x-ratelimit-period"].to_i if response["x-ratelimit-period"]
+          h[:rate] = (h[:limit] / h[:period]).to_f if h[:limit] && h[:period]
         end
-      rescue JSON::ParserError
-        raise NSOne::Transport::ResponseParseError
       end
 
       def opts(uri)
@@ -54,6 +69,7 @@ module NSOne
       def default_headers
         { "X-NSONE-Key" => @api_key }
       end
+      
     end
   end
-end
+end

data/lib/nsone/transport.rb

@@ -4,5 +4,6 @@ module NSOne
   module Transport
     class Error < StandardError; end
     class ResponseParseError < Error; end
+    class RateLimitExceeded < Error; end
   end
 end

data/lib/nsone/version.rb

@@ -1,3 +1,3 @@
 module NSOne
-  VERSION = "0.3.4"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ns-1
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.1
 platform: ruby
 authors:
 - Esteban Pastorino
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-06 00:00:00.000000000 Z
+date: 2019-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,7 +86,9 @@ files:
 - lib/nsone.rb
 - lib/nsone/api.rb
 - lib/nsone/api/account.rb
+- lib/nsone/api/feeds.rb
 - lib/nsone/api/jobs.rb
+- lib/nsone/api/networks.rb
 - lib/nsone/api/records.rb
 - lib/nsone/api/stats.rb
 - lib/nsone/api/zones.rb