joker-dmapi 0.0.1 → 0.1.2

data/README.md

@@ -1,6 +1,6 @@
 # Joker DMAPI client library
 
-https://joker.com/faq/category/33/22-dmapi.html
+Description of the API can be found at https://joker.com/faq/category/33/22-dmapi.html
 
 ## Installation
 

data/lib/joker-dmapi.rb

@@ -1 +1 @@
-require "joker-dmapi/client"
+require "#{File.dirname(__FILE__)}/joker-dmapi/client"

data/lib/joker-dmapi/client.rb

@@ -1,27 +1,33 @@
 require "net/http"
 require "addressable/uri"
-require "joker-dmapi/result"
-require "joker-dmapi/contact"
-require "joker-dmapi/domain"
+require "#{File.dirname(__FILE__)}/result"
+require "#{File.dirname(__FILE__)}/contact"
+require "#{File.dirname(__FILE__)}/host"
+require "#{File.dirname(__FILE__)}/domain"
 
 module JokerDMAPI
-  VERSION = '0.0.1'
+  VERSION = '0.1.2'
 
   class Client
-    URI = 'https://dmapi.joker.com:443/request/'
+    DEFAULT_URI = 'https://dmapi.joker.com:443/request/'
 
     include JokerDMAPI::Result
     include JokerDMAPI::Contact
+    include JokerDMAPI::Host
     include JokerDMAPI::Domain
 
-    def initialize(username, password)
-      @username, @password = username, password
+    def initialize(username, password, uri = DEFAULT_URI)
+      @username, @password, @uri = username, password, uri
     end
 
-    def self.with_connection(username, password, &block)
-      connection = self.new(username, password)
-      yield connection
-      connection.logout
+    def self.connection(username, password, uri = DEFAULT_URI, &block)
+      connection = self.new(username, password, uri)
+      if block_given?
+        yield connection
+        connection.logout
+      else
+        connection
+      end
     end
 
     def logout
@@ -32,14 +38,23 @@ module JokerDMAPI
     end
 
     def query(request, params = {})
-      params['auth-sid'] = auth_sid
-      response = request(request, params.inject({}) { |r, (key, value)| r[key.to_s.gsub('_', '-')] = value; r })
-      check_status response
+      response = query_no_raise request, params
+      raise_response(response) unless response[:headers][:status_code] == '0'
       response
     end
 
+    def tlds
+      auth_sid unless @auth_sid
+      @tlds
+    end
+
     private
 
+    def query_no_raise(request, params = {})
+      params['auth-sid'] = auth_sid
+      request(request, params.inject({}) { |r, (key, value)| r[key.to_s.gsub('_', '-')] = value; r })
+    end
+
     def parse_line(line)
       parts = line.split /\s*:\s*/, 2
       if parts.length == 2
@@ -64,29 +79,29 @@ module JokerDMAPI
     end
 
     def request(request, params = {})
-      uri = Addressable::URI.parse(URI + request.to_s)
+      request = request.to_s.gsub('_', '-')
+      uri = Addressable::URI.parse(@uri + request)
       uri.query_values = params
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
-      #http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      puts ">> #{uri.request_uri}" if ENV['JOKER_DMAPI_DEBUG']
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      puts ">> #{uri}" if ENV['JOKER_DMAPI_DEBUG']
       parse_response http.request(Net::HTTP::Get.new(uri.request_uri)).body
     end
 
-    def check_status(response)
-      if response[:headers][:status_code] != '0'
-        raise "#{response[:headers][:status_code]}: #{response[:headers][:error]}\n"
-      end
-    end
-
     def auth_sid
       if @auth_sid.nil?
         response = request(:login, username: @username, password: @password)
-        check_status response
+        raise "Authentication error" unless response[:headers].has_key? :auth_sid
         @auth_sid = response[:headers][:auth_sid]
         @tlds = response[:body].split "\n"
       end
       @auth_sid
     end
+
+    def raise_response(response)
+      raise "\n\n" + response[:headers].inject([]) { |s, (key, value)| s << "#{key}: #{value}"}.join("\n") +
+              "\n\n" + response[:body] + "\n\n"
+    end
   end
 end

data/lib/joker-dmapi/contact.rb

@@ -4,7 +4,7 @@ module JokerDMAPI
     CONTACT_ALLOWED = CONTACT_REQUIRED + [ :organization, :state, :fax ]
     CONTACT_LENGTH_LIMIT = %w(biz cn eu)
 
-    # Returns the information about a contact
+    # Returns the information about a contact or <tt>nil</tt> if not exists
     #
     # Takes handler as string
     #
@@ -23,27 +23,33 @@ module JokerDMAPI
     # [<tt>:created_date</tt>] the date and time of contact created
     # [<tt>:modified_date</tt>] the date and time of contact modified
     def contact_info(handle)
-      response = query 'query-whois', contact: handle
-      result = {}
-      response[:body].split("\n").each do |line|
-        line.slice! /^contact\./
-        line_parsed = parse_line(line)
-        next if line_parsed.is_a? String
-        key, value = line_parsed.first
-        case key
-          when :name then next if value == "- -"
-          when :address_1, :address_2, :address_3 then
-            result[:address] = [] unless result.has_key? :address
-            result[:address] << value
-          when :state then next if value == "--"
-          when :organization then next if value == "-" or value.empty?
-          when :created_date, :modified_date then
-            result[key] = DateTime.parse value
-          else
-            result.merge! line_parsed
-        end
+      response = query_no_raise :query_whois, contact: handle
+      case response[:headers][:status_code]
+        when '2303' then nil
+        when '0' then
+          result = {}
+          response[:body].split("\n").each do |line|
+            line.slice! /^contact\./
+            line_parsed = parse_line(line)
+            next if line_parsed.is_a? String
+            key, value = line_parsed.first
+            case key
+              when :name then next if value == "- -"
+              when :address_1, :address_2, :address_3 then
+                result[:address] = [] unless result.has_key? :address
+                result[:address] << value
+              when :state then next if value == "--"
+              when :organization then next if value == "-" or value.empty?
+              when :created_date, :modified_date then
+                result[key] = DateTime.parse value
+              else
+                result.merge! line_parsed
+            end
+          end
+          result
+        else
+          raise_response response
       end
-      result
     end
 
     # Create new contact
@@ -66,7 +72,7 @@ module JokerDMAPI
     #   [<tt>:proc_id</tt>] process ID (used at check result)
     #   [<tt>:tracking_id</tt>] tracking ID
     def contact_create(fields)
-      query 'contact-create', contact_prepare(fields)
+      query :contact_create, contact_prepare(fields)
     end
 
     # Check result of create contact
@@ -75,11 +81,15 @@ module JokerDMAPI
     # Returned contact's handle name (and delete result) or <tt>nil</tt> if don't ready
     def contact_create_result(proc_id)
       result = parse_attributes(result_retrieve(proc_id)[:body].split("\n\n", 1)[0])
-      if result.has_key?(:completion_status) and result[:completion_status] == 'ack'
-        result_delete proc_id
-        result[:object_name]
-      else
-        nil
+      return nil unless result.has_key? :completion_status
+      case result[:completion_status]
+        when 'ack' then
+          result_delete proc_id
+          result[:object_name]
+        when 'nack' then
+          raise_response response
+        else
+          nil
       end
     end
 
@@ -117,8 +127,7 @@ module JokerDMAPI
 
     def contact_prepare(fields)
       raise ArgumentError, "Required fields not found" unless (CONTACT_REQUIRED - fields.keys).empty?
-      auth_sid
-      raise ArgumentError, "TLD must be one of accepted" unless @tlds.include? fields[:tld]
+      raise ArgumentError, "TLD must be one of accepted" unless self.tlds.include? fields[:tld]
       if CONTACT_LENGTH_LIMIT.include? fields[:tld]
         [ :name, :organization, :city, :state ].each do |field|
           next unless fields.has_key? field

data/lib/joker-dmapi/domain.rb

@@ -1,6 +1,6 @@
 module JokerDMAPI
   module Domain
-    # Returns the information about a domain
+    # Returns the information about a domain or <tt>nil</tt> if not exists
     #
     # Takes FQDN as string
     #
@@ -26,37 +26,43 @@ module JokerDMAPI
     # [<tt>:modified_date</tt>] date and time of modification
     # [<tt>:expires</tt>] date and time of expiration
     def domain_info(domain)
-      response = query 'query-whois', domain: domain
-      result = {}
-      response[:body].split("\n").each do |line|
-        line.slice! /^domain\./
-        line_parsed = parse_line(line)
-        next if line_parsed.is_a? String
-        key, value = line_parsed.first
-        case key
-          when :fqdn, :status then result.merge! line_parsed
-          when :name, :organization, :city, :postal_code, :country, :owner_c_email, :email, :phone, :fax then
-            result[:registrant] = {} unless result.has_key? :registrant
-            result[:registrant].merge! line_parsed
-          when :address_1, :address_2, :address_3 then
-            result[:registrant] = {} unless result.has_key? :registrant
-            result[:registrant][:address] = [] unless result[:registrant].has_key? :address
-            result[:registrant][:address] << value
-          when :reseller_line then
-            result[:reseller_lines] = [] unless result.has_key? :reseller_lines
-            result[:reseller_lines] << value
-          when :created_date, :modified_date, :expires then
-            result[key] = DateTime.parse value
-          when :admin_c, :tech_c, :billing_c then
-            result.merge! line_parsed
-          when :nservers_nserver_handle then
-            result[:nservers] = [] unless result.has_key? :nservers
-            result[:nservers] << value
-          else
-            next
-        end
+      response = query_no_raise :query_whois, domain: domain
+      case response[:headers][:status_code]
+        when '2303' then nil
+        when '0' then
+          result = {}
+          response[:body].split("\n").each do |line|
+            line.slice! /^domain\./
+            line_parsed = parse_line(line)
+            next if line_parsed.is_a? String
+            key, value = line_parsed.first
+            case key
+              when :fqdn, :status then result.merge! line_parsed
+              when :name, :organization, :city, :postal_code, :country, :owner_c_email, :email, :phone, :fax then
+                result[:registrant] = {} unless result.has_key? :registrant
+                result[:registrant].merge! line_parsed
+              when :address_1, :address_2, :address_3 then
+                result[:registrant] = {} unless result.has_key? :registrant
+                result[:registrant][:address] = [] unless result[:registrant].has_key? :address
+                result[:registrant][:address] << value
+              when :reseller_line then
+                result[:reseller_lines] = [] unless result.has_key? :reseller_lines
+                result[:reseller_lines] << value
+              when :created_date, :modified_date, :expires then
+                result[key] = DateTime.parse value
+              when :admin_c, :tech_c, :billing_c then
+                result.merge! line_parsed
+              when :nservers_nserver_handle then
+                result[:nservers] = [] unless result.has_key? :nservers
+                result[:nservers] << value
+              else
+                next
+            end
+          end
+          result
+        else
+          raise_response response
       end
-      result
     end
 
     # Register new domain
@@ -77,7 +83,7 @@ module JokerDMAPI
       unless ([ :period, :registrant, :admin, :tech, :billing, :nservers ] - fields.keys).empty?
         raise ArgumentError, "Required fields not found"
       end
-      query 'domain-register', {
+      query :domain_register, {
         domain: domain,
         period: (fields[:period] * 12),
         owner_c: fields[:registrant],
@@ -104,7 +110,7 @@ module JokerDMAPI
       unless ([ :admin, :tech, :billing, :nservers ] - fields.keys).empty?
         raise ArgumentError, "Required fields not found"
       end
-      query 'domain-modify', {
+      query :domain_modify, {
         domain: domain,
         admin_c: fields[:admin],
         tech_c: fields[:tech],
@@ -118,7 +124,7 @@ module JokerDMAPI
     # Takes <tt>domain</tt> and <tt>period</tt>
     # WARNING!!! <tt>period</tt> in YEARS
     def domain_renew(domain, period)
-      query 'domain-renew', { domain: domain, period: (12 * period) }
+      query :domain_renew, { domain: domain, period: (12 * period) }
     end
 
     # Update registrant's info
@@ -127,7 +133,7 @@ module JokerDMAPI
     def domain_registrant_update(domain, fields)
       fields = contact_prepare(fields)
       fields[:domain] = domain
-      query 'domain-owner-change', fields
+      query :domain_owner_change, fields
     end
   end
 end

data/lib/joker-dmapi/host.rb

@@ -0,0 +1,51 @@
+require "resolv"
+
+module JokerDMAPI
+  module Host
+    def host_info(host)
+      response = query_no_raise :query_whois, { host: host }
+      case response[:headers][:status_code]
+        when '2303' then nil
+        when '0' then
+          result = {}
+          response[:body].split("\n").each do |line|
+            line.slice! /^host\./
+            line_parsed = parse_line(line)
+            next if line_parsed.is_a? String
+            key, value = line_parsed.first
+            case key
+              when :fqdn then result[:host] = value
+              when :created_date, :modified_date then
+                result[key] = DateTime.parse value
+              else
+                result.merge! line_parsed
+            end
+          end
+          result
+        else
+          raise_response response
+      end
+    end
+
+    def host_create(host, fields)
+      host_request :ns_create, host, fields
+    end
+
+    def host_update(host, fields)
+      host_request :ns_modify, host, fields
+    end
+
+    private
+
+    def host_request(request, host, fields)
+      unless fields.has_key?(:ipv4)
+        raise ArgumentError, "Required fields not found"
+      end
+      p = { host: host }
+      p[:ip] = fields[:ipv4] unless fields[:ipv4].empty?
+      p[:ipv6] = fields[:ipv6] if fields.has_key? :ipv6
+      query request, p
+    end
+
+  end
+end

data/lib/joker-dmapi/result.rb

@@ -5,21 +5,27 @@ module JokerDMAPI
     # Get <tt>proc_id</tt>
     # Returned <tt>true</tt> if done (result deleted)
     def complete?(proc_id)
-      result = parse_attributes(result_retrieve(proc_id)[:body].split("\n\n", 1)[0])
-      if result.has_key?(:completion_status) and result[:completion_status] == 'ack'
-        result_delete proc_id
-        true
-      else
-        false
+      response = result_retrieve(proc_id)
+      result = parse_attributes(response[:body].split("\n\n", 1)[0])
+      return false unless result.has_key? :completion_status
+      case result[:completion_status]
+        when 'ack' then
+          result_delete proc_id
+          true
+        when 'nack' then
+          raise_response response
+        else
+          false
       end
     end
 
     def result_retrieve(proc_id)
-      query 'result-retrieve', { proc_id: proc_id }
+      query :result_retrieve, { proc_id: proc_id }
     end
 
     def result_delete(proc_id)
-      query 'result-delete', { proc_id: proc_id }
+      query :result_delete, { proc_id: proc_id }
     end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: joker-dmapi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-15 00:00:00.000000000 Z
+date: 2013-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -60,6 +60,7 @@ files:
 - lib/joker-dmapi/client.rb
 - lib/joker-dmapi/contact.rb
 - lib/joker-dmapi/domain.rb
+- lib/joker-dmapi/host.rb
 - lib/joker-dmapi/result.rb
 homepage: https://github.com/kolodovskyy/joker-dmapi
 licenses: []