dnsimple 4.6.0 → 5.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2010-2018 Aetrion LLC
+Copyright (c) 2010-2020 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,7 +2,7 @@
 
 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)
+[![Build Status](https://travis-ci.com/dnsimple/dnsimple-ruby.svg?branch=master)](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=master)
 
 [DNSimple](https://dnsimple.com/) provides DNS hosting and domain registration that is simple and friendly.
@@ -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-2020 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.4"
 
   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+.
@@ -61,7 +63,7 @@ module Dnsimple
     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 +206,10 @@ module Dnsimple
 
     def base_options
       {
-          format: :json,
-          headers: {
-              "Accept" => "application/json",
-          },
+        format: :json,
+        headers: {
+          "Accept" => "application/json",
+        },
       }
     end
 
@@ -234,15 +236,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
 

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

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
@@ -114,6 +116,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

data/lib/dnsimple/client/registrar_auto_renewal.rb

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

data/lib/dnsimple/client/registrar_delegation.rb

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

data/lib/dnsimple/client/registrar_whois_privacy.rb

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

data/lib/dnsimple/client/services.rb

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

data/lib/dnsimple/client/services_domains.rb

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

data/lib/dnsimple/client/templates.rb

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

data/lib/dnsimple/client/templates_domains.rb

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

data/lib/dnsimple/client/templates_records.rb

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

data/lib/dnsimple/client/tlds.rb

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

data/lib/dnsimple/client/vanity_name_servers.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 module Dnsimple
   class Client
     module VanityNameServers
 
       # Enable vanity name servers for the domain.
       #
-      # @see https://developer.dnsimple.com/v2/vanity/#enable
+      # @see https://developer.dnsimple.com/v2/vanity/#enableVanityNameServers
       #
       # @example Enable vanity name servers for example.com:
-      #   client.vanity_name_servers.enable(1010, "example.com")
+      #   client.vanity_name_servers.enable_vanity_name_servers(1010, "example.com")
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] domain_name the domain name
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  domain_name [#to_s] the domain name
+      # @param  options [Hash]
       # @return [Dnsimple::Response<Array>]
       #
       # @raise  [RequestError] When the request fails.
@@ -24,14 +26,14 @@ module Dnsimple
 
       # Disable vanity name servers for the domain.
       #
-      # @see https://developer.dnsimple.com/v2/vanity/#disable
+      # @see https://developer.dnsimple.com/v2/vanity/#disableVanityNameServers
       #
       # @example Disable vanity name servers for example.com:
-      #   client.vanity_name_servers.disable(1010, "example.com")
+      #   client.vanity_name_servers.disable_vanity_name_servers(1010, "example.com")
       #
-      # @param  [Integer] account_id the account ID
-      # @param  [#to_s] domain_name the domain name
-      # @param  [Hash] options
+      # @param  account_id [Integer] the account ID
+      # @param  domain_name [#to_s] the domain name
+      # @param  options [Hash]
       # @return [Dnsimple::Response<nil>]
       #
       # @raise  [RequestError] When the request fails.

data/lib/dnsimple/client/webhooks.rb

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

data/lib/dnsimple/client/zones.rb

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

data/lib/dnsimple/client/zones_distributions.rb

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

data/lib/dnsimple/client/zones_records.rb

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

data/lib/dnsimple/default.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module Dnsimple
 
   # Default configuration options for {Client}
   module Default
 
     # Default API endpoint
-    BASE_URL = "https://api.dnsimple.com/".freeze
+    BASE_URL = "https://api.dnsimple.com/"
 
     # Default User Agent header
-    USER_AGENT = "dnsimple-ruby/#{VERSION}".freeze
+    USER_AGENT = "dnsimple-ruby/#{VERSION}"
 
     class << self
 
@@ -15,13 +17,13 @@ module Dnsimple
       # @return [Array] of option keys
       def keys
         @keys ||= [
-            :base_url,
-            :username,
-            :password,
-            :access_token,
-            :domain_api_token,
-            :user_agent,
-            :proxy,
+          :base_url,
+          :username,
+          :password,
+          :access_token,
+          :domain_api_token,
+          :user_agent,
+          :proxy,
         ]
       end