peter-mueller 1.0.0

data/README.rdoc

@@ -0,0 +1,122 @@
+= PeterMueller
+
+{<img src="https://secure.travis-ci.org/tvw/peter-mueller.png?branch=master" alt="Build Status" />}[http://travis-ci.org/tvw/peter-mueller]
+
+PeterMueller is a library for creating fictitious German address data. Though
+pure fictitious, the address data look very real. The data is based on the
+most used firstnames, lastnames, towns, streets etc. in Germany.
+
+It can be used eg. to populate a database with fictitios data.
+
+
+== Usage
+
+=== Installing the Gem
+
+
+  gem install peter-mueller
+
+=== Examples  
+
+Creating a new Person:
+
+  require 'peter-mueller'
+  include PeterMueller
+
+  person = Person.new
+
+  puts person
+
+may result to:
+
+  Heinz-Werner Hagemann
+  
+  Breslauer Str. 65
+  24768 Rendsburg
+  
+  Telefon: 04331-687536
+  E-Mail: heinzwerner7259@gmx.net
+
+
+Creating a new Company:
+
+  company = Company.new
+  puts company
+
+may result to:
+
+  Rauch GmbH
+  
+  Einsteinstr. 120
+  60439 Frankfurt
+  
+  Telefon: 069-80095510-0
+  E-Mail: info@rauch-gmbh.de
+  WWW: www.rauch-gmbh.de
+
+Now lets create 2 employees for the same company:
+
+  company.employees(2).each do |e|
+    puts "-" * 20
+    puts e
+  end
+
+which results to:
+
+  --------------------
+  Hanna Fürst
+  
+  Luisenstr. 95
+  91126 Schwabach
+  
+  Telefon: 09122-507532
+  Mobil: 01577-87047253
+  E-Mail: hanna2178@hotmail.com
+  
+  Geschäftlich
+  Telefon: 069-80095510-100
+  E-Mail: hanna_fuerst@rauch-gmbh.de
+  --------------------
+  Claus-Dieter Wetzel
+  
+  Eschstr. 28
+  25980 Sylt
+  
+  Telefon: 04651-9177484
+  Mobil: 0170-99988691
+  
+  Geschäftlich
+  Telefon: 069-80095510-101
+  E-Mail: clausdieter9865@rauch-gmbh.de
+
+
+== Why PeterMueller?
+
+The generated addresses should not result in real addresses. Peter is probably
+the most used German firstname and Müller the probably most popular
+lastname. So PeterMueller stands for anybody and nobody. Something like that ;-)
+
+
+== Author
+
+Thomas Volkmar Worm <mailto:tvw@s4r.de>
+
+
+== License
+
+Copyright (c) 2012 Thomas Volkmar Worm <mailto:tvw@s4r.de>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions: The above copyright
+notice and this permission notice shall be included in all copies or
+substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS",
+WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
+THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
+THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rdoc/task'
+
+task :default do
+  sh %Q{bundle install}
+  sh %Q{rake build}
+  sh %Q{rake install}
+  rm_rf "pkg"
+end
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end

data/lib/peter-mueller/address.rb

@@ -0,0 +1,35 @@
+module PeterMueller
+
+  # A fictitious address. The address should look valid, but is not an existing address.
+  # The street might not even exist in the town. But, by accident, the address could exist.
+  class Address
+    # The zip code (PLZ).
+    attr_reader :zip
+
+    # Name of the town, the street and its numner.
+    attr_reader :town, :street_name, :street_number
+
+    # The landline phone prefix for the address. This can be used, when
+    # generating a Phonenumber which should fit with the address.
+    attr_reader :phone_prefix
+
+    # Creates a new Address.
+    def initialize
+      (@zip, @phone_prefix, @town) = TOWNS.sample.split("\t")
+      @street_name = STREETS.sample
+      @street_number = rand(1..120).to_s + (rand(30)==15 ? ('a'..'e').to_a.sample : "")
+    end
+
+    # The streetname and the streetnumber in one string.
+    def street
+      "#{@street_name} #{@street_number}"
+    end
+
+    # The string representation of the address.
+    def to_s
+      "#{street}\n#{zip} #{town}"
+    end
+
+  end
+
+end

data/lib/peter-mueller/company.rb

@@ -0,0 +1,79 @@
+module PeterMueller
+
+  # A fictitious company.
+  # This is how you create a company with 3 employees:
+  #
+  #   c = Company.new
+  #   puts c
+  #   c.employees(3).each do |e|
+  #     puts e
+  #   end
+  class Company
+    # The company name.
+    attr_reader :name
+    # The Address of the company.
+    attr_reader :address
+    # The Phonenumber of the company.
+    attr_reader :phonenumber
+    # The second level domain of the company for generating internet addresses.
+    attr_reader :domain
+    # The Email of the company.
+    attr_reader :email
+    # The World-Wide-Web-address of the company.
+    attr_reader :www
+
+    # Creates a new company.
+    def initialize
+      @name = Person.new.lastname + ' ' + FORM_OF_ORGANISATION.sample
+      @address = Address.new
+      @phonenumber = Phonenumber.new(@address.phone_prefix)
+      @phonenumber.extension = "0"
+      @domain = domain_from_name(@name)
+      @email = Email.new
+      @email.host = domain
+      @email.user = "info"
+      @www = "www.#{@domain}"
+      @last_ext = 99
+    end
+
+    # Creates and returns a new employee.
+    def employee
+      @last_ext += 1
+      p = Person.new
+      p.office_phonenumber = Phonenumber.new(@phonenumber.prefix, phonenumber.number, @last_ext.to_s)
+      p.office_email = Email.new(p)
+      p.office_email.host = @domain
+      p
+    end
+
+    # Returns n employees as an array or via a block.
+    def employees(n)
+      return n.times.collect{ employee } unless block_given?
+      n.times{ yield employee }
+    end
+
+    # The string representation of the company.
+    def to_s
+      fields = []
+      fields << name
+      fields << ""
+      fields << address.to_s
+      fields << ""
+      fields << "Telefon: #{phonenumber}"
+      fields << "E-Mail: #{email}"
+      fields << "WWW: #{www}"
+      fields.join("\n")
+    end
+
+
+    private
+    def domain_from_name(name)
+      [
+       name.split(/\-|\s/).collect{|s| Email.umlautfix(s).gsub(/[^a-zA-Z]/,"").downcase }.join("-"),
+       TLD.sample,
+      ].join(".")
+    end
+
+  end
+
+end

data/lib/peter-mueller/data/freemail_provider.txt

@@ -0,0 +1,8 @@
+aol.de
+freenet.de
+googlemail.com
+gmx.de
+gmx.net
+t-online.de
+hotmail.com
+web.de

data/lib/peter-mueller/data/mobilvorwahlen.txt

@@ -0,0 +1,53 @@
+1510
+1511
+1512
+1513
+1514
+1515
+1516
+1517
+1518
+1519
+160
+170
+171
+175
+1520
+1521
+1522
+1523
+1524
+1525
+1526
+1527
+1528
+1529
+162
+172
+173
+174
+1570
+1571
+1572
+1573
+1574
+1575
+1576
+1577
+1578
+1579
+163
+177
+178
+1590
+1591
+1592
+1593
+1594
+1595
+1596
+1597
+1598
+1599
+176
+179