internetbs 1.0.0

data/lib/internetbs/base.rb

@@ -0,0 +1,33 @@
+require 'virtus'
+
+module InternetBS
+  class Base
+    include Virtus.model
+    include Virtus::Equalizer.new(name || inspect)
+
+    attribute :errors,         Array[String]
+    attribute :status,         String        # SUCCESS or FAILURE or PENDING
+    attribute :transaction_id, String
+
+    def inspect
+      values = Hash[instance_variables.map{|name| [name, instance_variable_get(name)]}]
+      "<#{self.class.name} #{values}>"
+    end
+
+    private
+    
+    def ensure_attribute_has_value(*attributes)
+      @errors.clear
+      attributes.each do |attr|
+        unless instance_variable_get(("@" + attr.to_s).intern)
+          @errors << "#{attr.to_s} is required"
+        end
+      end
+    end
+    
+    def set_errors(response)
+      hash = JSON.parse(response.body)
+      @errors << hash["message"]
+    end
+  end
+end

data/lib/internetbs/client.rb

@@ -0,0 +1,49 @@
+require 'net/http'
+require 'net/https'
+
+module InternetBS
+  class Client
+    @headers = {
+      'User-Agent' => InternetBS::VERSION::SUMMARY,
+      'Accept' => 'application/json'
+    }
+
+    @params = {
+      :apikey => InternetBS.api_key,
+      :password => InternetBS.api_pwd,
+      :responseformat => 'json'
+    }
+    
+    def self.get(endpoint, params = {})
+      begin
+        uri = URI.parse([InternetBS.api_uri, endpoint].join)
+        @params.merge!(params) if params.any?
+        uri.query = URI.encode_www_form(@params)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        request = Net::HTTP::Get.new(uri, @headers)
+        response = http.request(request)
+      rescue StandardError => error
+        puts "Request failed (#{error.message})"
+      end
+    end
+    
+    def self.post(endpoint, params = {})
+      begin
+        uri = URI.parse([InternetBS.api_uri, endpoint].join)
+        uri.query = URI.encode_www_form(@params)
+        body = URI.encode_www_form(params)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        request = Net::HTTP::Post.new(uri, @headers)
+        request.add_field "Content-Type", "application/x-www-form-urlencoded"
+        request.body = body
+        response = http.request(request)
+      rescue StandardError => error
+        puts "Request failed (#{error.message})"
+      end
+    end
+  end
+end

data/lib/internetbs/configuration.rb

@@ -0,0 +1,61 @@
+module InternetBS
+  class Configuration
+    attr_writer :credentials
+    
+    def api_key
+      InternetBS.credentials[InternetBS.environment][:api_key]
+    end
+    
+    def api_key=(value)
+      InternetBS.credentials[InternetBS.environment][:api_key] = value
+    end
+
+    def api_pwd
+      InternetBS.credentials[InternetBS.environment][:api_pwd]
+    end
+    
+    def api_pwd=(value)
+      InternetBS.credentials[InternetBS.environment][:api_pwd] = value
+    end
+    
+    def api_uri
+      InternetBS.credentials[InternetBS.environment][:api_uri]
+    end
+    
+    def api_uri=(value)
+      InternetBS.credentials[InternetBS.environment][:api_uri] = value
+    end
+    
+    def credentials
+      @credentials ||= {
+        :production => {
+          :api_key => ENV['INTERNETBS_API_KEY'],
+          :api_pwd => ENV['INTERNETBS_API_PWD'],
+          :api_uri => "https://api.internet.bs"
+        },
+        :test => {
+          :api_key => "testapi",
+          :api_pwd => "testpass",
+          :api_uri => "https://testapi.internet.bs"
+        },
+        :development => {
+          :api_key => "testapi",
+          :api_pwd => "testpass",
+          :api_uri => "https://testapi.internet.bs"
+        }
+      }
+    end
+    
+    def environment
+      @environment ||= :production
+    end
+    
+    def environment=(value)
+      @environment = value.is_a?(String) ? value.to_sym : value
+    end
+    
+    def environments
+      InternetBS.credentials.keys
+    end
+  end
+end

data/lib/internetbs/country_codes.rb

@@ -0,0 +1,288 @@
+module InternetBS
+  # This list is derived from https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
+  # The hash keys are ISO_3166-1_alpha-2 codes and the values are the country display name.
+  # The top 20 countries by number of Internet users are grouped first, see
+  # https://en.wikipedia.org/wiki/List_of_countries_by_number_of_Internet_users.
+  COUNTRY_CODES = {
+    "BR" =>	"Brazil",
+    "CA" =>	"Canada",	
+    "CN" =>	"China",	
+    "EG" =>	"Egypt",	
+    "FR" =>	"France",	
+    "DE" =>	"Germany",	
+    "IN" =>	"India",	
+    "ID" =>	"Indonesia",	
+    "IT" =>	"Italy",	
+    "JP" =>	"Japan",	
+    "MX" =>	"Mexico",	
+    "NG" =>	"Nigeria",	
+    "PH" =>	"Philippines",	
+    "RU" =>	"Russian Federation",
+    "ES" =>	"Spain",	
+    "KR" =>	"South Korea",
+    "TR" =>	"Turkey",	
+    "GB" =>	"United Kingdom",	
+    "US" =>	"United States",	
+    "VN" =>	"Vietnam",
+    "AD" =>	"Andorra",	
+    "AE" =>	"United Arab Emirates",	
+    "AF" =>	"Afghanistan",	
+    "AG" =>	"Antigua and Barbuda",	
+    "AI" =>	"Anguilla",	
+    "AL" =>	"Albania",	
+    "AM" =>	"Armenia",	
+    "AO" =>	"Angola",	
+    "AQ" =>	"Antarctica",	
+    "AR" =>	"Argentina",	
+    "AS" =>	"American Samoa",	
+    "AT" =>	"Austria",	
+    "AU" =>	"Australia",	
+    "AW" =>	"Aruba",	
+    "AX" =>	"Åland Islands",	
+    "AZ" =>	"Azerbaijan",	
+    "BA" =>	"Bosnia and Herzegovina",	
+    "BB" =>	"Barbados",	
+    "BD" =>	"Bangladesh",	
+    "BE" =>	"Belgium",	
+    "BF" =>	"Burkina Faso",	
+    "BG" =>	"Bulgaria",	
+    "BH" =>	"Bahrain",	
+    "BI" =>	"Burundi",	
+    "BJ" =>	"Benin",	
+    "BL" =>	"Saint Barthélemy",	
+    "BM" =>	"Bermuda",	
+    "BN" =>	"Brunei",
+    "BO" =>	"Bolivia",
+    "BQ" =>	"Bonaire, Sint Eustatius and Saba	Caribbean Netherlands",
+    "BS" =>	"Bahamas",
+    "BT" =>	"Bhutan",	
+    "BV" =>	"Bouvet Island",	
+    "BW" =>	"Botswana",	
+    "BY" =>	"Belarus",	
+    "BZ" =>	"Belize",	
+    "CC" =>	"Cocos (Keeling) Islands",	
+    "CD" =>	"Congo, the Democratic Republic of",
+    "CF" =>	"Central African Republic",	
+    "CG" =>	"Congo",
+    "CH" =>	"Switzerland",	
+    "CI" =>	"Côte d'Ivoire",	
+    "CK" =>	"Cook Islands",	
+    "CL" =>	"Chile",	
+    "CM" =>	"Cameroon",	
+    "CO" =>	"Colombia",	
+    "CR" =>	"Costa Rica",	
+    "CU" =>	"Cuba",	
+    "CV" =>	"Cabo Verde",	
+    "CW" =>	"Curaçao",	
+    "CX" =>	"Christmas Island",	
+    "CY" =>	"Cyprus",	
+    "CZ" =>	"Czech Republic",	
+    "DJ" =>	"Djibouti",	
+    "DK" =>	"Denmark",	
+    "DM" =>	"Dominica",	
+    "DO" =>	"Dominican Republic",	
+    "DZ" =>	"Algeria",	
+    "EC" =>	"Ecuador",	
+    "EE" =>	"Estonia",	
+    "EH" =>	"Western Sahara",	
+    "ER" =>	"Eritrea",	
+    "ET" =>	"Ethiopia",	
+    "FI" =>	"Finland",	
+    "FJ" =>	"Fiji",	
+    "FK" =>	"Falkland Islands (Malvinas)",
+    "FM" =>	"Federated States of Micronesia",
+    "FO" =>	"Faroe Islands",	
+    "GA" =>	"Gabon",	
+    "GD" =>	"Grenada",	
+    "GE" =>	"Georgia",
+    "GF" =>	"French Guiana",	
+    "GG" =>	"Guernsey",	
+    "GH" =>	"Ghana",	
+    "GI" =>	"Gibraltar",	
+    "GL" =>	"Greenland",	
+    "GM" =>	"Gambia",
+    "GN" =>	"Guinea",	
+    "GP" =>	"Guadeloupe",	
+    "GQ" =>	"Equatorial Guinea",	
+    "GR" =>	"Greece",	
+    "GS" =>	"South Georgia and the South Sandwich Islands",	
+    "GT" =>	"Guatemala",	
+    "GU" =>	"Guam",	
+    "GW" =>	"Guinea-Bissau",	
+    "GY" =>	"Guyana",	
+    "HK" =>	"Hong Kong",	
+    "HM" =>	"Heard Island and McDonald Islands",	
+    "HN" =>	"Honduras",	
+    "HR" =>	"Croatia",	
+    "HT" =>	"Haiti",	
+    "HU" =>	"Hungary",	
+    "IE" =>	"Ireland",
+    "IL" =>	"Israel",	
+    "IM" =>	"Isle of Man",	
+    "IO" =>	"British Indian Ocean Territory",	
+    "IQ" =>	"Iraq",	
+    "IR" =>	"Iran",
+    "IS" =>	"Iceland",	
+    "JE" =>	"Jersey",	
+    "JM" =>	"Jamaica",	
+    "JO" =>	"Jordan",	
+    "KE" =>	"Kenya",	
+    "KG" =>	"Kyrgyzstan",	
+    "KH" =>	"Cambodia",	
+    "KI" =>	"Kiribati",	
+    "KM" =>	"Comoros",	
+    "KN" =>	"Saint Kitts and Nevis",	
+    "KP" =>	"North Korea",
+    "KW" =>	"Kuwait",	
+    "KY" =>	"Cayman Islands",	
+    "KZ" =>	"Kazakhstan",	
+    "LA" =>	"Laos",
+    "LB" =>	"Lebanon",	
+    "LC" =>	"Saint Lucia",	
+    "LI" =>	"Liechtenstein",	
+    "LK" =>	"Sri Lanka",	
+    "LR" =>	"Liberia",	
+    "LS" =>	"Lesotho",	
+    "LT" =>	"Lithuania",	
+    "LU" =>	"Luxembourg",	
+    "LV" =>	"Latvia",	
+    "LY" =>	"Libya",	
+    "MA" =>	"Morocco",	
+    "MC" =>	"Monaco",	
+    "MD" =>	"Moldova",
+    "ME" =>	"Montenegro",	
+    "MF" =>	"Saint Martin (French part)", 
+    "MG" =>	"Madagascar",	
+    "MH" =>	"Marshall Islands",	
+    "MK" =>	"Macedonia",
+    "ML" =>	"Mali",	
+    "MM" =>	"Myanmar",	
+    "MN" =>	"Mongolia",	
+    "MO" =>	"Macao",
+    "MP" =>	"Northern Mariana Islands",	
+    "MQ" =>	"Martinique",	
+    "MR" =>	"Mauritania",	
+    "MS" =>	"Montserrat",	
+    "MT" =>	"Malta",	
+    "MU" =>	"Mauritius",	
+    "MV" =>	"Maldives",	
+    "MW" =>	"Malawi",	
+    "MY" =>	"Malaysia",	
+    "MZ" =>	"Mozambique",	
+    "NA" =>	"Namibia",	
+    "NC" =>	"New Caledonia",	
+    "NE" =>	"Niger",	
+    "NF" =>	"Norfolk Island",	
+    "NI" =>	"Nicaragua",	
+    "NL" =>	"Netherlands",	
+    "NO" =>	"Norway",
+    "NP" =>	"Nepal",	
+    "NR" =>	"Nauru",	
+    "NU" =>	"Niue",	
+    "NZ" =>	"New Zealand",	
+    "OM" =>	"Oman",	
+    "PA" =>	"Panama",	
+    "PE" =>	"Peru",	
+    "PF" =>	"French Polynesia",	
+    "PG" =>	"Papua New Guinea",	
+    "PK" =>	"Pakistan",	
+    "PL" =>	"Poland",	
+    "PM" =>	"Saint Pierre and Miquelon",	
+    "PN" =>	"Pitcairn",
+    "PR" =>	"Puerto Rico",	
+    "PS" =>	"Palestine",
+    "PT" =>	"Portugal",	
+    "PW" =>	"Palau",	
+    "PY" =>	"Paraguay",	
+    "QA" =>	"Qatar",	
+    "RE" =>	"Réunion",	
+    "RO" =>	"Romania",	
+    "RS" =>	"Serbia",	
+    "RW" =>	"Rwanda",	
+    "SA" =>	"Saudi Arabia",	
+    "SB" =>	"Solomon Islands",	
+    "SC" =>	"Seychelles",	
+    "SD" =>	"Sudan",	
+    "SE" =>	"Sweden",	
+    "SG" =>	"Singapore",	
+    "SH" =>	"Saint Helena, Ascension and Tristan da Cunha",	
+    "SI" =>	"Slovenia",	
+    "SJ" =>	"Svalbard and Jan Mayen",	
+    "SK" =>	"Slovakia",	
+    "SL" =>	"Sierra Leone",	
+    "SM" =>	"San Marino",	
+    "SN" =>	"Senegal",	
+    "SO" =>	"Somalia",	
+    "SR" =>	"Suriname",	
+    "SS" =>	"South Sudan",	
+    "ST" =>	"Sao Tome and Principe",
+    "SV" =>	"El Salvador",	
+    "SX" =>	"Sint Maarten (Dutch part)",
+    "SY" =>	"Syria",
+    "SZ" =>	"Swaziland",	
+    "TC" =>	"Turks and Caicos Islands",	
+    "TD" =>	"Chad",	
+    "TF" =>	"French Southern Territories",
+    "TG" =>	"Togo",	
+    "TH" =>	"Thailand",	
+    "TJ" =>	"Tajikistan",	
+    "TK" =>	"Tokelau",	
+    "TL" =>	"Timor-Leste",
+    "TM" =>	"Turkmenistan",	
+    "TN" =>	"Tunisia",	
+    "TO" =>	"Tonga",	
+    "TT" =>	"Trinidad and Tobago",	
+    "TV" =>	"Tuvalu",	
+    "TW" =>	"Taiwan",	
+    "TZ" =>	"Tanzania",
+    "UA" =>	"Ukraine",	
+    "UG" =>	"Uganda",	
+    "UM" =>	"United States Minor Outlying Islands",	
+    "UY" =>	"Uruguay",	
+    "UZ" =>	"Uzbekistan",	
+    "VA" =>	"Vatican City",
+    "VC" =>	"Saint Vincent and the Grenadines",	
+    "VE" =>	"Venezuela",
+    "VG" =>	"Virgin Islands, British",
+    "VI" =>	"Virgin Islands, U.S.",
+    "VU" =>	"Vanuatu",	
+    "WF" =>	"Wallis and Futuna",	
+    "WS" =>	"Samoa",	
+    "YE" =>	"Yemen",	
+    "YT" =>	"Mayotte",	
+    "ZA" =>	"South Africa",	
+    "ZM" =>	"Zambia",	
+    "ZW" =>	"Zimbabwe"	
+  }
+  
+  COUNTRY_CODES_EU = {
+    "AT" =>	"Austria",
+    "BE" =>	"Belgium",
+    "BG" =>	"Bulgaria",
+    "HR" =>	"Croatia",
+    "CY" =>	"Cyprus",
+    "CZ" =>	"Czech Republic",
+    "DK" =>	"Denmark",
+    "EE" =>	"Estonia",
+    "FI" =>	"Finland",
+    "FR" =>	"France",
+    "DE" =>	"Germany",
+    "GR" =>	"Greece",
+    "HU" =>	"Hungary",
+    "IE" =>	"Ireland",
+    "IT" =>	"Italy",
+    "LV" =>	"Latvia",
+    "LT" =>	"Lithuania",
+    "LU" =>	"Luxembourg",
+    "MT" =>	"Malta",
+    "NL" =>	"Netherlands",
+    "PL" =>	"Poland",
+    "PT" =>	"Portugal",
+    "RO" =>	"Romania",
+    "SK" =>	"Slovakia",
+    "SI" =>	"Slovenia",
+    "ES" =>	"Spain",
+    "SE" =>	"Sweden",
+    "GB" =>	"United Kingdom"
+  }
+end

data/lib/internetbs/domain_availability.rb

@@ -0,0 +1,37 @@
+module InternetBS
+  class DomainAvailability < Base
+    attribute :domain,                 String
+    attribute :max_reg_period,         String
+    attribute :min_reg_period,         String
+    attribute :private_whois_allowed,  Boolean
+    attribute :realtime_registration,  Boolean
+    attribute :registrar_lock_allowed, Boolean
+    
+    def fetch
+      ensure_attribute_has_value :domain
+      return false if @errors.any?
+      
+      params = {'domain' => @domain}
+      response = Client.get('/domain/check', params)
+      code = response.code rescue ""
+      
+      case code
+      when '200'
+        hash = JSON.parse(response.body)
+        
+        @status = hash['status']
+        @transaction_id = hash['transactid']
+        @max_registration_period = hash['maxregperiod']
+        @min_registration_period = hash['minregperiod']
+        @private_whois_allowed   = hash['privatewhoisallowed']  == 'YES' ? true : false
+        @realtime_registration   = hash['realtimeregistration'] == 'YES' ? true : false
+        @registrar_lock_allowed  = hash['registrarlockallowed'] == 'YES' ? true : false
+        
+        return true
+      else
+        set_errors(response)
+        return false
+      end
+    end
+  end
+end