dnsimple 4.6.0 → 7.0.0

data/CONTRIBUTING.md

@@ -24,6 +24,49 @@ bundle
 [Run the test suite](#testing) to check everything works as expected.
 
 
+## Releasing
+
+The following instructions uses `$VERSION` as a placeholder, where `$VERSION` is a `MAJOR.MINOR.BUGFIX` release such as `1.2.0`.
+
+1. Set the version in `version.rb`:
+
+    ```ruby
+    VERSION = "$VERSION"
+    ```
+
+1. Run the test suite and ensure all the tests pass.
+
+1. Finalize the `## main` section in `CHANGELOG.md` assigning the version.
+
+1. Commit and push the changes
+
+    ```shell
+    git commit -a -m "Release $VERSION"
+    git push origin main
+    ```
+
+1. Wait for CI to complete.
+
+1. Create a signed tag.
+
+    ```shell
+    git tag -a v$VERSION -s -m "Release $VERSION"
+    git push origin --tags
+    ```
+
+1. Build the package.
+
+    ```shell
+    rake build
+    ```
+
+1. Release to RubyGems.
+
+    ```shell
+    gem push pkg/<filename>
+    ```
+
+
 ## Testing
 
 To run the test suite:

data/Gemfile

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
 gem 'coveralls', require: false
-gem 'rubocop', require: false
+gem 'rubocop', '1.16.0', require: false
+gem 'rubocop-performance', require: false
+gem 'rubocop-rake', require: false
+gem 'rubocop-rspec', require: false

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2010-2018 Aetrion LLC
+Copyright (c) 2010-2021 DNSimple Corporation
 
 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

@@ -2,8 +2,8 @@
 
 A Ruby client for the [DNSimple API v2](https://developer.dnsimple.com/v2/).
 
-[![Build Status](https://travis-ci.org/dnsimple/dnsimple-ruby.svg?branch=master)](https://travis-ci.org/dnsimple/dnsimple-ruby)
-[![Coverage Status](https://img.shields.io/coveralls/dnsimple/dnsimple-ruby.svg)](https://coveralls.io/r/dnsimple/dnsimple-ruby?branch=master)
+[![Build Status](https://travis-ci.com/dnsimple/dnsimple-ruby.svg?branch=main)](https://travis-ci.com/dnsimple/dnsimple-ruby)
+[![Coverage Status](https://img.shields.io/coveralls/dnsimple/dnsimple-ruby.svg)](https://coveralls.io/r/dnsimple/dnsimple-ruby?branch=main)
 
 [DNSimple](https://dnsimple.com/) provides DNS hosting and domain registration that is simple and friendly.
 We provide a full API and an easy-to-use web interface so you can get your domain registered and set up with a minimal amount of effort.
@@ -20,7 +20,7 @@ gem install dnsimple
 Or use Bundler and define it as a dependency in your Gemfile:
 
 ```
-gem 'dnsimple', '~> 4.0'
+gem 'dnsimple', '~> 6.0'
 ```
 
 ## Usage
@@ -77,14 +77,17 @@ You will need to ensure that you are using an access token created in the sandbo
 
 ## Setting a custom `User-Agent` header
 
-You customize the `User-Agent` header for the calls made to the DNSimple API:
+You can customize the `User-Agent` header for the calls made to the DNSimple API:
 
 ```ruby
-client = Dnsimple::Client.new(user_agent: "my-app")
+client = Dnsimple::Client.new(user_agent: "my-app/1.0")
 ```
 
-The value you provide will be appended to the default `User-Agent` the client uses. For example, if you use `my-app`, the final header value will be `dnsimple-ruby/4.1.0 my-app` (note that it will vary depending on the client version).
+The value you provide will be prepended to the default `User-Agent` the client uses. For example, if you use `my-app/1.0`, the final header value will be `my-app/1.0 dnsimple-ruby/0.14.0` (note that it will vary depending on the client version).
+
+We recommend to customize the user agent. If you are building a library or integration on top of the official client, customizing the client will help us to understand what is this client used for, and allow to contribute back or get in touch.
+
 
 ## License
 
-Copyright (c) 2010-2018 Aetrion LLC. This is Free Software distributed under the MIT license.
+Copyright (c) 2010-2021 DNSimple Corporation. This is Free Software distributed under the MIT license.

data/dnsimple.gemspec

@@ -5,13 +5,13 @@ require 'dnsimple/version'
 Gem::Specification.new do |s|
   s.name        = 'dnsimple'
   s.version     = Dnsimple::VERSION
-  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.authors     = ['DNSimple']
+  s.email       = ['support@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.'
 
-  s.required_ruby_version = ">= 2.1"
+  s.required_ruby_version = ">= 2.6"
 
   s.require_paths    = ['lib']
   s.files            = `git ls-files`.split("\n")

data/lib/dnsimple.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
 
   # Echoes a deprecation warning message.

data/lib/dnsimple/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'httparty'
 require 'dnsimple/extra'
 require 'dnsimple/struct'
@@ -23,10 +25,10 @@ module Dnsimple
   #   client = Dnsimple::Client.new(base_url: "https://api.sandbox.dnsimple.com", access_token: "abc")
   class Client
 
-    HEADER_AUTHORIZATION = "Authorization".freeze
+    HEADER_AUTHORIZATION = "Authorization"
 
     # @return [String] The current API version.
-    API_VERSION = "v2".freeze
+    API_VERSION = "v2"
 
 
     # Prepends the correct API version to +path+.
@@ -40,28 +42,36 @@ module Dnsimple
     # @!attribute username
     #   @see https://developer.dnsimple.com/v2/#authentication
     #   @return [String] DNSimple username for Basic Authentication
+    attr_accessor :username
+
     # @!attribute password
     #   @see https://developer.dnsimple.com/v2/#authentication
     #   @return [String] DNSimple password for Basic Authentication
+    attr_accessor :password
+
     # @!attribute domain_api_token
     #   @see https://developer.dnsimple.com/v2/#authentication
     #   @return [String] Domain API access token for authentication
+    attr_accessor :domain_api_token
+
     # @!attribute access_token
     #   @see https://developer.dnsimple.com/v2/#authentication
     #   @return [String] Domain API access token for authentication
+    attr_accessor :access_token
+
     # @!attribute user_agent
     #   @return [String] Configure User-Agent header for requests.
+    attr_accessor :user_agent
+
     # @!attribute proxy
     #   @return [String,nil] Configure address:port values for proxy server
-
-    attr_accessor :username, :password, :domain_api_token, :access_token,
-                  :user_agent, :proxy
+    attr_accessor :proxy
 
 
     def initialize(options = {})
       defaults = Dnsimple::Default.options
 
-      Dnsimple::Default.keys.each do |key|
+      Dnsimple::Default.keys.each do |key| # rubocop:disable Style/HashEachMethods
         instance_variable_set(:"@#{key}", options[key] || defaults[key])
       end
 
@@ -204,10 +214,10 @@ module Dnsimple
 
     def base_options
       {
-          format: :json,
-          headers: {
-              "Accept" => "application/json",
-          },
+        format: :json,
+        headers: {
+          "Accept" => "application/json",
+        },
       }
     end
 
@@ -234,15 +244,15 @@ module Dnsimple
     #     dnsimple-ruby/1.0
     #
     # If a custom user agent is provided, the final user agent is the combination
-    # of the custom user agent prepended by the default user agent.
+    # of the default user agent prepended by the custom user agent.
     #
-    #     dnsimple-ruby/1.0 customAgentFlag
+    #     customAgentFlag dnsimple-ruby/1.0
     #
     def format_user_agent
       if user_agent.to_s.empty?
         Dnsimple::Default::USER_AGENT
       else
-        "#{Dnsimple::Default::USER_AGENT} #{user_agent}"
+        "#{user_agent} #{Dnsimple::Default::USER_AGENT}"
       end
     end
 

data/lib/dnsimple/client/accounts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Accounts

data/lib/dnsimple/client/certificates.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Certificates

data/lib/dnsimple/client/clients.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
 
@@ -96,14 +98,15 @@ module Dnsimple
         options = args.pop
         response = nil
 
-        begin
+        loop do
           current_page += 1
           query = Extra.deep_merge(options, query: { page: current_page, per_page: 100 })
 
           response = send(method, *(args + [query]))
           total_pages ||= response.total_pages
           collection.concat(response.data)
-        end while current_page < total_pages
+          break unless current_page < total_pages
+        end
 
         CollectionResponse.new(response.http_response, collection)
       end

data/lib/dnsimple/client/contacts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Contacts

data/lib/dnsimple/client/domains.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Domains
@@ -14,7 +16,7 @@ module Dnsimple
       #   client.domains.list(1010, page: 2)
       #
       # @example List domains, provide a sorting policy
-      #   client.domains.list(1010, sort: "expires_on:asc")
+      #   client.domains.list(1010, sort: "expiration:asc")
       #
       # @example List domains, provide a filtering policy
       #   client.domains.list(1010, filter: { name_like: "example" })
@@ -112,24 +114,6 @@ module Dnsimple
 
         Dnsimple::Response.new(response, nil)
       end
-
-      # Resets the domain token.
-      #
-      # @see https://developer.dnsimple.com/v2/domains/#reset-token
-      #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] domain_id The domain ID or domain name
-      # @param  [Hash] options
-      # @return [Dnsimple::Response<nil>]
-      #
-      # @raise  [Dnsimple::NotFoundError]
-      # @raise  [Dnsimple::RequestError]
-      def reset_domain_token(account_id, domain_id, options = {})
-        response = client.post(Client.versioned("/%s/domains/%s/token" % [account_id, domain_id]), nil, options)
-
-        Dnsimple::Response.new(response, Struct::Domain.new(response["data"]))
-      end
-
     end
   end
 end

data/lib/dnsimple/client/domains_collaborators.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module DomainsCollaborators

data/lib/dnsimple/client/domains_delegation_signer_records.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module DomainsDelegationSignerRecords

data/lib/dnsimple/client/domains_dnssec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module DomainsDnssec

data/lib/dnsimple/client/domains_email_forwards.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module DomainsEmailForwards

data/lib/dnsimple/client/domains_pushes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module DomainsPushes

data/lib/dnsimple/client/identity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Identity

data/lib/dnsimple/client/oauth.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Oauth

data/lib/dnsimple/client/registrar.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module Registrar
@@ -40,7 +42,10 @@ module Dnsimple
       # @return [Struct::DomainPremiumPrice]
       #
       # @raise  [RequestError] When the request fails.
+      #
+      # @deprecated Use {#get_domain_prices} instead of this one as it will soon be removed from the API.
       def domain_premium_price(account_id, domain_name, options = {})
+        Dnsimple.deprecate("Use {#get_domain_prices} instead of this one as it will soon be removed from the API.")
         endpoint = Client.versioned("/%s/registrar/domains/%s/premium_price" % [account_id, domain_name])
         options[:query] = { action: options.delete(:action) } if options.key?(:action)
         response = client.get(endpoint, options)
@@ -48,6 +53,26 @@ module Dnsimple
         Dnsimple::Response.new(response, Struct::DomainPremiumPrice.new(response["data"]))
       end
 
+      # Get prices for a domain.
+      # @see https://developer.dnsimple.com/v2/registrar/#getDomainPrices
+      #
+      # @example Check prices for example.com:
+      #   client.registrar.get_domain_prices(1010, "example.com")
+      #
+      # @param [Integer] account_id the Account id
+      # @param [String] domain_name the domain name to find the prices
+      # @param [Hash] options
+      #
+      # @return [Struct::DomainPrice]
+      #
+      # @raise [RequestError] When the request fails.
+      def get_domain_prices(account_id, domain_name, options = {})
+        endpoint = Client.versioned("/%s/registrar/domains/%s/prices" % [account_id, domain_name])
+        response = client.get(endpoint, options)
+
+        Dnsimple::Response.new(response, Struct::DomainPrice.new(response["data"]))
+      end
+
       # Registers a domain.
       #
       # @see https://developer.dnsimple.com/v2/registrar/#register
@@ -114,6 +139,50 @@ module Dnsimple
         Dnsimple::Response.new(response, Struct::DomainTransfer.new(response["data"]))
       end
 
+      # Retrieves the details of an existing domain transfer.
+      #
+      # @see https://developer.dnsimple.com/v2/registrar/#getDomainTransfer
+      #
+      # @example Retrieve the transfer 42 for example.com:
+      #   client.registrar.get_domain_transfer(1010, "example.com", 42)
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Integer] domain_transfer_id the domain transfer ID
+      # @param  [Hash] options
+      # @return [Struct::DomainTransfer]
+      #
+      # @raise  [NotFoundError] When record is not found.
+      # @raise  [RequestError]  When the request fails.
+      def get_domain_transfer(account_id, domain_name, domain_transfer_id, options = {})
+        endpoint = Client.versioned("/%s/registrar/domains/%s/transfers/%s" % [account_id, domain_name, domain_transfer_id])
+        response = client.get(endpoint, options)
+
+        Dnsimple::Response.new(response, Struct::DomainTransfer.new(response["data"]))
+      end
+
+      # Cancels an in progress domain transfer.
+      #
+      # @see https://developer.dnsimple.com/v2/registrar/#cancelDomainTransfer
+      #
+      # @example Cancel the transfer 42 for example.com:
+      #   client.registrar.cancel_domain_transfer(1010, "example.com", 42)
+      #
+      # @param  [Integer] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Integer] domain_transfer_id the domain transfer ID
+      # @param  [Hash] options
+      # @return [Struct::DomainTransfer]
+      #
+      # @raise  [NotFoundError] When record is not found.
+      # @raise  [RequestError]  When the request fails.
+      def cancel_domain_transfer(account_id, domain_name, domain_transfer_id, options = {})
+        endpoint = Client.versioned("/%s/registrar/domains/%s/transfers/%s" % [account_id, domain_name, domain_transfer_id])
+        response = client.delete(endpoint, options)
+
+        Dnsimple::Response.new(response, Struct::DomainTransfer.new(response["data"]))
+      end
+
       # Requests the transfer of a domain out of DNSimple.
       #
       # @see https://developer.dnsimple.com/v2/registrar/#transfer-out