joker-dmapi 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+.DS_Store
+dev

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in epp-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Yuriy Kolodovskyy
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# Joker DMAPI client library
+
+https://joker.com/faq/category/33/22-dmapi.html
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'joker-dmapi'
+
+or this line:
+
+    gem 'joker-dmapi', git: 'https://github.com/kolodovskyy/joker-dmapi.git'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install joker-dmapi
+
+## Usage (example)
+
+    require "joker-dmapi"
+
+    ENV['JOKER_DMAPI_DEBUG'] = 'yes'
+
+    JokerDMAPI::Client.with_connection('LOGIN', 'PASSWORD') do |j|
+        j.contact_info 'CCOM-000000'
+        j.domain_info 'joker.com'
+
+        j.contact_create {
+            tld: 'com',
+            name: 'Test name',
+            email: 'test@tes.com',
+            address: ['Test str.'],
+            city: 'Kiev',
+            postal_code: '00000',
+            country: 'UA',
+            phone: '+380.443063232',
+        }
+
+        # handle returted
+        j.contact_create_result '51930786'
+
+        j.contact_delete 'CCOM-000000'
+        j.complete? '51930793'
+
+        j.domain_registrant_update 'ukrtoday.com', {
+            tld: 'com',
+            name: 'Test name',
+            organization: 'Test org',
+            address: [ 'Test str.' ],
+            city: 'Kiev',
+            postal_code: '00000',
+            country: 'UA',
+            phone: '+380.442063232',
+            fax: '+380.442063233',
+            email: 'test@test.com'
+        }
+
+        j.complete? '51931047'
+
+        j.domain_update 'ukrtoday.com', {
+            admin: 'CCOM-000000',
+            tech: 'CCOM-000000',
+            billing: 'CCOM-000000',
+            nservers: %w(ns1.test.com ns2.test.com)
+        }
+    end
+
+## Maintainers and Authors
+
+Yuriy Kolodovskyy (https://github.com/kolodovskyy)
+
+## License
+
+MIT License. Copyright 2012 [Yuriy Kolodovskyy](http://twitter.com/kolodovskyy)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/joker-dmapi.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'joker-dmapi'
+
+Gem::Specification.new do |gem|
+  gem.name          = "joker-dmapi"
+  gem.version       = JokerDMAPI::VERSION
+  gem.authors       = ["Yuriy Kolodovskyy"]
+  gem.email         = %w{kolodovskyy@ukrindex.com}
+  gem.description   = %q{Joker DMAPI client library}
+  gem.summary       = %q{Joker DMAPI client library}
+  gem.homepage      = "https://github.com/kolodovskyy/joker-dmapi"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = %w{lib}
+
+  gem.add_dependency "addressable"
+  gem.add_development_dependency "bundler"
+end

data/lib/joker-dmapi/client.rb

@@ -0,0 +1,92 @@
+require "net/http"
+require "addressable/uri"
+require "joker-dmapi/result"
+require "joker-dmapi/contact"
+require "joker-dmapi/domain"
+
+module JokerDMAPI
+  VERSION = '0.0.1'
+
+  class Client
+    URI = 'https://dmapi.joker.com:443/request/'
+
+    include JokerDMAPI::Result
+    include JokerDMAPI::Contact
+    include JokerDMAPI::Domain
+
+    def initialize(username, password)
+      @username, @password = username, password
+    end
+
+    def self.with_connection(username, password, &block)
+      connection = self.new(username, password)
+      yield connection
+      connection.logout
+    end
+
+    def logout
+      unless @auth_sid.nil?
+        query :logout
+        @auth_sid = nil
+      end
+    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
+    end
+
+    private
+
+    def parse_line(line)
+      parts = line.split /\s*:\s*/, 2
+      if parts.length == 2
+        { parts[0].downcase.gsub('-', '_').gsub('.', '_').to_sym => parts[1] }
+      else
+        line
+      end
+    end
+
+    def parse_attributes(attributes)
+      attributes.split("\n").inject({}) do |h, line|
+        attribute = parse_line line
+        h.merge!(attribute) if attribute.is_a? Hash
+        h
+      end
+    end
+
+    def parse_response(response)
+      response.each_line { |line| puts "<< #{line}" } if ENV['JOKER_DMAPI_DEBUG']
+      parts = response.split "\n\n", 2
+      { headers: parse_attributes(parts[0]), body: parts[1] }
+    end
+
+    def request(request, params = {})
+      uri = Addressable::URI.parse(URI + request.to_s)
+      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']
+      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
+        @auth_sid = response[:headers][:auth_sid]
+        @tlds = response[:body].split "\n"
+      end
+      @auth_sid
+    end
+  end
+end

data/lib/joker-dmapi/contact.rb

@@ -0,0 +1,147 @@
+module JokerDMAPI
+  module Contact
+    CONTACT_REQUIRED = [ :tld, :name, :email, :address, :city, :postal_code, :country, :phone ]
+    CONTACT_ALLOWED = CONTACT_REQUIRED + [ :organization, :state, :fax ]
+    CONTACT_LENGTH_LIMIT = %w(biz cn eu)
+
+    # Returns the information about a contact
+    #
+    # Takes handler as string
+    #
+    # Returned is a hash:
+    # [<tt>:name</tt>] the contact's name
+    # [<tt>:organization</tt>] the contact's organization name
+    # [<tt>:address</tt>] an array containing from one to three elements with contact's address
+    # [<tt>:city</tt>] the contact's city
+    # [<tt>:state</tt>] the contact's state
+    # [<tt>:postal_code</tt>] the contact's postal code
+    # [<tt>:country</tt>] the contact's country code (UA)
+    # [<tt>:email</tt>] the contact's email address
+    # [<tt>:phone</tt>] the contact's voice phone number
+    # [<tt>:fax</tt>] the contact's fax number
+    # [<tt>:handle</tt>] the contact's handler from Joker
+    # [<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
+      end
+      result
+    end
+
+    # Create new contact
+    #
+    # Takes contact's fields as hash:
+    # [<tt>:tld</tt>] the TLD to use new contact
+    # [<tt>:name</tt>] the contact's name
+    # [<tt>:organization</tt>] the contact's organization name
+    # [<tt>:address</tt>] an array containing from one to three elements with contact's address
+    # [<tt>:city</tt>] the contact's city
+    # [<tt>:state</tt>] the contact's state
+    # [<tt>:postal_code</tt>] the contact's postal code
+    # [<tt>:country</tt>] the contact's country code (UA)
+    # [<tt>:email</tt>] the contact's email address
+    # [<tt>:phone</tt>] the contact's voice phone number
+    # [<tt>:fax</tt>] the contact's fax number
+    #
+    # Returned is a hash of response:
+    # [<tt>:headers</tt>]
+    #   [<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)
+    end
+
+    # Check result of create contact
+    #
+    # Get <tt>proc_id</tt>
+    # 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
+      end
+    end
+
+    # Update contact
+    #
+    # Takes <tt>handle</tt> to select contact and contact's fields as hash:
+    # [<tt>:name</tt>] the contact's name
+    # [<tt>:organization</tt>] the contact's organization name
+    # [<tt>:address</tt>] an array containing from one to three elements with contact's address
+    # [<tt>:city</tt>] the contact's city
+    # [<tt>:state</tt>] the contact's state
+    # [<tt>:postal_code</tt>] the contact's postal code
+    # [<tt>:country</tt>] the contact's country code (UA)
+    # [<tt>:email</tt>] the contact's email address
+    # [<tt>:phone</tt>] the contact's voice phone number
+    # [<tt>:fax</tt>] the contact's fax number
+    #
+    # Returned is a hash of response:
+    # [<tt>:headers</tt>]
+    #   [<tt>:proc_id</tt>] process ID (used at check result)
+    #   [<tt>:tracking_id</tt>] tracking ID
+    def contact_update(handle, fields)
+      fields = contact_prepare(fields)
+      fields[:handle] = handle
+      query 'contact-modify', fields
+    end
+
+    # Delete contact
+    # Takes <tt>handle</tt>
+    def contact_delete(handle)
+      query 'contact-delete', { handle: handle }
+    end
+
+    private
+
+    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]
+      if CONTACT_LENGTH_LIMIT.include? fields[:tld]
+        [ :name, :organization, :city, :state ].each do |field|
+          next unless fields.has_key? field
+          fields[field] = fields[field][0...30] # only 30 allowed
+        end
+        if fields.has_key? :address
+          fields[:address].map! { |addr| addr[0...30] }
+        end
+      end
+      fields = fields.keep_if { |key, value| CONTACT_ALLOWED.include? key }
+      if fields.has_key? :organization and !fields[:organization].empty?
+        fields[:individual] = 'No'
+      else
+        fields[:individual] = 'Yes'
+      end
+      unless fields[:address].size > 0 and fields[:address].size <= 3
+        raise ArgumentError, "From one to three lines of address allowed"
+      end
+      (1..3).each do |index|
+        fields["address-" + index.to_s] = fields[:address][index-1].nil? ? '' : fields[:address][index-1]
+      end
+      fields.delete :address
+      fields
+    end
+  end
+end

data/lib/joker-dmapi/domain.rb

@@ -0,0 +1,133 @@
+module JokerDMAPI
+  module Domain
+    # Returns the information about a domain
+    #
+    # Takes FQDN as string
+    #
+    # Returned is a hash:
+    # [<tt>:fqdn</tt>] FQDN
+    # [<tt>:status</tt>] domain status
+    # [<tt>:registrant</tt>] registrant (owner) as hash keys:
+    #   [<tt>:name</tt>] registrant's name
+    #   [<tt>:organization</tt>] registrant's organization
+    #   [<tt>:address</tt>] an array of registrant's address
+    #   [<tt>:postal_code</tt>] registrant's postal code
+    #   [<tt>:country</tt>] registrant's country code
+    #   [<tt>:owner_c_email</tt>] owner's email address
+    #   [<tt>:email</tt>] registrant's email address
+    #   [<tt>:phone</tt>] registrant's voice phone number
+    #   [<tt>:fax</tt>] registrant's fax number
+    # [<tt>:reseller_lines</tt>] an array of reseller data
+    # [<tt>:admin_c</tt>] registrant's admin-c handle
+    # [<tt>:tech_c</tt>] registrant's tech-c handle
+    # [<tt>:billing_c</tt>] registrant's billing-c handle
+    # [<tt>:nservers</tt>] an array of NS servers
+    # [<tt>:created_date</tt>] date and time of creation
+    # [<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
+      end
+      result
+    end
+
+    # Register new domain
+    #
+    # Takes <tt>domain</tt> and domain's fields as hash:
+    # [<tt>:period</tt>] registration period (years!!!)
+    # [<tt>:registrant</tt>] registrant (owner) handle (registered)
+    # [<tt>:admin</tt>] admin handle (registered)
+    # [<tt>:tech</tt>] tech handle (registered)
+    # [<tt>:billing</tt>] billing handle (registered)
+    # [<tt>:nservers</tt>] an array of NS servers
+    #
+    # Returned is a hash of response:
+    # [<tt>:headers</tt>]
+    #   [<tt>:proc_id</tt>] process ID (used at check result)
+    #   [<tt>:tracking_id</tt>] tracking ID
+    def domain_create(domain, fields)
+      unless ([ :period, :registrant, :admin, :tech, :billing, :nservers ] - fields.keys).empty?
+        raise ArgumentError, "Required fields not found"
+      end
+      query 'domain-register', {
+        domain: domain,
+        period: (fields[:period] * 12),
+        owner_c: fields[:registrant],
+        admin_c: fields[:admin],
+        tech_c: fields[:tech],
+        billing_c: fields[:billing],
+        ns_list: fields[:nservers].join(':')
+      }
+    end
+
+    # Update domain
+    #
+    # Takes <tt>domain</tt> and domain's fields as hash:
+    # [<tt>:admin</tt>] admin handle (registered)
+    # [<tt>:tech</tt>] tech handle (registered)
+    # [<tt>:billing</tt>] billing handle (registered)
+    # [<tt>:nservers</tt>] an array of NS servers
+    #
+    # Returned is a hash of response:
+    # [<tt>:headers</tt>]
+    #   [<tt>:proc_id</tt>] process ID (used at check result)
+    #   [<tt>:tracking_id</tt>] tracking ID
+    def domain_update(domain, fields)
+      unless ([ :admin, :tech, :billing, :nservers ] - fields.keys).empty?
+        raise ArgumentError, "Required fields not found"
+      end
+      query 'domain-modify', {
+        domain: domain,
+        admin_c: fields[:admin],
+        tech_c: fields[:tech],
+        billing_c: fields[:billing],
+        ns_list: fields[:nservers].join(':')
+      }
+    end
+
+    # Renew domain
+    #
+    # 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) }
+    end
+
+    # Update registrant's info
+    #
+    # Takes <tt>domain</tt> and fields (see contact_update)
+    def domain_registrant_update(domain, fields)
+      fields = contact_prepare(fields)
+      fields[:domain] = domain
+      query 'domain-owner-change', fields
+    end
+  end
+end

data/lib/joker-dmapi/result.rb

@@ -0,0 +1,25 @@
+module JokerDMAPI
+  module Result
+    # Check result
+    #
+    # 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
+      end
+    end
+
+    def result_retrieve(proc_id)
+      query 'result-retrieve', { proc_id: proc_id }
+    end
+
+    def result_delete(proc_id)
+      query 'result-delete', { proc_id: proc_id }
+    end
+  end
+end

data/lib/joker-dmapi.rb

@@ -0,0 +1 @@
+require "joker-dmapi/client"

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: joker-dmapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yuriy Kolodovskyy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Joker DMAPI client library
+email:
+- kolodovskyy@ukrindex.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- joker-dmapi.gemspec
+- lib/joker-dmapi.rb
+- lib/joker-dmapi/client.rb
+- lib/joker-dmapi/contact.rb
+- lib/joker-dmapi/domain.rb
+- lib/joker-dmapi/result.rb
+homepage: https://github.com/kolodovskyy/joker-dmapi
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Joker DMAPI client library
+test_files: []