dnsimple 2.0.0.alpha2 → 2.0.0.alpha3

data/lib/dnsimple/default.rb

@@ -0,0 +1,86 @@
+module Dnsimple
+
+  # Default configuration options for {Client}
+  module Default
+
+    # Default API endpoint
+    API_ENDPOINT = "https://api.dnsimple.com/".freeze
+
+    # Default User Agent header
+    USER_AGENT   = "dnsimple-ruby/#{VERSION}".freeze
+
+    class << self
+
+      # List of configurable keys for {Client}
+      # @return [Array] of option keys
+      def keys
+        @keys ||= [
+            :api_endpoint,
+            :username,
+            :password,
+            :exchange_token,
+            :api_token,
+            :domain_api_token,
+            :user_agent,
+            :proxy,
+        ]
+      end
+
+      # Configuration options
+      # @return [Hash]
+      def options
+        Hash[keys.map { |key| [key, send(key)]}]
+      end
+
+      # Default API endpoint from ENV or {API_ENDPOINT}
+      # @return [String]
+      def api_endpoint
+        ENV['DNSIMPLE_API_ENDPOINT'] || API_ENDPOINT
+      end
+
+      # Default DNSimple username for Basic Auth from ENV
+      # @return [String]
+      def username
+        ENV['DNSIMPLE_USERNAME']
+      end
+
+      # Default DNSimple password for Basic Auth from ENV
+      # @return [String]
+      def password
+        ENV['DNSIMPLE_PASSWORD']
+      end
+
+      # Default DNSimple Exchange Token for Basic Auth from ENV
+      # @return [String]
+      def exchange_token
+        ENV['DNSIMPLE_API_EXCHANGE_TOKEN']
+      end
+
+      # Default DNSimple API Token for Token Auth from ENV
+      # @return [String]
+      def domain_api_token
+        ENV['DNSIMPLE_API_TOKEN']
+      end
+
+      # Default DNSimple Domain API Token for Token Auth from ENV
+      # @return [String]
+      def api_token
+        ENV['DNSIMPLE_API_DOMAIN_TOKEN']
+      end
+
+      # Default User-Agent header string from ENV or {USER_AGENT}
+      # @return [String]
+      def user_agent
+        ENV['DNSIMPLE_USER_AGENT'] || USER_AGENT
+      end
+
+      # Default Proxy address:port from ENV
+      # @return [String]
+      def proxy
+        ENV['DNSIMPLE_PROXY']
+      end
+
+    end
+  end
+
+end

data/lib/dnsimple/error.rb

@@ -3,20 +3,16 @@ module Dnsimple
   class Error < StandardError
   end
 
-  class RecordExists < Error
-  end
-
-  class RecordNotFound < Error
-  end
+  class RequestError < Error
+    attr_reader :response
 
-  # An exception that is raised if a method is called with missing or invalid parameter values.
-  class ValidationError < Error
+    def initialize(response)
+      @response = response
+      super("#{response.code}")
+    end
   end
 
-  class RequestError < Error
-    def initialize(description, response)
-      super("#{description}: #{response["error"]}")
-    end
+  class RecordNotFound < RequestError
   end
 
   class AuthenticationError < Error

data/lib/dnsimple/extra.rb

@@ -0,0 +1,54 @@
+module Dnsimple
+  module Extra
+
+    # Returns a new hash with +self+ and +other+ merged recursively.
+    #
+    #   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] } }
+    #
+    # 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 }
+    #   # => { 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+.
+    def self.deep_merge!(this, other, &block)
+      other.each_pair do |current_key, other_value|
+        this_value = this[current_key]
+
+        this[current_key] = if this_value.is_a?(Hash) && other_value.is_a?(Hash)
+          deep_merge(this_value, other_value, &block)
+        else
+          if block_given? && key?(current_key)
+            block.call(current_key, this_value, other_value)
+          else
+            other_value
+          end
+        end
+      end
+
+      this
+    end
+
+    # Validates the presence of mandatory attributes.
+    #
+    # @param  [Hash] attributes
+    # @param  [Array<Symbol>] required
+    # @return [void]
+    # @raise  [ArgumentError]
+    def self.validate_mandatory_attributes(attributes, required)
+      required.each do |name|
+        attributes.key?(name) or raise(ArgumentError, ":#{name} is required")
+      end
+    end
+
+  end
+end

data/lib/dnsimple/struct.rb

@@ -0,0 +1,29 @@
+module Dnsimple
+  module Struct
+
+    class Base
+      def initialize(attributes = {})
+        attributes.each do |key, value|
+          m = "#{key}=".to_sym
+          self.send(m, value) if self.respond_to?(m)
+        end
+      end
+    end
+
+  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'

data/lib/dnsimple/struct/certificate.rb

@@ -0,0 +1,56 @@
+module Dnsimple
+  module Struct
+
+    class Certificate < Base
+      # @return [Fixnum] The certificate ID in DNSimple.
+      attr_accessor :id
+
+      # @return [Fixnum] The associated domain ID.
+      attr_accessor :domain_id
+
+      # The Fixnum associated contact ID.
+      attr_accessor :contact_id
+
+      # The String subdomain on the certificate.
+      attr_accessor :name
+
+      # The String state.
+      attr_accessor :state
+
+      # The String Certificate Signing Request.
+      attr_accessor :csr
+
+      # The String SSL certificate.
+      # It is set only if the order issued by the Certificate Authority.
+      attr_accessor :ssl_certificate
+
+      # The String private key.
+      # It is set only if DNSimple generated the Certificate Signing Request.
+      attr_accessor :private_key
+
+      # The String approver email address
+      # It is set only if the state is submitted.
+      attr_accessor :approver_email
+
+      # The Array of all emails that can be used to approve the certificate.
+      # It is set only if the state is configured.
+      attr_accessor :approver_emails
+
+      # @return [String] When the certificate was created in DNSimple.
+      attr_accessor :created_at
+
+      # @return [String] When the certificate was last updated in DNSimple.
+      attr_accessor :updated_at
+
+      # The Date the certificate was configured.
+      attr_accessor :configured_at
+
+      # The Date the certificate will expire.
+      attr_accessor :expires_on
+
+      # The associated Domain.
+      attr_accessor :domain
+    end
+
+  end
+end

data/lib/dnsimple/struct/contact.rb

@@ -0,0 +1,61 @@
+module Dnsimple
+  module Struct
+
+    class Contact < Base
+      # @return [Fixnum] The contact ID in DNSimple.
+      attr_accessor :id
+
+      # @return [String] The label to represent the contact.
+      attr_accessor :label
+
+      # @return [String] The contact first name.
+      attr_accessor :first_name
+
+      # @return [String] The contact last name.
+      attr_accessor :last_name
+
+      # @return [String] The contact's job title.
+      attr_accessor :job_title
+
+      # @return [String] The name of the organization in which the contact works.
+      attr_accessor :organization_name
+
+      # @return [String] The contact street address.
+      attr_accessor :address1
+
+      # @return [String] Apartment or suite number.
+      attr_accessor :address2
+
+      # @return [String] The city name.
+      attr_accessor :city
+
+      # @return [String] The state or province name.
+      attr_accessor :state_province
+
+      # @return [String] The contact postal code.
+      attr_accessor :postal_code
+
+      # @return [String] The contact country (as a 2-character country code).
+      attr_accessor :country
+
+      # @return [String] The contact phone number.
+      attr_accessor :phone
+
+      # @return [String] The contact fax number (may be omitted).
+      attr_accessor :fax
+
+      # @return [String] The contact email address.
+      attr_accessor :email_address
+
+      # @return [String] When the contact was created in DNSimple.
+      attr_accessor :created_at
+
+      # @return [String] When the contact was last updated in DNSimple.
+      attr_accessor :updated_at
+
+      alias :email :email_address
+      alias :email= :email_address=
+    end
+
+  end
+end

data/lib/dnsimple/struct/domain.rb

@@ -0,0 +1,40 @@
+module Dnsimple
+  module Struct
+
+    class Domain < Base
+      # @return [Fixnum] The domain ID in DNSimple.
+      attr_accessor :id
+
+      # @return [Fixnum] The associated user ID.
+      attr_accessor :user_id
+
+      # @return [Fixnum] The associated registrant (contact) ID.
+      attr_accessor :registrant_id
+
+      # The String name.
+      attr_accessor :name
+
+      # The String state.
+      attr_accessor :state
+
+      # The String API token
+      attr_accessor :token
+
+      # Is the domain set to auto renew?
+      attr_accessor :auto_renew
+
+      # Is the whois information protected?
+      attr_accessor :whois_protected
+
+      # @return [String] The date the domain will expire.
+      attr_accessor :expires_on
+
+      # @return [String] When the domain was created in DNSimple.
+      attr_accessor :created_at
+
+      # @return [String] When the domain was last updated in DNSimple.
+      attr_accessor :updated_at
+    end
+
+  end
+end

data/lib/dnsimple/struct/email_forward.rb

@@ -0,0 +1,14 @@
+module Dnsimple
+  module Struct
+
+    class EmailForward < Base
+      attr_accessor :id
+      attr_accessor :domain_id
+      attr_accessor :from
+      attr_accessor :to
+      attr_accessor :created_at
+      attr_accessor :updated_at
+    end
+
+  end
+end

data/lib/dnsimple/struct/extended_attribute.rb

@@ -0,0 +1,39 @@
+module Dnsimple
+  module Struct
+
+    class ExtendedAttribute < Base
+
+      class Option < Base
+        # The option name
+        attr_accessor :title
+
+        # The option value
+        attr_accessor :value
+
+        # A long description of the option
+        attr_accessor :description
+      end
+
+      # The extended attribute name
+      attr_accessor :name
+
+      # A description of the extended attribute
+      attr_accessor :description
+
+      # Boolean indicating if the extended attribute is required
+      attr_accessor :required
+
+      def options
+        @options ||= []
+      end
+
+      def options=(opts)
+        @options = opts.map do |opt|
+          ExtendedAttribute::Option.new(opt)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/dnsimple/struct/membership.rb

@@ -0,0 +1,22 @@
+module Dnsimple
+  module Struct
+
+    class Membership < Base
+      # @return [Fixnum] The membership ID in DNSimple.
+      attr_accessor :id
+
+      # @return [Fixnum] The associated domain ID.
+      attr_accessor :domain_id
+
+      # @return [Fixnum] The associated user ID.
+      attr_accessor :user_id
+
+      # @return [String] When the membership was created in DNSimple.
+      attr_accessor :created_at
+
+      # @return [String] When the membership was last updated in DNSimple.
+      attr_accessor :updated_at
+    end
+
+  end
+end

data/lib/dnsimple/struct/price.rb

@@ -0,0 +1,16 @@
+module Dnsimple
+  module Struct
+
+    class Price < Base
+      attr_accessor :tld
+      attr_accessor :minimum_registration
+      attr_accessor :registration_price
+      attr_accessor :registration_enabled
+      attr_accessor :transfer_price
+      attr_accessor :transfer_enabled
+      attr_accessor :renewal_price
+      attr_accessor :renewal_enabled
+    end
+
+  end
+end