dnsimple 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af0c0df379377bed93734974abb9af0f682cd75e
-  data.tar.gz: 250b4394bf6b35d7ea80276ee6b92cc6d90b2d50
+  metadata.gz: ebcde22a916ca2575f93426b277d8fb2000da824
+  data.tar.gz: d26271208dcf497b132004385a800ff229432287
 SHA512:
-  metadata.gz: 075b9ffc70204575a94aec17e36f2bf11c1ba57384162abcbcb6d3daafb3a14a09e429d7a5ee6d87ce5e3800a6bdb72c37fff33c10891b7c335012a8989aa9fd
-  data.tar.gz: 489c8662934bdb41307a69ca9c972d8534125b707cb51bbe35e13d8b29dc3159062a970400a4dafbf3ea456bd0d07f6709777fd383054eb318f68a58855da13a
+  metadata.gz: 68991131ad17ff8d9a7bf14ddf3fed6a2f298668074e39945537478eff76bad1f921db9e90c8b34aa311fda12e19f8267fb208bb7605001f965bb9f65bd73c1e
+  data.tar.gz: 2993c7d50cd5a8eaf44a0d15276dc7b0ce6e1374f20be04f62ccac9bd650a7b43d7acfaf8ee7102ac66dc2b91be8baee72a2a297211b2b13039aae3e5ab6b267

data/.rubocop_dnsimple.yml

@@ -1,8 +1,15 @@
+# Defaults https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
 AllCops:
   Exclude:
     # Exclude .gemspec files because they are generally auto-generated
     - '*.gemspec'
 
+# In most cases, Gems are sorted alphabetically.
+# However, in some few cases the order is relevant due to dependencies.
+Bundler/OrderedGems:
+  Enabled: false
+
 # Generally, the keyword style uses a lot of space. This is particularly true when
 # you use case/if statements, in combination with a long-name variable.
 #
@@ -16,6 +23,10 @@ AllCops:
 Lint/EndAlignment:
   EnforcedStyleAlignWith: variable
 
+# [codesmell]
+Lint/HandleExceptions:
+  Enabled: false
+
 # [codesmell]
 Metrics/AbcSize:
   Enabled: false
@@ -93,54 +104,16 @@ Style/BlockDelimiters:
   IgnoredMethods:
     - expect
 
-# I'd rather use context_dependent, even if I'm not even sure we should enforce a style.
+# I'm not sure we should enforce a style,
+# but if we do, context_dependent offers a good compromise on readability.
 Style/BracesAroundHashParameters:
+  Enabled: false
   EnforcedStyle: context_dependent
 
-# For the same reason of EndAlignment, aligning with the case may have a bad impact
-# on a case after a very long variable.
-#
-#   invoice_error_message = case error
-#                           when 1 == 1
-#                             do_something
-#                           else
-#                             do_else
-#                           end
-#
-Style/CaseIndentation:
-  EnforcedStyle: end
-
-# I was a big fan of leading, but trailing seems to be more commonly adopted.
-# At least at the time being.
-Style/DotPosition:
-  EnforcedStyle: trailing
-
 # Warn on empty else.
 Style/EmptyElse:
   EnforcedStyle: empty
 
-# Double empty lines are useful to separate conceptually different methods
-# in the same class or module.
-Style/EmptyLines:
-  Enabled: false
-
-Style/EmptyLinesAroundBlockBody:
-  Exclude:
-    # RSpec is all made of blocks. Disable this config in RSpec
-    # to be consistent with EmptyLinesAroundClassBody and EmptyLinesAroundModuleBody
-    - 'spec/**/*_spec.rb'
-    - 'test/**/*_test.rb'
-
-# In most cases, a space is nice. Sometimes, it's not.
-# Just be consistent with the rest of the surrounding code.
-Style/EmptyLinesAroundClassBody:
-  Enabled: false
-
-# In most cases, a space is nice. Sometimes, it's not.
-# Just be consistent with the rest of the surrounding code.
-Style/EmptyLinesAroundModuleBody:
-  Enabled: false
-
 # There is no specific preference for empty methods.
 # One-line methods are not exceptionally nice in Ruby. Just ignore this cop for now.
 Style/EmptyMethod:
@@ -152,10 +125,6 @@ Style/EmptyMethod:
 Style/FormatString:
   Enabled: false
 
-# Multi-line differs from standard indentation, they are indented twice.
-Style/FirstParameterIndentation:
-  IndentationWidth: 4
-
 # We don't support frozen strings.
 # This is an experimental feature and we don't know if it will be shipped with
 # Ruby 3.0 or not.
@@ -174,16 +143,6 @@ Style/HashSyntax:
 Style/IfUnlessModifier:
   Enabled: false
 
-# Array indentation should be considered like MultilineMethodCallIndentation indentation
-# and use 4 spaces instead of 2.
-Style/IndentArray:
-  IndentationWidth: 4
-
-# Hash indentation should be considered like MultilineMethodCallIndentation indentation
-# and use 4 spaces instead of 2.
-Style/IndentHash:
-  IndentationWidth: 4
-
 # [codesmell]
 # It's not always that bad.
 Style/IfInsideElse:
@@ -199,16 +158,6 @@ Style/MultilineBlockChain:
     # RSpec uses multi-line blocks for certain features
     - 'spec/**/*_spec.rb'
 
-# Multi-line differs from standard indentation, they are indented twice.
-Style/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-  IndentationWidth: 4
-
-# Multi-line differs from standard indentation, they are indented twice.
-Style/MultilineOperationIndentation:
-  EnforcedStyle: indented
-  IndentationWidth: 4
-
 # unless is not always cool.
 Style/NegatedIf:
   Enabled: false
@@ -221,6 +170,18 @@ Style/NumericLiterals:
     - 'spec/**/*_spec.rb'
     - 'test/**/*_test.rb'
 
+# For years, %w() has been the de-facto standard. A lot of libraries are using ().
+# Switching to [] would be a nightmare.
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# We use it from time to time, as it's not always possible (or maintainable)
+# to use simple ? methods.
+# Moreover, it's actually more efficient to not-use predicates:
+# https://github.com/bbatsov/rubocop/issues/3633
+Style/PredicateName:
+  Enabled: false
+
 # Do we care?
 Style/RegexpLiteral:
   Enabled: false
@@ -230,15 +191,8 @@ Style/RegexpLiteral:
 Style/RescueModifier:
   Enabled: false
 
-# Sorry, but using trailing spaces helps readability.
-#
-#   %w( foo bar )
-#
-# looks better to me than
-#
-#   %w( foo bar )
-#
-Style/SpaceInsidePercentLiteralDelimiters:
+# This is quite annoying, especially in cases where we don't control it (e.g. schema.rb).
+Style/SymbolArray:
   Enabled: false
 
 # We don't have a preference.
@@ -252,6 +206,11 @@ Style/StringLiterals:
   Enabled: false
   EnforcedStyle: double_quotes
 
+# As before.
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+  EnforcedStyle: double_quotes
+
 # It's nice to be consistent. The trailing comma also allows easy reordering,
 # and doesn't cause a diff in Git when you add a line to the bottom.
 Style/TrailingCommaInLiteral:
@@ -270,3 +229,98 @@ Style/TrivialAccessors:
 Style/WordArray:
   EnforcedStyle: percent
   MinSize: 3
+
+# Forces the order of comparison arguments.
+#
+# According to this cop, the following statement is bad:
+#
+#   "https" == uri.scheme
+#
+# Whereas the following is considered good:
+#
+#   uri.scheme == "https"
+Style/YodaCondition:
+  Enabled: false
+
+# For the same reason of EndAlignment, aligning with the case may have a bad impact
+# on a case after a very long variable.
+#
+#   invoice_error_message = case error
+#                           when 1 == 1
+#                             do_something
+#                           else
+#                             do_else
+#                           end
+#
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+# I was a big fan of leading, but trailing seems to be more commonly adopted.
+# At least at the time being.
+Layout/DotPosition:
+  EnforcedStyle: leading
+
+# Double empty lines are useful to separate conceptually different methods
+# in the same class or module.
+Layout/EmptyLines:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    # RSpec is all made of blocks. Disable this config in RSpec
+    # to be consistent with EmptyLinesAroundClassBody and EmptyLinesAroundModuleBody
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+
+# In most cases, a space is nice. Sometimes, it's not.
+# Just be consistent with the rest of the surrounding code.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# We're ok with it. We use it quite often for method-level rescue statements.
+Layout/EmptyLinesAroundExceptionHandlingKeywords:
+  Enabled: false
+
+# In most cases, a space is nice. Sometimes, it's not.
+# Just be consistent with the rest of the surrounding code.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+# This is quite buggy, as it doesn't recognize double lines.
+Layout/EmptyLineBetweenDefs:
+  Enabled: false
+
+# Multi-line differs from standard indentation, they are indented twice.
+Layout/FirstParameterIndentation:
+  IndentationWidth: 4
+
+# Array indentation should be considered like MultilineMethodCallIndentation indentation
+# and use 4 spaces instead of 2.
+Layout/IndentArray:
+  IndentationWidth: 4
+
+# Hash indentation should be considered like MultilineMethodCallIndentation indentation
+# and use 4 spaces instead of 2.
+Layout/IndentHash:
+  IndentationWidth: 4
+
+# Multi-line differs from standard indentation, they are indented twice.
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 4
+
+# Multi-line differs from standard indentation, they are indented twice.
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 4
+
+# Sorry, but using trailing spaces helps readability.
+#
+#   %w( foo bar )
+#
+# looks better to me than
+#
+#   %w( foo bar )
+#
+Layout/SpaceInsidePercentLiteralDelimiters:
+  Enabled: false

data/.travis.yml

@@ -4,8 +4,8 @@ rvm:
 - 2.0
 - 2.1
 - 2.2
-- 2.3.3
-- 2.4.0
+- 2.3.4
+- 2.4.1
 env: COVERALL=1
 
 before_install:

data/CHANGELOG.md

@@ -2,10 +2,19 @@
 
 This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
+
+#### 4.3.0
+
+- NEW: Added `certificates.all_certificates` (dnsimple/dnsimple-ruby#155)
+
+- CHANGED: Updated registrar URLs (dnsimple/dnsimple-ruby#153)
+
+
 #### 4.2.0
 
 - NEW: Added DNSSEC support support (dnsimple/dnsimple-ruby#152)
 
+
 #### 4.1.0
 
 - NEW: Added domain premium price support (dnsimple/dnsimple-ruby#143)

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2010-2016 Aetrion LLC
+Copyright (c) 2010-2017 Aetrion LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -88,4 +88,4 @@ The value you provide will be appended to the default `User-Agent` the client us
 
 ## License
 
-Copyright (c) 2010-2016 Aetrion LLC. This is Free Software distributed under the MIT license.
+Copyright (c) 2010-2017 Aetrion LLC. This is Free Software distributed under the MIT license.

data/dnsimple.gemspec

@@ -5,8 +5,8 @@ require 'dnsimple/version'
 Gem::Specification.new do |s|
   s.name        = 'dnsimple'
   s.version     = Dnsimple::VERSION
-  s.authors     = ['Anthony Eden', 'Simone Carletti', 'Javier Acero', 'Joseph Caudle', 'Luca Guidi']
-  s.email       = ['anthony.eden@dnsimple.com', 'simone.carletti@dnsimple.com', 'javier.acero@dnsimple.com', 'joseph.caudle@dnsimple.com', 'luca.guidi@dnsimple.com']
+  s.authors     = ['Anthony Eden', 'Simone Carletti', 'Javier Acero', 'Luca Guidi']
+  s.email       = ['anthony.eden@dnsimple.com', 'simone.carletti@dnsimple.com', 'javier.acero@dnsimple.com', 'luca.guidi@dnsimple.com']
   s.homepage    = 'https://github.com/dnsimple/dnsimple-ruby'
   s.summary     = 'The DNSimple API client for Ruby'
   s.description = 'The DNSimple API client for Ruby.'

data/lib/dnsimple/client/certificates.rb

@@ -30,6 +30,30 @@ module Dnsimple
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Certificate.new(r) })
       end
 
+      # Lists ALL the certificates for the domain.
+      #
+      # This method is similar to {#certificates}, but instead of returning the results of a specific page
+      # it iterates all the pages and returns the entire collection.
+      #
+      # Please use this method carefully, as fetching the entire collection will increase the number of requests
+      # you send to the API server and you may eventually risk to hit the throttle limit.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/certificates/#list
+      # @see #certificates
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_name The domain ID or domain name
+      # @param  [Hash] options the filtering and sorting option
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @option options [String] :sort sorting policy
+      # @return [Dnsimple::CollectionResponse<Dnsimple::Struct::Certificate>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def all_certificates(account_id, domain_name, options = {})
+        paginate(:certificates, account_id, domain_name, options)
+      end
+
       # Gets a certificate associated to the domain.
       #
       # @see https://developer.dnsimple.com/v2/domains/certificates/#get

data/lib/dnsimple/client/registrar.rb

@@ -65,7 +65,7 @@ module Dnsimple
       # @raise  [RequestError] When the request fails.
       def register_domain(account_id, domain_name, attributes, options = {})
         Extra.validate_mandatory_attributes(attributes, [:registrant_id])
-        endpoint = Client.versioned("/%s/registrar/domains/%s/registration" % [account_id, domain_name])
+        endpoint = Client.versioned("/%s/registrar/domains/%s/registrations" % [account_id, domain_name])
         response = client.post(endpoint, attributes, options)
 
         Dnsimple::Response.new(response, Struct::DomainRegistration.new(response["data"]))
@@ -86,7 +86,7 @@ module Dnsimple
       #
       # @raise  [RequestError] When the request fails.
       def renew_domain(account_id, domain_name, attributes = nil, options = {})
-        endpoint = Client.versioned("/%s/registrar/domains/%s/renewal" % [account_id, domain_name])
+        endpoint = Client.versioned("/%s/registrar/domains/%s/renewals" % [account_id, domain_name])
         response = client.post(endpoint, attributes, options)
 
         Dnsimple::Response.new(response, Struct::DomainRenewal.new(response["data"]))
@@ -108,7 +108,7 @@ module Dnsimple
       # @raise  [RequestError] When the request fails.
       def transfer_domain(account_id, domain_name, attributes, options = {})
         Extra.validate_mandatory_attributes(attributes, [:registrant_id])
-        endpoint = Client.versioned("/%s/registrar/domains/%s/transfer" % [account_id, domain_name])
+        endpoint = Client.versioned("/%s/registrar/domains/%s/transfers" % [account_id, domain_name])
         response = client.post(endpoint, attributes, options)
 
         Dnsimple::Response.new(response, Struct::DomainTransfer.new(response["data"]))
@@ -128,7 +128,7 @@ module Dnsimple
       #
       # @raise  [RequestError] When the request fails.
       def transfer_domain_out(account_id, domain_name, options = {})
-        endpoint = Client.versioned("/%s/registrar/domains/%s/transfer_out" % [account_id, domain_name])
+        endpoint = Client.versioned("/%s/registrar/domains/%s/authorize_transfer_out" % [account_id, domain_name])
         response = client.post(endpoint, nil, options)
 
         Dnsimple::Response.new(response, nil)

data/lib/dnsimple/version.rb

@@ -1,3 +1,3 @@
 module Dnsimple
-  VERSION = "4.2.0".freeze
+  VERSION = "4.3.0".freeze
 end

data/spec/dnsimple/client/accounts_spec.rb

@@ -7,15 +7,15 @@ describe Dnsimple::Client, ".accounts" do
 
   describe "#accounts" do
     before do
-      stub_request(:get, %r{/v2/accounts$}).
-          to_return(read_http_fixture("listAccounts/success-user.http"))
+      stub_request(:get, %r{/v2/accounts$})
+          .to_return(read_http_fixture("listAccounts/success-user.http"))
     end
 
     it "builds the correct request" do
       subject.accounts
 
-      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/accounts").
-          with(headers: { 'Accept' => 'application/json' })
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/accounts")
+          .with(headers: { 'Accept' => 'application/json' })
     end
 
     it "returns the accounts" do

data/spec/dnsimple/client/certificates_spec.rb

@@ -9,15 +9,15 @@ describe Dnsimple::Client, ".certificates" do
     let(:domain_id)  { "example.com" }
 
     before do
-      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/certificates}).
-          to_return(read_http_fixture("listCertificates/success.http"))
+      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/certificates})
+          .to_return(read_http_fixture("listCertificates/success.http"))
     end
 
     it "builds the correct request" do
       subject.certificates(account_id, domain_id)
 
-      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/certificates").
-          with(headers: { 'Accept' => 'application/json' })
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/certificates")
+          .with(headers: { 'Accept' => 'application/json' })
     end
 
     it "supports pagination" do
@@ -56,21 +56,42 @@ describe Dnsimple::Client, ".certificates" do
     end
   end
 
+  describe "#all_certificates" do
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/certificates})
+          .to_return(read_http_fixture("listCertificates/success.http"))
+    end
+
+    let(:account_id) { 1010 }
+    let(:domain_id) { "example.com" }
+
+    it "delegates to client.paginate" do
+      expect(subject).to receive(:paginate).with(:certificates, account_id, domain_id, foo: "bar")
+      subject.all_certificates(account_id, domain_id, foo: "bar")
+    end
+
+    it "supports sorting" do
+      subject.all_certificates(account_id, domain_id, sort: "id:asc,expires_on:desc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/certificates?page=1&per_page=100&sort=id:asc,expires_on:desc")
+    end
+  end
+
   describe "#certificate" do
     let(:account_id)     { 1010 }
     let(:domain_id)      { "weppos.net" }
     let(:certificate_id) { 1 }
 
     before do
-      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/certificates/#{certificate_id}}).
-          to_return(read_http_fixture("getCertificate/success.http"))
+      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/certificates/#{certificate_id}})
+          .to_return(read_http_fixture("getCertificate/success.http"))
     end
 
     it "builds the correct request" do
       subject.certificate(account_id, domain_id, certificate_id)
 
-      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/certificates/#{certificate_id}").
-          with(headers: { 'Accept' => 'application/json' })
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/certificates/#{certificate_id}")
+          .with(headers: { 'Accept' => 'application/json' })
     end
 
     it "supports extra request options" do
@@ -99,8 +120,8 @@ describe Dnsimple::Client, ".certificates" do
 
     context "when the certificate does not exist" do
       it "raises NotFoundError" do
-        stub_request(:get, %r{/v2}).
-            to_return(read_http_fixture("notfound-certificate.http"))
+        stub_request(:get, %r{/v2})
+            .to_return(read_http_fixture("notfound-certificate.http"))
 
         expect {
           subject.certificate(account_id, domain_id, certificate_id)
@@ -115,15 +136,15 @@ describe Dnsimple::Client, ".certificates" do
     let(:certificate_id) { 1 }
 
     before do
-      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/certificates/#{certificate_id}/download}).
-          to_return(read_http_fixture("downloadCertificate/success.http"))
+      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/certificates/#{certificate_id}/download})
+          .to_return(read_http_fixture("downloadCertificate/success.http"))
     end
 
     it "builds the correct request" do
       subject.download_certificate(account_id, domain_id, certificate_id)
 
-      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/certificates/#{certificate_id}/download").
-          with(headers: { 'Accept' => 'application/json' })
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/certificates/#{certificate_id}/download")
+          .with(headers: { 'Accept' => 'application/json' })
     end
 
     it "supports extra request options" do
@@ -146,8 +167,8 @@ describe Dnsimple::Client, ".certificates" do
 
     context "when the certificate does not exist" do
       it "raises NotFoundError" do
-        stub_request(:get, %r{/v2}).
-            to_return(read_http_fixture("notfound-certificate.http"))
+        stub_request(:get, %r{/v2})
+            .to_return(read_http_fixture("notfound-certificate.http"))
 
         expect {
           subject.download_certificate(account_id, domain_id, certificate_id)
@@ -162,15 +183,15 @@ describe Dnsimple::Client, ".certificates" do
     let(:certificate_id) { 1 }
 
     before do
-      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/certificates/#{certificate_id}/private_key}).
-          to_return(read_http_fixture("getCertificatePrivateKey/success.http"))
+      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/certificates/#{certificate_id}/private_key})
+          .to_return(read_http_fixture("getCertificatePrivateKey/success.http"))
     end
 
     it "builds the correct request" do
       subject.certificate_private_key(account_id, domain_id, certificate_id)
 
-      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/certificates/#{certificate_id}/private_key").
-          with(headers: { 'Accept' => 'application/json' })
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/certificates/#{certificate_id}/private_key")
+          .with(headers: { 'Accept' => 'application/json' })
     end
 
     it "supports extra request options" do
@@ -193,8 +214,8 @@ describe Dnsimple::Client, ".certificates" do
 
     context "when the certificate does not exist" do
       it "raises NotFoundError" do
-        stub_request(:get, %r{/v2}).
-            to_return(read_http_fixture("notfound-certificate.http"))
+        stub_request(:get, %r{/v2})
+            .to_return(read_http_fixture("notfound-certificate.http"))
 
         expect {
           subject.certificate_private_key(account_id, domain_id, certificate_id)