ns1 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0eadbc0ca65b4e99e0da1933be0b2d61a6063a93
+  data.tar.gz: 869141a53e4107a9bf5169e6da73eac76db4b938
+SHA512:
+  metadata.gz: ee7655d6ad2557ad79424358429d6c0c3c07e9d895e5ab6f8a179b14c1a39c8d9b9308228d77395fd1c51d883c80c415d5a778dc313a269c80baecaa02cb3b0e
+  data.tar.gz: c07111bf5b6fe83c9bcd40a19f369b955b33d706ad36357cc00f523a722bc597bf8040bebdd56af930d9491e2923771e323d70008c58961ba3f3444b9f94ecf3

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.6
+  - 2.4.4
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ns1.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    ns1 (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.7)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  ns1!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 3.3.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,69 @@
+# NS1
+
+[NS1](https://ns1.com/) API Client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ns1'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ns1
+
+## Usage
+
+```ruby
+# Instantiate a client
+client = NS1::Client.new("your api key")
+
+# ZONES
+
+# Get all active zones and basic zone configuration details for each.
+client.zones 
+
+# Get a single active Zone and its basic configuration details.
+client.zone("example.com")
+
+# Create a new DNS zone
+# For details on configuration options, see https://ns1.com/api#create-a-new-dns-zone
+client.create_zone("yourdomain.com", { optional: :params }) 
+
+# Modify basic details of a DNS zone
+client.modify_zone("yourdomain.com", { refresh: 3600 }) 
+
+# Delete an existing DNS zone and all records in the zone
+client.delete_zone("yourdomain.com") 
+
+# RECORDS
+
+# Get full configuration for a DNS record
+client.record("example.com", "www.example.com", "A")
+
+# Create a new DNS record in the specified zone, for the specified domain, of the given record type
+# `answers` option is required. For other options, see https://ns1.com/api#create-a-new-dns-record
+client.create_record("yourdomain.com", "www.yourdomain.com", "A", { answers: [] })
+
+# Modify configuration details for an existing DNS record.
+client.modify_record("yourdomain.com", "www.yourdomain.com", "A" { use_client_subnet: false })
+
+# Remove an existing record and all associated answers and configuration details
+client.delete_record("yourdomain.com", "www.yourdomain.com", "A")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ns1.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ns1"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ns1.rb

@@ -0,0 +1,5 @@
+module NS1
+end
+
+require "ns1/version"
+require "ns1/client"

data/lib/ns1/api.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+Dir[ File.expand_path('../api/*.rb', __FILE__) ].each { |f| require f }
+
+module NS1
+  module API
+    HTTP_GET    = "GET"
+    HTTP_POST   = "POST"
+    HTTP_PUT    = "PUT"
+    HTTP_DELETE = "DELETE"
+
+    def self.included(base)
+      base.send :include,
+        NS1::API::Zones,
+        NS1::API::Records
+    end
+
+  end
+end

data/lib/ns1/api/records.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module NS1
+  module API
+    module Records
+      def record(zone, domain, type)
+        raise NS1::MissingParameter, "zone cannot be blank" if blank?(zone)
+        raise NS1::MissingParameter, "domain cannot be blank" if blank?(domain)
+        raise NS1::MissingParameter, "type cannot be blank" if blank?(type)
+        perform_request(HTTP_GET, "/v1/zones/#{zone}/#{domain}/#{type}")
+      end
+
+      def create_record(zone, domain, type, params = {})
+        raise NS1::MissingParameter, "zone cannot be blank" if blank?(zone)
+        raise NS1::MissingParameter, "domain cannot be blank" if blank?(domain)
+        raise NS1::MissingParameter, "type cannot be blank" if blank?(type)
+        validate_required!(params, :answers)
+        params = params.merge(zone: zone, domain: domain, type: type)
+        perform_request(HTTP_PUT, "/v1/zones/#{zone}/#{domain}/#{type}", params)
+      end
+
+      def modify_record(zone, domain, type, params)
+        raise NS1::MissingParameter, "zone cannot be blank" if blank?(zone)
+        raise NS1::MissingParameter, "domain cannot be blank" if blank?(domain)
+        raise NS1::MissingParameter, "type cannot be blank" if blank?(type)
+        perform_request(HTTP_POST, "/v1/zones/#{zone}/#{domain}/#{type}", params)
+      end
+
+      def delete_record(zone, domain, type)
+        raise NS1::MissingParameter, "zone cannot be blank" if blank?(zone)
+        raise NS1::MissingParameter, "domain cannot be blank" if blank?(domain)
+        raise NS1::MissingParameter, "type cannot be blank" if blank?(type)
+        perform_request(HTTP_DELETE, "/v1/zones/#{zone}/#{domain}/#{type}")
+      end
+    end
+  end
+end

data/lib/ns1/api/zones.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module NS1
+  module API
+    module Zones
+      def zones
+        perform_request(HTTP_GET, "/v1/zones")
+      end
+
+      def zone(zone)
+        raise NS1::MissingParameter, "zone cannot be blank" if blank?(zone)
+        perform_request(HTTP_GET, "/v1/zones/#{zone}")
+      end
+
+      def create_zone(zone, params = {})
+        raise NS1::MissingParameter, "zone cannot be blank" if blank?(zone)
+        params = params.merge(zone: zone)
+        perform_request(HTTP_PUT, "/v1/zones/#{zone}", params)
+      end
+
+      def modify_zone(zone, params)
+        raise NS1::MissingParameter, "zone cannot be blank" if blank?(zone)
+        perform_request(HTTP_POST, "/v1/zones/#{zone}", params)
+      end
+
+      def delete_zone(zone)
+        raise NS1::MissingParameter, "zone cannot be blank" if blank?(zone)
+        perform_request(HTTP_DELETE, "/v1/zones/#{zone}")
+      end
+    end
+  end
+end

data/lib/ns1/client.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "ns1/api"
+require "ns1/transport/net_http"
+require "ns1/error"
+
+module NS1
+  class Client
+    include NS1::API
+    BASE_URL = "https://api.nsone.net"
+
+    def initialize(api_key, base_url: BASE_URL, logger: nil)
+      @api_key = api_key
+      @base_url = base_url
+      @logger = logger
+    end
+
+    private
+
+    def perform_request(method, path, body = nil)
+      body = JSON.dump(body) if body.is_a? Hash
+      log("[NS1] > #{method} #{path}")
+      log("[NS1] > #{body}") if body
+      response = transport.request(method, path, body)
+      log("[NS1] < #{response.inspect}")
+      response
+    end
+
+    def log(message)
+      @logger && @logger.debug(message)
+    end
+
+    def transport
+      @transport ||= NS1::Transport::NetHttp.new(@base_url, @api_key)
+    end
+
+    def blank?(object)
+      object.respond_to?(:empty?) ? !!object.empty? : !object
+    end
+
+    def validate_required!(params, *keys)
+      raise ArgumentError, "Paramenters must be a hash" unless params.is_a? Hash
+      missing = keys.reject { |key| params.has_key?(key) or params.has_key?(key.to_s) }
+      if missing.any?
+        raise MissingParameter, "Missing key(s): #{missing.join(", ")}"
+      end
+    end
+  end
+end

data/lib/ns1/error.rb

@@ -0,0 +1,4 @@
+module NS1
+  class Error < StandardError; end
+  class MissingParameter < Error; end
+end

data/lib/ns1/response.rb

@@ -0,0 +1,7 @@
+module NS1
+  module Response
+  end
+end
+
+require "ns1/response/success"
+require "ns1/response/error"

data/lib/ns1/response/base.rb

@@ -0,0 +1,8 @@
+require 'delegate'
+
+module NS1
+  module Response
+    class Base < SimpleDelegator
+    end
+  end
+end

data/lib/ns1/response/error.rb

@@ -0,0 +1,9 @@
+require "ns1/response/base"
+
+module NS1
+  module Response
+    class Error < Base
+    end
+  end
+end
+

data/lib/ns1/response/success.rb

@@ -0,0 +1,8 @@
+require "ns1/response/base"
+
+module NS1
+  module Response
+    class Success < Base
+    end
+  end
+end

data/lib/ns1/transport.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module NS1
+  module Transport
+    class Error < StandardError; end
+    class ResponseParseError < Error; end
+  end
+end

data/lib/ns1/transport/net_http.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "openssl"
+require "json"
+require "uri"
+require "ns1/transport"
+require "ns1/response"
+
+module NS1
+  module Transport
+    class NetHttp
+      def initialize(base_url, api_key)
+        @base_url = base_url
+        @api_key = api_key
+      end
+
+      def request(method, path, body = nil)
+        uri = URI.join(@base_url, path)
+        Net::HTTP.start(uri.host, uri.port, opts(uri)) do |http|
+          response = http.send_request(method, uri, body, headers(body))
+          process_response(response)
+        end
+      end
+
+      private
+
+      def process_response(response)
+        body = JSON.parse(response.body)
+        case response
+        when Net::HTTPOK
+          NS1::Response::Success.new(body)
+        else
+          NS1::Response::Error.new(body)
+        end
+      rescue JSON::ParserError
+        raise NS1::Transport::ResponseParseError
+      end
+
+      def opts(uri)
+        if uri.scheme == "https"
+          {
+            use_ssl: true,
+            ssl_mode: OpenSSL::SSL::VERIFY_PEER
+          }
+        end
+      end
+
+      def headers(body)
+        extra_headers = body.nil? ? {} : { "Content-Type" => "application/json" }
+        default_headers.merge(extra_headers)
+      end
+
+      def default_headers
+        { "X-NSONE-Key" => @api_key }
+      end
+    end
+  end
+end

data/lib/ns1/version.rb

@@ -0,0 +1,3 @@
+module NS1
+  VERSION = "0.1.0"
+end

data/ns1.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ns1/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ns1"
+  spec.version       = NS1::VERSION
+  spec.authors       = ["Esteban Pastorino"]
+  spec.email         = ["ejpastorino@gmail.com"]
+
+  spec.summary       = %q{NS1 API Client}
+  spec.description   = %q{NS1 API Client}
+  spec.homepage      = "https://github.com/kitop/ns1"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.3.0"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: ns1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Esteban Pastorino
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: NS1 API Client
+email:
+- ejpastorino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ns1.rb
+- lib/ns1/api.rb
+- lib/ns1/api/records.rb
+- lib/ns1/api/zones.rb
+- lib/ns1/client.rb
+- lib/ns1/error.rb
+- lib/ns1/response.rb
+- lib/ns1/response/base.rb
+- lib/ns1/response/error.rb
+- lib/ns1/response/success.rb
+- lib/ns1/transport.rb
+- lib/ns1/transport/net_http.rb
+- lib/ns1/version.rb
+- ns1.gemspec
+homepage: https://github.com/kitop/ns1
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: NS1 API Client
+test_files: []