dnsimple 8.1.0 → 8.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 926c26b50cdc2958b19e86a45cd6eb0394f5d884bcc12e45e8fda88b194c8fac
-  data.tar.gz: 930e5d25b213d496faa3268b3af1a0a1a407e0b632ad9a4a7f16fc8cb2a72256
+  metadata.gz: d47bee5f7278d2aab4a2faa9b88121cbec92c510f6bbb807d5d0dd973429e360
+  data.tar.gz: abf2e8a9fe7a3613fbb3a80bcf375065f7a804fabd8369b1ec91760d8749e6c3
 SHA512:
-  metadata.gz: 94cb5d1a3c141069d239d26a95e097b016b008acca7dcb2c14ff7040ed325a896e0ceaea4139344e22de6fb72360c7709df016de5aba668eab5b9afba17db8fc
-  data.tar.gz: 0c975b2a65075d1df91923e26d1604600d6fa595634fd3b1ec85aa31fedef28627774340cca6b2d63b09bae96731d4895745a4a040943a835cab4387cb94acb4
+  metadata.gz: a2bbab24f39ead5c46bb0657bae0d67c2a98e0a5648d45baf9f4a03d497c2a38bb677ffde8f039b1fe6fc380c731376c948211927ddb94c969027ed89dafb828
+  data.tar.gz: f041d09f3b51854c802af60219e2713a3f42544dca0efc2b3cd28f179c8f225d52c4ae46b8aeb6ae18c67a6bdadfee8c3ab84096da1d6f33c850e2ec7636c16b

data/.github/CODEOWNERS

@@ -1 +1 @@
-* @dnsimple/client-ruby
+* @dnsimple/external-integrations

data/.github/dependabot.yml

@@ -4,19 +4,19 @@ updates:
   - package-ecosystem: bundler
     directory: /
     schedule:
-      interval: daily
+      interval: monthly
       time: '12:00'
     open-pull-requests-limit: 10
     labels:
       - task
       - dependencies
-
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: monthly
       time: '12:00'
     open-pull-requests-limit: 10
     labels:
       - task
       - dependencies
+      - automerge

data/.github/workflows/auto-merge.yml

@@ -0,0 +1,32 @@
+name: Auto-merge
+
+on:
+  pull_request:
+    types:
+      - labeled
+      - synchronize
+      - opened
+
+jobs:
+  auto-merge:
+    name: 'Auto-merge'
+    runs-on: ubuntu-latest
+    permissions: write-all
+
+    if: github.event.pull_request.user.login == 'dependabot[bot]' && contains(github.event.pull_request.labels.*.name, 'automerge')
+    steps:
+      - name: Wait for tests to succeed
+        uses: lewagon/wait-on-check-action@v1.3.1
+        timeout-minutes: 15
+        with:
+          ref: ${{ github.ref }}
+          running-workflow-name: 'Auto-merge'
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          wait-interval: 10
+          allowed-conclusions: success
+      - uses: juliangruber/merge-pull-request-action@v1
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+          number: ${{ github.event.number }}
+          method: squash
+          repo: dnsimple/dnsimple-ruby

data/.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Checkout Code
         uses: actions/checkout@v3
       - name: Run markdownlint-cli
-        uses: nosborn/github-action-markdown-cli@v3.1.0
+        uses: nosborn/github-action-markdown-cli@v3.2.0
         with:
           files: .
           config_file: ".markdownlint.yaml"
@@ -42,6 +42,7 @@ jobs:
           - '2.7'
           - '3.0'
           - '3.1'
+          - '3.2'
           - 'ruby-head'
           - 'truffleruby-head'
     steps:

data/.github/workflows/release.yml

@@ -7,11 +7,11 @@ on:
 jobs:
   publish:
     name: Release to RubyGems
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
 
     steps:
       - name: Wait for tests to succeed
-        uses: lewagon/wait-on-check-action@v1.1.2
+        uses: lewagon/wait-on-check-action@v1.3.1
         with:
           ref: 'refs/heads/main'
           running-workflow-name: 'Release to RubyGems'
@@ -22,7 +22,8 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Release Gem
-        uses: cadwallion/publish-rubygems-action@8f9e0538302643309e4e43bf48cd34173ca48cfc # yamllint disable-line
+        uses: simplyqio/publish-rubygems-action@2.0.0
         env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
-          RELEASE_COMMAND: rake release
+          RELEASE_COMMAND: "rake build && gem push pkg/*.gem"

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-09-01 12:27:48 UTC using RuboCop version 1.36.0.
+# on 2023-01-26 12:48:02 UTC using RuboCop version 1.44.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 70
+# Offense count: 74
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 17
@@ -16,18 +16,19 @@ RSpec/LeakyConstantDeclaration:
   Exclude:
     - 'spec/dnsimple/client/client_service_spec.rb'
 
-# Offense count: 11
+# Offense count: 12
 # Configuration parameters: .
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
   EnforcedStyle: receive
 
-# Offense count: 111
+# Offense count: 115
 RSpec/MultipleExpectations:
   Max: 15
 
-# Offense count: 371
-# Configuration parameters: IgnoreSharedExamples.
+# Offense count: 372
+# Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
+# SupportedStyles: always, named_only
 RSpec/NamedSubject:
   Enabled: false
 
@@ -47,7 +48,7 @@ RSpec/SubjectStub:
     - 'spec/dnsimple/client/zones_spec.rb'
     - 'spec/dnsimple/client_spec.rb'
 
-# Offense count: 37
+# Offense count: 69
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false

data/CHANGELOG.md

@@ -4,6 +4,19 @@ This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 ## main
 
+## 8.3.1
+
+- FIXED: Our release process had failed to push correctly `8.2.0` and `8.3.0` to RubyGems resulting in empty gem releases. This releases fixes the issue and contains the same changes of `8.2.0` and `8.3.0`.
+
+## 8.3.0
+
+- CHANGED: Wrap 400 errors on the OAuth endpoint in `Dnsimple::OAuthInvalidRequestError` (dnsimple/dnsimple-ruby#336)
+
+## 8.2.0
+
+- NEW: Added getDomainRenewal and getDomainRegistration endpoints (dnsimple/dnsimple-ruby#332)
+- NEW: Documented the new `signature_algorithm` parameter for the Lets Encrypt certificate purchase endpoint (dnsimple/dnsimple-ruby#331)
+
 ## 8.1.0
 
 - CHANGED: Fixed and updated documentation for domain endpoints (dnsimple/dnsimple-ruby#300)

data/Gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'coveralls', require: false
-gem 'rubocop', '1.36.0', require: false
-gem 'rubocop-performance', '1.15.0', require: false
+gem 'rubocop', '1.48.0', require: false
+gem 'rubocop-performance', '1.16.0', require: false
 gem 'rubocop-rake', '0.6.0', require: false
-gem 'rubocop-rspec', '2.13.1', require: false
+gem 'rubocop-rspec', '2.19.0', require: false

data/lib/dnsimple/client/certificates.rb

@@ -124,6 +124,7 @@ module Dnsimple
       # @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)
+      # @option attributes [String] :signature_algorithm the signature algorithm used to sign the certificate (optional)
       # @param  options[Hash]
       #
       # @return [Dnsimple::Response<Dnsimple::Struct::CertificatPurchase>]
@@ -166,6 +167,15 @@ module Dnsimple
       #   certificate.common_name     # => "www.example.com"
       #   certificate.alternate_names # => []
       #   certificate.auto_renew      # => true
+      #
+      # @example Signature Algorithm
+      #   response    = client.certificates.purchase_letsencrypt_certificate(1010, "example.com", signature_algorithm: "RSA")
+      #   certificate = response.data
+      #
+      #   certificate.id              # => 100
+      #   certificate.common_name     # => "www.example.com"
+      #   certificate.alternate_names # => []
+      #   certificate.auto_renew      # => false
       def purchase_letsencrypt_certificate(account_id, domain_id, attributes = {}, options = {})
         response = client.post(Client.versioned("/%s/domains/%s/certificates/letsencrypt" % [account_id, domain_id]), attributes, options)
 
@@ -209,6 +219,7 @@ module Dnsimple
       # @param  certificate_id [Integer] the certificate ID
       # @param  attributes [Hash]
       # @option attributes [TrueClass,FalseClass] :auto_renew enable certificate auto renew (optional)
+      # @option attributes [String] :signature_algorithm the signature algorithm used to sign the certificate (optional)
       # @param  options [Hash]
       #
       # @return [Dnsimple::Response<Dnsimple::Struct::CertificateRenewal>]
@@ -231,6 +242,14 @@ module Dnsimple
       #   certificate_renewal.id                 # => 999
       #   certificate_renewal.old_certificate_id # => 200
       #   certificate_renewal.new_certificate_id # => 300
+      #
+      # @example Signature Algorithm
+      #   response            = client.certificates.purchase_letsencrypt_certificate_renewal(1010, "example.com", 200, signature_algorithm: "RSA")
+      #   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)
 

data/lib/dnsimple/client/oauth.rb

@@ -19,6 +19,11 @@ module Dnsimple
         attributes[:redirect_uri] = options.delete(:redirect_uri) if options.key?(:redirect_uri)
         response = client.post(Client.versioned("/oauth/access_token"), attributes, options)
         Struct::OauthToken.new(response)
+
+      rescue Dnsimple::RequestError => exception
+        raise exception unless exception.http_response.code == 400
+
+        raise Dnsimple::OAuthInvalidRequestError, exception.http_response
       end
 
       # Gets the URL to authorize an user for an application via the OAuth2 flow.

data/lib/dnsimple/client/registrar.rb

@@ -67,6 +67,28 @@ module Dnsimple
         Dnsimple::Response.new(response, Struct::DomainRegistration.new(response["data"]))
       end
 
+      # Retrieves the details of an existing domain registration.
+      #
+      # @see https://developer.dnsimple.com/v2/registrar/#getDomainRegistration
+      #
+      # @example Retrieve the registration 42 for example.com:
+      #   client.registrar.get_domain_registration(1010, "example.com", 42)
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Integer] domain_registration_id the domain registration ID
+      # @param  [Hash] options
+      # @return [Struct::DomainRegistration]
+      #
+      # @raise  [NotFoundError] When record is not found.
+      # @raise  [RequestError]  When the request fails.
+      def get_domain_registration(account_id, domain_name, domain_registration_id, options = {})
+        endpoint = Client.versioned("/%s/registrar/domains/%s/registrations/%s" % [account_id, domain_name, domain_registration_id])
+        response = client.get(endpoint, options)
+
+        Dnsimple::Response.new(response, Struct::DomainRegistration.new(response["data"]))
+      end
+
       # Renews a domain.
       #
       # @see https://developer.dnsimple.com/v2/registrar/#renew
@@ -88,6 +110,28 @@ module Dnsimple
         Dnsimple::Response.new(response, Struct::DomainRenewal.new(response["data"]))
       end
 
+      # Retrieve the details of an existing domain renewal.
+      #
+      # @see https://developer.dnsimple.com/v2/registrar/#getDomainRenewal
+      #
+      # @example Retrieve the renewal 42 for example.com:
+      #   client.registrar.get_domain_renewal(1010, "example.com", 42)
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Integer] domain_renewal_id the domain renewal ID
+      # @param  [Hash] options
+      # @return [Struct::DomainRenewal]
+      #
+      # @raise  [NotFoundError] When record is not found.
+      # @raise  [RequestError]  When the request fails.
+      def get_domain_renewal(account_id, domain_name, domain_renewal_id, options = {})
+        endpoint = Client.versioned("/%s/registrar/domains/%s/renewals/%s" % [account_id, domain_name, domain_renewal_id])
+        response = client.get(endpoint, options)
+
+        Dnsimple::Response.new(response, Struct::DomainRenewal.new(response["data"]))
+      end
+
       # Starts the transfer of a domain to DNSimple.
       #
       # @see https://developer.dnsimple.com/v2/registrar/#transfer

data/lib/dnsimple/error.rb

@@ -48,4 +48,21 @@ module Dnsimple
   class AuthenticationFailed < AuthenticationError
   end
 
+  class OAuthInvalidRequestError < Error
+    attr_reader :http_response, :error, :error_description
+
+    def initialize(http_response)
+      @http_response = http_response
+      @error = http_response.parsed_response["error"]
+      @error_description = http_response.parsed_response["error_description"]
+      super(message)
+    end
+
+    private
+
+    def message
+      "#{error}: #{error_description}"
+    end
+  end
+
 end

data/lib/dnsimple/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dnsimple
-  VERSION = "8.1.0"
+  VERSION = "8.3.1"
 end

data/spec/dnsimple/client/oauth_spec.rb

@@ -46,6 +46,25 @@ describe Dnsimple::Client, ".oauth" do
             .with(headers: { 'Accept' => 'application/json' })
       end
     end
+
+    context "when the request fails with 400" do
+      before do
+        stub_request(:post, %r{/v2/oauth/access_token$})
+            .to_return(read_http_fixture("oauthAccessToken/error-invalid-request.http"))
+      end
+
+      it "raises OAuthInvalidRequestError" do
+        expect {
+          subject.exchange_authorization_for_token(code, client_id, client_secret, state: state)
+        }.to raise_error(Dnsimple::OAuthInvalidRequestError) do |e|
+          error = "invalid_request"
+          error_description = "Invalid \"state\": value doesn't match the \"state\" in the authorization request"
+          expect(e.error).to eq(error)
+          expect(e.error_description).to eq(error_description)
+          expect(e.to_s).to eq("#{error}: #{error_description}")
+        end
+      end
+    end
   end
 
   describe "#authorize_url" do

data/spec/dnsimple/client/registrar_spec.rb

@@ -112,6 +112,32 @@ describe Dnsimple::Client, ".registrar" do
     end
   end
 
+  describe "#get_domain_registration" do
+    let(:account_id) { 1010 }
+
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/registrar/domains/.+/registrations/.+$})
+          .to_return(read_http_fixture("getDomainRegistration/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.get_domain_registration(account_id, domain_name = "example.com", registration_id = 361)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/registrar/domains/#{domain_name}/registrations/#{registration_id}")
+          .with(headers: { "Accept" => "application/json" })
+    end
+
+    it "returns the domain transfer" do
+      response = subject.get_domain_registration(account_id, "example.com", 361)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::DomainRegistration)
+      expect(result.id).to be_a(Integer)
+      expect(result.domain_id).to be_a(Integer)
+    end
+  end
+
   describe "#renew_domain" do
     let(:account_id) { 1010 }
     let(:attributes) { { period: "3" } }
@@ -152,6 +178,32 @@ describe Dnsimple::Client, ".registrar" do
     end
   end
 
+  describe "#get_domain_renewal" do
+    let(:account_id) { 1010 }
+
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/registrar/domains/.+/renewals/.+$})
+          .to_return(read_http_fixture("getDomainRenewal/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.get_domain_renewal(account_id, domain_name = "example.com", renewal_id = 361)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/registrar/domains/#{domain_name}/renewals/#{renewal_id}")
+          .with(headers: { "Accept" => "application/json" })
+    end
+
+    it "returns the domain renewal" do
+      response = subject.get_domain_renewal(account_id, "example.com", 361)
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result).to be_a(Dnsimple::Struct::DomainRenewal)
+      expect(result.id).to be_a(Integer)
+      expect(result.domain_id).to be_a(Integer)
+    end
+  end
+
   describe "#transfer_domain" do
     let(:account_id) { 1010 }
     let(:attributes) { { registrant_id: "10", auth_code: "x1y2z3" } }

data/spec/fixtures.http/getDomainRegistration/success.http

@@ -0,0 +1,20 @@
+HTTP/1.1 200 OK
+Server: nginx
+Date: Fri, 05 Jun 2020 18:23:53 GMT
+Content-Type: application/json; charset=utf-8
+Connection: keep-alive
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2392
+X-RateLimit-Reset: 1591384034
+ETag: W/"80c5827934c13b1ca87a587d96e7d1e8"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: 9f4959ee-06a9-488c-906e-27a570cafbbf
+X-Runtime: 0.078429
+X-Frame-Options: DENY
+X-Content-Type-Options: nosniff
+X-XSS-Protection: 1; mode=block
+X-Download-Options: noopen
+X-Permitted-Cross-Domain-Policies: none
+Strict-Transport-Security: max-age=31536000
+
+{"data":{"id":361,"domain_id":104040,"registrant_id":2715,"period":1,"state":"registering","auto_renew":false,"whois_privacy":false,"created_at":"2023-01-27T17:44:32Z","updated_at":"2023-01-27T17:44:40Z"}}

data/spec/fixtures.http/getDomainRenewal/success.http

@@ -0,0 +1,20 @@
+HTTP/1.1 201 Created
+Server: nginx
+Date: Fri, 09 Dec 2016 19:46:57 GMT
+Content-Type: application/json; charset=utf-8
+Connection: keep-alive
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2394
+X-RateLimit-Reset: 1481315245
+ETag: W/"179d85ea8a26a3d5dc76e42de2d7918e"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: ba6f2707-5df0-4ffa-b91b-51d4460bab8e
+X-Runtime: 13.571302
+X-Content-Type-Options: nosniff
+X-Download-Options: noopen
+X-Frame-Options: DENY
+X-Permitted-Cross-Domain-Policies: none
+X-XSS-Protection: 1; mode=block
+Strict-Transport-Security: max-age=31536000
+
+{"data":{"id":1,"domain_id":999,"period":1,"state":"renewed","created_at":"2016-12-09T19:46:45Z","updated_at":"2016-12-12T19:46:45Z"}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dnsimple
 version: !ruby/object:Gem::Version
-  version: 8.1.0
+  version: 8.3.1
 platform: ruby
 authors:
 - DNSimple
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-19 00:00:00.000000000 Z
+date: 2023-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -90,6 +90,7 @@ extra_rdoc_files:
 files:
 - ".github/CODEOWNERS"
 - ".github/dependabot.yml"
+- ".github/workflows/auto-merge.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/release.yml"
 - ".gitignore"
@@ -276,6 +277,8 @@ files:
 - spec/fixtures.http/getDomainPremiumPrice/success.http
 - spec/fixtures.http/getDomainPrices/failure.http
 - spec/fixtures.http/getDomainPrices/success.http
+- spec/fixtures.http/getDomainRegistration/success.http
+- spec/fixtures.http/getDomainRenewal/success.http
 - spec/fixtures.http/getDomainTransfer/success.http
 - spec/fixtures.http/getEmailForward/success.http
 - spec/fixtures.http/getPrimaryServer/success.http
@@ -375,7 +378,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: The DNSimple API client for Ruby