internetbs 1.0.0

data/lib/internetbs/domain_records.rb

@@ -0,0 +1,172 @@
+module InternetBS
+  class DomainRecords < Base    
+    attribute :domain,      String              # Only used by #fetch method
+    attribute :filter_type, String              # One of DomainRecord::TYPES, only used by #fetch method
+    attribute :list,        Array[DomainRecord]
+    
+    def add(dns_record)
+      set_record :add, dns_record
+    end
+    
+    def fetch
+      ensure_attribute_has_value :domain
+      return false if @errors.any?
+      
+      params = {'domain' => @domain}
+      params.merge!({'filtertype' => @filter_type}) if @filter_type
+        
+      response = Client.get('/domain/dnsrecord/list', params)
+      code = response.code rescue ""
+      
+      case code
+      when '200'
+        hash = JSON.parse(response.body)
+
+        @status = hash['status']
+        @transaction_id = hash['transactid']
+        
+        if @status == 'SUCCESS'
+          hash['records'].each do |record|
+            @list << DomainRecord.new(
+              :name  => record['name'],
+              :value => record['value'],
+              :ttl   => record['ttl'],
+              :type  => record['type']
+            )
+          end
+        else
+          set_errors(response)
+          return false
+        end
+        
+        return true
+      else
+        set_errors(response)
+        return false
+      end
+    end
+    
+    def remove(dns_record)
+      set_record :remove, dns_record
+    end
+    
+    def update(current_dns_record, new_dns_record)
+      @errors.clear
+      
+      unless current_dns_record.valid? && new_dns_record.valid?
+        current_dns_record.each do |err|
+          @errors << "current: #{err}"
+        end
+        
+        new_dns_record.each do |err|
+          @errors << "new: #{err}"
+        end
+        
+        return false
+      end
+      
+      params = {
+        'fullrecordname' => current_dns_record.full_record_name,
+        'type' => current_dns_record.type
+      }
+
+      if current_dns_record.value && dns_record.value
+        params.merge!({ 
+          'currentvalue' => current_dns_record.value, 
+          'newvalue' => new_dns_record.value 
+        })
+      end
+      
+      if current_dns_record.ttl && \
+         new_dns_record.ttl && \
+         current_dns_record.ttl == new_dns_record.ttl
+        params.merge!({ 
+          'currentttl' => current_dns_record.ttl, 
+          'newttl' => new_dns_record.ttl 
+        })
+      end
+      
+      if current_dns_record.type == 'MX' && \
+         current_dns_record.priority && \
+         new_dns_record.priority && 
+         current_dns_record.priority == new_dns_record.priority
+        params.merge!({ 
+          'currentpriority' => current_dns_record.priority, 
+          'newpriority' => new_dns_record.priority 
+        })
+      end
+      
+      response = Client.post("/domain/dnsrecord/update", params)
+      code = response.code rescue ""
+      
+      case code
+      when '200'
+        hash = JSON.parse(response.body)
+
+        @status = hash['status']
+        @transaction_id = hash['transactid']
+        
+        unless @status == 'SUCCESS'
+          set_errors(response)
+          return false
+        end
+        
+        return true
+      else
+        set_errors(response)
+        return false
+      end
+    end
+    
+    private
+    
+    # Expects an action parameter of either :add or :remove.
+    def set_record(action, dns_record)
+      @errors.clear
+      
+      unless dns_record.valid?
+        @errors = dns_record.errors
+        return false
+      end
+      
+      params = {
+        'fullrecordname' => dns_record.full_record_name,
+        'type'           => dns_record.type
+      }
+
+      if dns_record.value
+        params.merge!({'value' => dns_record.value})
+      end
+      
+      if action == :add
+        if dns_record.ttl
+          params.merge!({'ttl' => dns_record.ttl})
+        end
+        if dns_record.priority && dns_record.type == 'MX'
+          params.merge!({'priority' => dns_record.priority})
+        end
+      end
+        
+      response = Client.post("/domain/dnsrecord/#{action.to_s}", params)
+      code = response.code rescue ""
+      
+      case code
+      when '200'
+        hash = JSON.parse(response.body)
+
+        @status = hash['status']
+        @transaction_id = hash['transactid']
+        
+        unless @status == 'SUCCESS'
+          set_errors(response)
+          return false
+        end
+        
+        return true
+      else
+        set_errors(response)
+        return false
+      end
+    end
+  end
+end

data/lib/internetbs/domain_total.rb

@@ -0,0 +1,8 @@
+module InternetBS
+  class DomainTotal
+    include Virtus.model
+    
+    attribute :tld, String
+    attribute :total, Integer
+  end
+end

data/lib/internetbs/dot_asia_attributes.rb

@@ -0,0 +1,56 @@
+module InternetBS
+  class DotAsiaAttributes < AdditionalAttributes
+    CED_ENTITY_TYPES = \
+      %w[naturalperson corporation cooperative partnership government politicalparty society institution other]
+      
+    CED_ID_FORM_TYPES = \
+      %w[passport certificate legislation societiesregistry policalpartyregistry other]
+    
+    # Additional attributes are for Charter Eligibility Declaration (CED)
+    attribute :ced_locality,       String # Required
+    attribute :ced_entity,         String # Required - must be one of CED_ENTITY_TYPES
+    attribute :ced_entity_other,   String # Required if ced_entity is 'other'
+    attribute :ced_id_form,        String # Required - must be one of CED_ID_FORM_TYPES
+    attribute :ced_id_form_other,  String # Required if ced_id_form is 'other'
+    attribute :ced_city,           String # Optional
+    attribute :ced_id_number,      String # Optional
+    attribute :ced_state_province, String # Optional
+    
+    def is_sunrise?
+      false # Sunrise and landrush periods ended March, 26 2008 when .asia transitioned to GoLive
+    end
+    
+    def mandatory_params
+      params = {
+        'dotasiacedlocality' => @ced_locality, 
+        'dotasiacedentity' => @ced_entity, 
+        'dotasiacedidform' => @ced_id_form
+      }
+      params.merge!({'dotasiacedentityother' => @ced_entity_other}) if @ced_entity == 'other'
+      params.merge!({'dotasiacedidformother' => @ced_id_form_other}) if @ced_id_form == 'other'
+      return params
+    end
+    
+    def optional_params
+      params = {}
+      params.merge!({'dotasiacedcity' => @ced_city}) if @ced_city
+      params.merge!({'dotasiacedidnumber' => @ced_id_number}) if @ced_id_number
+      params.merge!({'dotasiacedstateprovince' => @ced_state_province}) if @ced_state_province
+      return params
+    end
+    
+    def valid?(inputs = {})
+      ensure_attribute_has_value :ced_locality, :ced_entity, :ced_id_form
+      unless CED_ENTITY_TYPES.include?(@ced_entity)
+        @errors << "ced_entity must be one of CED_ENTITY_TYPES"
+      end
+      unless CED_ID_FORM_TYPES.include?(@ced_id_form)
+        @errors << "ced_id_form must be one of CED_ID_FORM_TYPES"
+      end
+      ensure_attribute_has_value :ced_entity_other if @ced_entity == 'other'
+      ensure_attribute_has_value :ced_id_form_other if @ced_id_form == 'other'
+      ensure_attribute_has_value :cd_id_number if is_sunrise?
+      super
+    end
+  end
+end

data/lib/internetbs/dot_de_attributes.rb

@@ -0,0 +1,64 @@
+require_relative 'country_codes'
+
+module InternetBS
+  class DotDEAttributes < AdditionalAttributes
+    ROLES = {
+      'PERSON' => 'Natural person',
+      'ROLE'   => 'An abstract name for a group of persons (so-called role account, e.g. Business Services)',
+      'ORG'    => 'A legal person (company, association, grouping of holders, organization etc.)'
+    }
+        
+    attribute :role,             String                     # Required - one in ROLES
+    attribute :ip_address,       String                     # Required
+    attribute :disclose_name,    Boolean, :default => false # Required
+    attribute :disclose_contact, Boolean, :default => false # Required
+    attribute :disclose_address, Boolean, :default => false # Required
+    attribute :remark,           String                     # Optional
+    attribute :sip_uri,          String                     # Optional
+    attribute :terms_accepted,   Boolean, :default => false # Required
+    
+    def mandatory_params
+      params = {"#{@contact_type.to_s}_role" => @role, "#{@contact_type.to_s}_clientip" => @ip_address}
+      params.merge!({"#{@contact_type.to_s}_disclosename" => @disclose_name ? 'YES' : 'NO'})
+      params.merge!({"#{@contact_type.to_s}_disclosecontact" => @disclose_contact ? 'YES' : 'NO'})
+      params.merge!({"#{@contact_type.to_s}_discloseaddress" => @disclose_address ? 'YES' : 'NO'})
+      params.merge!({"#{@contact_type.to_s}_tosagree" => @terms_accepted ? 'YES' : 'NO'})
+      return params
+    end
+    
+    def optional_params
+      params = {}
+      params.merge!({"#{@contact_type.to_s}_sip" => @sip_uri}) if @sip_uri
+      params.merge!({"#{@contact_type.to_s}_remark" => @remark}) if @remark
+      return params
+    end
+    
+    def valid?(inputs = {})
+      ensure_attribute_has_value :role, :disclose_name, :disclose_contact, 
+        :disclose_address, :terms_accepted, :ip_address
+      unless ROLES.has_key?(@role)
+        @errors << "role must be one in ROLES"
+      else
+        case @contact_type
+        when :registrant
+          unless ['PERSON', 'ORG'].include?(@role)
+            @errors << 'role must be either PERSON or ORG for registrant contact'
+          end
+        when :admin
+          unless ['PERSON'].include?(@role)
+            @errors << 'role must be PERSON for admin contact'
+          end
+        when :tech
+          unless ['PERSON', 'ORG'].include?(@role)
+            @errors << 'role must be either PERSON or ORG for tech contact'
+          end
+        when :zone
+          unless ['PERSON', 'ORG'].include?(@role)
+            @errors << 'role must be either PERSON or ORG for zone contact'
+          end
+        end
+      end
+      super
+    end
+  end
+end

data/lib/internetbs/dot_eu_attributes.rb

@@ -0,0 +1,20 @@
+require_relative 'language_codes'
+
+module InternetBS
+  class DotEUAttributes < AdditionalAttributes
+    attribute :language, String # Required - must be one of LANGUAGE_CODES
+    
+    def registrant_params
+      params = {'registrant_language' => @language}
+      return params
+    end
+    
+    def valid?(inputs = {})
+      ensure_attribute_has_value :language
+      unless @language && LANGUAGE_CODES.include?(@language)
+        @errors << "language must be one of LANGUAGE_CODES"
+      end
+      super
+    end
+  end
+end

data/lib/internetbs/dot_fr_attributes.rb

@@ -0,0 +1,138 @@
+require_relative 'country_codes'
+
+module InternetBS
+  class DotFRAttributes < AdditionalAttributes
+    CONTACT_ENTITY_TYPES = %w[INDIVIDUAL COMPANY TRADEMARK ASSOCIATION OTHER]
+    
+    attribute :entity_type,                        String  # Must be one of CONTACT_ENTITY_TYPES
+    attribute :entity_name,                        String
+    attribute :entity_vat,                         String  # Optional
+    attribute :entity_siren,                       String  # Optional
+    attribute :entity_duns,                        String  # Optional
+    attribute :entity_trade_mark,                  String
+    attribute :entity_waldec,                      String
+    attribute :entity_date_of_association,         Date    # YYYY-MM-DD
+    attribute :entity_date_of_publication,         Date    # YYYY-MM-DD
+    attribute :entity_gazette_announcement_number, String
+    attribute :entity_gazette_page_number,         String 
+    attribute :entity_birth_date,                  Date    # YYYY-MM-DD
+    attribute :entity_birth_place_country_code,    String  # Must be one in COUNTRY_CODES
+    attribute :entity_birth_city,                  String
+    attribute :entity_birth_place_postal_code,     String
+    attribute :entity_restricted_publication,      Boolean # 1 = true, 0 = false
+    attribute :other_contact_entity,               String
+    
+    def registrant_params
+      params = {"registrant_dot#{@domain_extension}contactentitytype" => @entity_type}
+      case @entity_type
+      when 'INDIVIDUAL'
+        params.merge!({"registrant_dot#{@domain_extension}contactentitybirthdate" => @entity_birth_date.strftime('%Y-%m-%d')})
+        params.merge!({"registrant_dot#{@domain_extension}contactentitybirthplacecountrycode" => @entity_birth_place_country_code})
+        if @entity_birth_place_country_code == 'FR'
+          params.merge!({"registrant_dot#{@domain_extension}contactentitybirthcity" => @entity_birth_city})
+          params.merge!({"registrant_dot#{@domain_extension}contactentitybirthplacepostalcode" => @entity_birth_place_postal_code})
+        end
+      when 'COMPANY'
+        params.merge!({"registrant_dot#{@domain_extension}contactentityname" => @entity_name})
+        params.merge!({"registrant_dot#{@domain_extension}contactentitysiren" => @entity_siren})
+      when 'TRADEMARK'
+        params.merge!({"registrant_dot#{@domain_extension}contactentityname" => @entity_name})
+        params.merge!({"registrant_dot#{@domain_extension}contactentitytrademark" => @entity_trade_mark})
+      when 'ASSOCIATION'
+        params.merge!({"registrant_dot#{@domain_extension}contactentityname" => @entity_name})
+        params.merge!({"registrant_dot#{@domain_extension}contactentitywaldec" => @entity_waldec})
+        params.merge!({"registrant_dot#{@domain_extension}contactentitydateofassocation" => @entity_date_of_association.strftime('%Y-%m-%d')})
+        params.merge!({"registrant_dot#{@domain_extension}contactentityannounceno" => @entity_gazette_announcement_number})
+        params.merge!({"registrant_dot#{@domain_extension}contactentitydateofpublication" => @entity_date_of_publication.strftime('%Y-%m-%d')})
+        params.merge!({"registrant_dot#{@domain_extension}contactentitypageno" => @entity_gazette_page_number})
+      when 'OTHER'
+        params.merge!({"registrant_dot#{@domain_extension}contactentityname" => @entity_name})
+        params.merge!({"registrant_dot#{@domain_extension}othercontactentity" => @other_contact_entity})
+      end
+      return params
+    end
+    
+    def admin_params
+      params = {"admin_dot#{@domain_extension}contactentitytype" => @entity_type}
+      case @entity_type
+      when 'INDIVIDUAL'
+        params.merge!({"admin_dot#{@domain_extension}contactentitybirthdate" => @entity_birth_date.strftime('%Y-%m-%d')})
+        params.merge!({"admin_dot#{@domain_extension}contactentitybirthplacecountrycode" => @entity_birth_place_country_code})
+        if @entity_birth_place_country_code == 'FR'
+          params.merge!({"admin_dot#{@domain_extension}contactentitybirthcity" => @entity_birth_city})
+          params.merge!({"admin_dot#{@domain_extension}contactentitybirthplacepostalcode" => @entity_birth_place_postal_code})
+        end
+      when 'COMPANY'
+        params.merge!({"admin_dot#{@domain_extension}contactentityname" => @entity_name})
+        params.merge!({"admin_dot#{@domain_extension}contactentitysiren" => @entity_siren})
+      when 'TRADEMARK'
+        params.merge!({"admin_dot#{@domain_extension}contactentityname" => @entity_name})
+        params.merge!({"admin_dot#{@domain_extension}contactentitytrademark" => @entity_trade_mark})
+      when 'ASSOCIATION'
+        params.merge!({"admin_dot#{@domain_extension}contactentityname" => @entity_name})
+        params.merge!({"admin_dot#{@domain_extension}contactentitywaldec" => @entity_waldec})
+        params.merge!({"admin_dot#{@domain_extension}contactentitydateofassocation" => @entity_date_of_association.strftime('%Y-%m-%d')})
+        params.merge!({"admin_dot#{@domain_extension}contactentityannounceno" => @entity_gazette_announcement_number})
+        params.merge!({"admin_dot#{@domain_extension}contactentitydateofpublication" => @entity_date_of_publication.strftime('%Y-%m-%d')})
+        params.merge!({"admin_dot#{@domain_extension}contactentitypageno" => @entity_gazette_page_number})
+      when 'OTHER'
+        params.merge!({"admin_dot#{@domain_extension}contactentityname" => @entity_name})
+        params.merge!({"admin_dot#{@domain_extension}othercontactentity" => @other_contact_entity})
+      end
+      return params
+    end
+    
+    def optional_params
+      params = {}
+      if @entity_type == 'INDIVIDUAL'
+        if @entity_birth_date
+          params.merge!({"#{@contact_type.to_s}_dot#{@domain_extension}contactentitybirthdate" => @entity_birth_date})
+        end
+        if @entity_birth_place_country_code
+          params.merge!({"#{@contact_type.to_s}_dot#{@domain_extension}contactentitybirthplacecountrycode" => @entity_birth_place_country_code})
+        end
+        if @entity_birth_city
+          params.merge!({"#{@contact_type.to_s}_dot#{@domain_extension}contactentitybirthcity" => @entity_birth_city})
+        end
+        if @entity_birth_place_postal_code
+          params.merge!({"#{@contact_type.to_s}_dot#{@domain_extension}contactentitybirthplacepostalcode" => @entity_birth_place_postal_code})
+        end
+        if @entity_restricted_publication
+          params.merge!({"#{@contact_type.to_s}_dot#{@domain_extension}contactentityrestrictedpublication" => @entity_restricted_publication == true ? 1 : 0})
+        end
+      end
+      if @entity_vat
+        params.merge!({"#{@contact_type.to_s}_dot#{@domain_extension}contactentityvat" => @entity_vat})
+      end
+      if @entity_duns
+        params.merge!({"#{@contact_type.to_s}_dot#{@domain_extension}contactentityduns" => @entity_duns})
+      end
+      return params
+    end
+    
+    def valid?(inputs = {})
+      ensure_attribute_has_value :entity_type
+      case @entity_type
+      when 'INDIVIDUAL'
+        unless COUNTRY_CODES.has_key?(@entity_birth_place_country_code)
+          @errors << "entity_birth_place_country_code must be one in COUNTRY_CODES"
+        end
+        if @entity_birth_place_country_code == 'FR'
+          ensure_attribute_has_value :entity_birth_city, :entity_birth_place_postal_code
+        end
+      case 'COMPANY'
+        ensure_attribute_has_value :entity_name
+      case 'TRADEMARK'
+        ensure_attribute_has_value :entity_name, :entity_trade_mark
+      case 'ASSOCIATION'
+        ensure_attribute_has_value :entity_name
+        unless @entity_waldec
+          ensure_attribute_has_value :entity_date_of_association, :entity_date_of_publication, :entity_announce_no, :entity_page_no
+        end
+      case 'ENTITY'
+        ensure_attribute_has_value :entity_name
+      end 
+      super   
+    end
+  end
+end