namecheap 0.0.2 → 0.1.0

data/config/namecheap.yml.orig

@@ -1,7 +1,7 @@
 development:
-  key: 4fad5a63f8bd4e03a8bbc8131a2fb331
-  username: parasquid
-  client_ip: 175.136.192.89
+  key: apikey
+  username: apiuser
+  client_ip: 127.0.0.1
 
 test:
   key: apikey

data/lib/monkey_patch.rb

@@ -1,3 +1,5 @@
+# Monkey-patches, mostly taken from Rails :)
+
 class Hash
   def symbolize_keys!
     keys.each do |key|
@@ -19,3 +21,36 @@ class Hash
     "#{CGI.escape(key.to_param)}=#{CGI.escape(to_param.to_s)}"
   end
 end
+
+class Module
+  # Delegate method
+  # It expects an array of arguments that contains
+  # the methods to be delegated and a hash of options
+  def delegate(*methods)
+    # Pop up the options hash from arguments array
+    options = methods.pop
+    # Check the availability of the options hash
+    # and more specifically the :to option
+    # Raises an error if one of them is not there
+    unless options.is_a?(Hash) && to = options[:to]
+      raise ArgumentError, "Delegation needs a target. Supply an options hash with a :to key as the last argument (e.g. delegate :hello, :to => :greeter)."
+    end
+
+    # Make sure the :to option follows syntax rules
+    # for method names
+    if options[:prefix] == true && options[:to].to_s =~ /^[^a-z_]/
+      raise ArgumentError, "Can only automatically set the delegation prefix when delegating to a method."
+    end
+
+    # Set the real prefix value
+    prefix = options[:prefix] && "#{options[:prefix] == true ? to : options[:prefix]}_"
+
+    # Here comes the magic of ruby :)
+    # Reflection techniques are used here:
+    # module_eval is used to add new methods on the fly which:
+    # expose the contained methods' objects
+    methods.each do |method|
+      module_eval("def #{prefix}#{method}(*args, &block)\n#{to}.__send__(#{method.inspect}, *args, &block)\nend\n", "(__DELEGATION__)", 1)
+    end
+  end
+end

data/lib/namecheap.rb

@@ -1,33 +1,33 @@
 require 'httparty'
+require 'monkey_patch'
+require 'pp'
+
+$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/namecheap")
+Dir.glob("#{File.dirname(__FILE__)}/namecheap/*.rb") { |lib| require File.basename(lib, '.*') }
 
 module Namecheap
-  SANDBOX = 'https://api.sandbox.namecheap.com/xml.response'
-  PRODUCTION = 'https://api.namecheap.com/xml.response'
-  class Api
-    attr_reader :username, :key, :client_ip
-    def initialize(options = {})
-      config_file = options[:config_file] || "#{File.dirname(__FILE__)}/../config/namecheap.yml"
-      environment = options[:environment] || ENV['RACK_ENV'] || 'development'
-      config = options[:config_file] || YAML.load_file(config_file)[environment].symbolize_keys!
-      @key = options[:key] || config[:key]
-      @username = options[:username] || config[:username]
-      @client_ip = options[:client_ip] || config[:client_ip]
-      @endpoint = (environment == 'production' ? PRODUCTION : SANDBOX)
-    end
 
-    protected
+  extend self
 
-    def api_call(command, command_args)
-      args = {}
-      args['ApiUser'] = args['UserName'] = @username
-      args['ApiKey'] = @key
-      args['ClientIp'] = @client_ip
-      args['Command'] = command
-      query = @endpoint + '?' + args.to_param
-      HTTParty.get(query)
-    end
+  # Sets the Mongoid configuration options. Best used by passing a block.
+  #
+  # @example Set up configuration options.
+  #   Namecheap.configure do |config|
+  #     key = "apikey"
+  #     username = "apiuser"
+  #     client_ip = "127.0.0.1"
+  #   end
+  # @return [ Config ] The configuration obejct.
+  def configure
+    block_given? ? yield(Config) : Config
   end
-end
+  alias :config :configure
+  
+  # Take all the public instance methods from the Config singleton and allow
+  # them to be accessed through the Namecheap module directly.
+  #
+  # @example Delegate the configuration methods.
+  #   Namecheap.key = 'newkey'
+  delegate *(Config.public_instance_methods(false) << { :to => Config })
 
-$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/namecheap")
-Dir.glob("#{File.dirname(__FILE__)}/namecheap/*.rb") { |lib| require File.basename(lib, '.*') }
+end

data/lib/namecheap/api.rb

@@ -0,0 +1,19 @@
+module Namecheap
+  class Api
+    SANDBOX = 'https://api.sandbox.namecheap.com/xml.response'
+    PRODUCTION = 'https://api.namecheap.com/xml.response'
+    ENVIRONMENT = defined?(Rails) && Rails.respond_to?(:env) ? Rails.env : (ENV["RACK_ENV"] || 'development')
+    ENDPOINT = (ENVIRONMENT == 'production' ? PRODUCTION : SANDBOX)
+
+    def api_call(command, command_args)
+      args = {}
+      args['ApiUser'] = args['UserName'] = Namecheap.username
+      args['ApiKey'] = Namecheap.key
+      args['ClientIp'] = Namecheap.client_ip
+      args['Command'] = command
+      args.merge! command_args
+      query = ENDPOINT + '?' + args.to_param
+      HTTParty.get(query)
+    end
+  end
+end

data/lib/namecheap/config.rb

@@ -0,0 +1,78 @@
+module Namecheap
+  module Config
+    # Taken and modified from Mongoid config.rb
+
+    extend self
+
+    attr_accessor :settings, :defaults
+    @settings = {}
+    @defaults = {}
+
+    # Define a configuration option with a default.
+    #
+    # @example Define the option.
+    #   Config.option(:client_ip, :default => '127.0.0.1')
+    #
+    # @param [ Symbol ] name The name of the configuration option.
+    # @param [ Hash ] options Extras for the option.
+    #
+    # @option options [ Object ] :default The default value.
+    def option(name, options = {})
+      defaults[name] = settings[name] = options[:default]
+
+      class_eval <<-RUBY
+        def #{name}
+          settings[#{name.inspect}]
+        end
+
+        def #{name}=(value)
+          settings[#{name.inspect}] = value
+        end
+
+        def #{name}?
+          #{name}
+        end
+      RUBY
+    end
+
+    option :key, :default => 'apikey'
+    option :username, :default => 'apiuser'
+    option :client_ip, :default => '127.0.0.1'
+
+    # Configure namecheap from a hash. This is usually called after parsing a
+    # yaml config file such as mongoid.yml.
+    #
+    # @example Configure Namecheap.
+    #   config.from_hash({})
+    #
+    # @param [ Hash ] options The settings to use.
+    def from_hash(options = {})
+      options.each_pair do |name, value|
+        send("#{name}=", value) if respond_to?("#{name}=")
+      end
+    end
+
+    # Load the settings from a compliant namecheap.yml file. This can be used for
+    # easy setup with frameworks other than Rails.
+    #
+    # @example Configure Namecheap.
+    #   Namecheap.load!("/path/to/namecheap.yml")
+    #
+    # @param [ String ] path The path to the file.
+    def load!(path)
+      settings = YAML.load(ERB.new(File.new(path).read).result)[ENVIRONMENT]
+      if settings.present?
+        from_hash(settings)
+      end
+    end
+
+    # Reset the configuration options to the defaults.
+    #
+    # @example Reset the configuration options.
+    #   config.reset
+    def reset
+      settings.replace(defaults)
+    end
+
+  end
+end

data/lib/namecheap/domains.rb

@@ -1,8 +1,14 @@
 module Namecheap
-  class Domains < Namecheap::Api
+  class Domains < Api
     def get_list(options = {})
       args = options.clone
       api_call('namecheap.domains.getList', args)
     end
+
+    def check(domains = [], options = {})
+      args = options.clone
+      args['DomainList'] = domains.respond_to?(:join) ? domains.join(',') : domains
+      api_call('namecheap.domains.check', args)
+    end
   end
-end
+end

data/lib/namecheap/version.rb

@@ -1,3 +1,3 @@
 module Namecheap
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/domains_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "Domains"  do
-  it "should instantiate"  do
-    Namecheap::Domains.new(:environment => 'test')
+  it 'should initialize' do
+    Namecheap::Domains.new
   end
 end

data/spec/namecheap_spec.rb

@@ -2,34 +2,46 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 describe "NamecheapAPI Wrapper"  do
   describe "initializating settings" do
+
+    before :each do
+      Namecheap.reset
+    end
+
     describe "with defaults" do
       it "should contain a username" do
-        namecheap = Namecheap::Api.new(:environment => 'test')
-        namecheap.send(:username).should == 'apiuser'
+        Namecheap.username.should == 'apiuser'
       end
       it "should contain a key" do
-        namecheap = Namecheap::Api.new(:environment => 'test')
-        namecheap.send(:key).should == 'apikey'
+        Namecheap.key.should == 'apikey'
       end
       it "should contain a client_ip" do
-        namecheap = Namecheap::Api.new(:environment => 'test')
-        namecheap.send(:client_ip).should == '127.0.0.1'
+        Namecheap.client_ip.should == '127.0.0.1'
       end
     end
 
     describe "with defaults overidden" do
-      it "shoud contain a overidden username" do
-        namecheap = Namecheap::Api.new(:environment => 'test', :username => 'testuser')
-        namecheap.send(:username).should == 'testuser'
+      it "should contain an overidden key" do
+        Namecheap.configure do |config|
+          config.key = 'newkey'
+        end
+
+        Namecheap.key.should == 'newkey'
       end
 
-      it "shoud contain a key" do
-        namecheap = Namecheap::Api.new(:environment => 'test', :key => 'testkey')
-        namecheap.send(:key).should == 'testkey'
+      it "should contain an overridden username" do
+        Namecheap.configure do |config|
+          config.username = 'newuser'
+        end
+
+        Namecheap.username.should == 'newuser'
       end
-      it "shoud contain a client_ip" do
-        namecheap = Namecheap::Api.new(:environmeny => 'test', :client_ip => '66.11.22.44')
-        namecheap.send(:client_ip).should == '66.11.22.44'
+
+      it "should contain an overridden client_ip" do
+        Namecheap.configure do |config|
+          config.client_ip = '192.168.0.1'
+        end
+
+        Namecheap.client_ip.should == '192.168.0.1'
       end
     end
   end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - parasquid
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-14 00:00:00 Z
+date: 2011-10-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -63,6 +63,8 @@ files:
 - config/namecheap.yml.orig
 - lib/monkey_patch.rb
 - lib/namecheap.rb
+- lib/namecheap/api.rb
+- lib/namecheap/config.rb
 - lib/namecheap/domains.rb
 - lib/namecheap/version.rb
 - namecheap.gemspec