dnsimple 8.0.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54546cd64cb573f075ed2538cebd73573708a1f9919364b4b963a082b1dc97bf
-  data.tar.gz: 9e86592b7ff194316f5466d2b0a4cf0f988df1e90973bc29cfc30a4b7e2bccd8
+  metadata.gz: 926c26b50cdc2958b19e86a45cd6eb0394f5d884bcc12e45e8fda88b194c8fac
+  data.tar.gz: 930e5d25b213d496faa3268b3af1a0a1a407e0b632ad9a4a7f16fc8cb2a72256
 SHA512:
-  metadata.gz: 997ac7555b02778d5bb10c03aa97640a5a2b3e2a55064785657774da5032a8b11cf009b0de1d47dc4864c5835ea1426bc46bed082119d7aae1c87dc5058d44ed
-  data.tar.gz: 7fee63c8c4f9ae899023989de18fc920b45bd5405b2075040ef167f1b7f82e0b8ddf7b6364dd23f42ac9f6ff5a53a900493af42eb489f7fa0f6acc17be74fd3b
+  metadata.gz: 94cb5d1a3c141069d239d26a95e097b016b008acca7dcb2c14ff7040ed325a896e0ceaea4139344e22de6fb72360c7709df016de5aba668eab5b9afba17db8fc
+  data.tar.gz: 0c975b2a65075d1df91923e26d1604600d6fa595634fd3b1ec85aa31fedef28627774340cca6b2d63b09bae96731d4895745a4a040943a835cab4387cb94acb4

data/.gitignore

@@ -1,3 +1,6 @@
+# ASDF
+.tool-versions
+
 # Bundler
 .bundle
 pkg/*
@@ -7,6 +10,3 @@ Gemfile.lock
 .yardoc
 yardoc/
 doc/
-
-#ASDF
-.tool-versions

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-08-09 14:54:31 UTC using RuboCop version 1.34.1.
+# on 2022-09-01 12:27:48 UTC using RuboCop version 1.36.0.
 # 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: 71
+# Offense count: 70
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 17
@@ -22,11 +22,11 @@ RSpec/LeakyConstantDeclaration:
 RSpec/MessageSpies:
   EnforcedStyle: receive
 
-# Offense count: 112
+# Offense count: 111
 RSpec/MultipleExpectations:
   Max: 15
 
-# Offense count: 375
+# Offense count: 371
 # Configuration parameters: IgnoreSharedExamples.
 RSpec/NamedSubject:
   Enabled: false

data/CHANGELOG.md

@@ -4,6 +4,11 @@ This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 ## main
 
+## 8.1.0
+
+- CHANGED: Fixed and updated documentation for domain endpoints (dnsimple/dnsimple-ruby#300)
+- CHANGED: Expose all information available in error responses (dnsimple/dnsimple-ruby#298)
+
 ## 8.0.0
 
 - CHANGED: Minimum Ruby version is now 2.7

data/Gemfile

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

data/README.md

@@ -8,6 +8,10 @@ A Ruby client for the [DNSimple API v2](https://developer.dnsimple.com/v2/).
 [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.
 
+## Requirements
+
+- Ruby: MRI > 2.7+
+
 ## Installation
 
 You can install the gem manually:
@@ -22,13 +26,50 @@ Or use Bundler and define it as a dependency in your Gemfile:
 gem 'dnsimple', '~> 6.0'
 ```
 
-## Usage
+## Documentation
+
+### Relevant links
+
+- [`dnsimple-ruby` RDocs](https://www.rubydoc.info/gems/dnsimple/).
+- [DNSimple API documentation](https://developer.dnsimple.com).
+- [DNSimple API examples repository](https://github.com/dnsimple/dnsimple-api-examples).
+- [DNSimple support documentation](https://support.dnsimple.com).
 
-This library is a Ruby client you can use to interact with the [DNSimple API v2](https://developer.dnsimple.com/v2/). Here are some examples.
+### Sandbox Environment
+
+We highly recommend testing against our [sandbox environment](https://developer.dnsimple.com/sandbox/) before using our production environment. This will allow you to avoid real purchases, live charges on your credit card, and reduce the chance of your running up against rate limits.
+
+The client supports both the production and sandbox environment. To switch to sandbox pass the sandbox API host using the `base_url` option when you construct the client:
+
+```ruby
+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.
+
+### Examples
+
+Be sure to require the gem before trying any of the examples:
 
 ```ruby
 require 'dnsimple'
+```
+
+#### Setting a custom `User-Agent` header
+
+You can customize the `User-Agent` header for the calls made to the DNSimple API:
+
+```ruby
+client = Dnsimple::Client.new(user_agent: "my-app/1.0")
+```
+
+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.
+
+#### Authentication
 
+```ruby
 client = Dnsimple::Client.new(access_token: "a1b2c3")
 
 # Fetch your details
@@ -43,47 +84,30 @@ account_id = 1010
 # as long as you authenticate with an Account access token
 whoami = client.identity.whoami.data
 account_id = whoami.account.id
+```
 
-# List your domains
+#### Listing your domains
+
+```ruby
 puts client.domains.list_domains(account_id).data                      # => domains from the account 1234, first page
 puts client.domains.list_domains(account_id, query: { page: 3 }).data  # => domains from the account 1234, third page
 puts client.domains.all_domains(account_id).data                       # => all domains from the account 1234 (use carefully)
-
-# Create a domain
-response = client.domains.create_domain(account_id, name: "example.com")
-puts response.data
-
-# Get a domain
-response = client.domains.domain(account_id, "example.com")
-puts response.data
 ```
 
-For the full library documentation visit <http://rubydoc.info/gems/dnsimple>
-
-## Sandbox Environment
-
-We highly recommend testing against our [sandbox environment](https://developer.dnsimple.com/sandbox/) before using our production environment. This will allow you to avoid real purchases, live charges on your credit card, and reduce the chance of your running up against rate limits.
-
-The client supports both the production and sandbox environment. To switch to sandbox pass the sandbox API host using the `base_url` option when you construct the client:
+#### Create a domain
 
 ```ruby
-client = Dnsimple::Client.new(base_url: "https://api.sandbox.dnsimple.com", access_token: "a1b2c3")
+response = client.domains.create_domain(account_id, name: "example.com")
+puts response.data
 ```
 
-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.
-
-## Setting a custom `User-Agent` header
-
-You can customize the `User-Agent` header for the calls made to the DNSimple API:
+#### Get a domain
 
 ```ruby
-client = Dnsimple::Client.new(user_agent: "my-app/1.0")
+response = client.domains.domain(account_id, "example.com")
+puts response.data
 ```
 
-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-2022 DNSimple Corporation. This is Free Software distributed under the MIT license.

data/lib/dnsimple/client/domains.rb

@@ -6,20 +6,20 @@ module Dnsimple
 
       # Lists the domains in the account.
       #
-      # @see https://developer.dnsimple.com/v2/domains/#list
+      # @see https://developer.dnsimple.com/v2/domains/#listDomains
       # @see #all_domains
       #
       # @example List domains in the first page
-      #   client.domains.list(1010)
+      #   client.domains.domains(1010)
       #
       # @example List domains, provide a specific page
-      #   client.domains.list(1010, page: 2)
+      #   client.domains.domains(1010, page: 2)
       #
       # @example List domains, provide a sorting policy
-      #   client.domains.list(1010, sort: "expiration:asc")
+      #   client.domains.domains(1010, sort: "expiration:asc")
       #
       # @example List domains, provide a filtering policy
-      #   client.domains.list(1010, filter: { name_like: "example" })
+      #   client.domains.domains(1010, filter: { name_like: "example" })
       #
       # @param  [Integer] account_id the account ID
       # @param  [Hash] options the filtering and sorting options
@@ -45,7 +45,7 @@ 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/#list
+      # @see https://developer.dnsimple.com/v2/domains/#listDomains
       # @see #domains
       #
       # @param  [Integer] account_id the account ID
@@ -63,7 +63,10 @@ module Dnsimple
 
       # Creates a domain in the account.
       #
-      # @see https://developer.dnsimple.com/v2/domains/#create
+      # @see https://developer.dnsimple.com/v2/domains/#createDomain
+      #
+      # @example Creating a domain in a specific account. Does not register the domain
+      #   client.domains.create_domain(1010, name: "example.com")
       #
       # @param  [Integer] account_id the account ID
       # @param  [Hash] attributes
@@ -81,7 +84,13 @@ module Dnsimple
 
       # Gets a domain from the account.
       #
-      # @see https://developer.dnsimple.com/v2/domains/#get
+      # @see https://developer.dnsimple.com/v2/domains/#getDomain
+      #
+      #
+      # @example Getting a domain in a specific account, by domain id
+      #   client.domains.domain(1010, 12345)
+      # @example Getting a domain in a specific account, by domain name
+      #   client.domains.domain(1010, "example.com")
       #
       # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name
@@ -100,7 +109,12 @@ module Dnsimple
       #
       # WARNING: this cannot be undone.
       #
-      # @see https://developer.dnsimple.com/v2/domains/#delete
+      # @see https://developer.dnsimple.com/v2/domains/#deleteDomain
+      #
+      # @example Deleting a domain in a specific account, by domain id
+      #   client.domains.delete_domain(1010, 12345)
+      # @example Deleting a domain in a specific account, by domain name
+      #   client.domains.delete_domain(1010, "example.com")
       #
       # @param  [Integer] account_id the account ID
       # @param  [#to_s] domain_id The domain ID or domain name

data/lib/dnsimple/error.rb

@@ -7,18 +7,24 @@ module Dnsimple
 
   # RequestError is raised when an API request fails for an client, a server error or invalid request information.
   class RequestError < Error
-    attr_reader :http_response
+    attr_reader :http_response, :attribute_errors
 
     def initialize(http_response)
       @http_response = http_response
+      @attribute_errors = attribute_errors_from(http_response)
       super(message_from(http_response))
     end
 
     private
 
+    def attribute_errors_from(http_response)
+      return unless is_json_response?(http_response)
+
+      http_response.parsed_response["errors"]
+    end
+
     def message_from(http_response)
-      content_type = http_response.headers["Content-Type"]
-      if content_type&.start_with?("application/json")
+      if is_json_response?(http_response)
         http_response.parsed_response["message"]
       else
         net_http_response = http_response.response
@@ -26,6 +32,11 @@ module Dnsimple
       end
     end
 
+    def is_json_response?(http_response)
+      content_type = http_response.headers["Content-Type"]
+      content_type&.start_with?("application/json")
+    end
+
   end
 
   class NotFoundError < RequestError

data/lib/dnsimple/version.rb

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

data/spec/dnsimple/client/registrar_whois_privacy_spec.rb

@@ -28,9 +28,9 @@ describe Dnsimple::Client, ".registrar" do
 
       result = response.data
       expect(result).to be_a(Dnsimple::Struct::WhoisPrivacy)
-      expect(result.domain_id).to be_kind_of(Integer)
+      expect(result.domain_id).to be_a(Integer)
       expect(result.enabled).to be(true)
-      expect(result.expires_on).to be_kind_of(String)
+      expect(result.expires_on).to be_a(String)
     end
   end
 
@@ -57,9 +57,9 @@ describe Dnsimple::Client, ".registrar" do
 
         result = response.data
         expect(result).to be_a(Dnsimple::Struct::WhoisPrivacy)
-        expect(result.domain_id).to be_kind_of(Integer)
+        expect(result.domain_id).to be_a(Integer)
         expect(result.enabled).to be(true)
-        expect(result.expires_on).to be_kind_of(String)
+        expect(result.expires_on).to be_a(String)
       end
     end
 
@@ -83,7 +83,7 @@ describe Dnsimple::Client, ".registrar" do
 
         result = response.data
         expect(result).to be_a(Dnsimple::Struct::WhoisPrivacy)
-        expect(result.domain_id).to be_kind_of(Integer)
+        expect(result.domain_id).to be_a(Integer)
         expect(result.enabled).to be_nil
         expect(result.expires_on).to be_nil
       end
@@ -112,9 +112,9 @@ describe Dnsimple::Client, ".registrar" do
 
       result = response.data
       expect(result).to be_a(Dnsimple::Struct::WhoisPrivacy)
-      expect(result.domain_id).to be_kind_of(Integer)
+      expect(result.domain_id).to be_a(Integer)
       expect(result.enabled).to be(false)
-      expect(result.expires_on).to be_kind_of(String)
+      expect(result.expires_on).to be_a(String)
     end
   end
 
@@ -140,10 +140,10 @@ describe Dnsimple::Client, ".registrar" do
 
       result = response.data
       expect(result).to be_a(Dnsimple::Struct::WhoisPrivacyRenewal)
-      expect(result.domain_id).to be_kind_of(Integer)
-      expect(result.whois_privacy_id).to be_kind_of(Integer)
+      expect(result.domain_id).to be_a(Integer)
+      expect(result.whois_privacy_id).to be_a(Integer)
       expect(result.enabled).to be(true)
-      expect(result.expires_on).to be_kind_of(String)
+      expect(result.expires_on).to be_a(String)
     end
 
     context "when whois privacy was't previously purchased" do

data/spec/dnsimple/client_spec.rb

@@ -90,7 +90,22 @@ describe Dnsimple::Client do
 
       expect {
         subject.execute(:post, "foo", {})
-      }.to raise_error(Dnsimple::RequestError, "The domain google.com is already in DNSimple and cannot be added")
+      }.to raise_error(Dnsimple::RequestError, "The domain google.com is already in DNSimple and cannot be added") do |exception|
+        expect(exception.attribute_errors).to be_nil
+      end
+    end
+
+    it "raises a Request error in case of an error with a JSON response with attribute errors" do
+      stub_request(:post, %r{/foo}).to_return(read_http_fixture("validation-error.http"))
+
+      expect {
+        subject.execute(:post, "foo", {})
+      }.to raise_error(Dnsimple::RequestError, "Validation failed") do |exception|
+        expect(exception).to respond_to(:attribute_errors)
+        expect(exception.attribute_errors).to be_a(Hash)
+        expect(exception.attribute_errors["email"]).to eq(["can't be blank", "is an invalid email address"])
+        expect(exception.attribute_errors["address1"]).to eq(["can't be blank"])
+      end
     end
 
     it "raises RequestError in case of error with an HTML response" do
@@ -98,7 +113,9 @@ describe Dnsimple::Client do
 
       expect {
         subject.execute(:get, "foo", {})
-      }.to raise_error(Dnsimple::RequestError, "502 Bad Gateway")
+      }.to raise_error(Dnsimple::RequestError, "502 Bad Gateway") do |exception|
+        expect(exception.attribute_errors).to be_nil
+      end
     end
 
     it "raises RequestError in absence of content types" do
@@ -106,7 +123,9 @@ describe Dnsimple::Client do
 
       expect {
         subject.execute(:put, "foo", {})
-      }.to raise_error(Dnsimple::RequestError, "405 Method Not Allowed")
+      }.to raise_error(Dnsimple::RequestError, "405 Method Not Allowed") do |exception|
+        expect(exception.attribute_errors).to be_nil
+      end
     end
   end
 
@@ -126,7 +145,7 @@ describe Dnsimple::Client do
     it "delegates to HTTParty" do
       stub_request(:get, %r{/foo})
 
-      allow(HTTParty).to receive(:get)
+      expect(HTTParty).to receive(:get)
           .with(
               "#{subject.base_url}foo", {
                 format: :json,
@@ -150,7 +169,9 @@ describe Dnsimple::Client do
               }
             )
 
-      subject.request(:put, 'foo', { something: "else" }, { query: { foo: "bar" }, headers: { "Custom" => "Header" } })
+      expect {
+        subject.request(:put, 'foo', { something: "else" }, { query: { foo: "bar" }, headers: { "Custom" => "Header" } })
+      }.not_to raise_error
     end
 
     it "handles non application/json content types" do
@@ -164,7 +185,9 @@ describe Dnsimple::Client do
               }
             )
 
-      subject.request(:post, 'foo', { something: "else" }, { headers: { "Content-Type" => "application/x-www-form-urlencoded" } })
+      expect {
+        subject.request(:post, 'foo', { something: "else" }, { headers: { "Content-Type" => "application/x-www-form-urlencoded" } })
+      }.not_to raise_error
     end
 
     it "includes options for proxy support" do
@@ -178,8 +201,10 @@ describe Dnsimple::Client do
               }
             )
 
-      subject = described_class.new(proxy: "example-proxy.com:4321")
-      subject.request(:get, "test", nil, {})
+      expect {
+        subject = described_class.new(proxy: "example-proxy.com:4321")
+        subject.request(:get, "test", nil, {})
+      }.not_to raise_error
     end
 
     it "supports custom user agent" do
@@ -190,8 +215,10 @@ describe Dnsimple::Client do
                 headers: hash_including("User-Agent" => "customAgent #{Dnsimple::Default::USER_AGENT}"), }
             )
 
-      subject = described_class.new(user_agent: "customAgent")
-      subject.request(:get, "test", nil)
+      expect {
+        subject = described_class.new(user_agent: "customAgent")
+        subject.request(:get, "test", nil)
+      }.not_to raise_error
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dnsimple
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - DNSimple
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-10 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty