dnsmadeeasy-rest-api 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad96706553c3063b3459a6db5a040c964b5e4804
-  data.tar.gz: 03e58dfc227d4100e15d052a190531106188dfca
+  metadata.gz: 3987a44ee6657d03fe2746d75007b772672c1899
+  data.tar.gz: 9b94abad19f6ebc718369b1be6ac7aabf68e738b
 SHA512:
-  metadata.gz: 1f950d3f6577f89843f5055847981e43b853a8af04a7d65e11db501ddece19ab1745ca0ec915e1f91367c519c19f6367ff1c8056697a4f76e0a94e4a8b587b29
-  data.tar.gz: 88e2629ed703584d9307e25962c409c28d27b8b2720ed8e0859bccd7a58d46c7412a77dbf5238be63c21b8572c7ca407b57a5d7be086f55dc48bf9f44ca12c87
+  metadata.gz: 17ba812ec3bad74eacfbd157a8b8b8697b1b2d7ebf60379d8141a6b51d1bbf240440788daf2c344196ed64c6fe9d461943231f69178f1bb502427f722a80d8b4
+  data.tar.gz: 6f2873e2ad365e6a0f3125f053762887019834fea444d0db5e1f78178f510ca39bf1e6ff79ca79897f974e7c96e7e36f86a07fa729517bed8120e8e99b046d3a

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/LineLength:
+  Max: 300
+
+Style/SpaceBeforeFirstArg:
+    Exclude:
+        - '**/metadata.rb'

data/README.md

@@ -93,6 +93,10 @@ api.delete_record('hello.example.com', 123)
 # To delete multiple records:
 
 api.delete_records('hello.example.com', [123, 143])
+
+# To delete all records in the domain:
+
+api.delete_all_records('hello.example.com')
 ```
 
 To create a record:

data/Rakefile

@@ -1,2 +1,22 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
+namespace :style do
+  desc 'Run Ruby style checks'
+  RuboCop::RakeTask.new(:ruby) do |t|
+    t.options = ['-D']
+  end
+end
+
+desc 'Run all style checks'
+task style: ['style:ruby']
+
+desc 'Run CRSpec unit tests'
+RSpec::Core::RakeTask.new(:unit) do |t|
+  t.rspec_opts = '--color --format documentation'
+end
+
+# The default rake task should just run it all
+desc 'Run all tests'
+task default: %w(style unit)

data/dnsmadeeasy-rest-api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'dnsmadeeasy-rest-api'
-  s.version       = '1.0.3'
+  s.version       = '1.0.4'
   s.authors       = ['Arnoud Vermeer', 'Paul Henry', 'James Hart']
   s.email         = ['a.vermeer@freshway.biz', 'ops@wanelo.com']
   s.license       = 'Apache'
@@ -12,4 +12,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'webmock'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rubocop'
 end

data/lib/dnsmadeeasy-rest-api.rb

@@ -4,16 +4,17 @@ require 'json'
 require 'uri'
 require 'net/http'
 
+# A class to interact with the DNSMadeEasy REST API v2.0
 class DnsMadeEasy
-
   attr_accessor :base_uri
 
-  def initialize (api_key, api_secret, sandbox = false)
-    raise "api_key is undefined" unless api_key
-    raise "api_secret is undefined" unless api_secret
+  def initialize(api_key, api_secret, sandbox = false, options = {})
+    fail 'api_key is undefined' unless api_key
+    fail 'api_secret is undefined' unless api_secret
 
     @api_key = api_key
     @api_secret = api_secret
+    @options = options
 
     if sandbox
       self.base_uri = 'https://api.sandbox.dnsmadeeasy.com/V2.0'
@@ -58,80 +59,90 @@ class DnsMadeEasy
     get "/dns/managed/#{get_id_by_domain(domain_name)}/records"
   end
 
+  def find(domain_name, name, type)
+    records = records_for(domain_name)
+    records['data'].detect { |r| r['name'] == name && r['type'] == type }
+  end
+
   def find_record_id(domain_name, name, type)
     records = records_for(domain_name)
 
-    records['data'].select { |r| r['name'] == name && r['type'] == type }
-                   .map    { |r| r['id'] }
+    records['data'].select { |r| r['name'] == name && r['type'] == type }.map { |r| r['id'] }
+  end
+
+  def delete_record(domain_name, record_id)
+    delete "/dns/managed/#{get_id_by_domain(domain_name)}/records/#{record_id}/"
   end
 
   def delete_records(domain_name, ids = [])
-    id = get_id_by_domain(domain_name)
+    return if ids.empty?
+    domain_id = get_id_by_domain(domain_name)
 
-    delete "/dns/managed/#{id}/records/", ids
+    delete "/dns/managed/#{domain_id}/records?ids=#{ids.join(',')}"
   end
 
-  def delete_record(domain_name, record_id)
-    delete "/dns/managed/#{get_id_by_domain(domain_name)}/records/#{record_id}/"
+  def delete_all_records(domain_name)
+    domain_id = get_id_by_domain(domain_name)
+    delete "/dns/managed/#{domain_id}/records"
   end
 
   def create_record(domain_name, name, type, value, options = {})
-    body = {"name" => name, "type" => type, "value" => value, "ttl" => 3600, "gtdLocation" => "DEFAULT"}
+    body = { 'name' => name, 'type' => type, 'value' => value, 'ttl' => 3600, 'gtdLocation' => 'DEFAULT' }
     post "/dns/managed/#{get_id_by_domain(domain_name)}/records/", body.merge(options)
   end
 
   def create_a_record(domain_name, name, value, options = {})
-    # todo: match IPv4 for value
-    create_record domain_name, name, "A", value, options
+    # TODO: match IPv4 for value
+    create_record domain_name, name, 'A', value, options
   end
 
   def create_aaaa_record(domain_name, name, value, options = {})
-    # todo: match IPv6 for value
-    create_record domain_name, name, "AAAA", value, options
+    # TODO: match IPv6 for value
+    create_record domain_name, name, 'AAAA', value, options
   end
 
   def create_ptr_record(domain_name, name, value, options = {})
-    # todo: match PTR value
-    create_record domain_name, name, "PTR", value, options
+    # TODO: match PTR value
+    create_record domain_name, name, 'PTR', value, options
   end
 
   def create_txt_record(domain_name, name, value, options = {})
-    # todo: match TXT value
-    create_record domain_name, name, "TXT", value, options
+    # TODO: match TXT value
+    create_record domain_name, name, 'TXT', value, options
   end
 
   def create_cname_record(domain_name, name, value, options = {})
-    # todo: match CNAME value
-    create_record domain_name, name, "CNAME", value, options
+    # TODO: match CNAME value
+    create_record domain_name, name, 'CNAME', value, options
   end
 
   def create_ns_record(domain_name, name, value, options = {})
-    # todo: match domainname for value
-    create_record domain_name, name, "NS", value, options
+    # TODO: match domainname for value
+    create_record domain_name, name, 'NS', value, options
   end
 
   def create_spf_record(domain_name, name, value, options = {})
-    create_record domain_name, name, "SPF", value, options
+    create_record domain_name, name, 'SPF', value, options
   end
 
   def create_mx_record(domain_name, name, priority, value, options = {})
-    options.merge!({"mxLevel" => priority})
+    options.merge!('mxLevel' => priority)
 
-    create_record domain_name, name, "MX", value, options
+    create_record domain_name, name, 'MX', value, options
   end
 
   def create_srv_record(domain_name, name, priority, weight, port, value, options = {})
-    options.merge!({"priority" => priority, "weight" => weight, "port" => port})
-    create_record domain_name, name, "SRV", value, options
+    options.merge!('priority' => priority, 'weight' => weight, 'port' => port)
+    create_record domain_name, name, 'SRV', value, options
   end
 
-  def create_httpred_record(domain_name, name, value, redirectType = "STANDARD - 302", description = "", keywords = "", title = "", options = {})
-    options.merge!({"redirectType" => redirectType, "description" => description, "keywords" => keywords, "title" => title})
-    create_record domain_name, name, "HTTPRED", value, options
+  def create_httpred_record(domain_name, name, value, redirectType = 'STANDARD - 302', description = '', keywords = '', title = '', options = {})
+    options.merge!('redirectType' => redirectType, 'description' => description, 'keywords' => keywords, 'title' => title)
+    create_record domain_name, name, 'HTTPRED', value, options
   end
 
   def update_record(domain, record_id, name, type, value, options = {})
-    body = { "name" => name, "type" => type, "value" => value, "ttl" => 3600, "gtdLocation" => "DEFAULT", "id" => record_id}
+    body = { 'name' => name, 'type' => type, 'value' => value, 'ttl' => 3600, 'gtdLocation' => 'DEFAULT', 'id' => record_id }
     put "/dns/managed/#{get_id_by_domain(domain)}/records/#{record_id}/", body.merge(options)
   end
 
@@ -139,13 +150,13 @@ class DnsMadeEasy
 
   def get(path)
     request(path) do |uri|
-      Net::HTTP::Get.new(uri.path)
+      Net::HTTP::Get.new(uri)
     end
   end
 
   def delete(path, body = nil)
     request(path) do |uri|
-      req = Net::HTTP::Delete.new(uri.path)
+      req = Net::HTTP::Delete.new(uri)
       req.body = body.to_json if body
       req
     end
@@ -153,7 +164,7 @@ class DnsMadeEasy
 
   def put(path, body = nil)
     request(path) do |uri|
-      req = Net::HTTP::Put.new(uri.path)
+      req = Net::HTTP::Put.new(uri)
       req.body = body.to_json if body
       req
     end
@@ -161,7 +172,7 @@ class DnsMadeEasy
 
   def post(path, body)
     request(path) do |uri|
-      req = Net::HTTP::Post.new(uri.path)
+      req = Net::HTTP::Post.new(uri)
       req.body = body.to_json
       req
     end
@@ -172,6 +183,8 @@ class DnsMadeEasy
 
     http = Net::HTTP.new(uri.host, uri.port)
     http.use_ssl = true
+    http.open_timeout = @options[:open_timeout] if @options.key?(:open_timeout)
+    http.read_timeout = @options[:read_timeout] if @options.key?(:read_timeout)
 
     request = yield(uri)
 
@@ -180,7 +193,9 @@ class DnsMadeEasy
     end
 
     response = http.request(request)
-    unparsed_json = response.body == "" ? "{}" : response.body
+    response.value # raise Net::HTTPServerException unless response was 2xx
+
+    unparsed_json = response.body.to_s.empty? ? '{}' : response.body
 
     JSON.parse(unparsed_json)
   end

data/spec/lib/dnsmadeeasyapi-rest-api_spec.rb

@@ -111,6 +111,25 @@ describe DnsMadeEasy do
     end
   end
 
+  describe '#find' do
+    let(:records_for_response) do
+      {
+        'data' => [
+          { 'name' => 'demo', 'type' => 'A', 'id' => 123},
+          { 'name' => 'demo', 'type' => 'A', 'id' => 143}
+        ]
+      }
+    end
+
+    before do
+      subject.stub(:records_for).with('something.wanelo.com').and_return(records_for_response)
+    end
+
+    it 'finds the first record that matches name and type' do
+      expect(subject.find('something.wanelo.com', 'demo', 'A')).to eq({ 'name' => 'demo', 'type' => 'A', 'id' => 123})
+    end
+  end
+
   describe '#find_record_id' do
     let(:records_for_response) do
       {
@@ -132,17 +151,47 @@ describe DnsMadeEasy do
 
   describe '#delete_records' do
     let(:response) { "{}" }
+    let(:domain) { 'something.wanelo.com' }
+    let(:domain_id) { 123 }
 
-    before do
-      subject.stub(:get_id_by_domain).with('something.wanelo.com').and_return(123)
+    context 'with an array of record ids' do
+      let(:ids) { [147, 159] }
+
+      before do
+        subject.stub(:get_id_by_domain).with(domain).and_return(domain_id)
+
+        stub_request(:delete, "https://api.dnsmadeeasy.com/V2.0/dns/managed/#{domain_id}/records?ids=#{ids.join(',')}").
+          with(headers: request_headers).
+          to_return(:status => 200, :body => response, :headers => {})
+      end
+
+      it 'deletes a list of records from a given domain' do
+        expect(subject.delete_records('something.wanelo.com', ids)).to eq({})
+      end
     end
 
-    it 'deletes a list of records from a given domain' do
-      stub_request(:delete, "https://api.dnsmadeeasy.com/V2.0/dns/managed/123/records/").
-        with(headers: request_headers, body: "[147,159]").
+    context 'with an empty array' do
+      it 'returns early without deleting anything' do
+        expect(subject.delete_records('something.wanelo.com', [])).to eq(nil)
+      end
+    end
+  end
+
+  describe '#delete_all_records' do
+    let(:response) { "{}" }
+    let(:domain) { 'something.wanelo.com' }
+    let(:domain_id) { 123 }
+
+    before do
+      subject.stub(:get_id_by_domain).with(domain).and_return(domain_id)
+
+      stub_request(:delete, "https://api.dnsmadeeasy.com/V2.0/dns/managed/#{domain_id}/records").
+        with(headers: request_headers).
         to_return(:status => 200, :body => response, :headers => {})
+    end
 
-      expect(subject.delete_records('something.wanelo.com', [147, 159])).to eq({})
+    it 'deletes all records from the domain' do
+      expect(subject.delete_all_records('something.wanelo.com')).to eq({})
     end
   end
 
@@ -242,14 +291,39 @@ describe DnsMadeEasy do
         to_return(:status => 200, :body => response, :headers => {})
 
 
-      expect(subject.update_record('something.wanelo.com', 21, 'mail', 'A', '1.1.1.1', options = {})).to eq({})
+      expect(subject.update_record('something.wanelo.com', 21, 'mail', 'A', '1.1.1.1', {})).to eq({})
     end
   end
 
   describe "#request" do
-    it "handles an empty string response" do
-      Net::HTTP.any_instance.stub(:request).and_return(double(body: ""))
-      expect(subject.send(:request, "/some_path") { {} }).to eq({})
+    before do
+      stub_request(:get, "https://api.dnsmadeeasy.com/V2.0/some_path").
+        with(headers: request_headers).
+        to_return(status: status, body: body, headers: {})
+    end
+
+    let(:response) do
+      subject.send(:request, "/some_path") { |uri|
+        Net::HTTP::Get.new(uri.path)
+      }
+    end
+
+    context "with a 2xx, empty-string response" do
+      let(:status) { 200 }
+      let(:body) { "" }
+
+      it "handles gracefully" do
+        expect(response).to eq({})
+      end
+    end
+
+    context "with a non-2xx response" do
+      let(:status) { 400 }
+      let(:body) { "<xml> JSON.parse won't like this very much </xml>" }
+
+      it "raises a Net::HTTPServerException instead of a JSON::ParserError" do
+        expect { response }.to raise_exception(Net::HTTPServerException)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dnsmadeeasy-rest-api
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Arnoud Vermeer
@@ -10,34 +10,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-14 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: DNS Made Easy V2.0 REST API client for Ruby. With tests and no dependencies.
@@ -48,9 +76,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rubocop.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -68,17 +96,17 @@ 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.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: DNS Made Easy V2.0 REST API client for Ruby

data/Gemfile.lock

@@ -1,32 +0,0 @@
-PATH
-  remote: .
-  specs:
-    dnsmadeeasy-rest-api (1.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.6)
-    crack (0.4.2)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.2.5)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    safe_yaml (1.0.3)
-    webmock (1.18.0)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  dnsmadeeasy-rest-api!
-  rspec
-  webmock