netsol 0.1 → 0.2.0

data/api_docs/PartnerProtocol_XML_DTD_6.8/UserLookupResponse.dtd

@@ -0,0 +1,47 @@
+<!-- ===================================================================== -->
+<!-- ====  User Lookup Response Message and Body Declaration. ============ -->
+<!-- ===================================================================== -->
+
+<!ELEMENT UserLookupResponse (ResponseHeader, Body)>
+<!ELEMENT Body (Status, User*)>
+<!ELEMENT User (Individual | Business)>
+
+<!ELEMENT Individual (
+   UserID, 
+   NicHandle?, 
+   LoginName?, 
+   FirstName, 
+   MiddleName?, 
+   LastName, 
+   Address, 
+   Phone, 
+   Fax?, 
+   Email, 
+   AuthQuestion, 
+   AuthAnswer,
+   SupplementalRegistryData?,
+   Password? ) >
+	
+<!ELEMENT Business (
+   UserID, 
+   NicHandle?, 
+   LoginName?, 
+   CompanyName, 
+   Address, 
+   Phone, 
+   Fax?, 
+   Email?, 
+   LegalContact, 
+   AuthQuestion, 
+   AuthAnswer,
+   SupplementalRegistryData? ) >
+
+
+<!-- ===================================================================== -->
+<!-- ==== Inclusion of externally defined elements. ====================== -->
+<!-- ===================================================================== -->
+
+<!ENTITY % ResponseHeader SYSTEM "ResponseHeader.dtd">
+%ResponseHeader;
+
+<!-- sccsID "%TC-INFO%" -->

data/api_docs/PartnerProtocol_XML_DTD_6.8/UserRequest.dtd

@@ -0,0 +1,118 @@
+<!-- ===================================================================== -->
+<!-- ====  User Request Message and Body Declaration. ==================== -->
+<!-- ===================================================================== -->
+
+<!ELEMENT UserRequest (RequestHeader, Body)>
+<!ELEMENT Body (
+	( CreateIndividual | 
+	  CreateBusiness | 
+	  ModifyIndividual	|
+	  ModifyBusiness | 
+	  IndividualNewInfo | 
+	  BusinessNewInfo |
+	  CreateRegistryContact |
+	  ExtendCARegistrantApproval ) ) >
+	  
+<!ELEMENT CreateIndividual (
+   LoginName?, 
+   Password, 
+   FirstName, 
+   MiddleName?, 
+   LastName, 
+   Address, 
+   Phone, 
+   Fax?, 
+   Email, 
+   AuthQuestion, 
+   AuthAnswer,
+   SupplementalRegistryData?) >
+	
+<!ELEMENT ModifyIndividual (
+   AuthorizedAgent, 
+   CustomerID, 
+   NewLoginName?, 
+   NewPassword?, 
+   FirstName?, 
+   MiddleName?, 
+   LastName?, 
+   Address?, 
+   Phone?, 
+   Fax?, 
+   Email?, 
+   (AuthQuestion, AuthAnswer)?,
+   SupplementalRegistryData? ) >
+	
+<!ELEMENT CreateBusiness (
+   LoginName?, 
+   Password, 
+   CompanyName, 
+   Address, 
+   Phone, 
+   Fax?, 
+   Email, 
+   LegalContact, 
+   AuthQuestion, 
+   AuthAnswer,
+   SupplementalRegistryData?) >
+	
+<!ELEMENT ModifyBusiness (
+   AuthorizedAgent, 
+   CustomerID, 
+   NewLoginName?, 
+   NewPassword?, 
+   CompanyName?, 
+   Address?, 
+   Phone?, 
+   Fax?, 
+   Email?, 
+   LegalContact?, 
+   (AuthQuestion, AuthAnswer)?,
+   SupplementalRegistryData? ) >
+
+<!-- Remove all old information and replace with new. -->
+<!ELEMENT IndividualNewInfo (
+   AuthorizedAgent, 
+   CustomerID, 
+   FirstName, 
+   MiddleName?, 
+   LastName, 
+   Address, 
+   Phone, 
+   Fax?, 
+   Email ) >
+
+<!-- Remove all old information and replace with new. -->
+<!ELEMENT BusinessNewInfo (
+   AuthorizedAgent, 
+   CustomerID, 
+   CompanyName, 
+   Address, 
+   Phone, 
+   Fax?, 
+   Email, 
+   LegalContact ) >
+   
+   	
+<!-- ==== Create user login name, password at Registry for specific TLDs ===== -->
+<!ELEMENT CreateRegistryContact (
+   AuthorizedAgent, 
+   CustomerID, 
+   RegistryContact) >
+
+
+<!ELEMENT NewLoginName (#PCDATA)>
+<!ELEMENT NewPassword (#PCDATA)>
+<!ELEMENT RegistryContact (DotTELRegistryContact?)>
+<!ELEMENT DotTELRegistryContact (LoginName, Password)>
+
+<!-- === Extend .CA Registrant approval request ======= -->
+<!ELEMENT ExtendCARegistrantApproval (AuthorizedAgent, CustomerID)>
+
+<!-- ===================================================================== -->
+<!-- ==== Inclusion of externally defined elements. ====================== -->
+<!-- ===================================================================== -->
+
+<!ENTITY % RequestHeader SYSTEM "RequestHeader.dtd">
+%RequestHeader;
+
+<!-- sccsID "%TC-INFO%" -->

data/api_docs/PartnerProtocol_XML_DTD_6.8/UserResponse.dtd

@@ -0,0 +1,21 @@
+<!-- ===================================================================== -->
+<!-- ====  User Response Message and Body Declaration. =================== -->
+<!-- ===================================================================== -->
+
+<!ELEMENT UserResponse (ResponseHeader, Body)>
+
+<!ELEMENT Body (
+	Status, 
+	UserID?, 
+	NicHandle?, 
+	LoginName? ) >
+
+
+<!-- ===================================================================== -->
+<!-- ==== Inclusion of externally defined elements. ====================== -->
+<!-- ===================================================================== -->
+
+<!ENTITY % ResponseHeader SYSTEM "ResponseHeader.dtd">
+%ResponseHeader;
+
+<!-- sccsID "%TC-INFO%" -->

data/api_docs/PartnerProtocol_XML_DTD_6.8/WebForwardingProduct.dtd

@@ -0,0 +1,15 @@
+<!-- ===================================================================== -->
+<!-- ====  Web Forwarding product actions =========================== -->
+<!-- ===================================================================== -->
+<!-- ====  Create Web Forwarding for existing domain ==== -->
+<!ELEMENT CreateWebForwarding (WebForwardingProduct+, PurchasePeriod)>
+<!-- ====  Modify Web Forwarding products only ===================== -->
+<!ELEMENT ModifyWebForwarding (WebForwardingProduct+)>
+<!-- ====  Delete Web Forwarding products only ===================== -->
+<!ELEMENT DeleteWebForwarding (DomainName+)>
+<!-- ====  Renew Web Forwarding products only ====================== -->
+<!ELEMENT RenewWebForwarding (DomainName+, PurchasePeriod)>
+<!-- ====  Webforwarding elements ====================== -->
+<!ELEMENT WebForwardingProduct (DomainName, DestURL?, Masking?)>
+<!ELEMENT DestURL (#PCDATA)>
+<!ELEMENT Masking (#PCDATA)>

data/lib/netsol.rb

@@ -1,5 +1,5 @@
 require 'net/https'
-require 'erb'
+require 'haml'
 require 'nokogiri'
 
 class Netsol
@@ -31,6 +31,46 @@ class Netsol
     @host = CONFIG[:host][@mode]
   end
 
+  # This is to split the lookup request into smaller requests
+  # (NetSol blocks requests which are too long)
+  def lookup_domain(domain_names)
+    result = {}
+    result[:domains] = {}
+
+    group_array(domain_names, per_group = 100).each do |domain_names_100|
+      result[:domains].merge!(_lookup_domain(domain_names_100)[:domains])
+    end
+
+    result
+  end
+  
+  def _lookup_domain(domain_names)
+    @domain_names = domain_names
+    response = Nokogiri::XML(transmit(CONFIG[:api][:transaction], request_body).body, &:noblanks)
+
+    status = response.xpath('/LookupResponse/Body/Status')
+    status_code = status.xpath('StatusCode/text()')[0].to_s.to_i
+    status_desc = status.xpath('Description/text()')[0].to_s
+    success_codes = [11702]
+
+    raise "Unable to modify registration: [#{status_code}] #{status_desc}" unless success_codes.include?(status_code)
+
+    domains = {}
+    
+    response.xpath('/LookupResponse/Body/Domain').each do |de|
+      domains[de.xpath('DomainNameProperties/text()')[0].to_s] =
+        de.xpath('HostData').map{ |host| host.xpath('HostName/text()')[0].to_s }
+    end
+
+    {
+      :status => {
+        :code => status_code,
+        :message => status_desc
+      },
+      :domains => domains
+    }
+  end
+
   def find_all_customers_for_partner
     response = transmit(CONFIG[:api][:transaction], request_body)
 
@@ -77,11 +117,25 @@ class Netsol
     end
   end
 
-  def modify_registration
-    raise 'Not yet implemented'
-    # @domain_name = nil
-    # @customer_id = nil
-    # @auto_renew  = nil
+  def modify_registration(customer_id, domain_name, auto_renew)
+    @customer_id,@domain_name,@auto_renew = customer_id,domain_name,auto_renew
+    response = Nokogiri::XML(transmit(CONFIG[:api][:transaction], request_body).body, &:noblanks)
+    
+    status = response.xpath('/OrderResponse/Body/Order/Status')
+    status_code = status.xpath('StatusCode/text()')[0].to_s.to_i
+    status_desc = status.xpath('Description/text()')[0].to_s
+    success_codes = [7000]
+
+    raise "Unable to modify registration: [#{status_code}] #{status_desc}" unless success_codes.include?(status_code)
+
+    {
+      :status => {
+        :code => status_code,
+        :message => status_desc
+      },
+      :reference_number => response.xpath('/OrderResponse/Body/Order/ReferenceNumber/text()')[0].to_s,
+      :order_id => response.xpath('/OrderResponse/Body/Order/OrderID/text()')[0].to_s
+    }
   end
 
   def create_individual(individual)
@@ -126,6 +180,32 @@ class Netsol
     }
   end
 
+  def create_registration(customer_id, domain, purchase_period)
+    @customer_id = customer_id
+    @domain = {
+      :name => domain,
+      :purchase_period => purchase_period,
+    }
+
+    response = Nokogiri::XML(transmit(CONFIG[:api][:transaction], request_body).body, &:noblanks)
+
+    status = response.xpath('/OrderResponse/Body/Order/Status')
+    status_code = status.xpath('StatusCode/text()')[0].to_s.to_i
+    status_desc = status.xpath('Description/text()')[0].to_s
+    success_codes = [7000]
+
+    raise "Unable to create registration: [#{status_code}] #{status_desc}" unless success_codes.include?(status_code)
+    
+    {
+      :status => {
+        :code => status_code,
+        :message => status_desc
+      },
+      :order_id => response.xpath('/OrderResponse/Body/Order/OrderID/text()')[0].to_s.to_i,
+      :price => response.xpath('/OrderResponse/Body/Order/Price/text()')[0].to_s.to_f
+    }
+  end
+
 private
 
   def root
@@ -135,6 +215,7 @@ private
   def transmit(location, body)
     https = Net::HTTP.new(@host, location[:port])
     https.use_ssl = true
+    https.read_timeout = 5 * 60
     https.verify_mode = OpenSSL::SSL::VERIFY_NONE
     response = https.start{ |http| http.post(location[:path], body) }
     raise "Response returned code #{response.code}: #{response.msg}." unless response.code == '200'
@@ -145,11 +226,29 @@ private
   def request_body
     method = caller[0][/`([^']*)'/, 1]
 
-    ERB.new(File.read("#{root}/xml/#{method}.xml.erb")).result(binding)
+    Haml::Engine.new(File.read("#{root}/xml/#{method}.haml")).render(binding)
   end
 
   def header
-    @header_xml ||= ERB.new(File.read("#{root}/xml/header.xml.erb")).result(binding)
+    @header_xml ||= Haml::Engine.new(File.read("#{root}/xml/_header.haml")).render(binding)
+  end
+
+  def auth
+    @auth_xml ||= Haml::Engine.new(File.read("#{root}/xml/_auth.haml")).render(binding)
+  end
+
+  # This is necessary as including activesupport (outside of rails) is a nightmare prior to v3.0
+  def group_array(array, per_group)
+    container = []
+    array.each do |item|
+      if container.last && container.last.size < per_group
+        container.last << item
+      else
+        container << [item]
+      end
+    end
+
+    container
   end
 
 end

data/netsol.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'netsol'
-  spec.version       = '0.1'
+  spec.version       = '0.2.0'
   spec.authors       = ['Michael Malet']
   spec.email         = ['michael@tagadab.com']
   spec.description   = %q{A gem to make interacting with NetSol's Partner API less painful}
@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'nokogiri', '~> 1.4.7'
+  spec.add_dependency 'haml'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'

data/xml/_auth.haml

@@ -0,0 +1,4 @@
+%AuthorizedAgent(SystemUserType="partner")
+  %SystemUser
+    %UserID= @user
+    %Password= @pass

data/xml/_header.haml

@@ -0,0 +1,5 @@
+%RequestHeader
+  %VERSION_6_8
+  %Authentication
+    %PartnerID= @user
+    %PartnerPassword= @pass

data/xml/_lookup_domain.haml

@@ -0,0 +1,11 @@
+!!! XML
+%LookupRequest
+  = header
+  %Body
+    %AuthorizedAgent(SystemUserType="partner")
+      %SystemUser
+        %UserID= @user
+        %Password= @pass
+    %LookupDomain
+      - @domain_names.each do |domain_name|
+        %DomainName= domain_name

data/xml/create_individual.haml

@@ -0,0 +1,21 @@
+!!! XML
+%UserRequest
+  = header
+  %Body
+    %CreateIndividual
+    %LoginName= @individual[:login_name]
+    %Password= @individual[:password]
+    %FirstName= @individual[:first_name]
+    %MiddleName= @individual[:middle_name]
+    %LastName= @individual[:last_name]
+    %Address
+      %AddressLine1= @individual[:address][:line_1]
+      %City= @individual[:address][:city]
+      %State= @individual[:address][:state]
+      %PostalCode= @individual[:address][:post_code]
+      %CountryCode= @individual[:address][:country_code]
+    %Phone= @individual[:phone]
+    %Fax= @individual[:fax]
+    %Email= @individual[:email]
+    %AuthQuestion= @individual[:auth][:question]
+    %AuthAnswer= @individual[:auth][:answer]

data/xml/create_registration.haml

@@ -0,0 +1,10 @@
+!!! XML
+%OrderRequest
+  = header
+  %Body
+    = auth
+    %CustomerID= @customer_id
+    %Product
+      %CreateRegistration
+        %DomainName= @domain[:name]
+        %PurchasePeriod= @domain[:purchase_period]

data/xml/find_all_customers_for_partner.haml

@@ -0,0 +1,5 @@
+!!! XML
+%PartnerManagerRequest
+  = header
+  %Body
+    %FindAllCustomersForPartner

data/xml/find_all_domains_for_partner.haml

@@ -0,0 +1,5 @@
+!!! XML
+%PartnerManagerRequest
+  = header
+  %Body
+    %FindAllDomainsForPartner