fake_name_generator 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fake_name_generator (0.0.1)
+    fake_name_generator (0.0.2)
       json (>= 1.5.1)
 
 GEM
@@ -9,7 +9,7 @@ GEM
   specs:
     diff-lcs (1.1.2)
     fakeweb (1.3.0)
-    json (1.5.1)
+    json (1.5.3)
     rspec (2.5.0)
       rspec-core (~> 2.5.0)
       rspec-expectations (~> 2.5.0)

data/README.rdoc

@@ -52,6 +52,7 @@ I would love some help and pointers on how to make this a better gem.
 == Authors
 
 * Bill Turner <billturner@gmail.com>
+* Jim Meyer <https://github.com/purp/>
 
 == License
 

data/lib/fake_name_generator.rb

@@ -50,7 +50,7 @@ class FakeNameGenerator
 
   ##
   # The current version of the gem
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 
   ##
   # The current FakeNameGenerator.com API endpoint
@@ -76,42 +76,7 @@ class FakeNameGenerator
   class APIConnectionError < StandardError; end
   class APIKeyInvalidError < StandardError; end
 
-  attr_reader :country,
-    :nameset,
-    :gender,
-    :data,
-    :full_name,
-    :first_name,
-    :middle_name,
-    :last_name,
-    :maiden_name,
-    :email_address,
-    :gender_name,
-    :street1,
-    :street2,
-    :street3,
-    :city,
-    :state,
-    :zip,
-    :country_code,
-    :phone_number,
-    :birthday,
-    :occupation,
-    :password,
-    :domain,
-    :cc_type,
-    :cc_number,
-    :cc_exp_month,
-    :cc_exp_year,
-    :cc_cvv,
-    :national_id,
-    :national_id_type,
-    :blood_type,
-    :weight_kilograms,
-    :weight_pounds,
-    :height_centimeters,
-    :height_inches,
-    :ups_tracking_number
+  attr_reader :country, :data, :gender, :nameset
 
   # === Parameters
   # * _api_key_ = API key for accessing the FakeNameGenerator.com API (required)
@@ -119,7 +84,8 @@ class FakeNameGenerator
   # * _nameset_ = language-related names returned (default: 'us')
   # * _gender_ = specify whether random, male, or female values returned (default: random)
   def initialize(options={})
-    @api_key = options[:api_key] or raise ArgumentError, "No API key provided"
+    options[:api_key] || options[:json_data] or raise ArgumentError, "No API key or JSON data provided"
+    @api_key = options[:api_key]
     @country = options[:country] || DEFAULT_COUNTRY
     @nameset = options[:nameset] || DEFAULT_NAMESET
     @gender = options[:gender] || DEFAULT_GENDER
@@ -128,21 +94,29 @@ class FakeNameGenerator
     raise ArgumentError, "Specified nameset parameter is not valid. Please see FakeNameGenerator::VALID_NAMESET_CODES" unless VALID_NAMESET_CODES.include?(@nameset)
     raise ArgumentError, "Specified gender parameter is not valid. Please see FakeNameGenerator::VALID_GENDER_CODES" unless VALID_GENDER_CODES.include?(@gender)
 
-    url = [API_URL, build_params].join('?')
-    response = Net::HTTP.get_response(URI.parse(url))
-
-    case response.code
-    when '500' || 500
-      raise APIConnectionError, "FakeNameGenerator API not working (500 Error)"
-    when '403' || 403
-      raise APIKeyInvalidError, "Provided API key is not valid (403 Error)"
-    when '200' || 200
-      @data = JSON.parse(response.body)
-      build_name
+    if options[:json_data]
+      @data = JSON.parse(options[:json_data])
     else
-      raise StandardError, "Unexpected response from FakeNameGenerator.com API"
+      url = [API_URL, build_params].join('?')
+      response = Net::HTTP.get_response(URI.parse(url))
+
+      case response.code
+      when '500' || 500
+        raise APIConnectionError, "FakeNameGenerator API not working (500 Error)"
+      when '403' || 403
+        raise APIKeyInvalidError, "Provided API key is not valid (403 Error)"
+      when '200' || 200
+        @data = JSON.parse(response.body)
+      else
+        raise StandardError, "Unexpected response from FakeNameGenerator.com API"
+      end
     end
+  end
 
+  ##
+  # Return the current fake name attributes as JSON
+  def to_json
+    @data.to_json
   end
 
   private
@@ -151,46 +125,20 @@ class FakeNameGenerator
     "wsvKey=#{@api_key}&output=#{DEFAULT_OUTPUT}&c=#{@country}&n=#{@nameset}&gen=#{@gender}"
   end
 
-  def build_name
-    # name, gender info
-    @gender_name              = data['identity']['gender']['value']
-    @full_name                = data['identity']['full_name']['value']
-    @first_name               = data['identity']['given_name']['value']
-    @middle_name              = data['identity']['middle_name']['value']
-    @last_name                = data['identity']['surname']['value']
-    @maiden_name              = data['identity']['maiden_name']['value']
-    @email_address            = data['identity']['email_address']['value']
-    # street address
-    @street1                  = data['identity']['street1']['value']
-    @street2                  = data['identity']['street2']['value']
-    @street3                  = data['identity']['street3']['value']
-    @city                     = data['identity']['city']['value']
-    @state                    = data['identity']['state']['value']
-    @zip                      = data['identity']['zip']['value']
-    @country_code             = data['identity']['country_code']['value']
-    @phone_number             = data['identity']['phone_number']['value']
-    # misc personal info
-    @birthday                 = data['identity']['birthday']['value']
-    @occupation               = data['identity']['occupation']['value']
-    @password                 = data['identity']['password']['value']
-    @domain                   = data['identity']['domain']['value']
-    # credit card info
-    @cc_type                  = data['identity']['cc_type']['value']
-    @cc_number                = data['identity']['cc_number']['value']
-    @cc_exp_month             = data['identity']['cc_exp_month']['value']
-    @cc_exp_year              = data['identity']['cc_exp_year']['value']
-    @cc_cvv                   = data['identity']['cc_cvv']['value']
-    # identifying information
-    @national_id              = data['identity']['national_id']['value']
-    @national_id_type         = data['identity']['national_id_type']['value']
-    @blood_type               = data['identity']['blood_type']['value']
-    @weight_kilograms         = data['identity']['weight_kilograms']['value']
-    @weight_pounds            = data['identity']['weight_pounds']['value']
-    @height_centimeters       = data['identity']['height_centimeters']['value']
-    @height_inches            = data['identity']['height_inches']['value']
-    @ups_tracking_number      = data['identity']['ups_tracking_number']['value']
-
+  METHOD_ALIASES = {
+    :gender_name => :gender,
+    :first_name => :given_name,
+    :last_name => :surname
+  }
+
+  def method_missing(sym)
+    if data['identity'][sym.to_s]
+      data['identity'][sym.to_s]['value']
+    elsif METHOD_ALIASES[sym]
+      data['identity'][METHOD_ALIASES[sym].to_s]['value']
+    else
+      raise NoMethodError, "undefined method \`#{sym}' for #{self}"
+    end
   end
-
 end
 

data/spec/fake_name_generator_spec.rb

@@ -69,52 +69,66 @@ describe FakeNameGenerator do
 
   #end
 
-  context "valid api key" do
-
-    before do
-      @fake = FakeNameGenerator.new(:api_key => 'VALID_API_KEY')
-    end
-
-    it "should fill in the name fields" do
-      @fake.full_name.should_not be_empty
-      @fake.first_name.should_not be_empty
-      @fake.middle_name.should_not be_empty
-      @fake.last_name.should_not be_empty
-      @fake.maiden_name.should_not be_empty
-    end
-
-    it "should fill in the address fields" do
-      @fake.street1.should_not be_empty
-      @fake.street2.should_not be_empty
-      @fake.city.should_not be_empty
-      @fake.state.should_not be_empty
-      @fake.zip.should_not be_empty
-      @fake.country_code.should_not be_empty
-      @fake.phone_number.should_not be_empty
-    end
-
-    it "should fill in the credit card fields" do
-      @fake.cc_type.should_not be_empty
-      @fake.cc_number.should_not be_empty
-      @fake.cc_exp_month.should_not be_nil
-      @fake.cc_exp_year.should_not be_nil
-      @fake.cc_cvv.should_not be_empty
-    end
-
-    it "should fill in the other random values" do
-      @fake.gender_name.should_not be_empty
-      @fake.birthday.should_not be_empty
-      @fake.occupation.should_not be_empty
-      @fake.password.should_not be_empty
-      @fake.domain.should_not be_empty
-      @fake.national_id.should_not be_empty
-      @fake.national_id_type.should_not be_empty
-      @fake.blood_type.should_not be_empty
-      @fake.weight_kilograms.should_not be_nil
-      @fake.weight_pounds.should_not be_nil
-      @fake.height_centimeters.should_not be_nil
-      @fake.height_inches.should_not be_nil
-      @fake.ups_tracking_number.should_not be_empty
+  describe "validly initialized" do
+
+    shared_examples_for "a valid instance" do
+      it "should fill in the name fields" do
+        fake.full_name.should_not be_empty
+        fake.first_name.should_not be_empty
+        fake.middle_name.should_not be_empty
+        fake.last_name.should_not be_empty
+        fake.maiden_name.should_not be_empty
+      end
+
+      it "should fill in the address fields" do
+        fake.street1.should_not be_empty
+        fake.street2.should_not be_empty
+        fake.city.should_not be_empty
+        fake.state.should_not be_empty
+        fake.zip.should_not be_empty
+        fake.country_code.should_not be_empty
+        fake.phone_number.should_not be_empty
+      end
+
+      it "should fill in the credit card fields" do
+        fake.cc_type.should_not be_empty
+        fake.cc_number.should_not be_empty
+        fake.cc_exp_month.should_not be_nil
+        fake.cc_exp_year.should_not be_nil
+        fake.cc_cvv.should_not be_empty
+      end
+
+      it "should fill in the other random values" do
+        fake.gender_name.should_not be_empty
+        fake.birthday.should_not be_empty
+        fake.occupation.should_not be_empty
+        fake.password.should_not be_empty
+        fake.domain.should_not be_empty
+        fake.national_id.should_not be_empty
+        fake.national_id_type.should_not be_empty
+        fake.blood_type.should_not be_empty
+        fake.weight_kilograms.should_not be_nil
+        fake.weight_pounds.should_not be_nil
+        fake.height_centimeters.should_not be_nil
+        fake.height_inches.should_not be_nil
+        fake.ups_tracking_number.should_not be_empty
+      end
+
+      it "should provide its data in JSON form when converted to_json" do
+        fake.to_json.should == fake.data.to_json
+      end
+    end
+
+    describe "from the web" do
+      it_should_behave_like "a valid instance" do
+        let(:fake) { FakeNameGenerator.new(:api_key => 'VALID_API_KEY') }
+      end
+    end
+
+    describe "using JSON data" do
+      it_should_behave_like "a valid instance" do
+        let(:fake) { FakeNameGenerator.new(:json_data => valid_api_body) }
+      end
     end
 
   end

data/spec/spec_helper.rb

@@ -7,12 +7,20 @@ require 'fakeweb'
 
 require 'fake_name_generator'
 
-fixtures = File.dirname(File.expand_path(__FILE__)) + "/fixtures"
+FIXTURES = File.dirname(File.expand_path(__FILE__)) + "/fixtures"
+
+def valid_api_body
+  File.read("#{FIXTURES}/VALID_API_KEY.json")
+end
+
+def invalid_api_body
+  File.read("#{FIXTURES}/INVALID_API_KEY.xml")
+end
 
 FakeWeb.allow_net_connect = false
 
-FakeWeb.register_uri(:get, %r[http://svc\.webservius\.com/v1/CorbanWork/fakename\?(.*&|)wsvKey=VALID_API_KEY]i, :body => File.read("#{fixtures}/VALID_API_KEY.json", :content_type => 'text/json', :status => ['200', 'OK']))
-FakeWeb.register_uri(:get, %r[http://svc\.webservius\.com/v1/CorbanWork/fakename\?(.*&|)wsvKey=INVALID_API_KEY]i, :body => File.read("#{fixtures}/INVALID_API_KEY.xml", :content_type => 'application/xml', :status => ["403", "Forbidden"]))
+FakeWeb.register_uri(:get, %r[http://svc\.webservius\.com/v1/CorbanWork/fakename\?(.*&|)wsvKey=VALID_API_KEY]i, :body => valid_api_body, :content_type => 'text/json', :status => ['200', 'OK'])
+FakeWeb.register_uri(:get, %r[http://svc\.webservius\.com/v1/CorbanWork/fakename\?(.*&|)wsvKey=INVALID_API_KEY]i, :body => invalid_api_body, :content_type => 'application/xml', :status => ["403", "Forbidden"])
 
 RSpec.configure do |config|
 end

metadata

@@ -2,7 +2,7 @@
 name: fake_name_generator
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Bill Turner
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-01 00:00:00 -05:00
+date: 2011-06-22 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: fake_name_generator
-rubygems_version: 1.5.1
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A simple Ruby wrapper to the FakeNameGenerator.com API