dnsimple 8.7.1 → 8.8.0

data/lib/dnsimple/struct/whoami.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class Whoami < Base
+
       # @return [Account] The account, if present.
       attr_reader :account
 
@@ -26,7 +26,7 @@ module Dnsimple
       def user=(user)
         @user = user ? Struct::User.new(user) : user
       end
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/whois_privacy.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class WhoisPrivacy < Base
+
       # @return [Integer] The associated domain ID.
       attr_accessor :domain_id
 
@@ -18,7 +18,7 @@ module Dnsimple
 
       # @return [String] When the whois privacy was last updated in DNSimple.
       attr_accessor :updated_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/whois_privacy_renewal.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class WhoisPrivacyRenewal < Base
+
       # @return [Integer] The associated domain ID.
       attr_accessor :domain_id
 
@@ -24,7 +24,7 @@ module Dnsimple
 
       # @return [String] When the WHOIS Privacy was last updated in DNSimple.
       attr_accessor :updated_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/zone.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class Zone < Base
+
       # @return [Integer] The zone ID in DNSimple.
       attr_accessor :id
 
@@ -30,7 +30,7 @@ module Dnsimple
 
       # @return [String] When the zone was last updated in DNSimple.
       attr_accessor :updated_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/zone_distribution.rb

@@ -2,12 +2,12 @@
 
 module Dnsimple
   module Struct
-
     class ZoneDistribution < Base
+
       # @return [Boolean] true if the zone is properly distributed across
       #         all DNSimple name servers.
       attr_accessor :distributed
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/zone_file.rb

@@ -2,11 +2,11 @@
 
 module Dnsimple
   module Struct
-
     class ZoneFile < Base
+
       # @return [String] The zone file contents.
       attr_accessor :zone
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct/zone_record.rb

@@ -2,8 +2,8 @@
 
 module Dnsimple
   module Struct
-
     class ZoneRecord < Base
+
       # @return [Integer] The record ID in DNSimple.
       attr_accessor :id
 
@@ -39,7 +39,7 @@ module Dnsimple
 
       # @return [String] When the record was last updated in DNSimple.
       attr_accessor :updated_at
-    end
 
+    end
   end
 end

data/lib/dnsimple/struct.rb

@@ -2,16 +2,16 @@
 
 module Dnsimple
   module Struct
-
     class Base
+
       def initialize(attributes = {})
         attributes.each do |key, value|
-          m = "#{key}=".to_sym
+          m = :"#{key}="
           send(m, value) if respond_to?(m)
         end
       end
-    end
 
+    end
   end
 end
 
@@ -33,6 +33,7 @@ require_relative 'struct/domain_push'
 require_relative 'struct/domain_registration'
 require_relative 'struct/domain_transfer'
 require_relative 'struct/domain_renewal'
+require_relative 'struct/dns_analytics'
 require_relative 'struct/email_forward'
 require_relative 'struct/extended_attribute'
 require_relative 'struct/oauth_token'

data/lib/dnsimple/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 module Dnsimple
-  VERSION = "8.7.1"
+
+  VERSION = "8.8.0"
+
 end

data/spec/dnsimple/client/dns_analytics_spec.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Dnsimple::Client, ".dns_analytics" do
+
+  subject { described_class.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").dns_analytics }
+
+  describe "#query" do
+    before do
+      stub_request(:get, %r{/v2/1/dns_analytics})
+          .to_return(read_http_fixture("dnsAnalytics/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.query(1)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/1/dns_analytics")
+          .with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "supports pagination" do
+      subject.query(1, page: 2, per_page: 200)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/1/dns_analytics?page=2&per_page=200")
+    end
+
+    it "supports sorting" do
+      subject.query(1, sort: "date:asc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/1/dns_analytics?sort=date:asc")
+    end
+
+    it "supports filtering" do
+      subject.query(1, filter: { start_date: '2024-08-01', end_date: '2024-09-01' })
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/1/dns_analytics?start_date=2024-08-01&end_date=2024-09-01")
+    end
+
+    it "supports groupings" do
+      subject.query(1, groupings: 'date,zone_name')
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/1/dns_analytics?groupings=date,zone_name")
+    end
+
+
+    it "returns a list of DNS Analytics entries" do
+      response = subject.query(1)
+
+      expect(response).to be_a(Dnsimple::PaginatedResponseWithQuery)
+      expect(response.data).to be_a(Array)
+      expect(response.data.size).to eq(12)
+
+      expect(response.data.all?(Dnsimple::Struct::DnsAnalytics)).to be(true)
+      expect(response.data[0].date).to eq('2023-12-08')
+      expect(response.data[0].zone_name).to eq('bar.com')
+      expect(response.data[0].volume).to eq(1200)
+    end
+
+    it "exposes the pagination information" do
+      response = subject.query(1)
+
+      expect(response.respond_to?(:page)).to be(true)
+      expect(response.page).to eq(0)
+      expect(response.per_page).to eq(100)
+      expect(response.total_entries).to eq(93)
+      expect(response.total_pages).to eq(1)
+    end
+
+    it "exposes the query parameters applied to produce the results" do
+      response = subject.query(1)
+
+      expect(response.respond_to?(:query)).to be(true)
+      query = response.query
+      expect(query["account_id"]).to eq("1")
+      expect(query["start_date"]).to eq('2023-12-08')
+      expect(query["end_date"]).to eq('2024-01-08')
+      expect(query["sort"]).to eq("zone_name:asc,date:asc")
+      expect(query["groupings"]).to eq("zone_name,date")
+      expect(query["page"]).to eq(0)
+      expect(query["per_page"]).to eq(100)
+    end
+  end
+end

data/spec/dnsimple/client/registrar_delegation_spec.rb

@@ -25,13 +25,13 @@ describe Dnsimple::Client, ".registrar" do
       response = subject.domain_delegation(account_id, "example.com")
       expect(response).to be_a(Dnsimple::Response)
 
-      expect(response.data).to match_array(%w(ns1.dnsimple.com ns2.dnsimple.com ns3.dnsimple.com ns4.dnsimple.com))
+      expect(response.data).to match_array(%w[ns1.dnsimple.com ns2.dnsimple.com ns3.dnsimple.com ns4.dnsimple.com])
     end
   end
 
   describe "#change_domain_delegation" do
     let(:account_id) { 1010 }
-    let(:attributes) { %w(ns1.dnsimple.com ns2.dnsimple.com ns3.dnsimple.com ns4.dnsimple.com) }
+    let(:attributes) { %w[ns1.dnsimple.com ns2.dnsimple.com ns3.dnsimple.com ns4.dnsimple.com] }
 
     before do
       stub_request(:put, %r{/v2/#{account_id}/registrar/domains/.+/delegation$})
@@ -51,13 +51,13 @@ describe Dnsimple::Client, ".registrar" do
       response = subject.change_domain_delegation(account_id, "example.com", attributes)
       expect(response).to be_a(Dnsimple::Response)
 
-      expect(response.data).to match_array(%w(ns1.dnsimple.com ns2.dnsimple.com ns3.dnsimple.com ns4.dnsimple.com))
+      expect(response.data).to match_array(%w[ns1.dnsimple.com ns2.dnsimple.com ns3.dnsimple.com ns4.dnsimple.com])
     end
   end
 
   describe "#change_domain_delegation_to_vanity" do
     let(:account_id) { 1010 }
-    let(:attributes) { %w(ns1.example.com ns2.example.com) }
+    let(:attributes) { %w[ns1.example.com ns2.example.com] }
 
     before do
       stub_request(:put, %r{/v2/#{account_id}/registrar/domains/.+/delegation/vanity$})

data/spec/dnsimple/client/vanity_name_servers_spec.rb

@@ -26,7 +26,7 @@ describe Dnsimple::Client, ".vanity_name_servers" do
       expect(response).to be_a(Dnsimple::Response)
 
       vanity_name_servers = response.data.map { |ns| ns["name"] }
-      expect(vanity_name_servers).to match_array(%w(ns1.example.com ns2.example.com ns3.example.com ns4.example.com))
+      expect(vanity_name_servers).to match_array(%w[ns1.example.com ns2.example.com ns3.example.com ns4.example.com])
     end
   end
 

data/spec/dnsimple/client/zones_records_spec.rb

@@ -112,7 +112,7 @@ describe Dnsimple::Client, ".zones" do
 
   describe "#create_zone_record" do
     let(:account_id) { 1010 }
-    let(:attributes) { { type: "A", name: "www", content: "127.0.0.1", regions: %w(global) } }
+    let(:attributes) { { type: "A", name: "www", content: "127.0.0.1", regions: %w[global] } }
     let(:zone_id) { "example.com" }
 
     before do
@@ -186,7 +186,7 @@ describe Dnsimple::Client, ".zones" do
       expect(result.ttl).to eq(600)
       expect(result.priority).to eq(10)
       expect(result.system_record).to be(false)
-      expect(result.regions).to eq(%w(SV1 IAD))
+      expect(result.regions).to eq(%w[SV1 IAD])
       expect(result.created_at).to eq("2016-10-05T09:51:35Z")
       expect(result.updated_at).to eq("2016-10-05T09:51:35Z")
     end

data/spec/dnsimple/client_spec.rb

@@ -33,7 +33,7 @@ describe Dnsimple::Client do
       subject = described_class.new(username: "user", password: "pass")
       subject.execute(:get, "test", {})
 
-      expect(WebMock).to have_requested(:get, "https://api.dnsimple.com/test").with(basic_auth: %w(user pass))
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.com/test").with(basic_auth: %w[user pass])
     end
 
     it "uses access token if there's an access token provided" do
@@ -138,7 +138,7 @@ describe Dnsimple::Client do
       subject.request(:get, 'foo', {})
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.com/foo")
-          .with(basic_auth: %w(user pass),
+          .with(basic_auth: %w[user pass],
                 headers: { 'Accept' => 'application/json', 'User-Agent' => Dnsimple::Default::USER_AGENT })
     end
 

data/spec/dnsimple/extra_spec.rb

@@ -24,7 +24,7 @@ describe Dnsimple::Extra do
   end
 
   describe ".validate_mandatory_attributes" do
-    let(:mandatory_attributes) { %i(name email) }
+    let(:mandatory_attributes) { %i[name email] }
 
     it "raises an error if a mandatory attribute is not present" do
       expect {

data/spec/fixtures.http/dnsAnalytics/success.http

@@ -0,0 +1,20 @@
+HTTP/1.1 200 OK
+Server: nginx
+Date: Tue, 14 Jun 2016 12:02:58 GMT
+Content-Type: application/json; charset=utf-8
+Connection: keep-alive
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2391
+X-RateLimit-Reset: 1465908577
+ETag: W/"9ef3b4bf1f441a9b1cd6d7041bc181aa"
+Cache-Control: max-age=0, private, must-revalidate
+X-Request-Id: f705b65b-3589-43ad-97ca-3b2821d49d81
+X-Runtime: 0.012661
+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": {"headers": ["zone_name", "date", "volume"], "rows": [["bar.com", "2023-12-08", 1200], ["bar.com", "2023-12-09", 1200], ["bar.com", "2024-01-07", 1200], ["bar.com", "2024-01-08", 1200], ["example.com", "2023-12-08", 1200], ["example.com", "2023-12-09", 1200], ["example.com", "2024-01-07", 1200], ["example.com", "2024-01-08", 1200], ["foo.com", "2023-12-08", 1200], ["foo.com", "2023-12-09", 1200], ["foo.com", "2024-01-07", 1200], ["foo.com", "2024-01-08", 1200]]}, "query": {"account_id": "1", "start_date": "2023-12-08", "end_date": "2024-01-08", "sort": "zone_name:asc,date:asc", "page": 0, "per_page": 100, "groupings": "zone_name,date"}, "pagination": {"current_page": 0, "per_page": 100, "total_entries": 93, "total_pages": 1}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dnsimple
 version: !ruby/object:Gem::Version
-  version: 8.7.1
+  version: 8.8.0
 platform: ruby
 authors:
 - DNSimple
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-22 00:00:00.000000000 Z
+date: 2024-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -114,6 +114,7 @@ files:
 - lib/dnsimple/client/certificates.rb
 - lib/dnsimple/client/clients.rb
 - lib/dnsimple/client/contacts.rb
+- lib/dnsimple/client/dns_analytics.rb
 - lib/dnsimple/client/domains.rb
 - lib/dnsimple/client/domains_collaborators.rb
 - lib/dnsimple/client/domains_delegation_signer_records.rb
@@ -154,6 +155,7 @@ files:
 - lib/dnsimple/struct/collaborator.rb
 - lib/dnsimple/struct/contact.rb
 - lib/dnsimple/struct/delegation_signer_record.rb
+- lib/dnsimple/struct/dns_analytics.rb
 - lib/dnsimple/struct/dnssec.rb
 - lib/dnsimple/struct/domain.rb
 - lib/dnsimple/struct/domain_check.rb
@@ -189,6 +191,7 @@ files:
 - spec/dnsimple/client/certificates_spec.rb
 - spec/dnsimple/client/client_service_spec.rb
 - spec/dnsimple/client/contacts_spec.rb
+- spec/dnsimple/client/dns_analytics_spec.rb
 - spec/dnsimple/client/domains_collaborators_spec.rb
 - spec/dnsimple/client/domains_delegation_signer_records_spec.rb
 - spec/dnsimple/client/domains_dnssec_spec.rb
@@ -275,6 +278,7 @@ files:
 - spec/fixtures.http/disableDomainTransferLock/success.http
 - spec/fixtures.http/disableVanityNameServers/success.http
 - spec/fixtures.http/disableWhoisPrivacy/success.http
+- spec/fixtures.http/dnsAnalytics/success.http
 - spec/fixtures.http/downloadCertificate/success.http
 - spec/fixtures.http/enableDnssec/success.http
 - spec/fixtures.http/enableDomainAutoRenewal/success.http
@@ -401,7 +405,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: The DNSimple API client for Ruby