moo_moo 0.1.1 → 0.2.0

data/.travis.yml

@@ -1,11 +1,17 @@
+language: ruby
 script: "bundle exec rake spec"
 notifications:
-  disabled: true
+  email:
+    recipients:
+      - engineering@internal.site5.com
+    on_success: never
+    on_failure: always
 rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
   - ree
-  - rbx
   - rbx-head
-  - jruby
+  - rbx-18mode
+  - jruby-18mode
+  - jruby-19mode

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Site5 LLC
+Copyright (c) 2012 Site5.com <http://www.site5.com>
 
 Permission  is  hereby granted, free of charge, to any person ob-
 taining a copy of  this  software  and  associated  documentation

data/README.md

@@ -23,9 +23,9 @@ documentation of the OpenSRS XML API see
 Usage
 -----
 
-First, create an opensrs object from which all commands are called:
+First, create an opensrs object for the namespace you want to use:
 
-    opensrs = MooMoo::OpenSRS::Base.new(
+    lookup = MooMoo::Lookup.new(
       "horizon.opensrs.net",
       "<YOUR_KEY>",
       "<YOUR_RESELLER_USER>",
@@ -43,12 +43,15 @@ Or configure MooMoo and you can initialize it without any arguments:
 
     ...
 
-    opensrs = MooMoo::OpenSRS::Base.new
+    lookup = MooMoo::Lookup.new
+
+As an alternative, you can create a .moomoo.yml file in your project root with a default
+configuration for the library to use.
 
 Now you can call a variety of commands to deal with domains, nameservers, etc.
 Here's how to check the availability of a domain name:
 
-    res = opensrs.lookup_domain('example.com')
+    res = lookup.lookup_domain('example.com')
     p res.success?
     p res.result['status']
 
@@ -60,6 +63,14 @@ if the call was successful and retrieve the response code and/or error
 message. The result variable is a hash that contains all of the relevant data
 returned by the call.
 
+Currently, there is support for the following services:
+
+  * Cookie
+  * Lookup
+  * Nameserver
+  * Provisioning
+  * Transfer
+
 Note on Patches/Pull Requests
 -----------------------------
 
@@ -75,4 +86,4 @@ Note on Patches/Pull Requests
 Copyright
 ---------
 
-Copyright (c) 2011 Site5 LLC. See LICENSE for details.
+Copyright (c) 2012 Site5.com. See LICENSE for details.

data/Rakefile

@@ -16,6 +16,22 @@ rescue LoadError
   puts "Can't load metric_fu"
 end
 
+begin
+  require 'rdoc/task'
+  Rake::RDocTask.new do |rdoc|
+    version = MooMoo::VERSION
+
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = "solusvm #{version}"
+    rdoc.rdoc_files.include('README*')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
+rescue LoadError
+  task :rdoc do
+    abort "rdoc is not available. In order to run rdoc, you must: sudo gem install rdoc"
+  end
+end
+
 desc "Sanitize sensitive info from cassettes"
 task :sanitize_cassettes do
   if ENV['OPENSRS_TEST_KEY'] && ENV['OPENSRS_TEST_URL'] && ENV['OPENSRS_TEST_USER'] && ENV['OPENSRS_TEST_PASS']
@@ -53,3 +69,8 @@ RSpec::Core::RakeTask.new(:rcov) do |t|
 end
 
 task :default => [:spec]
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/moo_moo.rb"
+end

data/lib/moo_moo/base.rb

@@ -0,0 +1,93 @@
+module MooMoo
+  class Base
+    attr_reader :host, :key, :user, :pass, :port
+
+    # Register an api service for the current class.
+    #
+    #     register_service :action_one, :object_one
+    #
+    # That will generate the following method for this class:
+    #
+    #    def action_one(params)
+    #      run_command :action_one, :object_one, params, cookie
+    #    end
+    #
+    # === Parameters
+    #
+    # * <tt>method_name</tt> - the method name
+    # * <tt>object</tt> - the object
+    # * <tt>action_name</tt> - the api action to be called; by default it is the same as method_name
+    def self.register_service(method_name, object, action_name = method_name, &block)
+      define_method(method_name) do |*args|
+        params = args.first || {}
+
+        params[:key] = 'attributes'
+        cookie = params.delete :cookie
+        instance_exec(params, &block) if block
+        run_command action_name, object, params, cookie
+      end
+    end
+
+    # Constructor
+    #
+    # === Required
+    #  * <tt>:host</tt> - host of the OpenSRS server
+    #  * <tt>:key</tt> - private key
+    #  * <tt>:user</tt> - username of the reseller
+    #  * <tt>:pass</tt> - password of the rseller
+    #
+    # === Optional
+    #  * <tt>:port</tt> - port to connect on
+    def initialize(host = nil, key = nil, user = nil, pass = nil, port = 55443)
+      @host = host || MooMoo.config.host || raise(ArgumentError, "Host is required")
+      @key  = key  || MooMoo.config.key  || raise(ArgumentError, "Key is required")
+      @user = user || MooMoo.config.user || raise(ArgumentError, "User is required")
+      @pass = pass || MooMoo.config.pass || raise(ArgumentError, "Password is required")
+      @port = port || MooMoo.config.port || raise(ArgumentError, "Port is required")
+    end
+
+    # Runs a command
+    #
+    # === Required
+    #  * <tt>:command</tt> - command to run
+    #  * <tt>:command</tt> - command to run
+    #
+    # === Optional
+    #  * <tt>:params</tt> - parameters for the command
+    #  * <tt>:cookie</tt> - cookie, if the command requires it
+    def run_command(action, object, params = {}, cookie = nil)
+      cmd = Command.new(action, object, params, cookie)
+
+      try_opensrs do
+        result = cmd.run(@host, @key, @user, @port)
+        Response.new(result, params[:key])
+      end
+    end
+
+    private
+
+    # Indexes an array by building a hash with numeric keys
+    #
+    # === Required
+    #  * <tt>:arr</tt> - array to build an indexed hash of
+    def index_array(arr)
+      arr_indexed = {}
+
+      arr.each_with_index do |item, index|
+        arr_indexed[index] = item
+      end
+
+      arr_indexed
+    end
+
+    def try_opensrs
+      begin
+        yield
+      rescue Exception => e
+        exception = OpenSRSException.new(e.message)
+        exception.set_backtrace(e.backtrace)
+        raise exception
+      end
+    end
+  end
+end

data/lib/moo_moo/command.rb

@@ -0,0 +1,36 @@
+module MooMoo
+  class Command
+    # Constructor
+    #
+    # ==== Required
+    #  * <tt>:action</tt> - action of the command
+    #  * <tt>:object</tt> - object the command operates on
+    #  * <tt>:params</tt> - additional parameters for the command
+    #
+    # ==== Optional
+    #  * <tt>:cookie</tt> - a cookie for the domain if the command requires it
+    def initialize(action, object, params = {}, cookie = nil)
+      @action = action
+      @object = object
+      @params = params
+      @cookie = cookie
+    end
+
+    # Runs the command against OpenSRS server
+    #
+    # ==== Required
+    #  * <tt>:host</tt> - host of the OpenSRS server
+    #  * <tt>:key</tt> - private key for the account
+    #  * <tt>:user</tt> - username for the account
+    #  * <tt>:port</tt> - port to connect to
+    def run(host, key, user, port)
+      @returned_parameters = Faraday.new(:url => "https://#{host}:#{port}", :ssl => {:verify => true}) do |c|
+        c.request :open_srs_xml_builder, @action, @object, @cookie, @params, key, user
+        c.response :parse_open_srs
+        c.response :open_srs_errors
+        c.adapter :net_http
+      end.post.body
+    end
+
+  end
+end

data/lib/moo_moo/config.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 module MooMoo
   class Config
     attr_accessor :host
@@ -7,7 +9,30 @@ module MooMoo
     attr_accessor :port
 
     def initialize
-      @host = 'horizion.opensrs.net'
+      @host = default_option("host") || 'horizon.opensrs.net'
+      @key  = default_option("key")
+      @user = default_option("user")
+      @pass = default_option("pass")
+      @port = default_option("port")
+    end
+
+    private
+
+    def options_file_name
+      ".moomoo.yml"
+    end
+
+    # Retrieves default options coming from a configuration file, if any.
+    def default_option(key)
+      @yaml ||= begin
+        if File.exists?(options_file_name)
+          YAML.load(File.open(options_file_name))
+        else
+          {}
+        end
+      end
+
+      @yaml[key.to_s]
     end
   end
 end

data/lib/moo_moo/cookie.rb

@@ -0,0 +1,28 @@
+module MooMoo
+  class Cookie < Base
+
+    ##
+    # Creates a cookie for use in commands where a cookie is required to access OpenSRS.
+    #
+    # http://www.opensrs.com/docs/apidomains/set_cookie.htm
+    register_service :set, :cookie
+
+    ##
+    # Deletes a cookie.
+    #
+    # http://www.opensrs.com/docs/apidomains/delete_(cookie).htm
+    register_service :delete, :cookie
+
+    ##
+    # Allows the client to change the domain associated with the current cookie.
+    #
+    # http://www.opensrs.com/docs/apidomains/update_(cookie).htm
+    register_service :update, :cookie
+
+    ##
+    # Cleanly terminates the connection.
+    #
+    # http://www.opensrs.com/docs/apidomains/quit_session.htm
+    register_service :quit_session, :session, :quit
+  end
+end

data/lib/moo_moo/dns_zone.rb

@@ -0,0 +1,45 @@
+module MooMoo
+  class DnsZone < Base
+
+    ##
+    # Creates a custom DNS zone for managed DNS service.
+    #
+    # http://www.opensrs.com/docs/apidomains/create_dns_zone_request.htm
+    register_service :create_dns_zone, :domain
+
+    ##
+    # Deletes the DNS zones for the specified domain.
+    #
+    # http://www.opensrs.com/docs/apidomains/delete_dns_zone_request.htm
+    register_service :delete_dns_zone, :domain
+
+    ##
+    # Changes the nameservers on your domain to use the 
+    # nameservers for managed DNS service.
+    #
+    # http://www.opensrs.com/docs/apidomains/Request_parameters_for_force_dns_nameservers.htm
+    register_service :force_dns_nameservers, :domain
+
+    ##
+    # View the DNS records for a specified domain.
+    #
+    # http://www.opensrs.com/docs/apidomains/get_dns_zone_request.htm
+    register_service :get_dns_zone, :domain
+
+    ##
+    # Sets the DNS zone to the values in the specified template.
+    # If a template is not specified in the command, the records 
+    # are set to what was in the template that was used to enable 
+    # the DNS service.
+    #
+    # http://www.opensrs.com/docs/apidomains/reset_dns_zone_request.htm
+    register_service :reset_dns_zone, :domain
+
+    ##
+    # Set the records for a domain's DNS zone.
+    #
+    # http://www.opensrs.com/docs/apidomains/set_dns_zone_request.htm
+    register_service :set_dns_zone, :domain
+
+  end
+end

data/lib/moo_moo/exceptions.rb

@@ -1,4 +1,4 @@
 module MooMoo
-  class MooMooArgumentError < ArgumentError; end
+  class ArgumentError < ::ArgumentError; end
   class OpenSRSException < Exception; end
 end

data/lib/moo_moo/lookup.rb

@@ -0,0 +1,97 @@
+module MooMoo
+  class Lookup < Base
+
+    ##
+    # Determines whether the domain belongs to the RSP who issued the command.
+    #
+    # http://www.opensrs.com/docs/apidomains/belongs_to_rsp.htm
+    register_service :belongs_to_rsp, :domain
+
+    ##
+    # Queries the requester's account, and returns the total amount of money in the account and
+    # the amount that is allocated to pending transactions.
+    #
+    # http://www.opensrs.com/docs/apidomains/get_balance.htm
+    register_service :get_balance, :balance
+
+    ##
+    # Lists domains that have been deleted due to expiration or deleted by request (revoked).
+    # This command applies to all domains in a Reseller's profile. Results include the domain,
+    # status, and deleted date.
+    #
+    # http://www.opensrs.com/docs/apidomains/get_deleted_domains.htm
+    register_service :get_deleted_domains, :domain
+
+    ##
+    # Queries various types of data regarding the user's domain. For example, the all_info type
+    # allows you to retrieve all data for the domain linked to the current cookie. The list type
+    # queries the list of domains associated with the user's profile. The list type can also be
+    # used to return a list of domains that expire within a specified range. The nameservers type
+    # returns the nameservers currently acting as DNS servers for the domain.
+    #
+    # http://www.opensrs.com/docs/apidomains/get_domain.htm
+    register_service :get_domain, :domain, :get
+
+    ##
+    # Queries contact information for a list of domains.
+    #
+    # http://www.opensrs.com/docs/apidomains/get_domains_contacts.htm
+    register_service :get_domains_contacts, :domain
+
+    ##
+    # Retrieves domains that expire within a specified date range.
+    #
+    # http://www.opensrs.com/docs/apidomains/get_domains_by_expiredate.htm
+    register_service :get_domains_by_expiredate, :domain
+
+    ##
+    # Retrieves the domain notes that detail the history of the domain, for example, renewals and
+    # transfers.
+    #
+    # http://www.opensrs.com/docs/apidomains/get_notes.htm
+    register_service :get_notes, :domain
+
+    ##
+    # Queries all the information for an order, but does not return sensitive information such as
+    # username, password, and Authcode.
+    #
+    # http://www.opensrs.com/docs/apidomains/get_order_info.htm
+    register_service :get_order_info, :domain
+
+    ##
+    # Retrieves information about orders placed for a specific domain.
+    #
+    # http://www.opensrs.com/docs/apidomains/get_orders_by_domain.htm
+    register_service :get_orders_by_domain, :domain
+
+    ##
+    # Queries the price of a domain, and can be used to determine the cost of a billable transaction
+    # for any TLD. A returned price for a given domain does not guarantee the availability of the
+    # domain, but indicates that the requested action is supported by the system and calculates the
+    # cost to register the domain (if available).
+    #
+    # http://www.opensrs.com/docs/apidomains/get_price.htm
+    register_service :get_price, :domain
+
+    ##
+    # Queries the properties of the specified Trust Service product
+    #
+    # ==== Required
+    #  * <tt>:product_id</tt> - ID of the product
+    register_service :get_product_info, :trust_service
+
+    ##
+    # Determines the availability of a specified domain name.
+    #
+    # http://www.opensrs.com/docs/apidomains/lookup_domain.htm
+    register_service :lookup_domain, :domain, :lookup
+
+    ##
+    # Checks whether a specified name, word, or phrase is available for registration in gTLDs and
+    # ccTLDs, suggests other similar domain names for .COM, .NET, .ORG, .INFO, .BIZ, .US, and .MOBI
+    # domains, and checks whether they are available. Reseller must be enabled for the specified TLDs.
+    #
+    # http://www.opensrs.com/docs/apidomains/name_suggest_domain.htm
+    register_service :name_suggest, :domain
+  end
+end

data/lib/moo_moo/middleware/open_srs_errors.rb

@@ -0,0 +1,12 @@
+module MooMoo
+  class OpenSRSErrors < Faraday::Response::Middleware
+
+    def on_complete(env)
+      # Checks for invalid http status
+      unless (200..299).include?(env[:status])
+        raise OpenSRSException, "Bad HTTP Status: #{env[:status]}"
+      end
+    end
+
+  end
+end

data/lib/moo_moo/middleware/open_srs_xml_builder.rb

@@ -0,0 +1,101 @@
+module MooMoo
+  class OpenSRSXMLBuilder < Faraday::Middleware
+    dependency 'rexml/document'
+    dependency 'digest/md5'
+      
+    def initialize(app, *args)
+      @action = args[0]
+      @object = args[1]
+      @cookie = args[2]
+      @params = args[3]
+      @key    = args[4]
+      @user   = args[5]
+      super(app)
+    end
+
+    def call(env)
+      env[:body] = build_command.to_s
+      env[:request_headers] = {
+        'Content-Type' => 'text/xml',
+        'X-Username' => @user,
+        'X-Signature' => signature(env[:body]),
+        'Content-Length' => env[:body].size.to_s
+        }.merge(env[:request_headers])
+      @app.call(env)
+    end
+
+  private
+
+    # Builds an XML string of the command which can be sent to OpenSRS
+    def build_command
+      xml = <<-XML
+      <?xml version='1.0' encoding='UTF-8' standalone='no' ?>
+      <!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
+      <OPS_envelope>
+        <header>
+          <version>0.9</version>
+        </header>
+        <body>
+          <data_block>
+            <dt_assoc>
+              <item key="protocol">XCP</item>
+              <item key="action">GET_BALANCE</item>
+              <item key="object">BALANCE</item>
+              <item key="registrant_ip"/>
+            </dt_assoc>
+          </data_block>
+        </body>
+      </OPS_envelope>
+      XML
+
+      doc = REXML::Document.new(xml)
+      doc.root.elements["body/data_block/dt_assoc/item[@key='action']"].text = @action
+      doc.root.elements["body/data_block/dt_assoc/item[@key='object']"].text = @object
+
+      unless @cookie.nil?
+        cookie_elem = doc.root.elements["body/data_block/dt_assoc"].add_element('item', {'key' => 'cookie'})
+        cookie_elem.text = @cookie
+      end
+
+      unless @params.nil?
+        elem = doc.root.elements["body/data_block/dt_assoc"].add_element('item', {'key' => 'attributes'})
+        build_child(elem, @params)
+      end
+
+      doc
+    end
+    
+    # Adds XML child elements to the specified XML element for a given collection
+    #
+    # ==== Required
+    #  * <tt>:elem</tt> - XML element to add the child nodes to
+    #  * <tt>:coll</tt> - collection that will be added as XML child elements
+    def build_child(elem, coll)
+      if coll.is_a?(Hash)
+        elem = elem.add_element("dt_assoc")
+        coll.each do |key, val|
+          child = elem.add_element('item', {'key' => key})
+          build_child(child, val)
+        end
+      elsif coll.is_a?(Array)
+        elem = elem.add_element("dt_array")
+        coll.each_with_index do |val, key|
+          child = elem.add_element('item', {'key' => key})
+          build_child(child, val)
+        end
+      else
+        elem.text = coll
+      end
+    end
+    
+
+    def signature(content)
+      Digest::MD5.hexdigest(
+        Digest::MD5.hexdigest(
+          content + @key
+        ) + @key
+      )
+    end
+ 
+  end
+end

data/lib/moo_moo/middleware/parse_open_srs.rb

@@ -0,0 +1,58 @@
+module MooMoo
+  class ParseOpenSRS < Faraday::Response::Middleware
+
+    def on_complete(env)
+      env[:body] = parse_response(env[:body])
+    end
+    
+    def response_values(env)
+      {:status => env[:status], :headers => env[:response_headers], :body => env[:body]}
+    end
+    
+  private
+    
+    # Parses an XML response from the OpenSRS registry and generates a
+    # hash containing all of the data. Elements with child elements
+    # are converted into hashes themselves, with the :element_text entry
+    # containing any raw text
+    #
+    # ==== Required
+    #  * <tt>data</tt> - data of the response
+    def parse_response(data)
+      doc = REXML::Document.new(data)
+
+      values = {}
+
+      elements = doc.elements["/OPS_envelope/body/data_block/dt_assoc"].select { |item|
+        item.is_a? REXML::Element
+      }
+
+      build_xml_hash(elements)
+    end
+
+    # Builds a hash from a collection of XML elements
+    #
+    # ==== Required
+    #  * <tt>elements</tt> - collection of elemenents
+    def build_xml_hash(elements)
+      data_hash = {}
+
+      elements.each do |elem|
+        key = elem.attributes['key']
+
+        if elem.elements.size > 0
+          if key.nil?
+            data_hash.merge!(build_xml_hash(elem.elements))
+          else
+            data_hash[key] = build_xml_hash(elem.elements)
+          end
+        else
+          data_hash[key] = elem.text unless key.nil?
+        end
+      end
+
+      data_hash
+    end
+
+  end
+end

data/lib/moo_moo/nameserver.rb

@@ -0,0 +1,29 @@
+module MooMoo
+  class Nameserver < Base
+
+    ##
+    # Creates a nameserver in the same domain space as the cookie's domain.
+    #
+    # http://www.opensrs.com/docs/apidomains/create_nameserver.htm
+    register_service :create, :nameserver
+
+    ##
+    # Deletes a nameserver.
+    #
+    # http://www.opensrs.com/docs/apidomains/Delete_Nameserver.htm
+    register_service :delete, :nameserver
+
+    ##
+    # Queries nameservers that exist in the current user profile (current cookie). These nameservers
+    # may or may not be currently assigned to a domain.
+    #
+    # http://www.opensrs.com/docs/apidomains/get_nameserver.htm
+    register_service :get, :nameserver
+
+    ##
+    # Renames a nameserver.
+    #
+    # http://www.opensrs.com/docs/apidomains/modify_nameserver.htm
+    register_service :modify, :nameserver
+  end
+end