internetbs 1.0.0

data/lib/internetbs/dot_it_attributes.rb

@@ -0,0 +1,182 @@
+require_relative 'country_codes'
+
+module InternetBS
+  class DotITAttributes < AdditionalAttributes
+    ENTITY_TYPES = {
+      '1' => 'Italian and foreign natural persons',
+      '2' => 'Companies/one man companies',
+      '3' => 'Freelance workers/professionals',
+      '4' => 'Non-profit organizations',
+      '5' => 'Public organizations',
+      '6' => 'Other subjects',
+      '7' => 'Foreigners who match 2-6'
+    }
+    
+    # From ISO 3166-2:IT @ https://en.wikipedia.org/wiki/ISO_3166-2:IT
+    PROVINCIAL_CODES = {
+      "AG" =>	"Agrigento",
+      "AL" =>	"Alessandria",
+      "AN" =>	"Ancona",
+      "AO" =>	"Aosta, Aoste (fr)",
+      "AR" =>	"Arezzo",
+      "AP" =>	"Ascoli Piceno",
+      "AT" =>	"Asti",
+      "AV" =>	"Avellino",
+      "BA" =>	"Bari",
+      "BT" =>	"Barletta-Andria-Trani",
+      "BL" =>	"Belluno",
+      "BN" =>	"Benevento",
+      "BG" =>	"Bergamo",
+      "BI" =>	"Biella",
+      "BO" =>	"Bologna",
+      "BZ" =>	"Bolzano, Bozen (de)",
+      "BS" =>	"Brescia",
+      "BR" =>	"Brindisi",
+      "CA" =>	"Cagliari",
+      "CL" =>	"Caltanissetta",
+      "CB" =>	"Campobasso",
+      "CI" =>	"Carbonia-Iglesias",
+      "CE" =>	"Caserta",
+      "CT" =>	"Catania",
+      "CZ" =>	"Catanzaro",
+      "CH" =>	"Chieti",
+      "CO" =>	"Como",
+      "CS" =>	"Cosenza",
+      "CR" =>	"Cremona",
+      "KR" =>	"Crotone",
+      "CN" =>	"Cuneo",
+      "EN" =>	"Enna",
+      "FM" =>	"Fermo",
+      "FE" =>	"Ferrara",
+      "FI" =>	"Firenze",
+      "FG" =>	"Foggia",
+      "FC" =>	"Forlì-Cesena",
+      "FR" =>	"Frosinone",
+      "GE" =>	"Genova",
+      "GO" =>	"Gorizia",
+      "GR" =>	"Grosseto",
+      "IM" =>	"Imperia",
+      "IS" =>	"Isernia",
+      "SP" =>	"La Spezia",
+      "AQ" =>	"L'Aquila",
+      "LT" =>	"Latina",
+      "LE" =>	"Lecce",
+      "LC" =>	"Lecco",
+      "LI" =>	"Livorno",
+      "LO" =>	"Lodi",
+      "LU" =>	"Lucca",
+      "MC" =>	"Macerata",
+      "MN" =>	"Mantova",
+      "MS" =>	"Massa-Carrara",
+      "MT" =>	"Matera",
+      "VS" =>	"Medio Campidano",
+      "ME" =>	"Messina",
+      "MI" =>	"Milano",
+      "MO" =>	"Modena",
+      "MB" =>	"Monza e Brianza",
+      "NA" =>	"Napoli",
+      "NO" =>	"Novara",
+      "NU" =>	"Nuoro",
+      "OG" =>	"Ogliastra",
+      "OT" =>	"Olbia-Tempio",
+      "OR" =>	"Oristano",
+      "PD" =>	"Padova",
+      "PA" =>	"Palermo",
+      "PR" =>	"Parma",
+      "PV" =>	"Pavia",
+      "PG" =>	"Perugia",
+      "PU" =>	"Pesaro e Urbino",
+      "PE" =>	"Pescara",
+      "PC" =>	"Piacenza",
+      "PI" =>	"Pisa",
+      "PT" =>	"Pistoia",
+      "PN" =>	"Pordenone",
+      "PZ" =>	"Potenza",
+      "PO" =>	"Prato",
+      "RG" =>	"Ragusa",
+      "RA" =>	"Ravenna",
+      "RC" =>	"Reggio Calabria",
+      "RE" =>	"Reggio Emilia",
+      "RI" =>	"Rieti",
+      "RN" =>	"Rimini",
+      "RM" =>	"Roma",
+      "RO" =>	"Rovigo",
+      "SA" =>	"Salerno",
+      "SS" =>	"Sassari",
+      "SV" =>	"Savona",
+      "SI" =>	"Siena",
+      "SR" =>	"Siracusa",
+      "SO" =>	"Sondrio",
+      "TA" =>	"Taranto",
+      "TE" =>	"Teramo",
+      "TR" =>	"Terni",
+      "TO" =>	"Torino",
+      "TP" =>	"Trapani",
+      "TN" =>	"Trento",
+      "TV" =>	"Treviso",
+      "TS" =>	"Trieste",
+      "UD" =>	"Udine",
+      "VA" =>	"Varese",
+      "VE" =>	"Venezia",
+      "VB" =>	"Verbano-Cusio-Ossola",
+      "VC" =>	"Vercelli",
+      "VR" =>	"Verona",
+      "VV" =>	"Vibo Valentia",
+      "VI" =>	"Vicenza",
+      "VT" =>	"Viterbo"
+    }
+    
+    attribute :entity_type,      String                     # Required - one in ENTITY_TYPES
+    attribute :nationality,      String                     # Required - one in COUNTRY_CODES
+    attribute :reg_code,         String
+    attribute :hide_whois,       Boolean, :default => false
+    attribute :province,         String                     # One in PROVINCIAL_CODES if nationality = IT
+    attribute :terms_1_accepted, Boolean, :default => false
+    attribute :terms_2_accepted, Boolean, :default => false
+    attribute :terms_3_accepted, Boolean, :default => false
+    attribute :terms_4_accepted, Boolean, :default => false
+    attribute :ip_address,       String
+    
+    def registrant_params
+      params = {
+        'registrant_dotitentitytype'  => @entity_type,
+        'registrant_dotitnationality' => @nationality,
+        'registrant_dotitregcode'     => @reg_code,
+        'registrant_dotithidewhois'   => @hide_whois ? 'YES' : 'NO',
+        'registrant_dotitprovince'    => @province,
+        'registrant_dotitterm1'       => @term_1 ? 'YES' : 'NO',
+        'registrant_dotitterm2'       => @term_2 ? 'YES' : 'NO',
+        'registrant_dotitterm3'       => @term_3 ? 'YES' : 'NO',
+        'registrant_dotitterm4'       => @term_4 ? 'YES' : 'NO',
+        'registrant_clientip'         => @ip_address
+      }
+      return params
+    end
+    
+    def valid?(inputs = {})
+      ensure_attribute_has_value :entity_type, :nationality, :reg_code, :province, :ip_address
+      
+      unless COUNTRY_CODES.has_key?(@nationality)
+        @errors << "nationality must be one in COUNTRY_CODES"
+      end
+      
+      if @nationality == 'IT'
+        unless PROVINCIAL_CODES.include?(@province)
+          @errors << "province must be one in PROVINCIAL_CODES when nationality is IT"
+        end
+      end
+      
+      case @entity_type
+      when '1'
+        unless COUNTRY_CODES_EU.include?(@nationality) || COUNTRY_CODES_EU.include?(inputs['registrant_country_code'])
+          @errors << "either nationality or registrant country_code must be member of EU"
+        end
+      else
+        unless @nationality != inputs['registrant_country_code']
+          @errors << "nationality must be the same as registrant country_code"
+        end
+      end
+      super
+    end
+  end
+end

data/lib/internetbs/dot_nl_attributes.rb

@@ -0,0 +1,47 @@
+module InternetBS
+  class DotNLAttributes < AdditionalAttributes
+    LEGAL_FORMS = {
+      'BGG'         => 'Non-Dutch EC company',
+      'BRO'         => 'Non-Dutch legal form/enterprise/subsidiary',
+      'BV'          => 'Limited company',
+      'BVI/O'       => 'Limited company in formation',
+      'COOP'        => 'Cooperative',
+      'CV'          => 'Limited Partnership',
+      'EENMANSZAAK' => 'Sole trader',
+      'EESV'        => 'European Economic Interest Group',
+      'KERK'        => 'Religious society',
+      'MAATSCHAP'   => 'Partnership',
+      'NV'          => 'Public Company',
+      'OWM'         => 'Mutual benefit company',
+      'PERSOON'     => 'Natural person',
+      'REDR'        => 'Shipping company',
+      'STICHTING'   => 'Foundation',
+      'VERENIGING'  => 'Association',
+      'VOF Trading' => 'partnership',
+      'ANDERS'      => 'Other'
+    }
+        
+    attribute :ip_address,          String                     # Required
+    attribute :legal_form,          String                     # Required - one of LEGAL_FORMS
+    attribute :registration_number, String                     # Optional
+    attribute :terms_accepted,      Boolean, :default => false # Required - YES = true, NO = false
+    
+    def registrant_params
+      params = {
+        'registrant_nllegalform' => @legal_form,
+        'registrant_nlterm'      => @terms_accepted ? 'YES' : 'NO',
+        'registrant_clientip'    => @ip_address
+      }
+      params.merge!({'registrant_nlregnumber' => @registration_number}) if @registration_number
+      return params
+    end
+    
+    def valid?(inputs = {})
+      ensure_attribute_has_value :ip_address, :legal_form, :terms_accepted
+      unless LEGAL_FORMS.include?(@legal_form)
+        @errors << "legal_form must be one in LEGAL_FORMS"
+      end
+      super
+    end
+  end
+end

data/lib/internetbs/dot_uk_attributes.rb

@@ -0,0 +1,60 @@
+module InternetBS
+  class DotUKAttributes < AdditionalAttributes
+    ORGANIZATION_TYPES = {
+      'LTD'    => 'UK Limited Company',
+      'PLC'    => 'UK Public Limited Company',
+      'PTNR'   => 'UK Partnership',
+      'STRA'   => 'UK Sole Trader',
+      'LLP'    => 'UK Limited Liability Partnership',
+      'IP'     => 'UK Industrial/Provident Registered Company',
+      'IND'    => 'UK Individual (self representing)',
+      'SCH'    => 'UK School',
+      'RCHAR'  => 'UK Registered Charity',
+      'GOV'    => 'UK Government Body',
+      'CRO'    => 'UK Corporation by Royal Charter',
+      'STAT'   => 'UK Statutory Body',
+      'OTHER'  => 'UK Entity that does not fit into any of the above',
+      'FIND'   => 'Non-UK Individual (self representing)',
+      'FCORP'  => 'Non-UK Corporation',
+      'FOTHER' => 'Non-UK Entity that does not fit into any of the above'
+    }
+    
+    attribute :county,              String
+  # attribute :locality,            String                     # DEPRECATED
+  # attribute :mobile,              String                     # DEPRECATED
+    attribute :opt_out,             Boolean, :default => false # Y = hide, N = no hide, only for FIND or IND
+    attribute :organization_type,   String                     # Required, must be one of ORGANIZATION_TYPES
+    attribute :organization_number, String                     # Required if LTD, PLC, LLP, IP, SCH, RCHAR
+    attribute :registration_number, String                     # Required for LTD, PLC, LLP, IP, SCH, RCHAR
+    
+    def registrant_params
+      params = {'registrant_county' => @county, 'registrant_dotukorgtype' => @organization_type}
+      if %w[LTD PLC LLP IP SCH RCHAR].include?(@organization_type)
+        params.merge!({
+          'registrant_dotukorgno' => @organization_number, 
+          'registrant_dotukregistrationnumber' => @registration_number
+        })
+      end
+      returns params
+    end
+    
+    def optional_params
+      params = {} 
+      if %w[IND FIND].include?(@organization_type)
+        params.merge!({"#{@contact_type.to_s}_dotukoptout" => @opt_out ? 'Y' : 'N'})
+      end
+      return params
+    end
+    
+    def valid?(inputs = {})
+      ensure_attribute_has_value :county, :organization_type
+      unless ORGANIZATION_TYPES.has_key?(@organization_type)
+        @errors << "organization_type must be one in ORGANIZATION_TYPES"
+      end
+      if %w[LTD PLC LLP IP SCH RCHAR].include?(@organization_type)
+        ensure_attribute_has_value :organization_number, :registration_number
+      end
+      super
+    end
+  end
+end

data/lib/internetbs/dot_us_attributes.rb

@@ -0,0 +1,54 @@
+require_relative 'country_codes'
+
+module InternetBS
+  class DotUSAttributes < AdditionalAttributes
+    PURPOSES = {
+      'P1' => 'Business use for profit',
+      'P2' => 'Non-profit business, club, association, religious organization, etc.',
+      'P3' => 'Personal use',
+      'P4' => 'Educational purposes',
+      'P5' => 'Government purposes'
+    }
+    
+    NEXUS_CATEGORIES = {
+      'C11' => 'A natural person who is a US Citizen',
+      'C12' => 'A natural person who is a Permanent Resident',
+      'C21' => 'An entity or organization that is (i) incorporated within one of the fifty US states, the District of Columbia, or any of the US possessions or territories, or (ii) organized or otherwise constituted under the laws of a state of the US, the District of Columbia or any of its possessions and territories (including federal, state, or local government of the US, or a political subdivision thereof, and non-commercial organizations based in the US.)',
+      'C31' => 'A foreign organization that regularly engages in lawful activities (sales of goods or services or other business, commercial, or non-commercial, including not for profit relations) in the United States.',
+      'C32' => 'Organization has an office or other facility in the US'
+    }
+    
+    attribute :purpose,        String # Required - one of PURPOSES
+    attribute :nexus_category, String # Required - one of NEXUS_CATEGORIES
+    attribute :nexus_country,  String # Required if nexus_category is C31 or C32 - one of COUNTRY_CODES
+    
+    def registrant_params
+      params = {'registrant_uspurpose' => @purpose, 'registrant_usnexuscategory' => @nexus_category}
+      if ['C31', 'C32'].include?(@nexus_category)
+        params.merge!({'registrant_usnexuscountry' => @nexus_country})
+      end
+      return params
+    end
+    
+    def valid?(inputs = {})
+      ensure_attribute_has_value :purpose, :nexus_category
+      unless PURPOSES.include?(@purpose)
+        @errors << "purpose must be one in PURPOSES"
+      end
+      unless NEXUS_CATEGORIES.inlcude?(@nexus_category)
+        @errors << "nexus_category must be one in NEXUS_CATEGORIES"
+      end
+      case @nexus_category
+      when 'C31', 'C32'
+        unless @nexus_country
+          @errors << "nexus_country is required"
+        else
+          unless COUNTRY_CODES.has_key?(@nexus_country)
+            @errors << "nexus_country must be one in COUNTRY_CODES"
+          end
+        end
+      end
+      super
+    end
+  end
+end

data/lib/internetbs/error.rb

@@ -0,0 +1,38 @@
+module InternetBS
+  class Error
+    
+    # 100001  Unexpected error occurred!
+    # 100002  Invalid value "{wrong_value}" for parameter "{parameter_name}"!
+    # 100003  Required parameter "{parameter_name}" missing!
+    # 100004  The domain {domain_name} has a not supported extension!
+    # 100005  The domain "{domain_name}" is not accessible. Permission denied!
+    # 100008  Invalid operation!
+    # 100010  The current domain status prohibits this operation!
+    # 100013  Registry not available
+    # 100014  Feature not supported for {entity_name}
+    # 100015  Value "{value_example}" is out of range for parameter {parameter_name}
+    # 100021  Invallid integer value "{value_example}"!
+    # 100026  Parameter {parameter_name} and {parameter_name} cannot be used both at the same time. They are mutually exclusive
+    # 100028  Maximum length exceeded for {entity_name}, given {given_value}, maximum allowed {limit}
+    # 100029  Parameter(s) {parameter_name} not recognized by the command
+    # 100033  Value "{value_example}" is out of range
+    # 107001  Account locked
+    # 107002  Invalid API key and/or Password
+    # 107003  Daily limit exceeded for command
+    # 107004  Hourly limit exceeded for command
+    # 107005  Minute limit exceeded for command
+    # 107006  Monthly limit exceeded for command
+    # 107007  Weekly limit exceeded for command
+    # 107008  Daily global API usage limit exceeded
+    # 107009  Hourly global API usage limit exceeded
+    # 107010  Minute global API usage limit exceeded
+    # 107011  Monthly global API usage limit exceeded
+    # 107012  Weekly global API usage limit exceeded
+    # 107013  API command does not exist!
+    # 107015  Unexpected ERROR: Tech department has been notified!
+    # 107016  API temporary blocked, please contact us at {support_email}
+    # 107017  Connection refused from unauthorized host. IP {ip_address} is NOT allowed to access your account
+    # 107018  Authentication error
+    
+  end
+end

data/lib/internetbs/language_codes.rb

@@ -0,0 +1,27 @@
+module InternetBS
+  LANGUAGE_CODES = {
+    "cs" => "Čeština",
+    "da" => "Dansk",
+    "de" => "Deutsch",
+    "el" => "Ελληνικά",
+    "en" =  "English",
+    "es" => "Espanol",
+    "et" => "Eesti",
+    "fi" => "Suomi",
+    "fr" => "Francais",
+    "hu" => "Magyar",
+    "it" => "Italiano",
+    "lt" => "Lithuanian",
+    "lv" => "Latviešu",
+    "mt" => "Malti",
+    "nl" => "Nederlands",
+    "pl" => "Polski",
+    "pt" => "Português",
+    "sk" => "Slovenčina",
+    "sl" => "Slovenščina",
+    "sv" => "Svenska",
+    "ro" => "Romana",
+    "bg" => "Bulgarian",
+    "ga" => "Irish"
+  }
+end

data/lib/internetbs/order_domain.rb

@@ -0,0 +1,78 @@
+module InternetBS
+  class OrderDomain < Base
+    attribute :auto_renew,           Boolean                   # YES or NO
+    attribute :contacts,             Array[DomainContact]
+    attribute :currency,             String, :default => 'USD'
+    attribute :discount_code,        String 
+    attribute :domain,               String
+    attribute :domain_extension,     String 
+    attribute :nameservers,          Array[String]
+    attribute :period,               String                    # 1Y, 2Y up to 10Y
+    attribute :private_whois,        String                    # DISABLED or FULL or PARTIAL
+    attribute :registrar_lock,       String                    # ENABLED or DISABLED or NOTADMITTED
+    attribute :tel_hosting_account,  String                    # .tel domains only
+    attribute :tel_hosting_password, String                    # .tel domains only
+    attribute :tel_hide_whois_data,  Boolean                   # .tel domains only, either YES or NO
+    attribute :total_price,          Float
+    attribute :transfer_auth_info,   String
+    
+    def purchase!
+      ensure_attribute_has_value :domain
+      return false if @errors.any?
+      
+      @domain_extension = @domain.split('.').last
+      
+      params = {
+        'domain'   => @domain, 
+        'currency' => @currency,
+        'period'   => @period,
+        'ns_list'  => @nameservers.join(',')
+      }
+      
+      params.merge!({'transferauthinfo' => @transfer_auth_info}) if @transfer_auth_info
+      parmas.merge!({'registrarlock' => @registrar_lock}) if @registrar_lock
+      params.merge!({'privatewhois' => @private_whois}) if @private_whois
+      params.merge!({'discountcode' => @discount_code}) if @discount_code
+      params.merge!({'autorenew' => @auto_renew ? 'YES' : 'NO'}) if @auto_renew
+      
+      @contacts.each do |contact|
+        params.merge!(contact.params)
+      end
+
+      if @domain_extension == "tel"
+        params.merge!({
+          'telhostingaccount' => @tel_hosting_account,
+          'telhostingpassword' => @tel_hosting_password
+        })
+        if @tel_hide_whois_data
+          params.merge!({'telhidewhoisdata' => @tel_hide_whois_data ? 'YES' : 'NO'})
+        end
+      end
+      
+      response = Client.post('/domain/create', params)
+      code = response.code rescue ""
+      
+      case code
+      when '200'
+        hash = JSON.parse(response.body)
+
+        @status = hash['status']
+        @transaction_id = hash['transactid']
+        
+        if @status == 'SUCCESS'
+          @currency    = hash['currency']
+          @total_price = hash['price']
+        else
+          set_errors(response)
+          return false
+        end
+                
+        return true
+      else
+        set_errors(response)
+        return false
+      end
+    end
+    
+  end
+end