dnsimple 8.6.0 → 8.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 644e524e7010bc680c34ba6abf09315fbe41e2a5ec63ee6c82e443df4f21326a
-  data.tar.gz: aa84484bdf2a0b8b48ca45ad448dcea01c8c879acdf4b1c018f2cb8fb73ad7cf
+  metadata.gz: 71cf40738100b3388caeebb75622d78d73a3b1810711cfd9099b3f5fb97fbd43
+  data.tar.gz: 812bb20d76f731d08065dfa7703fd77a41e56cd9078f5a8f7c431f36df7d6a7d
 SHA512:
-  metadata.gz: fa53931624fc7c23d8f91332c9d86379560fc3609fe0f351d6346b6e38fb5b9337bb04e0aa6120c639431b9931cbc100405bc7bca544e04ee805b1ef07e2d4cb
-  data.tar.gz: 0032b9d9c4b3df0581e9037a5196bc8376c9f01dbb87ced552eb0372f6d30263a1121bdd86ba16e1a5a992974b64639cbdb81b9ba50e8442603bd0c6ab39f0b2
+  metadata.gz: fda1515e6b1d10f098f86c951d6f3d20af9bbbea762b062dd01ab4ebfa90f313c2fcf63718e93b016df05518101653edbb9d7cf0cd28e2d0870106ef9ee07e05
+  data.tar.gz: bfad72709061c258c83829366b7aa4fa5758fb3765eac93cc58748c737f644f8d4e35981d33d76104e6b4126f9b6ecb5cf28ea091b95c6e048f0fdbd8ac4738b

data/.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Run markdownlint-cli
         uses: nosborn/github-action-markdown-cli@v3.3.0
         with:
@@ -37,7 +37,7 @@ jobs:
           - 'ruby-head'
           - 'truffleruby-head'
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/release.yml

@@ -19,7 +19,7 @@ jobs:
           wait-interval: 10
           allowed-conclusions: success
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Release Gem
         uses: simplyqio/publish-rubygems-action@2.0.0

data/CHANGELOG.md

@@ -4,6 +4,12 @@ This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 ## main
 
+## 8.7.0
+
+FEATURES:
+
+- NEW: Added `Dnsimple::Client::Billing#charges` to retrieve the list of billing charges for an account. (dnsimple/dnsimple-ruby#365)
+
 ## 8.6.0
 
 FEATURES:

data/Gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'coveralls', require: false
-gem 'rubocop', '1.56.2', require: false
-gem 'rubocop-performance', '1.19.0', require: false
+gem 'rubocop', '1.57.1', require: false
+gem 'rubocop-performance', '1.19.1', require: false
 gem 'rubocop-rake', '0.6.0', require: false
-gem 'rubocop-rspec', '2.23.2', require: false
+gem 'rubocop-rspec', '2.24.1', require: false

data/lib/dnsimple/client/billing.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Dnsimple
+  class Client
+    module Billing
+      # List the billing charges for the account.
+      #
+      # @see https://developer.dnsimple.com/v2/billing/#listCharges
+      #
+      # @example List charges in the first page
+      #   client.charges.list(1010)
+      #
+      # @example List charges, provide a filter start date
+      #   client.charges.list(1010, filter: { start_date: "2023-01-01" })
+      #
+      # @example List charges, provide a sorting policy
+      #   client.charges.list(1010, sort: "invoiced:asc")
+      #
+      # @param  [Integer] account_id the account ID
+      # @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)
+      # @option options [String] :sort sorting policy
+      # @return [Dnsimple::PaginatedResponse<Dnsimple::Struct::Charge>]
+      #
+      # @raise  [Dnsimple::RequestError]
+      def charges(account_id, options = {})
+        response = client.get(Client.versioned("/%s/billing/charges" % [account_id]), Options::ListOptions.new(options))
+
+        Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Charge.new(r) })
+      end
+      alias list_charges charges
+    end
+  end
+end

data/lib/dnsimple/client/clients.rb

@@ -8,6 +8,11 @@ module Dnsimple
       @services[:accounts] ||= Client::AccountsService.new(self)
     end
 
+    # @return [Dnsimple::Client::BillingService] The billing-related API proxy.
+    def billing
+      @services[:billing] ||= Client::BillingService.new(self)
+    end
+
     # @return [Dnsimple::Client::CertificatesService] The certificate-related API proxy.
     def certificates
       @services[:certificates] ||= Client::CertificatesService.new(self)
@@ -115,6 +120,11 @@ module Dnsimple
       include Client::Accounts
     end
 
+    require_relative 'billing'
+
+    class BillingService < ClientService
+      include Client::Billing
+    end
 
     require_relative 'certificates'
 

data/lib/dnsimple/struct/charge.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+
+module Dnsimple
+  module Struct
+    class Charge < Base
+
+      class ChargeItem < Base
+        # @return [String] The description of the charge item.
+        attr_accessor :description
+
+        # @return [Float] The amount of the charge item.
+        attr_reader :amount
+
+        # @return [Integer] The ID of the product that was charged.
+        attr_accessor :product_id
+
+        # @return [String] The type of the product that was charged.
+        attr_accessor :product_type
+
+        # @return [String] A unique or representative reference.
+        attr_accessor :product_reference
+
+        # Converts amount to a Float and sets it.
+        #
+        # @param  [String] amount
+        # @return [void]
+        def amount=(amount)
+          @amount = BigDecimal(amount)
+        end
+      end
+
+      # @return [String] The reference number of the invoice.
+      attr_accessor :reference
+
+      # @return [Float] The aggregate amount of all line items, that need to be paid.
+      attr_reader :total_amount
+
+      # @return [Float] The amount that was paid via wallet.
+      attr_reader :balance_amount
+
+      # @return [String] The state of the charge.
+      attr_accessor :state
+
+      # @return [DateTime] When the charge was invoiced.
+      attr_accessor :invoiced_at
+
+      # @return [Array<ChargeItems>] The charge items.
+      attr_reader :items
+
+      def initialize(*)
+        super
+        @items ||= []
+      end
+
+      # Converts items to an Array<Struct::Charge::ChargeItem> and sets it.
+      #
+      # @param  [Array<Hash>] charge_items
+      # @return [void]
+      def items=(charge_items)
+        @items = charge_items.map do |charge_item|
+          Charge::ChargeItem.new(charge_item)
+        end
+      end
+
+      # Converts balance_amount to a Float and sets it.
+      #
+      # @param  [String] balance_amount
+      # @return [void]
+      def balance_amount=(balance_amount)
+        @balance_amount = BigDecimal(balance_amount)
+      end
+
+      # Converts total_amount to a Float and sets it.
+      #
+      # @param  [String] total_amount
+      # @return [void]
+      def total_amount=(total_amount)
+        @total_amount = BigDecimal(total_amount)
+      end
+    end
+
+  end
+end

data/lib/dnsimple/struct.rb

@@ -22,6 +22,7 @@ require_relative 'struct/certificate'
 require_relative 'struct/certificate_bundle'
 require_relative 'struct/certificate_purchase'
 require_relative 'struct/certificate_renewal'
+require_relative 'struct/charge'
 require_relative 'struct/delegation_signer_record'
 require_relative 'struct/dnssec'
 require_relative 'struct/domain'

data/lib/dnsimple/version.rb

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

data/spec/dnsimple/client/billing_spec.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+require 'bigdecimal/util'
+
+describe Dnsimple::Client, ".billing" do
+
+  subject { described_class.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").billing }
+
+  describe "#charges" do
+    let(:account_id) { 1010 }
+
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/billing/charges})
+          .to_return(read_http_fixture("listCharges/success.http"))
+    end
+
+    it "builds the correct request" do
+      subject.charges(account_id)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/billing/charges")
+          .with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "exposes the pagination information" do
+      response = subject.charges(account_id)
+
+      expect(response.respond_to?(:page)).to be(true)
+      expect(response.page).to eq(1)
+      expect(response.per_page).to be_a(Integer)
+      expect(response.total_entries).to be_a(Integer)
+      expect(response.total_pages).to be_a(Integer)
+    end
+
+    it "returns the charges" do
+      response = subject.charges(account_id)
+
+      expect(response).to be_a(Dnsimple::PaginatedResponse)
+      expect(response.data).to be_a(Array)
+      expect(response.data.size).to eq(3)
+
+      response.data.each do |result|
+        expect(result).to be_a(Dnsimple::Struct::Charge)
+        expect(result.balance_amount).to be_a(BigDecimal)
+        expect(result.reference).to be_a(String)
+        expect(result.items).to be_a(Array)
+        expect(result.items[0]).to be_a(Dnsimple::Struct::Charge::ChargeItem)
+      end
+
+      expect(response.data[0].total_amount).to be_a(BigDecimal)
+      expect(response.data[0].total_amount.to_s("F")).to eq("14.5")
+      expect(response.data[0].items[0].amount).to be_a(BigDecimal)
+      expect(response.data[0].items[0].amount.to_s("F")).to eq("14.5")
+    end
+
+    it "supports filters" do
+      subject.charges(account_id, filter: { start_date: "2023-01-01", end_date: "2023-08-31" })
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/billing/charges?start_date=2023-01-01&end_date=2023-08-31")
+    end
+
+    it "supports pagination" do
+      subject.charges(account_id, page: 2)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/billing/charges?page=2")
+    end
+
+    it "supports sorting" do
+      subject.charges(account_id, sort: "invoiced:asc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/billing/charges?sort=invoiced:asc")
+    end
+
+    context "when using a bad filter" do
+      before do
+        stub_request(:get, %r{/v2/#{account_id}/billing/charges})
+            .to_return(read_http_fixture("listCharges/fail-400-bad-filter.http"))
+      end
+
+      it "raises error" do
+        expect do
+          subject.charges(account_id, filter: { start_date: "01-01-2023" })
+        end.to raise_error(Dnsimple::RequestError, "Invalid date format must be ISO8601 (YYYY-MM-DD)")
+      end
+    end
+
+    context "when account is not authorized" do
+      before do
+        stub_request(:get, %r{/v2/#{account_id}/billing/charges})
+            .to_return(read_http_fixture("listCharges/fail-403.http"))
+      end
+
+      it "raises error" do
+        expect do
+          subject.charges(account_id)
+        end.to raise_error(Dnsimple::RequestError, "Permission Denied. Required Scope: billing:*:read")
+      end
+    end
+  end
+end

data/spec/fixtures.http/listCharges/fail-400-bad-filter.http

@@ -0,0 +1,14 @@
+HTTP/1.1 400 Bad Request
+Date: Tue, 24 Oct 2023 08:13:01 GMT
+Connection: close
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2392
+X-RateLimit-Reset: 1698136677
+Content-Type: application/json; charset=utf-8
+X-WORK-WITH-US: Love automation? So do we! https://dnsimple.com/jobs
+Cache-Control: no-cache
+X-Request-Id: bdfbf3a7-d9dc-4018-9732-61502be989a3
+X-Runtime: 0.455303
+Transfer-Encoding: chunked
+
+{"message":"Invalid date format must be ISO8601 (YYYY-MM-DD)"}

data/spec/fixtures.http/listCharges/fail-403.http

@@ -0,0 +1,14 @@
+HTTP/1.1 403 Forbidden
+Date: Tue, 24 Oct 2023 09:49:29 GMT
+Connection: close
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2398
+X-RateLimit-Reset: 1698143967
+Content-Type: application/json; charset=utf-8
+X-WORK-WITH-US: Love automation? So do we! https://dnsimple.com/jobs
+Cache-Control: no-cache
+X-Request-Id: 5554e2d3-2652-4ca7-8c5e-92b4c35f28d6
+X-Runtime: 0.035309
+Transfer-Encoding: chunked
+
+{"message":"Permission Denied. Required Scope: billing:*:read"}

data/spec/fixtures.http/listCharges/success.http

@@ -0,0 +1,14 @@
+HTTP/1.1 200 OK
+Date: Tue, 24 Oct 2023 09:52:55 GMT
+Connection: close
+X-RateLimit-Limit: 2400
+X-RateLimit-Remaining: 2397
+X-RateLimit-Reset: 1698143967
+Content-Type: application/json; charset=utf-8
+X-WORK-WITH-US: Love automation? So do we! https://dnsimple.com/jobs
+Cache-Control: no-store, must-revalidate, private, max-age=0
+X-Request-Id: a57a87c8-626a-4361-9fb8-b55ca9be8e5d
+X-Runtime: 0.060526
+Transfer-Encoding: chunked
+
+{"data":[{"invoiced_at":"2023-08-17T05:53:36Z","total_amount":"14.50","balance_amount":"0.00","reference":"1-2","state":"collected","items":[{"description":"Register bubble-registered.com","amount":"14.50","product_id":1,"product_type":"domain-registration","product_reference":"bubble-registered.com"}]},{"invoiced_at":"2023-08-17T05:57:53Z","total_amount":"14.50","balance_amount":"0.00","reference":"2-2","state":"refunded","items":[{"description":"Register example.com","amount":"14.50","product_id":2,"product_type":"domain-registration","product_reference":"example.com"}]},{"invoiced_at":"2023-10-24T07:49:05Z","total_amount":"1099999.99","balance_amount":"0.00","reference":"4-2","state":"collected","items":[{"description":"Test Line Item 1","amount":"99999.99","product_id":null,"product_type":"manual","product_reference":null},{"description":"Test Line Item 2","amount":"1000000.00","product_id":null,"product_type":"manual","product_reference":null}]}],"pagination":{"current_page":1,"per_page":30,"total_entries":3,"total_pages":1}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dnsimple
 version: !ruby/object:Gem::Version
-  version: 8.6.0
+  version: 8.7.0
 platform: ruby
 authors:
 - DNSimple
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-08 00:00:00.000000000 Z
+date: 2023-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -110,6 +110,7 @@ files:
 - lib/dnsimple.rb
 - lib/dnsimple/client.rb
 - lib/dnsimple/client/accounts.rb
+- lib/dnsimple/client/billing.rb
 - lib/dnsimple/client/certificates.rb
 - lib/dnsimple/client/clients.rb
 - lib/dnsimple/client/contacts.rb
@@ -149,6 +150,7 @@ files:
 - lib/dnsimple/struct/certificate_bundle.rb
 - lib/dnsimple/struct/certificate_purchase.rb
 - lib/dnsimple/struct/certificate_renewal.rb
+- lib/dnsimple/struct/charge.rb
 - lib/dnsimple/struct/collaborator.rb
 - lib/dnsimple/struct/contact.rb
 - lib/dnsimple/struct/delegation_signer_record.rb
@@ -183,6 +185,7 @@ files:
 - lib/dnsimple/struct/zone_record.rb
 - lib/dnsimple/version.rb
 - spec/dnsimple/client/accounts_spec.rb
+- spec/dnsimple/client/billing_spec.rb
 - spec/dnsimple/client/certificates_spec.rb
 - spec/dnsimple/client/client_service_spec.rb
 - spec/dnsimple/client/contacts_spec.rb
@@ -317,6 +320,9 @@ files:
 - spec/fixtures.http/listAccounts/success-account.http
 - spec/fixtures.http/listAccounts/success-user.http
 - spec/fixtures.http/listCertificates/success.http
+- spec/fixtures.http/listCharges/fail-400-bad-filter.http
+- spec/fixtures.http/listCharges/fail-403.http
+- spec/fixtures.http/listCharges/success.http
 - spec/fixtures.http/listCollaborators/success.http
 - spec/fixtures.http/listContacts/success.http
 - spec/fixtures.http/listDelegationSignerRecords/success.http