dnsimple 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebcde22a916ca2575f93426b277d8fb2000da824
-  data.tar.gz: d26271208dcf497b132004385a800ff229432287
+  metadata.gz: 5798dd92561074094a81017acdd5337d2497e6b0
+  data.tar.gz: cde903898b98b7d316d0542f7e9257de64f5196a
 SHA512:
-  metadata.gz: 68991131ad17ff8d9a7bf14ddf3fed6a2f298668074e39945537478eff76bad1f921db9e90c8b34aa311fda12e19f8267fb208bb7605001f965bb9f65bd73c1e
-  data.tar.gz: 2993c7d50cd5a8eaf44a0d15276dc7b0ce6e1374f20be04f62ccac9bd650a7b43d7acfaf8ee7102ac66dc2b91be8baee72a2a297211b2b13039aae3e5ab6b267
+  metadata.gz: dc7c8c73aa1deace9034c3d5e4f8a392c0dbd966b73ff28c1771f581614f6efbe74e331b01225552513c63d006637f24d3df07ac68b44940aa9ada62d0a99c99
+  data.tar.gz: 6c1cc1d2121ccbbc316bcd55a99d3c4fca2a00410298c56f69bbc22b925ce0cee1b46bc30ed97467d202183a690982b61c49ad3d84fefecbb1800b91394fe924

data/.rubocop.yml

@@ -2,6 +2,11 @@ inherit_from:
   - .rubocop_todo.yml
   - .rubocop_dnsimple.yml
 
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - 'Rakefile'
+
 # [codesmell]
 # It's irrelevant here, but it could be a code smell.
 # Hence keep it disabled, but don't include it in the DNSimple suite.

data/.rubocop_dnsimple.yml

@@ -84,6 +84,13 @@ Metrics/ParameterLists:
 Metrics/PerceivedComplexity:
   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
+Naming/PredicateName:
+  Enabled: false
+
 # [codesmell]
 # I don't really get the point of this cop.
 Performance/RedundantMerge:
@@ -119,12 +126,17 @@ Style/EmptyElse:
 Style/EmptyMethod:
   Enabled: false
 
-# I personally don't care about the format style.
-# In most cases I like to use %, but not at the point I want to enforce it
+# We don't care about the format style.
+# In most cases we use %, but not at the point we want to enforce it
 # as a convention in the entire code.
 Style/FormatString:
   Enabled: false
 
+# Annotated tokens (like %<foo>s) are a good thing, but in most cases we don't need them.
+# %s is a simpler and straightforward version that works in almost all cases. So don't complain.
+Style/FormatStringToken:
+  Enabled: false
+
 # 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.
@@ -175,12 +187,16 @@ Style/NumericLiterals:
 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
+# Enable but only for multiple returns value.
+#
+#   return foo, bar
+#
+# reads much better than
+#
+#   [foo, bar]
+#
+Style/RedundantReturn:
+  AllowMultipleReturnValues: true
 
 # Do we care?
 Style/RegexpLiteral:
@@ -265,6 +281,10 @@ Layout/DotPosition:
 Layout/EmptyLines:
   Enabled: false
 
+# This is buggy. It detects as a style violation a few `class` and `module` definitions
+Layout/EmptyLinesAroundArguments:
+  Enabled: false
+
 Layout/EmptyLinesAroundBlockBody:
   Exclude:
     # RSpec is all made of blocks. Disable this config in RSpec

data/.travis.yml

@@ -1,13 +1,18 @@
-sudo: false
 language: ruby
+
+sudo: false
+
 rvm:
-- 2.0
-- 2.1
-- 2.2
-- 2.3.4
-- 2.4.1
-env: COVERALL=1
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+
+env:
+  - COVERALL=1
 
 before_install:
+  - rvm get latest
   - gem update --system
   - gem install bundler

data/CHANGELOG.md

@@ -3,6 +3,13 @@
 This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 
+#### 4.4.0
+
+- NEW: Added Let's Encrypt certificate methods (GH-159)
+
+- REMOVED: Removed premium_price attribute from registrar order responses (GH-163). Please do not rely on that attribute, as it returned an incorrect value. The attribute is going to be removed, and the API now returns a null value.
+
+
 #### 4.3.0
 
 - NEW: Added `certificates.all_certificates` (dnsimple/dnsimple-ruby#155)

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2010-2017 Aetrion LLC
+Copyright (c) 2010-2018 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-2017 Aetrion LLC. This is Free Software distributed under the MIT license.
+Copyright (c) 2010-2018 Aetrion LLC. This is Free Software distributed under the MIT license.

data/lib/dnsimple/client.rb

@@ -61,7 +61,7 @@ module Dnsimple
     def initialize(options = {})
       defaults = Dnsimple::Default.options
 
-      Dnsimple::Default.keys.each do |key|
+      Dnsimple::Default.keys.each do |key| # rubocop:disable Performance/HashEachMethods
         instance_variable_set(:"@#{key}", options[key] || defaults[key])
       end
 

data/lib/dnsimple/client/certificates.rb

@@ -2,9 +2,9 @@ module Dnsimple
   class Client
     module Certificates
 
-      # Lists the certificates associated to the domain.
+      # List the certificates for the domain in the account.
       #
-      # @see https://developer.dnsimple.com/v2/domains/certificates/#list
+      # @see https://developer.dnsimple.com/v2/certificates/#listCertificates
       # @see #all_certificates
       #
       # @example List certificates in the first page
@@ -16,9 +16,9 @@ module Dnsimple
       # @example List certificates, provide a sorting policy
       #   client.certificates.list(1010, "example.com", sort: "email:asc")
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] domain_name the domain name
-      # @param  [Hash] options the filtering and sorting options
+      # @param  account_id  [Integer] the account ID
+      # @param  domain_name [#to_s] The domain ID or domain name
+      # @param  options [Hash] the filtering and sorting options
       # @option options [Integer] :page current page (pagination)
       # @option options [Integer] :per_page number of entries to return (pagination)
       # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Certificate>]
@@ -30,7 +30,7 @@ module Dnsimple
         Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Certificate.new(r) })
       end
 
-      # Lists ALL the certificates for the domain.
+      # List ALL the certificates for the domain in the account.
       #
       # 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.
@@ -38,12 +38,12 @@ module Dnsimple
       # 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 https://developer.dnsimple.com/v2/certificates/#listCertificates
       # @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
+      # @param  account_id [Integer] the account ID
+      # @param  domain_name [#to_s] The domain ID or domain name
+      # @param  options [Hash] 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
@@ -54,14 +54,14 @@ module Dnsimple
         paginate(:certificates, account_id, domain_name, options)
       end
 
-      # Gets a certificate associated to the domain.
+      # Get the details of a certificate.
       #
-      # @see https://developer.dnsimple.com/v2/domains/certificates/#get
+      # @see https://developer.dnsimple.com/v2/certificates/#getCertificate
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] domain_id the domain ID or domain name
-      # @param  [Integer] certificate_id the certificate ID
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  domain_id [#to_s] the domain ID or domain name
+      # @param  certificate_id [Integer] the certificate ID
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::Certificate>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -72,14 +72,14 @@ module Dnsimple
         Dnsimple::Response.new(response, Struct::Certificate.new(response["data"]))
       end
 
-      # Downloads a certificate associated to the domain.
+      # Get the PEM-encoded certificate, along with the root certificate and intermediate chain.
       #
-      # @see https://developer.dnsimple.com/v2/domains/certificates/#download
+      # @see https://developer.dnsimple.com/v2/certificates/#downloadCertificate
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] domain_id the domain ID or domain name
-      # @param  [Integer] certificate_id the certificate ID
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  domain_id [#to_s] the domain ID or domain name
+      # @param  certificate_id [Integer] the certificate ID
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::CertificateBundle>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -90,14 +90,14 @@ module Dnsimple
         Dnsimple::Response.new(response, Struct::CertificateBundle.new(response["data"]))
       end
 
-      # Get certificate private key associated to the domain.
+      # Get the PEM-encoded certificate private key.
       #
-      # @see https://developer.dnsimple.com/v2/domains/certificates/#get-private-key
+      # @see https://developer.dnsimple.com/v2/certificates/#getCertificatePrivateKey
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] domain_id the domain ID or domain name
-      # @param  [Integer] certificate_id the certificate ID
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  domain_id [#to_s] the domain ID or domain name
+      # @param  certificate_id [Integer] the certificate ID
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Dnsimple::Struct::CertificateBundle>]
       #
       # @raise  [Dnsimple::NotFoundError]
@@ -108,6 +108,163 @@ module Dnsimple
         Dnsimple::Response.new(response, Struct::CertificateBundle.new(response["data"]))
       end
 
+      # Purchase a Let's Encrypt certificate.
+      #
+      # This method creates a new certificate order. The certificate ID should be used to
+      # request the issuance of the certificate using {#issue_letsencrypt_certificate}.
+      #
+      # @see https://developer.dnsimple.com/v2/certificates/#purchaseLetsencryptCertificate
+      #
+      # @param  account_id [Integer] the account ID
+      # @param  domain_id [#to_s] the domain ID or domain name
+      # @param  attributes [Hash]
+      # @option attributes [Integer] :contact_id the contact ID (mandatory)
+      # @option attributes [String] :name the certificate name (optional)
+      # @option attributes [Array<String>] :alternate_names the certificate alternate names (optional)
+      # @option attributes [TrueClass,FalseClass] :auto_renew enable certificate auto renew (optional)
+      # @param  options[Hash]
+      #
+      # @return [Dnsimple::Response<Dnsimple::Struct::CertificatPurchase>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      #
+      # @example Basic usage
+      #   response    = client.certificates.purchase_letsencrypt_certificate(1010, "example.com", contact_id: 1)
+      #   certificate = response.data
+      #
+      #   certificate.id              # => 100
+      #   certificate.common_name     # => "www.example.com"
+      #   certificate.alternate_names # => []
+      #   certificate.auto_renew      # => false
+      #
+      # @example Custom name
+      #   response    = client.certificates.purchase_letsencrypt_certificate(1010, "example.com", contact_id: 1, name: "docs")
+      #   certificate = response.data
+      #
+      #   certificate.id              # => 100
+      #   certificate.common_name     # => "docs.example.com"
+      #   certificate.alternate_names # => []
+      #   certificate.auto_renew      # => false
+      #
+      # @example SAN names
+      #   response    = client.certificates.purchase_letsencrypt_certificate(1010, "example.com", contact_id: 1, alternate_names: ["api.example.com", "status.example.com"])
+      #   certificate = response.data
+      #
+      #   certificate.id              # => 100
+      #   certificate.common_name     # => "www.example.com"
+      #   certificate.alternate_names # => ["api.example.com", "status.example.com"]
+      #   certificate.auto_renew      # => false
+      #
+      # @example Auto renew
+      #   response    = client.certificates.purchase_letsencrypt_certificate(1010, "example.com", contact_id: 1, auto_renew: true)
+      #   certificate = response.data
+      #
+      #   certificate.id              # => 100
+      #   certificate.common_name     # => "www.example.com"
+      #   certificate.alternate_names # => []
+      #   certificate.auto_renew      # => true
+      def purchase_letsencrypt_certificate(account_id, domain_id, attributes, options = {})
+        Extra.validate_mandatory_attributes(attributes, [:contact_id])
+        response = client.post(Client.versioned("/%s/domains/%s/certificates/letsencrypt" % [account_id, domain_id]), attributes, options)
+
+        Dnsimple::Response.new(response, Struct::CertificatePurchase.new(response["data"]))
+      end
+
+      # Issue a pending Let's Encrypt certificate order.
+      #
+      # Note that the issuance process is async. A successful response means the issuance
+      # request has been successfully acknowledged and queued for processing.
+      #
+      # @see https://developer.dnsimple.com/v2/certificates/#issueLetsencryptCertificate
+      #
+      # @param  account_id [Integer] the account ID
+      # @param  domain_id [#to_s] the domain ID or domain name
+      # @param  certificate_id [Integer] the certificate ID returned by the purchase method
+      # @param  options [Hash]
+      #
+      # @return [Dnsimple::Response<Dnsimple::Struct::Certificate>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      #
+      # @example Basic usage
+      #   reponse     = client.certificates.issue_letsencrypt_certificate(1010, "example.com", 100)
+      #   certificate = response.data
+      #
+      #   certificate.state # => "requesting"
+      def issue_letsencrypt_certificate(account_id, domain_id, certificate_id, options = {})
+        response = client.post(Client.versioned("/%s/domains/%s/certificates/letsencrypt/%s/issue" % [account_id, domain_id, certificate_id]), options)
+
+        Dnsimple::Response.new(response, Struct::Certificate.new(response["data"]))
+      end
+
+      # Purchase a Let's Encrypt certificate renewal.
+      #
+      # @see https://developer.dnsimple.com/v2/certificates/#purchaseRenewalLetsencryptCertificate
+      #
+      # @param  account_id [Integer] the account ID
+      # @param  domain_id [#to_s] the domain ID or domain name
+      # @param  certificate_id [Integer] the certificate ID
+      # @param  attributes [Hash]
+      # @option attributes [TrueClass,FalseClass] :auto_renew enable certificate auto renew (optional)
+      # @param  options [Hash]
+      #
+      # @return [Dnsimple::Response<Dnsimple::Struct::CertificateRenewal>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      #
+      # @example Basic usage
+      #   response            = client.certificates.purchase_letsencrypt_certificate_renewal(1010, "example.com", 200)
+      #   certificate_renewal = response.data
+      #
+      #   certificate_renewal.id                 # => 999
+      #   certificate_renewal.old_certificate_id # => 200
+      #   certificate_renewal.new_certificate_id # => 300
+      #
+      # @example Auto renew
+      #   response            = client.certificates.purchase_letsencrypt_certificate_renewal(1010, "example.com", 200, auto_renew: true)
+      #   certificate_renewal = response.data
+      #
+      #   certificate_renewal.id                 # => 999
+      #   certificate_renewal.old_certificate_id # => 200
+      #   certificate_renewal.new_certificate_id # => 300
+      def purchase_letsencrypt_certificate_renewal(account_id, domain_id, certificate_id, attributes = {}, options = {})
+        response = client.post(Client.versioned("/%s/domains/%s/certificates/letsencrypt/%s/renewals" % [account_id, domain_id, certificate_id]), attributes, options)
+
+        Dnsimple::Response.new(response, Struct::CertificateRenewal.new(response["data"]))
+      end
+
+      # Issue a pending Let's Encrypt certificate renewal order.
+      #
+      # Note that the issuance process is async. A successful response means the issuance
+      # request has been successfully acknowledged and queued for processing.
+      #
+      # @see https://developer.dnsimple.com/v2/certificates/#issueRenewalLetsencryptCertificate
+      #
+      # @param  account_id [Integer] the account ID
+      # @param  domain_id [#to_s] the domain ID or domain name
+      # @param  certificate_id [Integer] the certificate ID
+      # @param  certificate_renewal_id [Integer] the certificate renewal ID
+      # @param  options [Hash]
+      #
+      # @return [Dnsimple::Response<Dnsimple::Struct::Certificate>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      #
+      # @example Basic usage
+      #   response    = client.certificates.issue_letsencrypt_certificate_renewal(1010, "example.com", 100, 999)
+      #   certificate = response.data
+      #
+      #   certificate.state # => "requesting"
+      def issue_letsencrypt_certificate_renewal(account_id, domain_id, certificate_id, certificate_renewal_id, options = {})
+        response = client.post(Client.versioned("/%s/domains/%s/certificates/letsencrypt/%s/renewals/%s/issue" % [account_id, domain_id, certificate_id, certificate_renewal_id]), options)
+
+        Dnsimple::Response.new(response, Struct::Certificate.new(response["data"]))
+      end
+
     end
   end
 end

data/lib/dnsimple/client/registrar.rb

@@ -7,7 +7,7 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/registrar/#check
       #
       # @example Check whether example.com is available:
-      #   client.registrar.check(1010, "example.com")
+      #   client.registrar.check_domain(1010, "example.com")
       #
       # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to check
@@ -54,7 +54,7 @@ module Dnsimple
       #
       # @example Initiate the registration of example.com using the contact 1234 as registrant
       #   including WHOIS privacy for the domain and enabling auto renewal:
-      #   client.registrar.register(1010, "example.com", registrant_id: 1234, private_whois: true, auto_renew: true)
+      #   client.registrar.register_domain(1010, "example.com", registrant_id: 1234, private_whois: true, auto_renew: true)
       #
       # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to register
@@ -76,7 +76,7 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/registrar/#renew
       #
       # @example Renew example.com for 3 years:
-      #   client.registrar.renew(1010, "example.com", period: 3)
+      #   client.registrar.renew_domain(1010, "example.com", period: 3)
       #
       # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to renew
@@ -97,7 +97,7 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/registrar/#transfer
       #
       # @example Initiate the transfer for example.com using the contact 1234 as registrant:
-      #   client.registrar.transfer(1010, "example.com", registrant_id: 1234, auth_code: "x1y2z3")
+      #   client.registrar.transfer_domain(1010, "example.com", registrant_id: 1234, auth_code: "x1y2z3")
       #
       # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to transfer
@@ -119,7 +119,7 @@ module Dnsimple
       # @see https://developer.dnsimple.com/v2/registrar/#transfer-out
       #
       # @example Request to transfer of example.com out of DNSimple:
-      #   client.registrar.transfer_out(1010, "example.com")
+      #   client.registrar.transfer_domain_out(1010, "example.com")
       #
       # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_name the domain name to transfer out