dnsimple 2.2.0 → 3.0.0.pre.beta1

data/lib/dnsimple/extra.rb

@@ -53,7 +53,7 @@ module Dnsimple
     # @raise  [ArgumentError]
     def self.validate_mandatory_attributes(attributes, required)
       required.each do |name|
-        attributes.key?(name) or raise(ArgumentError, ":#{name} is required")
+        attributes && attributes.key?(name) or raise(ArgumentError, ":#{name} is required")
       end
     end
 

data/lib/dnsimple/response.rb

@@ -0,0 +1,80 @@
+module Dnsimple
+
+  # The Response represents a response returned by a client request.
+  #
+  # It wraps the content of the response data, as well other response metadata such as rate-limiting information.
+  class Response
+
+    # @return [HTTParty::Response]
+    attr_reader :http_response
+
+    # @return [Struct::Base, Array] The content of the response data field.
+    attr_reader :data
+
+    # @return [Fixnum] The maximum number of requests this authentication context can perform per hour.
+    # @see https://developer.dnsimple.com/v2/#rate-limiting
+    attr_reader :rate_limit
+
+    # @return [Fixnum] The number of requests remaining in the current rate limit window.
+    # @see https://developer.dnsimple.com/v2/#rate-limiting
+    attr_reader :rate_limit_remaining
+
+    # @return [Fixnum] The time at which the current rate limit window in Unix time format.
+    # @see https://developer.dnsimple.com/v2/#rate-limiting
+    attr_reader :rate_limit_reset
+
+
+    # @param  [HTTParty::Response] http_response the HTTP response
+    # @param  [Object] data the response data
+    def initialize(http_response, data)
+      @http_response = http_response
+      @data = data
+
+      @rate_limit = http_response.headers['X-RateLimit-Limit'].to_i
+      @rate_limit_remaining = http_response.headers['X-RateLimit-Remaining'].to_i
+      @rate_limit_reset = Time.at(http_response.headers['X-RateLimit-Reset'].to_i)
+    end
+
+  end
+
+  # The CollectionResponse is a specific type of Response where the data is a collection of enumerable objects.
+  class CollectionResponse < Response
+    def initialize(http_response, collection)
+      super
+    end
+  end
+
+  # The PaginatedResponse is a specific type of Response that also exposes pagination metadata.
+  class PaginatedResponse < CollectionResponse
+
+    # @return [Fixnum] The current page.
+    attr_reader :page
+
+    # @return [Fixnum] The number of records per page.
+    attr_reader :per_page
+
+    # @return [Fixnum] The total number of records.
+    attr_reader :total_entries
+
+    # @return [Fixnum] The total number of pages.
+    attr_reader :total_pages
+
+
+    # Initializes a new paginated response from the response metadata,
+    # and with given collection.
+    #
+    # @param  [Hash] http_response the HTTP response
+    # @param  [Array] collection the enumerable collection of records returned in the response data
+    def initialize(http_response, collection)
+      super
+
+      pagination = http_response["pagination"]
+      @page           = pagination["current_page"]
+      @per_page       = pagination["per_page"]
+      @total_entries  = pagination["total_entries"]
+      @total_pages    = pagination["total_pages"]
+    end
+
+  end
+
+end

data/lib/dnsimple/struct.rb

@@ -13,17 +13,16 @@ module Dnsimple
   end
 end
 
-require 'dnsimple/struct/certificate'
-require 'dnsimple/struct/contact'
-require 'dnsimple/struct/domain'
-require 'dnsimple/struct/email_forward'
-require 'dnsimple/struct/extended_attribute'
-require 'dnsimple/struct/membership'
-require 'dnsimple/struct/price'
-require 'dnsimple/struct/record'
-require 'dnsimple/struct/service'
-require 'dnsimple/struct/template'
-require 'dnsimple/struct/template_record'
-require 'dnsimple/struct/transfer_order'
-require 'dnsimple/struct/user'
-require 'dnsimple/struct/whois_privacy'
+require_relative 'struct/account'
+require_relative 'struct/contact'
+require_relative 'struct/domain'
+require_relative 'struct/domain_check'
+require_relative 'struct/email_forward'
+require_relative 'struct/extended_attribute'
+require_relative 'struct/oauth_token'
+require_relative 'struct/record'
+require_relative 'struct/tld'
+require_relative 'struct/user'
+require_relative 'struct/whois_privacy'
+require_relative 'struct/zone'
+require_relative 'struct/webhook'

data/lib/dnsimple/struct/account.rb

@@ -0,0 +1,13 @@
+module Dnsimple
+  module Struct
+
+    class Account < Base
+      # @return [Fixnum] The account ID in DNSimple.
+      attr_accessor :id
+
+      # @return [String] The account email.
+      attr_accessor :email
+    end
+
+  end
+end

data/lib/dnsimple/struct/contact.rb

@@ -5,6 +5,9 @@ module Dnsimple
       # @return [Fixnum] The contact ID in DNSimple.
       attr_accessor :id
 
+      # @return [Fixnum] The associated account ID.
+      attr_accessor :account_id
+
       # @return [String] The label to represent the contact.
       attr_accessor :label
 
@@ -45,7 +48,7 @@ module Dnsimple
       attr_accessor :fax
 
       # @return [String] The contact email address.
-      attr_accessor :email_address
+      attr_accessor :email
 
       # @return [String] When the contact was created in DNSimple.
       attr_accessor :created_at
@@ -53,8 +56,8 @@ module Dnsimple
       # @return [String] When the contact was last updated in DNSimple.
       attr_accessor :updated_at
 
-      alias :email :email_address
-      alias :email= :email_address=
+      alias :email_address :email
+      alias :email_address= :email=
     end
 
   end

data/lib/dnsimple/struct/domain.rb

@@ -5,26 +5,26 @@ module Dnsimple
       # @return [Fixnum] The domain ID in DNSimple.
       attr_accessor :id
 
-      # @return [Fixnum] The associated user ID.
-      attr_accessor :user_id
+      # @return [Fixnum] The associated account ID.
+      attr_accessor :account_id
 
       # @return [Fixnum] The associated registrant (contact) ID.
       attr_accessor :registrant_id
 
-      # The String name.
+      # @return [String] The domain name.
       attr_accessor :name
 
-      # The String state.
-      attr_accessor :state
-
-      # The String API token
+      # @return [String] The domain API token used for domain authentication.
       attr_accessor :token
 
-      # Is the domain set to auto renew?
+      # @return [String] The domain state.
+      attr_accessor :state
+
+      # @return [Bool] True if the domain is set to auto-renew, false otherwise.
       attr_accessor :auto_renew
 
-      # Is the whois information protected?
-      attr_accessor :whois_protected
+      # @return [Bool] True if the domain WHOIS privacy is enabled, false otherwise.
+      attr_accessor :private_whois
 
       # @return [String] The date the domain will expire.
       attr_accessor :expires_on

data/lib/dnsimple/struct/domain_check.rb

@@ -0,0 +1,16 @@
+module Dnsimple
+  module Struct
+
+    class DomainCheck < Base
+      # @return [String] The domain name that was checked.
+      attr_accessor :domain
+
+      # @return [Boolean] Whether the domain name is available.
+      attr_accessor :available
+
+      # @return [Boolean] Whether the domain name is premium.
+      attr_accessor :premium
+    end
+
+  end
+end

data/lib/dnsimple/struct/email_forward.rb

@@ -2,13 +2,23 @@ module Dnsimple
   module Struct
 
     class EmailForward < Base
+      # @return [Fixnum] The email forward ID in DNSimple.
       attr_accessor :id
+
+      # @return [Fixnum] The associated domain ID.
       attr_accessor :domain_id
+
+      # @return [String] The "local part" of the originating email address. Anything to the left of the @ symbol.
       attr_accessor :from
+
+      # @return [String] The full email address to forward to.
       attr_accessor :to
+
+      # @return [String] When the email forward was created in DNSimple.
       attr_accessor :created_at
+
+      # @return [String] Then the email forward was last updated in DNSimple.
       attr_accessor :updated_at
     end
-
   end
 end

data/lib/dnsimple/struct/oauth_token.rb

@@ -0,0 +1,19 @@
+module Dnsimple
+  module Struct
+
+    class OauthToken < Base
+      # @return [String] The token you can use to authenticate.
+      attr_accessor :access_token
+
+      # @return [String] The token type.
+      attr_accessor :token_type
+
+      # @return [String] The token scope (not used for now).
+      attr_accessor :scope
+
+      # @return [Fixnum] The account ID in DNSimple this token belongs to.
+      attr_accessor :account_id
+    end
+
+  end
+end

data/lib/dnsimple/struct/record.rb

@@ -2,20 +2,38 @@ module Dnsimple
   module Struct
 
     class Record < Base
+      # @return [Fixnum] The record ID in DNSimple.
       attr_accessor :id
-      attr_accessor :domain_id
-      attr_accessor :name
+
+      # @return [String] The associated zone ID.
+      attr_accessor :zone_id
+
+      # @return [Fixnum] The ID of the parent record, if this record is dependent on another record.
+      attr_accessor :parent_id
+
+      # @return [String] The type of record, in uppercase.
       attr_accessor :type
+
+      # @return [String] The record name (without the domain name).
+      attr_accessor :name
+
+      # @return [String] The plain-text record content.
       attr_accessor :content
+
+      # @return [Fixnum] The TTL value.
       attr_accessor :ttl
+
+      # @return [Fixnum] The priority value, if the type of record accepts a priority.
       attr_accessor :priority
+
+      # @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.
       attr_accessor :created_at
-      attr_accessor :updated_at
 
-      alias :prio :priority
-      alias :prio= :priority=
-      alias :record_type :type
-      alias :record_type= :type=
+      # @return [String] When the domain was last updated in DNSimple.
+      attr_accessor :updated_at
     end
 
   end

data/lib/dnsimple/struct/tld.rb

@@ -0,0 +1,22 @@
+module Dnsimple
+  module Struct
+
+    class Tld < Base
+      # @return [String] The TLD in DNSimple.
+      attr_accessor :tld
+
+      # @return [Fixnum] The TLD type.
+      attr_accessor :tld_type
+      
+      # @return [Boolean] True if Whois Privacy Protection is available.
+      attr_accessor :whois_privacy
+
+      # @return [Boolean] True if TLD requires use of auto-renewal for renewals.
+      attr_accessor :auto_renew_only
+
+      # @return [Boolean] True if IDN is available.
+      attr_accessor :idn
+    end
+
+  end
+end

data/lib/dnsimple/struct/user.rb

@@ -2,15 +2,11 @@ module Dnsimple
   module Struct
 
     class User < Base
+      # @return [Fixnum] The user ID in DNSimple.
       attr_accessor :id
+
+      # @return [String] The user email.
       attr_accessor :email
-      attr_accessor :api_token
-      attr_accessor :domain_count
-      attr_accessor :domain_limit
-      attr_accessor :login_count
-      attr_accessor :failed_login_count
-      attr_accessor :created_at
-      attr_accessor :updated_at
     end
 
   end

data/lib/dnsimple/struct/webhook.rb

@@ -0,0 +1,13 @@
+module Dnsimple
+  module Struct
+
+    class Webhook < Base
+      # @return [Fixnum] The contact ID in DNSimple.
+      attr_accessor :id
+
+      # @return [String] The callback URL.
+      attr_accessor :url
+    end
+
+  end
+end

data/lib/dnsimple/struct/whois_privacy.rb

@@ -2,17 +2,20 @@ module Dnsimple
   module Struct
 
     class WhoisPrivacy < Base
-      # @return [Fixnum] The WHOIS privacy ID in DNSimple.
-      attr_accessor :id
-
       # @return [Fixnum] The associated domain ID.
       attr_accessor :domain_id
 
-      # @return [Bool] Whether the WHOIS privacy is enabled.
+      # @return [Boolean] Whether the whois privacy is enabled for the domain.
       attr_accessor :enabled
 
-      # @return [String] The date the domain will expire.
+      # @return [String] The date the whois privacy will expire on.
       attr_accessor :expires_on
+
+      # @return [String] When the whois privacy was created in DNSimple.
+      attr_accessor :created_at
+
+      # @return [String] When the whois privacy was last updated in DNSimple.
+      attr_accessor :updated_at
     end
 
   end

data/lib/dnsimple/struct/zone.rb

@@ -0,0 +1,25 @@
+module Dnsimple
+  module Struct
+
+    class Zone < Base
+      # @return [Fixnum] The zone ID in DNSimple.
+      attr_accessor :id
+
+      # @return [Fixnum] The associated account ID.
+      attr_accessor :account_id
+
+      # @return [String] The zone name.
+      attr_accessor :name
+
+      # @return [Boolean] True if the zone is a reverse zone.
+      attr_accessor :reverse
+
+      # @return [String] When the zone was created in DNSimple.
+      attr_accessor :created_at
+
+      # @return [String] When the zone was last updated in DNSimple.
+      attr_accessor :updated_at
+    end
+
+  end
+end

data/lib/dnsimple/version.rb

@@ -1,3 +1,3 @@
 module Dnsimple
-  VERSION = "2.2.0"
+  VERSION = "3.0.0-beta1"
 end

data/spec/dnsimple/client/client_service_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Dnsimple::Client::ClientService do
+
+  describe "#paginate" do
+    service_class = Class.new(Dnsimple::Client::ClientService) do
+      Item = Class.new(Dnsimple::Struct::Base) do
+        attr_accessor :id
+      end
+
+      def list(account_id, options = {})
+        response = client.get(Dnsimple::Client.versioned("/%s/list" % [account_id]), options)
+        Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Item.new(r) })
+      end
+    end
+
+    subject { service_class.new(Dnsimple::Client.new(base_url: "https://api.example.com/", access_token: "a1b2c3")) }
+
+    let(:account_id) { 1010 }
+
+    before do
+      stub_request(:get, %r[/v2/#{account_id}/list\?page=1&per_page=100])
+          .to_return(read_http_fixture("pages-1of3.http"))
+      stub_request(:get, %r[/v2/#{account_id}/list\?page=2&per_page=100])
+          .to_return(read_http_fixture("pages-2of3.http"))
+      stub_request(:get, %r[/v2/#{account_id}/list\?page=3&per_page=100])
+          .to_return(read_http_fixture("pages-3of3.http"))
+    end
+
+    it "loops all the pages" do
+      results = subject.paginate(:list, account_id, {})
+      expect(results.data.size).to eq(5)
+      expect(results.data.map(&:id)).to eq([1, 2, 3, 4, 5])
+    end
+  end
+
+end