robowhois 0.1.0 → 0.2.0

data/.gitignore

@@ -1,3 +1,7 @@
+# Bundler
 .bundle
 pkg/*
-yardoc
+
+# YARD
+.yardoc
+yardoc/

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
 
+## Release 0.2.0
+
+* NEW: Added support for Heroku ROBOWHOIS_API_KEY environment variable
+
+
 ## Release 0.1.0
 
 * First release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    robowhois (0.1.0)
+    robowhois (0.2.0)
       httparty (~> 0.8.0)
 
 GEM

data/README.md

@@ -2,6 +2,17 @@
 
 This is the official Ruby client for [RoboWhois](http://www.robowhois.com/) [API](http://docs.robowhois.com/api/).
 
+[RoboWhois](http://www.robowhois.com/) is a web service that provides an API suite to **access WHOIS records and domain related information with a unified, consistent interface**.
+
+Using RoboWhois API you can:
+
+- check domain availability for any supported TLD
+- lookup WHOIS information for a domain and retrieve the WHOIS record
+- access WHOIS data using a consistent, well-structured, HTTP-based interface
+- retrieve WHOIS details parsed as convenient JSON structure
+
+Visit RoboWhois [site](http://www.robowhois.com/) and [documentation](http://docs.robowhois.com/) to learn more about the service.
+
 
 ## Installation
 

data/lib/robo_whois/version.rb

@@ -12,7 +12,7 @@ class RoboWhois
   # Holds information about library version.
   module Version
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     PATCH = 0
     BUILD = nil
 

data/lib/robo_whois.rb

@@ -18,7 +18,7 @@ class RoboWhois
   end
 
   class APIError < Error
-
+    # @return [Hash] The :key => "value" hash of attributes.
     attr_reader :attributes
 
     def initialize(attributes)
@@ -30,13 +30,21 @@ class RoboWhois
 
   base_uri "http://api.robowhois.com"
 
+  # @return [HTTParty::Response] The response object returned by the last API call.
   attr_reader :last_response
 
 
-  def initialize(api_key)
-    @auth = { :username => api_key, :password => "X" }
+  def initialize(options = {})
+    options[:api_key] = (options[:api_key] || ENV["ROBOWHOIS_API_KEY"]).to_s
+
+    raise ArgumentError, "Missing API key" if options[:api_key].empty?
+
+    @auth = { :username => options[:api_key], :password => "X" }
   end
 
+  # Gets the current API key.
+  #
+  # @return [String]
   def api_key
     @auth[:username]
   end

data/robowhois.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "robowhois"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Simone Carletti"]

data/spec/unit/robo_whois_spec.rb

@@ -1,12 +1,26 @@
 require 'spec_helper'
 
 describe RoboWhois do
-  let(:client) { RoboWhois.new('API_KEY') }
+  let(:client) { RoboWhois.new(:api_key => 'API_KEY') }
 
   describe "#initialize" do
-    it "sets api_key" do
+    it "sets api_key from argument" do
+      client = RoboWhois.new(:api_key => 'API_KEY')
       client.api_key.should == 'API_KEY'
     end
+
+    it "sets api_key from environment" do
+      ENV['ROBOWHOIS_API_KEY'] = 'ENV_KEY'
+      client = RoboWhois.new
+      client.api_key.should == 'ENV_KEY'
+      ENV.delete('ROBOWHOIS_API_KEY')
+    end
+
+    it "raises if no api_key is set" do
+      lambda {
+        RoboWhois.new
+      }.should raise_error(ArgumentError, "Missing API key")
+    end
   end
 
   describe "#request" do
@@ -163,7 +177,7 @@ describe RoboWhois do
 
   context "request failure" do
     describe "BadCredentials" do
-      let(:client) { client = RoboWhois.new('BAD_KEY') }
+      let(:client) { client = RoboWhois.new(:api_key => 'BAD_KEY') }
 
       before do
         stub_get('http://BAD_KEY:X@api.robowhois.com/account', 'error_bad_credentials')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: robowhois
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70172086412360 !ruby/object:Gem::Requirement
+  requirement: &70097769102120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *70172086412360
+  version_requirements: *70097769102120
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70172086411840 !ruby/object:Gem::Requirement
+  requirement: &70097769101600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70172086411840
+  version_requirements: *70097769101600
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70172086411380 !ruby/object:Gem::Requirement
+  requirement: &70097769101200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70172086411380
+  version_requirements: *70097769101200
 description: Ruby client for the RoboWhois API.
 email:
 - weppos@weppos.net