dnsimple 3.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb3f3b1fc8b0c99b792b0c1a1d6b27830ff2331f
-  data.tar.gz: 1c79d167d1d71d3af51981a326494c1a3b02fb53
+  metadata.gz: bfd2d022a76ad12b6b4259ce10a2f349c618a31f
+  data.tar.gz: 30bb0e50b7d8ed4662c113c70a84c584ae1d9a55
 SHA512:
-  metadata.gz: 2f56e2bf1ca4267264aa5730b146de169430497389827745a8ce6bf80bd34dc5f8721454d9c330a83c6684e43f2fbb8ff0d0ec22ad30f70f9892ce64fb952872
-  data.tar.gz: 2574f383a0a03086b280ded7535153f563364e51d015a5499ea18ca93187f4eaa4c14e76109baab246f2837699426683159ece814c37f930edf8c19f5cc86a31
+  metadata.gz: 45b87521f74759ff510845caa7f3b661ce80af3d40aecaa962655296b07b5fab90ceb358e3f180a0a5f736105faadcb38a55078771961073303f496838a5d219
+  data.tar.gz: 364c11eb5e67241ff9123e67fa4ce5af26358c8d03eee7f5692b480cf882f56b155144f1c853f92b4b9072a97b69ed55f0fcb9792bb4b7448dd66830c0185b36

data/.rubocop.yml

@@ -11,3 +11,8 @@ Lint/Loop:
 # It doesn't seem to work as expected.
 Style/IfUnlessModifier:
   Enabled: false
+
+# This rule suggest to use safe navigation (&.) operator which was introduced
+# with Ruby 2.3. Because we are supporting Ruby 2.0+ we can't use this operator.
+Style/SafeNavigation:
+  Enabled: false

data/.rubocop_dnsimple.yml

@@ -23,19 +23,6 @@ Metrics/AbcSize:
     - 'spec/**/*_spec.rb'
     - 'test/**/*_test.rb'
 
-# 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:
-  IndentWhenRelativeTo: end
-
 # [codesmell]
 Metrics/ClassLength:
   Enabled: false
@@ -44,27 +31,27 @@ Metrics/ClassLength:
     - 'test/**/*_test.rb'
 
 # [codesmell]
-Metrics/MethodLength:
+Metrics/LineLength:
   Enabled: false
   Exclude:
     - 'spec/**/*_spec.rb'
     - 'test/**/*_test.rb'
-  Max: 10
+  Max: 100
 
 # [codesmell]
-Metrics/ModuleLength:
+Metrics/MethodLength:
   Enabled: false
   Exclude:
     - 'spec/**/*_spec.rb'
     - 'test/**/*_test.rb'
+  Max: 10
 
 # [codesmell]
-Metrics/LineLength:
+Metrics/ModuleLength:
   Enabled: false
   Exclude:
     - 'spec/**/*_spec.rb'
     - 'test/**/*_test.rb'
-  Max: 100
 
 # [codesmell]
 # I don't really get the point of this cop.
@@ -90,6 +77,19 @@ Style/BlockDelimiters:
 Style/BracesAroundHashParameters:
   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:
+  IndentWhenRelativeTo: end
+
 # I was a big fan of leading, but trailing seems to be more commonly adopted.
 # At least at the time being.
 Style/DotPosition:
@@ -131,6 +131,12 @@ Style/FormatString:
 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.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
 # Prefer the latest Hash syntax
 Style/HashSyntax:
   Exclude:

data/CHANGELOG.md

@@ -3,20 +3,32 @@
 This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 
+#### 4.0.0
+
+- NEW: Added domain collaborators support (GH-137).
+- NEW: Added regions support for zone records (GH-135, GH-139).
+- NEW: Added domain services support (GH-122).
+- NEW: Added domain templates support (GH-125).
+- NEW: Added zone file support (GH-124).
+- NEW: Added certificate support (GH-123).
+- NEW: Added domain delegation support (GH-120).
+- NEW: Added domain push support (GH-127).
+- NEW: Added vanity name server support (GH-121).
+
+- CHANGED: Record struct renamed to ZoneRecord (GH-117).
+- CHANGED: Updated Tld payload (GH-133, GH-129).
+- CHANGED: Renamed registrar `auth_info` into `auth_code` (GH-136).
+
+
 #### 3.1.0
 
 - NEW: Added accounts support (GH-113).
-
 - NEW: Added sorting and filtering support (GH-112).
-
 - NEW: Added template record support (GH-104).
 
 - CHANGED: Pagination params must be passed as top level options. Previously they were passed inside `:query` options (GH-116).
-
 - CHANGED: Authentication credentials presence is no longer validated on the client as it was causing an error getting the access token (GH-74 and GH-102).
-
 - CHANGED: Setting a custom user-agent no longer overrides the origina user-agent (GH-105).
-
 - CHANGED: Updated client to use Contact#email (GH-108).
 
 - REMOVED: Removed support for wildcard accounts (GH-107).

data/CONTRIBUTING.md

@@ -5,7 +5,7 @@
 Clone the repository and move into it:
 
 ```
-$ git clone git@github.com:aetrion/dnsimple-ruby.git
+$ git clone git@github.com:dnsimple/dnsimple-ruby.git
 $ cd dnsimple-ruby
 ```
 
@@ -31,5 +31,5 @@ $ rake
 
 Submit unit tests for your changes. You can test your changes on your machine by [running the test suite](#testing).
 
-When you submit a PR, tests will also be run on the continuous integration environment [through Travis](https://travis-ci.org/aetrion/dnsimple-ruby).
+When you submit a PR, tests will also be run on the continuous integration environment [through Travis](https://travis-ci.org/dnsimple/dnsimple-ruby).
 

data/Gemfile

@@ -2,6 +2,5 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rake', '< 11'
 gem 'coveralls', require: false
 gem 'rubocop', require: false

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/aetrion/dnsimple-ruby.svg?branch=master)](https://travis-ci.org/aetrion/dnsimple-ruby)
-[![Coverage Status](https://img.shields.io/coveralls/aetrion/dnsimple-ruby.svg)](https://coveralls.io/r/aetrion/dnsimple-ruby?branch=master)
+[![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)
 
 [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.
@@ -11,7 +11,7 @@ We provide a full API and an easy-to-use web interface so you can get your domai
 
 ## :warning: Beta Warning
 
-This branch targets the development of the API client for the [DNSimple API v2](https://developer.dnsimple.com/v2/). If you are looking for the stable version of the client for [DNSimple API v1](https://developer.dnsimple.com/v1/) then use the [`master-v1`](https://github.com/aetrion/dnsimple-ruby/tree/master-v1) branch.
+This branch targets the development of the API client for the [DNSimple API v2](https://developer.dnsimple.com/v2/). If you are looking for the stable version of the client for [DNSimple API v1](https://developer.dnsimple.com/v1/) then use the [`master-v1`](https://github.com/dnsimple/dnsimple-ruby/tree/master-v1) branch.
 
 This library is currently in beta version, the methods and the implementation should be considered a work-in-progress. Changes in the method naming, method signatures, public or internal APIs may happen during the beta period.
 
@@ -68,6 +68,17 @@ puts response.data
 
 For the full library documentation visit http://rubydoc.info/gems/dnsimple
 
+## Sandbox Usage
+
+If you would like to test the [DNSimple sandbox environment](https://developer.dnsimple.com/sandbox/) then pass the `base_url` named argument when you construct the client. For example:
+
+```ruby
+require 'dnsimple'
+
+client = Dnsimple::Client.new(base_url: "https://api.sandbox.dnsimple.com", access_token: "a1b2c3")
+```
+
+You will need to ensure that you are using an access token created in the sandbox environment. Production tokens will *not* work in the sandbox environment.
 
 ## License
 

data/dnsimple.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   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.homepage    = 'https://github.com/aetrion/dnsimple-ruby'
+  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.rb

@@ -185,11 +185,11 @@ module Dnsimple
     end
 
     def add_proxy_options!(options)
-      if proxy
-        address, port = proxy.split(":")
-        options[:http_proxyaddr] = address
-        options[:http_proxyport] = port
-      end
+      return if proxy.nil?
+
+      address, port = proxy.split(":")
+      options[:http_proxyaddr] = address
+      options[:http_proxyport] = port
     end
 
     def add_auth_options!(options)

data/lib/dnsimple/client/certificates.rb

@@ -0,0 +1,89 @@
+module Dnsimple
+  class Client
+    module Certificates
+
+      # Lists the certificates associated to the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/certificates/#list
+      # @see #all_certificates
+      #
+      # @example List certificates in the first page
+      #   client.certificates.list(1010, "example.com")
+      #
+      # @example List certificates, provide a specific page
+      #   client.certificates.list(1010, "example.com", page: 2)
+      #
+      # @example List certificates, provide a sorting policy
+      #   client.certificates.list(1010, "example.com", sort: "email:asc")
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] domain_name the domain name
+      # @param  [Hash] options 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>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def certificates(account_id, domain_name, options = {})
+        response = client.get(Client.versioned("/%s/domains/%s/certificates" % [account_id, domain_name]), Options::ListOptions.new(options))
+
+        Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Certificate.new(r) })
+      end
+
+      # Gets a certificate associated to the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/certificates/#get
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] domain_id the domain ID or domain name
+      # @param  [Fixnum] certificate_id the certificate ID
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::Certificate>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def certificate(account_id, domain_id, certificate_id, options = {})
+        response = client.get(Client.versioned("/%s/domains/%s/certificates/%s" % [account_id, domain_id, certificate_id]), options)
+
+        Dnsimple::Response.new(response, Struct::Certificate.new(response["data"]))
+      end
+
+      # Downloads a certificate associated to the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/certificates/#download
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] domain_id the domain ID or domain name
+      # @param  [Fixnum] certificate_id the certificate ID
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::CertificateBundle>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def download_certificate(account_id, domain_id, certificate_id, options = {})
+        response = client.get(Client.versioned("/%s/domains/%s/certificates/%s/download" % [account_id, domain_id, certificate_id]), options)
+
+        Dnsimple::Response.new(response, Struct::CertificateBundle.new(response["data"]))
+      end
+
+      # Get certificate private key associated to the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/certificates/#get-private-key
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] domain_id the domain ID or domain name
+      # @param  [Fixnum] certificate_id the certificate ID
+      # @param  [Hash] options
+      # @return [Dnsimple::Response<Dnsimple::Struct::CertificateBundle>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def certificate_private_key(account_id, domain_id, certificate_id, options = {})
+        response = client.get(Client.versioned("/%s/domains/%s/certificates/%s/private_key" % [account_id, domain_id, certificate_id]), options)
+
+        Dnsimple::Response.new(response, Struct::CertificateBundle.new(response["data"]))
+      end
+
+    end
+  end
+end

data/lib/dnsimple/client/clients.rb

@@ -6,6 +6,11 @@ module Dnsimple
       @services[:accounts] ||= Client::AccountsService.new(self)
     end
 
+    # @return [Dnsimple::Client::CertificatesService] The certificate-related API proxy.
+    def certificates
+      @services[:certificates] ||= Client::CertificatesService.new(self)
+    end
+
     # @return [Dnsimple::Client::ContactsService] The contact-related API proxy.
     def contacts
       @services[:contacts] ||= Client::ContactsService.new(self)
@@ -16,6 +21,11 @@ module Dnsimple
       @services[:domains] ||= Client::DomainsService.new(self)
     end
 
+    # @return [Dnsimple::Client::DomainServicesService] The domain-services-related API proxy.
+    def domain_services
+      @services[:domains] ||= Client::DomainServicesService.new(self)
+    end
+
     # @return [Dnsimple::Client::IdentityService] The identity-related API proxy.
     def identity
       @services[:auth] ||= Client::IdentityService.new(self)
@@ -46,6 +56,11 @@ module Dnsimple
       @services[:tlds] ||= Client::TldsService.new(self)
     end
 
+    # @return [Dnsimple::Client::VanityNameServersService] The vanity-name-server-related API proxy.
+    def vanity_name_servers
+      @services[:vanity_name_servers] ||= Client::VanityNameServersService.new(self)
+    end
+
     # @return [Dnsimple::Client::ZonesService] The zone-related API proxy.
     def zones
       @services[:zones] ||= Client::ZonesService.new(self)
@@ -103,6 +118,13 @@ module Dnsimple
     end
 
 
+    require_relative 'certificates'
+
+    class CertificatesService < ClientService
+      include Client::Certificates
+    end
+
+
     require_relative 'contacts'
 
     class ContactsService < ClientService
@@ -112,10 +134,14 @@ module Dnsimple
 
     require_relative 'domains'
     require_relative 'domains_email_forwards'
+    require_relative 'domains_pushes'
+    require_relative 'collaborators'
 
     class DomainsService < ClientService
       include Client::Domains
       include Client::DomainsEmailForwards
+      include Client::DomainsPushes
+      include Client::Collaborators
     end
 
 
@@ -147,17 +173,21 @@ module Dnsimple
 
 
     require_relative 'services'
+    require_relative 'services_domains'
 
     class ServicesService < ClientService
       include Client::Services
+      include Client::ServicesDomains
     end
 
 
     require_relative 'templates'
+    require_relative 'templates_domains'
     require_relative 'templates_records'
 
     class TemplatesService < ClientService
       include Client::Templates
+      include Client::TemplatesDomains
       include Client::TemplatesRecords
     end
 
@@ -169,6 +199,13 @@ module Dnsimple
     end
 
 
+    require_relative 'vanity_name_servers'
+
+    class VanityNameServersService < ClientService
+      include Client::VanityNameServers
+    end
+
+
     require_relative 'zones'
     require_relative 'zones_records'
 

data/lib/dnsimple/client/collaborators.rb

@@ -0,0 +1,76 @@
+module Dnsimple
+  class Client
+    module Collaborators
+
+      # Lists the collaborators for a domain.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/collaborators/#list
+      #
+      # @example List collaborators in the first page
+      #   client.domains.collaborators(1010, "example.com")
+      #
+      # @example List collaborators, provide a specific page
+      #   client.domains.collaborators(1010, "example.com", page: 2)
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] domain_id the domain ID or name
+      # @param  [Hash] request options
+      # @option options [Integer] :page current page (pagination)
+      # @option options [Integer] :per_page number of entries to return (pagination)
+      # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Collaborator>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def collaborators(account_id, domain_id, options = {})
+        response = client.get(Client.versioned("/%s/domains/%s/collaborators" % [account_id, domain_id]), Options::ListOptions.new(options))
+
+        Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Collaborator.new(r) })
+      end
+
+      # Add a collaborator to the domain.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/collaborators/#add
+      #
+      # @example Add collaborator
+      #   client.domains.add_collaborator(1010, "example.com", email: "user@example.com")
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] domain_id the domain ID or name
+      # @param  [Hash] user attributes
+      # @param  attributes [String] :email user email (mandatory)
+      # @param  [Hash] request options
+      # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Collaborator>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def add_collaborator(account_id, domain_id, attributes, options = {})
+        Extra.validate_mandatory_attributes(attributes, [:email])
+        response = client.post(Client.versioned("/%s/domains/%s/collaborators" % [account_id, domain_id]), attributes, options)
+
+        Dnsimple::Response.new(response, Struct::Collaborator.new(response["data"]))
+      end
+
+      # Removes a collaborator from the domain.
+      #
+      # WARNING: this cannot be undone.
+      #
+      # @see https://developer.dnsimple.com/v2/domains/collaborators/#remove
+      #
+      # @example Remove collaborator
+      #   client.domains.remove_collaborator(1010, "example.com", 999)
+      #
+      # @param  [Fixnum] account_id the account ID
+      # @param  [#to_s] domain_id the domain ID or name
+      # @param  [#to_s] contact_id the contact ID
+      # @param  [Hash] request options
+      # @return [Dnsimple::Response<nil>]
+      #
+      # @raise  [Dnsimple::NotFoundError]
+      # @raise  [Dnsimple::RequestError]
+      def remove_collaborator(account_id, domain_id, contact_id, options = {})
+        response = client.delete(Client.versioned("/%s/domains/%s/collaborators/%s" % [account_id, domain_id, contact_id]), options)
+
+        Dnsimple::Response.new(response, nil)
+      end
+
+    end
+  end
+end