domain_tools 0.0.1 → 0.0.2

data/examples/1_prepare.rb

@@ -14,7 +14,7 @@ DomainTools::where("var1=value1&var2=value2")
 # Useful to separate in a settings file your default configuration
 DomainTools::with({
   :username   => DOMAINTOOLS_USERNAME,
-  :key        => DOMAINTOOLS_KEY,         
+  :key        => DOMAINTOOLS_KEY,
   :service    => "whois",
   :format     => "json",
   :domain     => "domaintools.com",

data/examples/6_using_freeapi.rb

@@ -0,0 +1,36 @@
+# ----------------------------------------------------------------------------- 
+# 6. USING THE FREE API
+# -----------------------------------------------------------------------------
+
+# 6.A Define settings
+# This a a clear way to define each settings
+DomainTools::use(DOMAINTOOLS_USERNAME,DOMAINTOOLS_KEY)
+DomainTools::get("whois")
+# Set the API type using the "with_api" method
+DomainTools::with_api("free")
+DomainTools::on("domaintools.com")
+
+# 6.B All in one with a hash
+# Useful to separate in a settings file your default configuration
+DomainTools::with({
+  :username   => DOMAINTOOLS_USERNAME,
+  :key        => DOMAINTOOLS_KEY,
+  :service    => "whois",
+  :domain     => "domaintools.com",
+  :api        => "free"
+})     
+
+# 1.C Inline
+# Each call can be chained, useful in some case to gain space in your code
+DomainTools::use(DOMAINTOOLS_USERNAME,DOMAINTOOLS_KEY)::get("whois")::as("json")::on("domaintools.com")::with_api("free")
+# -----------------------------------------------------------------------------
+# TIPS
+# -----------------------------------------------------------------------------
+# You can use "is_free?" on a request object to test if it is using the freeapi
+
+request = DomainTools::get("whois")::as("json")::on("domaintools.com")::with_api("free").request
+if request.is_free?
+  puts "It's a free request!"
+else
+  puts "It's a standard request!"
+end

data/lib/domain_tools.rb

@@ -4,6 +4,9 @@ module DomainTools
 
   # Defaut HOST for the request
   HOST      = "api.domaintools.com"
+  # HOST for the Free API
+  FREE_HOST = "freeapi.domaintools.com"
+  
   # Use Signed Authentication
   SIGNED    = true              
   # Digest method used for HMAC signature

data/lib/domain_tools/core.rb

@@ -22,6 +22,11 @@ module DomainTools
     self
   end
   
+  # Change the host, to swith between free and standard API
+  def self.with_api(api)
+    self.set_data :api, api
+  end
+  
   # Select which service must be called for this request
   def self.get(service)
     self.set_data :service, service
@@ -93,7 +98,11 @@ module DomainTools
   
   def self.success?
     self.request.success?
-  end  
+  end
+  
+  def self.is_free?
+    self.request.is_free?
+  end
   
   def self.to_s
     self.request.to_s
@@ -127,6 +136,7 @@ module DomainTools
   
   def self.set_data(key,val)
     @data = {} unless @data
+    key = :host if key.to_s == 'api'
     @data[key.to_sym] = val
     # Update data for future request
     @request = DomainTools::Request.new @data

data/lib/domain_tools/request.rb

@@ -1,6 +1,6 @@
 module DomainTools
   class Request
-    attr_accessor :domain, :format, :service, :parameters
+    attr_accessor :username, :key, :domain, :format, :service, :parameters, :api
 
     def initialize(data)
       data.each{|key, value| set_data(key,value)}
@@ -42,10 +42,11 @@ module DomainTools
       @url = parts.join("")
     end
     
-    def authentication_params(uri)                                      
+    def authentication_params(uri)
+      return '' if is_free?
       return "&api_username=#{@username}&api_key=#{@key}" unless @signed
       timestamp = Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
-      data      = @username+timestamp+uri                                             
+      data      = @username+timestamp+uri
       require 'openssl'
       digester  = OpenSSL::Digest::Digest.new(DomainTools::DIGEST)
       signature = OpenSSL::HMAC.hexdigest(digester, @key, data)
@@ -55,12 +56,12 @@ module DomainTools
     
     def validate
       raise DomainTools::NoDomainException unless @domain || @parameters
-      raise DomainTools::NoCredentialsException unless @username || @key
+      raise DomainTools::NoCredentialsException unless @username && @key
       # must be a valid format (will be default FORMAT constant if empty or wrong)
-      @format       = DomainTools::FORMAT     if @format!="json" && @format!="xml" && @format != "html"
+      @format       = DomainTools::FORMAT     unless ['json','xml','html'].include?(@format)
       # if not already defined, use default
       @host         = DomainTools::HOST       if @host.nil?
-      @port         = DomainTools::PORT       if @port.nil?  
+      @port         = DomainTools::PORT       if @port.nil?
       @signed       = DomainTools::SIGNED     if @signed.nil?
       @version      = DomainTools::VERSION    if @version.nil?
     end
@@ -103,7 +104,7 @@ module DomainTools
     end
        
     # Check HTTP request status and raise an exception if needed
-    def validate_http_status    
+    def validate_http_status
       return true if @http.code.to_i == 200
       DomainTools::Exceptions::raise_by_code(@http.code)
     end   
@@ -155,10 +156,22 @@ module DomainTools
       nil
     end
     
-    private 
+    def is_free?
+      @host==DomainTools::FREE_HOST
+    end
+    
+    def api=(api)
+      self.host = api
+    end
+    
+    def host=(h)
+      @host = ['freeapi','free'].include?(h.to_s) ? DomainTools::FREE_HOST : DomainTools::HOST
+    end
+    
+    private
     
     def set_data(key,val)
-      eval("@#{key.to_s} = val")
+      eval("self.#{key.to_s} = val")
     end
     
     def format_parameters

metadata

@@ -1,32 +1,23 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: domain_tools
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.0.2
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - DomainTools, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-26 00:00:00 Z
+date: 2012-07-17 00:00:00.000000000 Z
 dependencies: []
-
-description: Ruby wrapper of the domaintools.com API, allowing you to easily request any service available on domaintools.com
+description: Ruby wrapper of the domaintools.com API, allowing you to easily request
+  any service available on domaintools.com
 email: MemberServices@DomainTools.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/domain_tools/core.rb
 - lib/domain_tools/error.rb
 - lib/domain_tools/error_parser.rb
@@ -42,40 +33,29 @@ files:
 - examples/3_browsing.rb
 - examples/4_error.rb
 - examples/5_complete.rb
+- examples/6_using_freeapi.rb
 homepage: http://www.domaintools.com/api/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 19
-      segments: 
-      - 1
-      - 3
-      - 4
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.4
 requirements: []
-
 rubyforge_project: domain_tools
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby gem for requesting domaintools.com webservices
 test_files: []
-