pepper 0.0.1

data/lib/pepper/commands.rb

@@ -0,0 +1,61 @@
+module Pepper
+  module Commands
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # http://www.nominet.org.uk/registrars/systems/nominetepp/login/
+      def login
+        unless @logged_in
+          builder = Nokogiri::XML::Builder.new do |xml|
+            xml.epp("xmlns"              => "urn:ietf:params:xml:ns:epp-1.0", 
+                    "xmlns:xsi"          => "http://www.w3.org/2001/XMLSchema-instance",
+                    "xsi:schemaLocation" => "urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd" ) {
+              xml.command {
+                xml.login {
+                  xml.clID @tag
+                  xml.pw   @password
+                  xml.options {
+                    xml.version "1.0"
+                    xml.lang    "en"
+                  }
+                  xml.svcs {
+                    xml.objURI "http://www.nominet.org.uk/epp/xml/nom-domain-2.0"
+                  }
+                }
+              }
+            }
+          end
+          r = self.write( builder.to_xml )
+        end
+        @logged_in = true
+      end
+      
+      def check(*domains)
+        login unless @logged_in
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.epp("xmlns"              => "urn:ietf:params:xml:ns:epp-1.0", 
+                  "xmlns:xsi"          => "http://www.w3.org/2001/XMLSchema-instance",
+                  "xsi:schemaLocation" => "urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd" ) {
+            xml.command {
+              xml.check {
+                xml.check("xmlns:domain"       => "http://www.nominet.org.uk/epp/xml/nom-domain-2.0",
+                          "xsi:schemaLocation" => "http://www.nominet.org.uk/epp/xml/nom-domain-2.0 nom-domain-2.0.xsd") {
+                  xml.parent.namespace = xml.parent.namespace_definitions.first
+                  domains.each {|d|
+                    xml["domain"].name d
+                  }
+                }
+              }
+            }
+          }
+        end
+        r = self.write( builder.to_xml )
+        r.response.resdata.chkdata.domain_names.inject({}){|hash,domain|
+          hash.merge( domain => r.response.resdata.chkdata.domain_names_avail.shift == "1")
+        }
+      end
+    end
+  end
+end

data/lib/pepper/connection.rb

@@ -0,0 +1,47 @@
+require "socket"
+require "openssl"
+require "eventmachine"
+
+module Pepper
+  module Connection
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      attr_accessor :connection
+      
+      def settings=(opts = {})
+        @server   = opts[:server]
+        @tag      = opts[:tag]
+        @password = opts[:password]
+        @port     = opts[:port] || 700
+        @lang     = opts[:lang] || "en"
+        
+        @logged_in = false
+        @parser    = nil
+      end
+      
+      def connect
+        sock                    = TCPSocket.new( @server, @port )
+        ssl_context             = OpenSSL::SSL::SSLContext.new
+        ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        self.connection         = OpenSSL::SSL::SSLSocket.new( sock, ssl_context )
+        
+        self.connection.sync_close
+        self.connection.connect
+        
+        @parser = StreamParser.new self.connection
+        @parser.get_frame
+        
+        self.connection
+      end
+      
+      def write(xml)
+        (@parser && self.connection || self.connect).write(xml)
+        @parser.get_frame
+      end
+    end
+    
+  end
+end

data/lib/pepper/error.rb

@@ -0,0 +1,12 @@
+module Pepper
+  module Error
+    class ProtocolSyntax              < StandardError; end
+    class ImplementationSpecificRules < StandardError; end
+    class Security                    < StandardError; end
+    class DataManagement              < StandardError; end
+    class ServerSystem                < StandardError; end
+    class ConnectionManagement        < StandardError; end
+    
+    class UnrecognisedResponse        < StandardError; end    
+  end
+end

data/lib/pepper/stanzas/chkdata.rb

@@ -0,0 +1,11 @@
+module Pepper
+  module Stanzas
+    class Chkdata
+      include SAXMachine
+      
+      elements "domain:name", :as => :domain_names
+      elements "domain:name", :value => :avail, :as => :domain_names_avail
+
+    end
+  end
+end

data/lib/pepper/stanzas/epp.rb

@@ -0,0 +1,10 @@
+module Pepper
+  module Stanzas
+    class Epp
+      include SAXMachine
+      
+      element :greeting
+      element :response, :class => Response
+    end
+  end
+end

data/lib/pepper/stanzas/resdata.rb

@@ -0,0 +1,9 @@
+module Pepper
+  module Stanzas
+    class Resdata
+      include SAXMachine
+        
+      element "domain:chkData", :as => :chkdata, :class => Chkdata
+    end
+  end
+end

data/lib/pepper/stanzas/response.rb

@@ -0,0 +1,11 @@
+module Pepper
+  module Stanzas
+    class Response
+      include SAXMachine
+      
+      element :result, :class => Result
+      element :result, :as => :result_code, :value => :code
+      element :resData, :as => :resdata, :class => Resdata
+    end
+  end
+end

data/lib/pepper/stanzas/result.rb

@@ -0,0 +1,9 @@
+module Pepper
+  module Stanzas
+    class Result
+      include SAXMachine
+      
+      element :msg
+    end
+  end
+end

data/lib/pepper/stanzas.rb

@@ -0,0 +1,6 @@
+require "sax-machine"
+require "pepper/stanzas/chkdata"
+require "pepper/stanzas/resdata"
+require "pepper/stanzas/result"
+require "pepper/stanzas/response"
+require "pepper/stanzas/epp"

data/lib/pepper/stream_parser.rb

@@ -0,0 +1,59 @@
+require "nokogiri"
+
+module Pepper
+  class StreamParser < Nokogiri::XML::SAX::Document
+        
+    def initialize(stream)
+      @stream = stream
+    end
+    
+    def get_frame
+      @parser = Nokogiri::XML::SAX::PushParser.new self
+      @data   = ""
+      @start, @end = nil
+      header = @stream.read(4)
+      begin
+        d = @stream.read(1)
+        @data   << d # Nasty: Duplicates data to feed into sax machine, done because sax-machine does not use a push parser
+        @parser << d # This parser is used to find the end of the stanza in the stream
+      end until @end
+      @stanza = Pepper::Stanzas::Epp.parse @data
+      parse_response_code @stanza.response unless @stanza.greeting
+      @stanza
+    end
+            
+    def start_element name, attrs = []
+      @start = name unless @start
+    end
+
+    def end_element name
+      @end = true if @start == name
+    end
+    
+  private
+    
+    def parse_response_code(response)
+      code = response.result_code
+      msg  = response.result.msg.strip
+      case code[0].chr
+      when "1"
+        # Positive completion reply
+      when "2"
+        # Negative completion reply
+        case code[1].chr
+        when "0" : raise Error::ProtocolSyntax.new msg
+        when "1" : raise Error::ImplentationSpecificRules.new msg
+        when "2" : raise Error::Security.new msg
+        when "3" : raise Error::DataManagement.new msg
+        when "4" : raise Error::ServerSystem.new msg
+        when "5" : raise Error::ConnectionManagement.new msg
+        else
+          raise Error::UnrecognisedResponse.new msg
+        end
+      else
+        raise Error::UnrecognisedResponse.new msg  
+      end
+    end
+    
+  end
+end

data/lib/pepper.rb

@@ -0,0 +1,13 @@
+require "rubygems"
+gem "sax-machine"
+
+require "pepper/stanzas"
+require "pepper/connection"
+require "pepper/commands"
+require "pepper/stream_parser"
+require "pepper/error"
+
+Pepper.class_eval do
+  include Pepper::Connection
+  include Pepper::Commands
+end

data/test/fixtures/login_success.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<epp xmlns="urn:ietf:params:xml:ns:epp-1.0"
+     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+     xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">
+  <response>
+    <result code="1000">
+      <msg>Command completed successfully</msg>
+    </result>
+    <trID>
+      <clTRID>ABC-12345</clTRID>
+      <svTRID>54321-XYZ</svTRID>
+    </trID>
+  </response>
+</epp>

data/test/live_pepper_test.rb

@@ -0,0 +1,51 @@
+$:.unshift File.dirname(__FILE__)
+require "test_helper"
+
+class LivePepperTest < Test::Unit::TestCase
+  
+  context "logging in with correct credentials" do
+    setup do
+      Pepper.settings = YAML.load_file( File.join(File.dirname(__FILE__), "live_settings.yaml" ))
+    end
+    
+    should "return true" do
+      assert_equal true, Pepper.login
+    end
+    
+    context "twice" do
+      should "return true" do
+        assert_equal true, Pepper.login
+        assert_equal true, Pepper.login
+      end
+    end
+  end
+
+  context "logging in with incorrect credentials" do
+    should "raise error" do
+      Pepper.settings = YAML.load_file( File.join(File.dirname(__FILE__), "live_settings.yaml" )).merge( :tag => "FOO" )
+      
+      assert_raises Pepper::Error::Security do
+        Pepper.login
+      end
+    end
+  end
+  
+  context "command" do
+    setup do
+      @hash = YAML.load_file( File.join(File.dirname(__FILE__), "live_settings.yaml" ))
+      Pepper.settings = @hash
+    end
+    
+    context "'check'" do
+      should "return available for 'foo.co.uk'" do
+        assert_equal( {"foo.co.uk" => true}, Pepper.check( 'foo.co.uk' ))
+      end
+      
+      should "return correct hash for 'foo.co.uk', 'bar.co.uk' and 'macduff-TAG.co.uk'" do
+        domains = {"foo.co.uk" => true, "bar.co.uk" => true, "macduff-#{@hash[:tag]}.co.uk" => false}
+        assert_equal domains, Pepper.check( *domains.keys )
+      end
+    end
+  end
+
+end

data/test/live_settings.yaml.example

@@ -0,0 +1,4 @@
+:server:   testbed-epp.nominet.org.uk
+:port:     700
+:tag:      FOO
+:password: secret

data/test/pepper_test.rb

@@ -0,0 +1,11 @@
+$:.unshift File.dirname(__FILE__)
+require "test_helper"
+
+class PepperTest < Test::Unit::TestCase
+  context "logging in" do
+    should "write login stanza" do
+      mock( Pepper ).write(anything) { response "login_success" }
+      Pepper.login
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+$:.unshift File.join( File.dirname(File.dirname(__FILE__)), "lib" )
+
+require "pepper"
+
+require "rubygems"
+
+require "test/unit"
+require "shoulda"
+require "rr"
+require 'stringio'
+
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit
+  
+  def response(name)
+    Pepper::Stanzas::Epp.parse File.read( File.join(File.dirname(__FILE__),"fixtures", "#{name}.xml") )
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: pepper
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Theo Cushion
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-16 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sax-machine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rr
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Currently supports connecting to Nominet and running checks on domain names
+email: theo@triplegeek.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- lib/pepper/commands.rb
+- lib/pepper/connection.rb
+- lib/pepper/error.rb
+- lib/pepper/stanzas/chkdata.rb
+- lib/pepper/stanzas/epp.rb
+- lib/pepper/stanzas/resdata.rb
+- lib/pepper/stanzas/response.rb
+- lib/pepper/stanzas/result.rb
+- lib/pepper/stanzas.rb
+- lib/pepper/stream_parser.rb
+- lib/pepper.rb
+has_rdoc: true
+homepage: http://github.com/theoooo/pepper
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Provides a simple interface to Nominets EPP service
+test_files: 
+- test/fixtures/login_success.xml
+- test/live_pepper_test.rb
+- test/pepper_test.rb
+- test/test_helper.rb
+- test/live_settings.yaml.example