internetbs 1.0.0

data/internetbs.gemspec

@@ -0,0 +1,18 @@
+require './lib/internetbs/version'
+
+Gem::Specification.new do |gem|
+  gem.name         = 'internetbs'
+  gem.version      = InternetBS::VERSION::STRING
+  gem.authors      = 'Jurgen Jocubeit'
+  gem.email        = 'support@brightcommerce.com'
+  gem.homepage     = 'https://github.com/brightcommerce/internetbs'
+  gem.summary      = InternetBS::VERSION::SUMMARY
+  gem.description  = 'A Ruby API client for InternetBS resellers.'
+  gem.license      = 'MIT'
+  gem.metadata     = { 'copyright' => 'Copyright 2015 Brightcommerce, Inc.' }
+  gem.files        = `git ls-files`.split($/)
+# gem.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_path = 'lib'
+  gem.required_ruby_version = '>= 2.0.0'
+  gem.add_dependency 'virtus', '~> 1.0.3'
+end

data/lib/internetbs.rb

@@ -0,0 +1,64 @@
+module InternetBS
+  autoload :AccountBalance,      'internetbs/account_balance'
+  autoload :AccountBalances,     'internetbs/account_balances'
+  autoload :AccountDomain,       'internetbs/account_domain'
+  autoload :AccountDomains,      'internetbs/account_domains'
+  autoload :AccountPrice,        'internetbs/account_price'
+  autoload :AccountPrices,       'internetbs/account_prices'
+  autoload :AccountTransaction,  'internetbs/account_transaction'
+  autoload :AccountTransactions, 'internetbs/account_transactions'
+  autoload :Base,                'internetbs/base'
+  autoload :Client,              'internetbs/client'
+  autoload :Configuration,       'internetbs/configuration'
+  autoload :DomainAvailability,  'internetbs/domain_availability'
+  autoload :DomainContact,       'internetbs/domain_contact'
+  autoload :DomainHost,          'internetbs/domain_host'
+  autoload :DomainHosts,         'internetbs/domain_hosts'
+  autoload :DomainInformation,   'internetbs/domain_information'
+  autoload :DomainPush,          'internetbs/domain_push'
+  autoload :DomainRecord,        'internetbs/domain_record'
+  autoload :DomainRecords,       'internetbs/domain_records'
+  autoload :DomainTotal,         'internetbs/domain_total'
+  autoload :DotAsiaAttributes,   'internetbs/dot_asia_attributes'
+  autoload :DotDEAttributes,     'internetbs/dot_de_attributes'
+  autoload :DotEUAttributes,     'internetbs/dot_eu_attributes'
+  autoload :DotFRAttributes,     'internetbs/dot_fr_attributes'
+  autoload :DotITAttributes,     'internetbs/dot_it_attributes'
+  autoload :DotNLAttributes,     'internetbs/dot_nl_attributes'
+  autoload :DotUKAttributes,     'internetbs/dot_uk_attributes'
+  autoload :DotUSAttributes,     'internetbs/dot_us_attributes'
+  autoload :OrderDomain,         'internetbs/order_domain'
+  autoload :PrivateWhois,        'internetbs/private_whois'
+  autoload :RegistrarLock,       'internetbs/registrar_lock'
+  autoload :RegistryStatus,      'internetbs/registry_status'
+  autoload :RenewDomain,         'internetbs/renew_domain'
+  autoload :UpdateDomain,        'internetbs/update_domain'
+
+  @@configuration = nil
+  
+  def self.configure
+    @@configuration = Configuration.new
+    yield(configuration) if block_given?
+    configuration
+  end
+
+  def self.configuration
+    @@configuration || configure
+  end
+  
+  def self.method_missing(method_sym, *arguments, &block)
+    if configuration.respond_to?(method_sym)
+      configuration.send(method_sym)
+    else
+      super
+    end
+  end
+
+  def self.respond_to?(method_sym, include_private = false)
+    if configuration.respond_to?(method_sym, include_private)
+      true
+    else
+      super
+    end    
+  end
+end

data/lib/internetbs/account_balance.rb

@@ -0,0 +1,8 @@
+module InternetBS
+  class AccountBalance
+    include Virtus.model
+    
+    attribute :currency, String
+    attribute :amount,   Float
+  end
+end

data/lib/internetbs/account_balances.rb

@@ -0,0 +1,40 @@
+module InternetBS
+  class AccountBalances < Base
+    attribute :list,     Array[AccountBalance]
+    attribute :currency, String
+
+    def fetch
+      @errors.clear
+      
+      params = {} 
+      params.merge!({'currency' => @currency}) if @currency
+      response = Client.get('/account/balance/get', 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['balance'].each do |balance|
+            @list << AccountBalance.new(
+              :amount => balance['amount'], 
+              :currency => balance['currency']
+            )
+          end
+        else
+          set_errors(response)
+          return false
+        end
+        
+        return true
+      else
+        set_errors(response)
+        return false
+      end
+    end
+  end
+end

data/lib/internetbs/account_domain.rb

@@ -0,0 +1,11 @@
+module InternetBS
+  class AccountDomain
+    include Virtus.model
+    
+    attribute :name,               String
+    attribute :expiration_date,    Date
+    attribute :registrar_lock,     String # ENABLED or DISABLED or NOTADMITTED
+    attribute :status,             String
+    attribute :transfer_auth_info, String
+  end
+end

data/lib/internetbs/account_domains.rb

@@ -0,0 +1,100 @@
+module InternetBS
+  class AccountDomains < Base
+    attribute :compact_list,          Boolean, :default => true         # YES or NO
+    attribute :expiring_only,         Integer                           # Number of days
+    attribute :extension_filter,      String
+    attribute :pending_transfer_only, Boolean, :default => false        # YES or NO
+    attribute :range_from,            Integer
+    attribute :range_to,              Integer
+    attribute :search_term_filter,    String
+    attribute :list,                  Array[AccountDomain]
+    attribute :sort_by,               String, :default => 'DOMAIN_NAME' # DOMAIN_NAME, DOMAIN_NAME_DESC, EXPIRATION, EXPIRATION_DESC
+    attribute :total_domains,         Integer
+    attribute :total_domains_by_tld,  Array[DomainTotal]
+    
+    def fetch
+      @errors.clear
+      @list.clear
+      @total_domains = 0
+      @total_domains_by_tld = 0
+      
+      params = {'compactlist' => @compact_list ? 'YES' : 'NO', 'sortby' => @sort_by}
+      params.merge!({'expiringonly' => @expiring_only}) if @expiring_only
+      params.merge!({'extensionfilter' => @extension_filter}) if @extension_filter
+      params.merge!({'pendingtransferonly' => 'YES'}) if @pending_transfer_only
+      params.merge!({'rangefrom' => @range_from, 'rangeto' => @range_to}) if @range_from && @range_to
+      params.merge!({'searchtermfilter' => @search_term_filter}) if @search_term_filter
+
+      response = Client.get('/domain/list', params)
+      code = response.code rescue ""
+      
+      case code
+      when '200'
+        hash = JSON.parse(response.body)
+        
+        @status = hash.delete('status')
+        @transaction_id = hash.delete('transactid')
+
+        if @status == 'SUCCESS'
+          @total_domains = hash['domaincount']
+          
+          if @compact_list
+            hash['domain'].each do |domain|
+              @list << AccountDomain.new(:name => domain)
+            end
+          else
+            hash['domain'].each do |domain|
+              @list << AccountDomain.new(
+                :name => domain['name'],
+                :expiration_date => domain['expiration'],
+                :registrar_lock => domain['registrarlock'],
+                :status => domain['status'],
+                :transfer_auth_info => domain['transferauthinfo']
+              )
+            end
+          end
+        else
+          set_errors(response)
+          return false
+        end
+        
+        return true
+      else
+        set_errors(response)
+        return false
+      end
+    end
+    
+    def totals
+      @errors.clear
+      
+      response = Client.get('/domain/count')
+      code = response.code rescue ""
+      
+      case code
+      when '200'
+        hash = JSON.parse(response.body)
+        
+        @status = hash.delete('status')
+        @transaction_id = hash.delete('transactid')
+
+        if @status == 'SUCCESS'
+          @total_domains = hash.delete('totaldomains')
+          @total_domains_by_tld.clear
+          
+          hash.each do |tld, total| 
+            @total_domains_by_tld << DomainTotal.new(:tld => tld, :total => total)
+          end
+        else
+          set_errors(response)
+          return false
+        end
+        
+        return true
+      else
+        set_errors(response)
+        return false
+      end
+    end
+  end
+end

data/lib/internetbs/account_price.rb

@@ -0,0 +1,19 @@
+module InternetBS
+  class AccountPrice
+    include Virtus.model
+    
+    attribute :currency,       String
+    attribute :name,           String
+    attribute :operation,      String
+    attribute :price_1_year,   Float
+    attribute :price_2_years,  Float
+    attribute :price_3_years,  Float
+    attribute :price_4_years,  Float
+    attribute :price_5_years,  Float
+    attribute :price_6_years,  Float
+    attribute :price_7_years,  Float
+    attribute :price_8_years,  Float
+    attribute :price_9_years,  Float
+    attribute :price_10_years, Float
+  end
+end

data/lib/internetbs/account_prices.rb

@@ -0,0 +1,70 @@
+module InternetBS
+  class AccountPrices < Base
+    attribute :currency,      String, :default => 'USD'
+    attribute :discount_code, String
+    attribute :level,         String
+    attribute :list,          Array[AccountPrice]
+    attribute :version,       Integer, :default => 1 # 1 or 2
+    
+    def fetch
+      @errors.clear
+      
+      params = {'currency' => @currency, 'version' => @version}
+      optional_params = {'discountcode' => @discount_code}
+      params.merge!(optional_params) if @discount_code
+      
+      response = Client.get('/account/pricelist/get', params)      
+      code = response.code rescue ""
+      
+      case code
+      when '200'
+        hash = JSON.parse(response.body)
+    
+        @status = hash["status"]
+        @transaction_id = hash["transactid"]
+        
+        if @status == 'SUCCESS'
+          case @version
+          when 1
+            hash['product'].each do |product|
+              @list << AccountPrice.new(
+                :currency     => @currency,
+                :name         => product['name'], 
+                :price_1_year => product['price']
+              )
+            end
+          when 2
+            @level    = hash['pricelevel']
+            @currency = hash['currency']
+          
+            hash['product'].each do |product|
+              @list << AccountPrice.new(
+                :currency       => @currency,
+                :name           => product['type'], 
+                :operation      => product['operation'],
+                :price_1_year   => product['period']['1'],
+                :price_2_years  => product['period']['2'],
+                :price_3_years  => product['period']['3'],
+                :price_4_years  => product['period']['4'],
+                :price_5_years  => product['period']['5'],
+                :price_6_years  => product['period']['6'],
+                :price_7_years  => product['period']['7'],
+                :price_8_years  => product['period']['8'],
+                :price_9_years  => product['period']['9'],
+                :price_10_years => product['period']['10']
+              )
+            end
+          end
+        else
+          set_errors(response)
+          return false
+        end
+        
+        return true
+      else
+        set_errors(response)
+        return false
+      end
+    end
+  end
+end

data/lib/internetbs/account_transaction.rb

@@ -0,0 +1,9 @@
+module InternetBS
+  class AccountTransaction
+    include Virtus.model
+    
+    attribute :currency, String
+    attribute :name,     String
+    attribute :price,    Float
+  end
+end

data/lib/internetbs/account_transactions.rb

@@ -0,0 +1,54 @@
+module InternetBS
+  class AccountTransactions < Base
+    attribute :client_transaction_id, String
+    attribute :currency,              String, :default => 'USD'
+    attribute :list,                  Array[AccountTransaction]
+    attribute :response_type,         String, :default => 'EXACT_RESPONSE' # EXACT_RESPONSE, RESPONSE_DATA or REQUEST_DATA
+    
+    def fetch
+      @errors.clear
+      
+      params = {}
+      params.merge!({'transaction_id' => @transaction_id}) if @transaction_id
+      params.merge!({'client_transaction_id' => @client_transaction_id}) if @client_transaction_id
+      
+      response = Client.get('/account/transactioninfo/get', params)
+      code = response.code rescue ""
+      
+      case code
+      when '200'
+        hash = JSON.parse(response.body)
+    
+        @status = hash["status"]
+        @transaction_id = hash["transactid"]
+
+        # Receiving: "FAILURE", "Permission Denied %1%"
+        # This endpoint may require activation by InternetBS themselves?
+        # Documentation exists in PDF only. May be an artifact, but would
+        # expect to receive an error stating the endpoint doesn't exist.
+        debugger
+        puts hash
+        
+        if @status == 'SUCCESS'
+          @currency = hash['currency']
+        
+          hash['product'].each do |product|
+            @list << AccountTransaction.new(
+              :currency => @currency ,
+              :name     => product['name'], 
+              :price    => product['price']
+            )
+          end
+        else
+          set_errors(response)
+          return false
+        end
+        
+        return true
+      else
+        set_errors(response)
+        return false
+      end
+    end
+  end
+end

data/lib/internetbs/additional_attributes.rb

@@ -0,0 +1,41 @@
+module InternetBS
+  class AdditionalAttributes < Base
+    attribute :contact_type,     String # Internal - symbol: one of :registrant, :admin, :billing, :tech, :zone
+    attribute :domain_extension, String
+    
+    def admin_params
+      return {}
+    end
+    
+    def billing_params
+      return {}
+    end
+    
+    # Mandatory attributes for all contact types
+    def mandatory_params
+      return {}
+    end
+    
+    # Optional attributes for all contact types
+    def optional_params
+      return {}
+    end
+    
+    def registrant_params
+      return {}
+    end
+    
+    def valid?(inputs = {})
+      if @errors.any?
+        return false
+      else
+        return true
+      end
+    end
+    
+    # .de domains only - substituted with billing contact
+    def zone_params
+      return {}
+    end
+  end
+end