dnsimple 3.0.0 → 3.1.0

data/lib/dnsimple/default.rb

@@ -61,10 +61,10 @@ module Dnsimple
         ENV['DNSIMPLE_API_DOMAIN_TOKEN']
       end
 
-      # Default User-Agent header string from ENV or {USER_AGENT}
+      # Default User-Agent header string from ENV
       # @return [String]
       def user_agent
-        ENV['DNSIMPLE_USER_AGENT'] || USER_AGENT
+        ENV['DNSIMPLE_USER_AGENT']
       end
 
       # Default Proxy address:port from ENV

data/lib/dnsimple/extra.rb

@@ -13,20 +13,20 @@ module Dnsimple
     #   h1 = { a: true, b: { c: [1, 2, 3] } }
     #   h2 = { a: false, b: { x: [3, 4, 5] } }
     #
-    #   h1.deep_merge(h2) #=> { a: false, b: { c: [1, 2, 3], x: [3, 4, 5] } }
+    #   Extra.deep_merge(h1, h2) #=> { a: false, b: { c: [1, 2, 3], x: [3, 4, 5] } }
     #
     # Like with Hash#merge in the standard library, a block can be provided
     # to merge values:
     #
     #   h1 = { a: 100, b: 200, c: { c1: 100 } }
     #   h2 = { b: 250, c: { c1: 200 } }
-    #   h1.deep_merge(h2) { |key, this_val, other_val| this_val + other_val }
+    #   Extra.deep_merge(h1, h2) { |key, this_val, other_val| this_val + other_val }
     #   # => { a: 100, b: 450, c: { c1: 300 } }
     def self.deep_merge(this, other, &block)
       deep_merge!(this.dup, other, &block)
     end
 
-    # Same as +deep_merge+, but modifies +self+.
+    # Same as +deep_merge+, but modifies +this+ instead of returning a new hash.
     def self.deep_merge!(this, other, &block)
       other.each_pair do |current_key, other_value|
         this_value = this[current_key]

data/lib/dnsimple/options.rb

@@ -0,0 +1,53 @@
+module Dnsimple
+  module Options
+
+    class Base
+      def initialize(options)
+        @options = (options || {}).dup
+      end
+
+      def to_h
+        @options
+      end
+    end
+
+    class ListOptions < Base
+      def initialize(options)
+        super
+        _prepare_query
+        _prepare_pagination
+        _prepare_sort
+        _prepare_filter
+      end
+
+      private
+
+      def _prepare_query
+        @options[:query] ||= {} if @options.any?
+      end
+
+      def _prepare_pagination
+        @page = @options.delete(:page)
+        _merge(page: @page) unless @page.nil?
+
+        @per_page = @options.delete(:per_page)
+        _merge(per_page: @per_page) unless @per_page.nil?
+      end
+
+      def _prepare_sort
+        @sort = @options.delete(:sort)
+        _merge(sort: @sort) unless @sort.nil?
+      end
+
+      def _prepare_filter
+        @filter = @options.delete(:filter)
+        _merge(@filter) unless @filter.nil?
+      end
+
+      def _merge(hash)
+        @options[:query].merge!(hash)
+      end
+    end
+
+  end
+end

data/lib/dnsimple/struct.rb

@@ -23,8 +23,10 @@ require_relative 'struct/oauth_token'
 require_relative 'struct/record'
 require_relative 'struct/service'
 require_relative 'struct/template'
+require_relative 'struct/template_record'
 require_relative 'struct/tld'
 require_relative 'struct/user'
 require_relative 'struct/whois_privacy'
 require_relative 'struct/zone'
 require_relative 'struct/webhook'
+require_relative 'struct/whoami'

data/lib/dnsimple/struct/account.rb

@@ -7,6 +7,9 @@ module Dnsimple
 
       # @return [String] The account email.
       attr_accessor :email
+
+      # @return [String] The identifier of the plan the account is subscribed to.
+      attr_accessor :plan_identifier
     end
 
   end

data/lib/dnsimple/struct/contact.rb

@@ -55,9 +55,6 @@ module Dnsimple
 
       # @return [String] When the contact was last updated in DNSimple.
       attr_accessor :updated_at
-
-      alias email_address email
-      alias email_address= email=
     end
 
   end

data/lib/dnsimple/struct/record.rb

@@ -29,10 +29,10 @@ module Dnsimple
       # @return [Bool] True if this is a system record created by DNSimple. System records are read-only.
       attr_accessor :system_record
 
-      # @return [String] When the domain was created in DNSimple.
+      # @return [String] When the record was created in DNSimple.
       attr_accessor :created_at
 
-      # @return [String] When the domain was last updated in DNSimple.
+      # @return [String] When the record was last updated in DNSimple.
       attr_accessor :updated_at
     end
 

data/lib/dnsimple/struct/template_record.rb

@@ -0,0 +1,34 @@
+module Dnsimple
+  module Struct
+
+    class TemplateRecord < Base
+      # @return [Fixnum] The template record ID in DNSimple.
+      attr_accessor :id
+
+      # @return [Fixnum] The template ID in DNSimple.
+      attr_accessor :template_id
+
+      # @return [String] The type of template record, in uppercase.
+      attr_accessor :type
+
+      # @return [String] The template record name (without the domain name).
+      attr_accessor :name
+
+      # @return [String] The plain-text template record content.
+      attr_accessor :content
+
+      # @return [Fixnum] The template record TTL value.
+      attr_accessor :ttl
+
+      # @return [Fixnum] The priority value, if the type of template record accepts a priority.
+      attr_accessor :priority
+
+      # @return [String] When the template record was created in DNSimple.
+      attr_accessor :created_at
+
+      # @return [String] When the template record was last updated in DNSimple.
+      attr_accessor :updated_at
+    end
+
+  end
+end

data/lib/dnsimple/struct/whoami.rb

@@ -0,0 +1,30 @@
+module Dnsimple
+  module Struct
+
+    class Whoami < Base
+      # @return [Account] The account, if present.
+      attr_accessor :account
+
+      # @return [String] The user, if present.
+      attr_accessor :user
+
+
+      # Converts account to a Struct::Account and sets it.
+      #
+      # @param  [Hash, nil] account
+      # @return [void]
+      def account=(account)
+        @account = account ? Struct::Account.new(account) : account
+      end
+
+      # Converts user to a Struct::User and sets it.
+      #
+      # @param  [Hash, nil] user
+      # @return [void]
+      def user=(user)
+        @user = user ? Struct::User.new(user) : user
+      end
+    end
+
+  end
+end

data/lib/dnsimple/version.rb

@@ -1,3 +1,3 @@
 module Dnsimple
-  VERSION = "3.0.0".freeze
+  VERSION = "3.1.0".freeze
 end

data/spec/dnsimple/client/accounts_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Dnsimple::Client, ".accounts" do
+
+  subject { described_class.new(base_url: "https://api.dnsimple.test", access_token: "a1b2c3").accounts }
+
+
+  describe "#accounts" do
+    before do
+      stub_request(:get, %r{/v2/accounts$}).
+          to_return(read_http_fixture("accounts/success-user.http"))
+    end
+
+    it "builds the correct request" do
+      subject.accounts
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/accounts").
+          with(headers: { 'Accept' => 'application/json' })
+    end
+
+    it "returns the accounts" do
+      response = subject.accounts
+      expect(response).to be_a(Dnsimple::Response)
+
+      result = response.data
+      expect(result.first).to be_a(Dnsimple::Struct::Account)
+      expect(result.last).to be_a(Dnsimple::Struct::Account)
+    end
+  end
+
+end

data/spec/dnsimple/client/contacts_spec.rb

@@ -21,7 +21,7 @@ describe Dnsimple::Client, ".contacts" do
     end
 
     it "supports pagination" do
-      subject.contacts(account_id, query: { page: 2 })
+      subject.contacts(account_id, page: 2)
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/contacts?page=2")
     end
@@ -32,6 +32,12 @@ describe Dnsimple::Client, ".contacts" do
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/contacts?foo=bar")
     end
 
+    it "supports sorting" do
+      subject.contacts(account_id, sort: "label:desc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/contacts?sort=label:desc")
+    end
+
     it "returns the contacts" do
       response = subject.contacts(account_id)
 
@@ -57,12 +63,23 @@ describe Dnsimple::Client, ".contacts" do
   end
 
   describe "#all_contacts" do
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/contacts}).
+          to_return(read_http_fixture("listContacts/success.http"))
+    end
+
     let(:account_id) { 1010 }
 
     it "delegates to client.paginate" do
       expect(subject).to receive(:paginate).with(:contacts, account_id, foo: "bar")
       subject.all_contacts(account_id, foo: "bar")
     end
+
+    it "supports sorting" do
+      subject.all_contacts(account_id, sort: "label:desc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/contacts?page=1&per_page=100&sort=label:desc")
+    end
   end
 
   describe "#create_contact" do
@@ -73,7 +90,7 @@ describe Dnsimple::Client, ".contacts" do
           to_return(read_http_fixture("createContact/created.http"))
     end
 
-    let(:attributes) { { first_name: "Simone", last_name: "Carletti", address1: "Italian Street", city: "Rome", state_province: "RM", postal_code: "00171", country: "IT", email_address: "example@example.com", phone: "+393391234567" } }
+    let(:attributes) { { first_name: "Simone", last_name: "Carletti", address1: "Italian Street", city: "Rome", state_province: "RM", postal_code: "00171", country: "IT", email: "example@example.com", phone: "+393391234567" } }
 
     it "builds the correct request" do
       subject.create_contact(account_id, attributes)

data/spec/dnsimple/client/domains_email_forwards_spec.rb

@@ -22,7 +22,7 @@ describe Dnsimple::Client, ".domains" do
     end
 
     it "supports pagination" do
-      subject.email_forwards(account_id, domain_id, query: { page: 2 })
+      subject.email_forwards(account_id, domain_id, page: 2)
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/email_forwards?page=2")
     end
@@ -33,6 +33,12 @@ describe Dnsimple::Client, ".domains" do
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/email_forwards?foo=bar")
     end
 
+    it "supports sorting" do
+      subject.email_forwards(account_id, domain_id, sort: "id:asc,from:desc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/email_forwards?sort=id:asc,from:desc")
+    end
+
     it "returns the email forwards" do
       response = subject.email_forwards(account_id, domain_id)
 
@@ -69,6 +75,11 @@ describe Dnsimple::Client, ".domains" do
   end
 
   describe "#all_email_forwards" do
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/domains/#{domain_id}/email_forwards}).
+          to_return(read_http_fixture("listEmailForwards/success.http"))
+    end
+
     let(:account_id) { 1010 }
     let(:domain_id) { "example.com" }
 
@@ -76,6 +87,12 @@ describe Dnsimple::Client, ".domains" do
       expect(subject).to receive(:paginate).with(:email_forwards, account_id, domain_id, foo: "bar")
       subject.all_email_forwards(account_id, domain_id, foo: "bar")
     end
+
+    it "supports sorting" do
+      subject.all_email_forwards(account_id, domain_id, sort: "id:asc,from:desc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains/#{domain_id}/email_forwards?page=1&per_page=100&sort=id:asc,from:desc")
+    end
   end
 
   describe "#create_email_forward" do

data/spec/dnsimple/client/domains_spec.rb

@@ -21,7 +21,7 @@ describe Dnsimple::Client, ".domains" do
     end
 
     it "supports pagination" do
-      subject.domains(account_id, query: { page: 2 })
+      subject.domains(account_id, page: 2)
 
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains?page=2")
     end
@@ -32,6 +32,18 @@ describe Dnsimple::Client, ".domains" do
       expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains?foo=bar")
     end
 
+    it "supports sorting" do
+      subject.domains(account_id, sort: "expires_on:asc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains?sort=expires_on:asc")
+    end
+
+    it "supports filtering" do
+      subject.domains(account_id, filter: { name_like: 'example' })
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains?name_like=example")
+    end
+
     it "returns the domains" do
       response = subject.domains(account_id)
 
@@ -57,12 +69,29 @@ describe Dnsimple::Client, ".domains" do
   end
 
   describe "#all_domains" do
+    before do
+      stub_request(:get, %r{/v2/#{account_id}/domains}).
+          to_return(read_http_fixture("listDomains/success.http"))
+    end
+
     let(:account_id) { 1010 }
 
     it "delegates to client.paginate" do
       expect(subject).to receive(:paginate).with(:domains, account_id, foo: "bar")
       subject.all_domains(account_id, foo: "bar")
     end
+
+    it "supports sorting" do
+      subject.all_domains(account_id, sort: "expires_on:asc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains?page=1&per_page=100&sort=expires_on:asc")
+    end
+
+    it "supports filtering" do
+      subject.all_domains(account_id, filter: { registrant_id: 99 })
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/#{account_id}/domains?page=1&per_page=100&registrant_id=99")
+    end
   end
 
   describe "#create_domain" do

data/spec/dnsimple/client/identity_spec.rb

@@ -18,12 +18,12 @@ describe Dnsimple::Client, ".identity" do
           with(headers: { 'Accept' => 'application/json' })
     end
 
-    it "returns a response" do
+    it "returns the whoami" do
       response = subject.whoami
       expect(response).to be_a(Dnsimple::Response)
 
       result = response.data
-      expect(result).to be_a(Hash)
+      expect(result).to be_a(Dnsimple::Struct::Whoami)
     end
 
     context "when authenticated as account" do
@@ -34,8 +34,8 @@ describe Dnsimple::Client, ".identity" do
 
       it "sets the account" do
         result = subject.whoami.data
-        expect(result[:account]).to be_a(Dnsimple::Struct::Account)
-        expect(result[:user]).to be_nil
+        expect(result.account).to be_a(Dnsimple::Struct::Account)
+        expect(result.user).to be_nil
       end
     end
 
@@ -47,8 +47,8 @@ describe Dnsimple::Client, ".identity" do
 
       it "sets the user" do
         result = subject.whoami.data
-        expect(result[:account]).to be_nil
-        expect(result[:user]).to be_a(Dnsimple::Struct::User)
+        expect(result.account).to be_nil
+        expect(result.user).to be_a(Dnsimple::Struct::User)
       end
     end
   end

data/spec/dnsimple/client/services_spec.rb

@@ -7,7 +7,7 @@ describe Dnsimple::Client, ".services" do
 
   describe "#list_services" do
     before do
-      stub_request(:get, %r{/v2/services$}).
+      stub_request(:get, %r{/v2/services}).
           to_return(read_http_fixture("listServices/success.http"))
     end
 
@@ -18,6 +18,24 @@ describe Dnsimple::Client, ".services" do
           with(headers: { "Accept" => "application/json" })
     end
 
+    it "supports pagination" do
+      subject.services(page: 2)
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/services?page=2")
+    end
+
+    it "supports extra request options" do
+      subject.services(query: { foo: "bar" })
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/services?foo=bar")
+    end
+
+    it "supports sorting" do
+      subject.services(sort: "short_name:asc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/services?sort=short_name:asc")
+    end
+
     it "returns the list of available services" do
       response = subject.list_services
       expect(response).to be_a(Dnsimple::CollectionResponse)
@@ -37,10 +55,21 @@ describe Dnsimple::Client, ".services" do
   end
 
   describe "#all_services" do
+    before do
+      stub_request(:get, %r{/v2/services}).
+          to_return(read_http_fixture("listServices/success.http"))
+    end
+
     it "delegates to client.paginate" do
       expect(subject).to receive(:paginate).with(:services, foo: "bar")
       subject.all_services(foo: "bar")
     end
+
+    it "supports sorting" do
+      subject.all_services(sort: "short_name:asc")
+
+      expect(WebMock).to have_requested(:get, "https://api.dnsimple.test/v2/services?page=1&per_page=100&sort=short_name:asc")
+    end
   end
 
   describe "#service" do