moo_moo 0.1.1 → 0.2.0

data/lib/moo_moo/provisioning.rb

@@ -0,0 +1,62 @@
+module MooMoo
+  class Provisioning < Base
+
+    ##
+    # Cancels a Trust Service order
+    register_service :cancel_order, :trust_service
+
+    ##
+    # Cancels orders with a status of pending or declined.
+    #
+    # http://www.opensrs.com/docs/apidomains/cancel_pending_orders.htm
+    register_service :cancel_pending_orders, :order
+
+    ##
+    # Changes information associated with a domain, such as contact info. The action request message
+    # is different depending on the type of modification being made, and is shown separately for each
+    # type.
+    #
+    # http://www.opensrs.com/docs/apidomains/modify_domain.htm
+    register_service :modify, :domain
+
+    ##
+    # Processes or cancels pending orders; also applicable to any order that is declined. The order
+    # is cancelled and a new order is created. Can also be used to process cancelled orders, provided
+    # the cancelled order was a new order or a transfer.
+    #
+    # http://www.opensrs.com/docs/apidomains/process_pending.htm
+    register_service :process_pending, :domain
+
+    ##
+    # Renews a domain and allows you to set the auto-renewal flag on a domain.
+    #
+    # http://www.opensrs.com/docs/apidomains/renew_domain.htm
+    register_service :renew_domain, :domain, :renew
+
+    ##
+    # Removes the domain at the registry. Use this command to request a refund for a domain purchase.
+    # This call can refund/revoke only one domain at the time.
+    #
+    # http://www.opensrs.com/docs/apidomains/revoke_domain.htm
+    register_service :revoke, :domain
+
+    ##
+    # Submits a domain-contact information update to the OpenSRS system. Each contact object is
+    # submitted as a whole to OpenSRS, and changes are parsed against the existing information.
+    #
+    # http://www.opensrs.com/docs/apidomains/update_contacts.htm
+    register_service :update_contacts, :domain
+
+    ##
+    # Submits a new domain registration or transfer order that obeys the Reseller's 'process
+    # immediately' flag setting.
+    #
+    # http://www.opensrs.com/docs/apidomains/sw_register.htm
+    # Note: Requirements vary depending on TLD
+    register_service :register_domain, :domain, :sw_register
+
+    ##
+    # Submits a new registration request or transfer order
+    register_service :register_trust_service, :trust_service
+  end
+end

data/lib/moo_moo/response.rb

@@ -0,0 +1,39 @@
+module MooMoo
+  class Response
+    # Constructor
+    #
+    # ==== Required
+    #  * <tt>:hash</tt> - hash of the response
+    #
+    # ==== Optional
+    #  * <tt>:key</tt> - primary key to use when indexing the hash
+    def initialize(hash, key = nil)
+      @hash = hash
+      @key = key
+    end
+
+    # Returns whether or not the command executed was successful
+    #
+    def success?
+      @hash['is_success'].nil? ? true : @hash['is_success'].to_i == 1
+    end
+
+    # Returns the error message if one is present
+    #
+    def error_msg
+      @hash['response_text']
+    end
+
+    # Returns the response code if one is present
+    #
+    def error_code
+      @hash['response_code'].to_i
+    end
+
+    # Returns the result hash
+    #
+    def result
+      @key.nil? ? @hash : @hash[@key]
+    end
+  end
+end

data/lib/moo_moo/transfer.rb

@@ -0,0 +1,60 @@
+module MooMoo
+  class Transfer < Base
+
+    ##
+    # Cancels transfers that are pending owner approval.
+    #
+    # http://www.opensrs.com/docs/apidomains/cancel_transfer.htm
+    register_service :cancel_transfer, :transfer
+
+    ##
+    # Cancels a transfer that is pending owner approval by order ID
+    #
+    # Note: This method may be deprecated
+    register_service :cancel_transfer_for_order, :transfer
+
+    ##
+    # Checks to see if the specified domain can be transferred in to OpenSRS, or transferred from one
+    # OpenSRS Reseller to another. This call can also be used to check the status of the last transfer
+    # request on a given domain name.
+    #
+    # http://www.opensrs.com/docs/apidomains/check_transfer.htm
+    register_service :check_transfer, :domain
+
+    ##
+    # Lists domains that have been transferred away. This command applies to all domains in a
+    # Reseller's profile.
+    #
+    # http://www.opensrs.com/docs/apidomains/get_transfers_away.htm
+    register_service :get_transfers_away, :domain
+
+    ##
+    # Lists domains that have been transferred in. This command applies to all domains in a Reseller's
+    # profile.
+    #
+    # http://www.opensrs.com/docs/apidomains/get_transfers_in.htm
+    register_service :get_transfers_in, :domain
+
+    ##
+    # Creates a new order with the same data as a cancelled order; the existing cancelled order is
+    # not modified. This command is only available for failed transfers with the status of 'cancelled'.
+    #
+    # http://www.opensrs.com/docs/apidomains/process_transfer.htm
+    register_service :process_transfer, :transfer
+
+    ##
+    # Resends an email message for a transfer that is in 'pending owner approval' state, to the admin
+    # contact listed for the domain at the time that the transfer request was submitted. If a transfer
+    # is currently in progress, but in a different state, an error is returned.
+    #
+    # http://www.opensrs.com/docs/apidomains/send_password_transfer.htm
+    register_service :send_password, :transfer
+
+    ##
+    # Transfer a domain from one Reseller to another Reseller. The domain is not renewed when it is
+    # transferred and so no charges are incurred.
+    #
+    # http://www.opensrs.com/docs/apidomains/rsp2rsp_push_transfer.htm
+    register_service :push_transfer, :domain, :rsp2rsp_push_transfer
+  end
+end

data/lib/moo_moo/version.rb

@@ -1,3 +1,3 @@
 module MooMoo
-  VERSION = Version = "0.1.1"
+  VERSION = Version = "0.2.0"
 end

data/lib/moo_moo.rb

@@ -1,9 +1,21 @@
 require 'moo_moo/exceptions'
+require 'faraday'
 
 module MooMoo
-  autoload :Version, 'moo_moo/version'
-  autoload :Config,  'moo_moo/config'
-  autoload :OpenSRS, 'moo_moo/opensrs'
+  autoload :Version,           'moo_moo/version'
+  autoload :Config,            'moo_moo/config'
+  autoload :Command,           'moo_moo/command'
+  autoload :Response,          'moo_moo/response'
+  autoload :Base,              'moo_moo/base'
+  autoload :Lookup,            'moo_moo/lookup'
+  autoload :Nameserver,        'moo_moo/nameserver'
+  autoload :Provisioning,      'moo_moo/provisioning'
+  autoload :Transfer,          'moo_moo/transfer'
+  autoload :DnsZone,           'moo_moo/dns_zone'
+  autoload :Cookie,            'moo_moo/cookie'
+  autoload :OpenSRSErrors,     'moo_moo/middleware/open_srs_errors'
+  autoload :ParseOpenSRS,      'moo_moo/middleware/parse_open_srs'
+  autoload :OpenSRSXMLBuilder, 'moo_moo/middleware/open_srs_xml_builder'
 
   class << self
     attr_accessor :config
@@ -16,3 +28,6 @@ module MooMoo
 
   self.config = Config.new
 end
+
+Faraday.register_middleware :request, :open_srs_xml_builder => MooMoo::OpenSRSXMLBuilder
+Faraday.register_middleware :response, :open_srs_errors => MooMoo::OpenSRSErrors, :parse_open_srs => MooMoo::ParseOpenSRS

data/moo_moo.gemspec

@@ -14,14 +14,16 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "opensrs"
 
-  s.add_runtime_dependency('jruby-openssl', '~> 0.7.3') if RUBY_PLATFORM == 'java'
+  s.add_runtime_dependency 'extlib', '~> 0.9.15'
+  s.add_runtime_dependency 'faraday', '~> 0.8.0.rc2'
+  s.add_runtime_dependency 'jruby-openssl', '~> 0.7.3' if RUBY_PLATFORM == 'java'
+
   s.add_development_dependency 'rake', '~> 0.9.2.2'
-  s.add_development_dependency 'rspec', '~> 2.8.0'
-  s.add_development_dependency 'fakeweb', '~> 1.3.0'
+  s.add_development_dependency 'rspec', '~> 2.10.0'
+  s.add_development_dependency 'rdoc', '~> 3.12'
+  s.add_development_dependency 'webmock', '~> 1.8.7'
   s.add_development_dependency 'vcr', '~> 1.11.3'
 
-  s.add_dependency 'extlib'
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/spec/fixtures/success_response.xml

@@ -0,0 +1,14 @@
+<?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="response_text">Command Successful</item>
+   </dt_assoc>
+  </data_block>
+ </body>
+</OPS_envelope>

data/spec/integration_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe "Real World integration" do
+
+  it "Lookup should work" do
+    lookup = MooMoo::Lookup.new
+
+    VCR.use_cassette("integration/lookup") do
+      response = lookup.lookup_domain(:domain => "opensrs.net")
+      pp response
+      response.result["status"].should == "taken"
+    end
+  end
+
+end

data/spec/moo_moo/base_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+class SampleService < MooMoo::Base
+  register_service :service1, :object1
+  register_service :service2, :object2, :action2
+  register_service :service3, :object3 do |params|
+    params[:example] = "theexample"
+  end
+end
+
+describe MooMoo::Base do
+
+  before :each do
+    @service = SampleService.new("thehost", "thekey", "theuser", "thepass", "theport")
+  end
+
+  describe "class methods" do
+    describe "#register_service" do
+      context "calls the services with the given parameters" do
+        it "service1" do
+          params = {:the => :params, :cookie => "thecookie"}
+
+          @service.should_receive(:run_command).
+                  with(:service1, :object1, params, "thecookie").
+                  and_return("theresult")
+
+          @service.service1(params).should == "theresult"
+        end
+
+        it "service2" do
+          params = {:the => :params, :cookie => "thecookie"}
+
+          @service.should_receive(:run_command).
+                  with(:action2, :object2, params, "thecookie").
+                  and_return("theresult")
+
+          @service.service2(params).should == "theresult"
+        end
+
+        it "service3" do
+          params = {:the => :params, :cookie => "thecookie"}
+          expected_params = {:the => :params, :key => "attributes", :example => "theexample"}
+
+          @service.should_receive(:run_command).
+                  with(:service3, :object3, expected_params, "thecookie").
+                  and_return("theresult")
+
+          @service.service3(params).should == "theresult"
+        end
+      end
+    end
+  end
+
+  describe "#run_command" do
+    it "should encapsulate response" do
+      result  = {:the => :result}
+      command = stub()
+      command.should_receive(:run).with("thehost", "thekey", "theuser", "theport").and_return(result)
+      MooMoo::Command.should_receive(:new).
+                     with("theaction", "theobject", {}, "thecookie").
+                     and_return(command)
+
+      response = @service.run_command("theaction", "theobject", {}, "thecookie")
+      response.result.should == result
+    end
+  end
+
+  describe "#try_opensrs" do
+    it "raises an OpenSRSException" do
+      expect do
+        MooMoo::Base.new.instance_eval do
+          try_opensrs { raise "Exception message" }
+        end
+      end.to raise_error MooMoo::OpenSRSException
+    end
+  end
+end

data/spec/moo_moo/command_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe MooMoo::Command do
+
+  let(:action)  { "theaction" }
+  let(:object)  { "theobject" }
+  let(:params)  { {
+    :string => "stringparam",
+    :hash => {:the => "hashparam"},
+    :array => [{:param => "arrayvalue1"}, {:param => "arrayvalue2"}],
+    :array_list => ["arrayvalue1", "arrayvalue2"]
+  } }
+  let(:cookie)  { "thecookie" }
+
+  let(:command) { MooMoo::Command.new(action, object, params, cookie) }
+
+  describe "#run" do
+    describe "success response" do
+      let(:xml)      { "xmlcontent" }
+      let(:response) { {:status => 200, :body => File.open("spec/fixtures/success_response.xml")} }
+
+      before :each do
+        @request = stub_request(:post, "https://thehost.com:12345/").to_return(response)
+        @response = command.run("thehost.com", "thekey", "theuser", "12345")
+      end
+
+      it "posts with correct parameters" do
+        @request.should have_been_made
+      end
+
+      it "returns the response" do
+        @response["response_text"].should == "Command Successful"
+      end
+    end
+
+    it "raises exception on invalid http status" do
+      stub_request(:post, "https://thehost:12345/").to_return(:status => ["401", "Unauthorized"])
+      lambda { command.run("thehost", "thekey", "theuser", "12345") }.should raise_error(MooMoo::OpenSRSException, "Bad HTTP Status: 401")
+    end
+  end
+
+end

data/spec/moo_moo/config_spec.rb

@@ -9,4 +9,42 @@ describe MooMoo::Config do
   it { @config.should have_attr_accessor :key  }
   it { @config.should have_attr_accessor :user }
   it { @config.should have_attr_accessor :pass }
+  it { @config.should have_attr_accessor :port }
+
+  describe "default configuration" do
+    before :each do
+      File.should_receive(:exists?).with(".moomoo.yml").and_return(true)
+      File.should_receive(:open).with(".moomoo.yml").and_return(
+        "
+        host: thehost
+        key: thekey
+        user: theuser
+        pass: thepass
+        port: theport
+        "
+      )
+
+      @config = MooMoo::Config.new
+    end
+
+    it "should set default host from default options file" do
+      @config.host.should == "thehost"
+    end
+
+    it "should set default key from default options file" do
+      @config.key.should == "thekey"
+    end
+
+    it "should set default user from default options file" do
+      @config.user.should == "theuser"
+    end
+
+    it "should set default pass from default options file" do
+      @config.pass.should == "thepass"
+    end
+
+    it "should set default port from default options file" do
+      @config.port.should == "theport"
+    end
+  end
 end

data/spec/moo_moo/cookie_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe MooMoo::Cookie do
+  it { should have_registered_service(:set, :cookie) }
+  it { should have_registered_service(:delete, :cookie) }
+  it { should have_registered_service(:update, :cookie) }
+  it { should have_registered_service(:quit_session, :session, :quit) }
+end

data/spec/moo_moo/dns_zone_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'date'
+
+describe MooMoo::DnsZone do
+  it { should have_registered_service(:create_dns_zone, :domain) }
+  it { should have_registered_service(:delete_dns_zone, :domain) }
+  it { should have_registered_service(:force_dns_nameservers, :domain) }
+  it { should have_registered_service(:get_dns_zone, :domain) }
+  it { should have_registered_service(:reset_dns_zone, :domain) }
+  it { should have_registered_service(:set_dns_zone, :domain) }
+end

data/spec/moo_moo/lookup_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'date'
+
+describe MooMoo::Lookup do
+  it { should have_registered_service(:belongs_to_rsp, :domain) }
+  it { should have_registered_service(:get_balance, :balance) }
+  it { should have_registered_service(:get_deleted_domains, :domain) }
+  it { should have_registered_service(:get_domain, :domain, :get) }
+  it { should have_registered_service(:get_domains_contacts, :domain) }
+  it { should have_registered_service(:get_domains_by_expiredate, :domain) }
+  it { should have_registered_service(:get_notes, :domain) }
+  it { should have_registered_service(:get_order_info, :domain) }
+  it { should have_registered_service(:get_orders_by_domain, :domain) }
+  it { should have_registered_service(:get_price, :domain) }
+  it { should have_registered_service(:get_product_info, :trust_service) }
+  it { should have_registered_service(:lookup_domain, :domain, :lookup) }
+  it { should have_registered_service(:name_suggest, :domain) }
+end

data/spec/moo_moo/middleware/open_srs_xml_builder_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe MooMoo::OpenSRSXMLBuilder do
+
+  describe "#build_command" do
+    before :each do
+      params =  {
+        :string => "stringparam",
+        :hash => {:the => "hashparam"},
+        :array => [{:param => "arrayvalue1"}, {:param => "arrayvalue2"}],
+        :array_list => ["arrayvalue1", "arrayvalue2"]
+      }
+      
+      middleware = described_class.new(lambda{|env| env}, "theaction", "theobject", "thecookie", params, "key")
+      env = {:body => nil, :request_headers => Faraday::Utils::Headers.new}
+      result = middleware.call(env)
+      @body = REXML::Document.new(result[:body])
+    end
+
+    it "should set the action" do
+      @body.root.elements["body/data_block/dt_assoc/item[@key='action']"].text.should == "theaction"
+    end
+
+    it "should set the object" do
+      @body.root.elements["body/data_block/dt_assoc/item[@key='object']"].text.should == "theobject"
+    end
+
+    it "should set the the cookie" do
+      @body.root.elements["body/data_block/dt_assoc/item[@key='cookie']"].text.should == "thecookie"
+    end
+
+    describe "attributes" do
+      it "should set string params" do
+        @body.root.elements["body/data_block/dt_assoc/item[@key='attributes']/dt_assoc/item[@key='string']"].text.should == "stringparam"
+      end
+
+      it "should set hash params" do
+        @body.root.elements["body/data_block/dt_assoc/item[@key='attributes']/dt_assoc/item[@key='hash']/dt_assoc/item[@key='the']"].text.should == "hashparam"
+      end
+
+      it "should set array params" do
+        @body.root.elements["body/data_block/dt_assoc/item[@key='attributes']/dt_assoc/item[@key='array']/dt_array/item[@key='0']/dt_assoc/item[@key='param']"].text.should == "arrayvalue1"
+        @body.root.elements["body/data_block/dt_assoc/item[@key='attributes']/dt_assoc/item[@key='array']/dt_array/item[@key='1']/dt_assoc/item[@key='param']"].text.should == "arrayvalue2"
+      end
+
+      it "should set array list params" do
+        @body.root.elements["body/data_block/dt_assoc/item[@key='attributes']/dt_assoc/item[@key='array_list']/dt_array/item[@key='0']"].text.should == "arrayvalue1"
+        @body.root.elements["body/data_block/dt_assoc/item[@key='attributes']/dt_assoc/item[@key='array_list']/dt_array/item[@key='1']"].text.should == "arrayvalue2"
+      end
+    end
+  end
+
+end

data/spec/moo_moo/nameserver_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe MooMoo::Nameserver do
+  it { should have_registered_service(:create, :nameserver) }
+  it { should have_registered_service(:delete, :nameserver) }
+  it { should have_registered_service(:get, :nameserver) }
+  it { should have_registered_service(:modify, :nameserver) }
+end

data/spec/moo_moo/provisioning_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'date'
+
+describe MooMoo::Provisioning do
+  it { should have_registered_service(:cancel_order, :trust_service) }
+  it { should have_registered_service(:cancel_pending_orders, :order) }
+  it { should have_registered_service(:modify, :domain) }
+  it { should have_registered_service(:process_pending, :domain) }
+  it { should have_registered_service(:renew_domain, :domain, :renew) }
+  it { should have_registered_service(:revoke, :domain) }
+  it { should have_registered_service(:update_contacts, :domain) }
+  it { should have_registered_service(:register_domain, :domain, :sw_register) }
+  it { should have_registered_service(:register_trust_service, :trust_service) }
+end

data/spec/moo_moo/transfer_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe MooMoo::Transfer do
+  it { should have_registered_service(:cancel_transfer, :transfer) }
+  it { should have_registered_service(:cancel_transfer_for_order, :transfer) }
+  it { should have_registered_service(:check_transfer, :domain) }
+  it { should have_registered_service(:get_transfers_away, :domain) }
+  it { should have_registered_service(:get_transfers_in, :domain) }
+  it { should have_registered_service(:process_transfer, :transfer) }
+  it { should have_registered_service(:send_password, :transfer) }
+  it { should have_registered_service(:push_transfer, :domain, :rsp2rsp_push_transfer) }
+end

data/spec/moo_moo_spec.rb

@@ -18,7 +18,7 @@ describe MooMoo do
         config.pass = 'secret2'
       end
 
-      opensrs = MooMoo::OpenSRS::Base.new
+      opensrs = MooMoo::Base.new
 
       opensrs.host.should == 'host.com'
       opensrs.key.should  == 'secret'

data/spec/spec_helper.rb

@@ -1,24 +1,18 @@
 require 'rspec'
 require 'moo_moo'
+require 'webmock/rspec'
 require 'vcr'
 require 'extlib'
 
-MooMoo.configure do |config|
-  config.host = ENV['OPENSRS_TEST_URL']
-  config.key = ENV['OPENSRS_TEST_KEY']
-  config.user = ENV['OPENSRS_TEST_USER']
-  config.pass = ENV['OPENSRS_TEST_PASS']
-end
-
 VCR.config do |c|
   c.cassette_library_dir = 'spec/vcr_cassettes'
-  c.stub_with :fakeweb
+  c.stub_with :webmock
 
-  c.default_cassette_options = {:record => :new_episodes, :match_requests_on => [:uri]}
+  c.default_cassette_options = {:record => :none, :match_requests_on => [:uri]}
 end
 
 def requires_attr(attr, &block)
-  expect { block.call }.to raise_error(MooMoo::MooMooArgumentError, /Missing required parameter: #{attr}/i)
+  expect { block.call }.to raise_error(MooMoo::ArgumentError, /Missing required parameter: #{attr}/i)
 end
 
 def live_test?
@@ -59,19 +53,17 @@ end
 RSpec.configure do |c|
   c.extend VCR::RSpec::Macros
   c.before(:each) do
-    if live_test?
-      MooMoo.configure do |config|
-        config.host = ENV['OPENSRS_TEST_URL']
-        config.key = ENV['OPENSRS_TEST_KEY']
-        config.user = ENV['OPENSRS_TEST_USER']
-        config.pass = ENV['OPENSRS_TEST_PASS']
-      end
-    else
-      MooMoo.configure do |config|
-        config.host = 'server.com'
-        config.key = '123key'
-        config.user = 'opensrs_user'
-        config.pass = 'password'
+    MooMoo.configure do |config|
+      if live_test?
+        config.host = ENV['OPENSRS_TEST_URL'] if ENV['OPENSRS_TEST_URL']
+        config.key  = ENV['OPENSRS_TEST_KEY']  || raise(ArgumentError, "OPENSRS_TEST_KEY is required")
+        config.user = ENV['OPENSRS_TEST_USER'] || raise(ArgumentError, "OPENSRS_TEST_USER is required")
+        config.pass = ENV['OPENSRS_TEST_PASS'] || raise(ArgumentError, "OPENSRS_TEST_PASS is required")
+      else
+        config.host = "testhost.com"
+        config.key  = "testkey"
+        config.user = "testuser"
+        config.pass = "testpass"
       end
     end
   end
@@ -86,3 +78,23 @@ RSpec::Matchers.define :have_attr_accessor do |attribute|
     "have attr_accessor :#{attribute}"
   end
 end
+
+RSpec::Matchers.define(:have_registered_service) do |*args|
+  method_name = args[0]
+  object_name = args[1]
+  action_name = args[2] || method_name
+
+  match do |object|
+    parameters = {:the => :params, :cookie => "thecookie"}
+    object.should_receive(:run_command).
+                  with(action_name, object_name, parameters, "thecookie").
+                  and_return("theresult")
+
+
+    object.send(method_name, parameters) == "theresult"
+  end
+
+  description do
+    "have registered service :#{method_name} delegating to action :#{action_name} and object :#{object_name}"
+  end
+end