fqdn_facts 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df9ca38b346ae900a649ac39a6815d26643ff556
+  data.tar.gz: 1f629c750963efc5f7020baaa237f359e51ad7ae
+SHA512:
+  metadata.gz: 2b39dc3811576c37969b974bf723578d99bce42897e9f79f4ae2d9f3f4fb5d1ac6426f66c65bdb28c57295a64048eaccf62cb0abc383324ddde1212bafaf9433
+  data.tar.gz: 2218beac65bf4292abde592da849aece27ee2926715317af70cf5351919315ea7cd1c17d6508335ada84d6f1304ba99e1c3363c9b07522e1586d51bb775d54f9

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fqdn_facts.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,340 @@
+GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    {description}
+    Copyright (C) 2015  Carl P. Corliss <rabbitt@gmail.com>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  {signature of Ty Coon}, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
+

data/README.md

@@ -0,0 +1,164 @@
+# FqdnFacts
+
+FqdnFacts allows you to create fact handlers for different FQDN formats. This is primarily intended for use with Puppet/Facter to facilitate dynamic fact generation based on FQDNs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fqdn_facts'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fqdn_facts
+
+## Usage
+
+An example is (hopefully) worth a thousand words:
+
+```ruby
+
+%w[
+  facter 
+  fqdn_facts 
+  awesome_print
+].each do |lib|
+  begin
+    require lib
+  rescue LoadError
+    puts "Unable to find lib '#{lib}' - try installing it: gem install #{lib}"
+    exit 1
+  end
+end
+
+# setup a baseline handler that we can use as a "catch-all"
+# as well as a foundation to derive from with other handlers.
+FqdnFacts.register(:baseline) do
+  priority 1000 # we want this to be used last as a catch-all
+
+  # this defines the order of the components
+  components :host, :sub, :tld
+
+  # if a component is not listed in 'components' it is
+  # assumed that the validation for it is :any. However,
+  # all sub-components /must/ have a validation defined.
+  component :host, {
+    # order of sub-components is important!
+    type:    %r'^([a-z][a-z-]*[a-z])',
+    id:      %r'(\d{2,})',
+    subtype: %r'([ms]?)'
+  }
+  component :sub, /.+/
+  component :tld, /.+/
+
+  # conversions happen during fact retrieval and
+  # prior to dynamic fact generation.
+  convert :host, {
+    subtype: ->(v) {
+      case v
+        when 'm' then 'master'
+        when 's' then 'slave'
+      end
+    },
+    id: ->(v) { v.to_i }
+  }
+
+  # facts generated dynamically using procs/lambdas are calculated
+  # after all conversions, and in order order of assignment. If you
+  # use a lambda/proc, it is expected to receive at most one parameter.
+  # If you receive for one, then that parameter will contain a hash of
+  # facts generated up until that point.
+  add_fact :hostname, ->(f) { f[:host] }
+  add_fact :domain, ->(f) { [f[:sub], f[:tld]].join('.') }
+end # this essentially matches ([a-z][a-z-]*[a-z])(\d{2,})([ms]?)\.([^\.]+)\.bar\.com
+
+# copy baseline to create the qa handler. This means
+# that the :qa handler will contain all the settings
+# that we defined in :baseline aside from any settings
+# that we override in :qa.
+FqdnFacts.register(:qa, copy: :baseline) do
+  priority 10
+  component :sub, %r:qa\d*:
+  add_fact :env, 'qa'
+end # this matches ([a-z][a-z-]*[a-z])(\d{2,})([ms]?)\.qa\d+\.bar\.com
+
+# let's say you don't have a server that conforms to your previously
+# defined :host component (e.g., it doesn't use id/subtype), but is instead
+# a static value.
+FqdnFacts.register(:qa_foo_server, copy: :baseline) do
+  # we can set this to the same priority as the :qa handler because
+  # the :qa handler will fail on the :host component for foo-server
+  # which will allow this handler to pick it up.
+  priority 10
+  component :host, 'foo-server'
+  add_fact :nifty, 'data'
+end # this matches foo-server\.qa\d+\.bar\.com
+
+# Now we gather our facts:
+begin
+  facts = FqdnFacts.handler(ARGV.first || Facter['fqdn'].value).retrieve_facts
+  facts.each do |fact, value|
+    Facter.add(fact) { setcode { value } }
+  end
+  ap facts
+rescue FqdnFacts::Error::UnresolveableHandler => e
+  puts e.message
+end
+
+=begin
+
+Now given a FQDN of foo-server.qa3.bar.com, we would get the following facts:
+
+{
+  :fqdn         => "foo-server.qa3.bar.com",
+  :handler_name => "qa_foo_server",
+  :hostname     => "foo-server",
+  :domain       => "qa3.bar.com",
+  :nifty        => "data",
+  :host         => "foo-server",
+  :sub          => "qa3",
+  :tld          => "bar.com"
+}
+
+And, for foobaz01.qa1.bar.com:
+
+{
+  :fqdn         => "foobaz01.qa1.bar.com",
+  :handler_name => "qa",
+  :hostname     => "foobaz01",
+  :domain       => "qa1.bar.com",
+  :env          => "qa",
+  :host         => "foobaz01",
+  :sub          => "qa1",
+  :tld          => "bar.com",
+  :host_type    => "foobaz",
+  :host_id      => 1
+}
+
+And, now one that baseline should catch, www01.abc.com:
+
+{
+  :fqdn         => "www01.abc.com",
+  :handler_name => "baseline",
+  :hostname     => "www01",
+  :domain       => "abc.com",
+  :host         => "www01",
+  :sub          => "abc",
+  :tld          => "com",
+  :host_type    => "www",
+  :host_id      => 1
+}
+=end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fqdn_facts/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/fqdn_facts.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fqdn_facts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fqdn_facts"
+  spec.version       = FqdnFacts::VERSION
+  spec.authors       = ["Carl P. Corliss"]
+  spec.email         = ["rabbitt@gmail.com"]
+  spec.summary       = %q{Provides a DSL for generating FQDN specific facts that can be used with Facter}
+  spec.description   = %q{FqdnFacts allows you to create fact handlers for different FQDN formats. This is primarily intended for use with Puppet/Facter to facilitate dynamic fact generation based on FQDNs.}
+  spec.homepage      = "https://github.com/rabbitt/fqdn_facts/"
+  spec.license       = "GPLv2"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/fqdn_facts/base_handler.rb

@@ -0,0 +1,279 @@
+=begin
+    Copyright (C) 2015  Carl P. Corliss <rabbitt@gmail.com>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+=end
+
+require_relative 'core_ext'
+require_relative 'errors'
+
+module FqdnFacts
+  #
+  # base class for all handlers.
+  #
+  class BaseHandler
+    class << self
+      # Creates a new instance of this object using the internal state
+      # of another handler object
+      def copy_from(other)
+        new(other.export)
+      end
+    end
+
+    attr_accessor :priority, :fqdn
+
+    # default validation hash of FQDN components
+    DEFAULT_COMPONENTS = {
+      host: %r'(.+)',
+      sub: %r:(.+):,
+      tld: %r'(.+)'
+    } unless defined? DEFAULT_COMPONENTS
+    private_constant :DEFAULT_COMPONENTS
+
+    # initilalizer
+    def initialize(data = {})
+      @priority        = data.delete(:priority)        || 1
+      @conversions     = data.delete(:conversions)     || {}
+      @components      = data.delete(:components)      || DEFAULT_COMPONENTS.dup
+      @component_order = data.delete(:component_order) || DEFAULT_COMPONENTS.keys
+      @facts           = data.delete(:facts)           || {}
+      @fqdn            = ''
+
+      add_fact :fqdn, ->() { @fqdn }
+      add_fact :handler_name, self.class.to_s.split('::').last.underscore
+    end
+
+    ## DSL Methods
+    # @!group DSL
+
+    # The priority of the registered Fqdn Fact handler
+    #
+    # Lower priority fqdn fact handlers win out over
+    # higer priority handlers.
+    #
+    # @return Integer
+    def priority(value = nil)
+      return @priority if value.nil?
+      @priority = value.to_i
+    end
+
+    # Defines the order of the defined components
+    # that make up the FQDN.
+    #
+    # This defaults to: host, :sub, :tld
+    def components(*args)
+      @component_order = args
+    end
+
+    # Define a validation rule for a component.
+    #
+    # Validation rules can be one of the following
+    #   * :any (the same as /.+/), Hash
+    #   * A Hash of sub_component/regexs
+    #   * An array of valid values
+    #   * a scalar for exact matching
+    #
+    # @param component Symbol the name of the component to set validation for
+    # @param validate Hash{Symbol=>Symbol,Hash,Array,Scalar}
+    def component(component, validate=:any)
+      v = case validate
+        when :any then %r:(.+):
+        when Hash then
+          if @components[component.to_sym].is_a?(Hash)
+            basis = @components[component.to_sym]
+          else
+            basis = {}
+          end
+
+          basis.merge(
+            Hash[validate.keys.zip(
+              validate.values.collect {|v|
+                case v
+                  when :any then %r:(.+):
+                  when Regexp then v
+                  else Regexp.new(v)
+                end
+              }
+            )]
+          )
+        when Array then
+          %r:(#{validate.join('|')}):
+        else validate
+      end
+
+      if @components[component.to_sym]
+        # if their not the same class, then remove any conversions
+        unless @components[component.to_sym].is_a?(v.class)
+          @conversions.delete(component.to_sym)
+        end
+      end
+
+      @components[component.to_sym]  = v
+    end
+
+    # Defines a conversion rule for a given component.
+    # The conversion must be a Proc/Lambda
+    #
+    # @param component Symbol the name of the component to set validation for
+    # @param conversion Proc the conversion proc/lambda
+    def convert(component, conversion)
+      conversion = case conversion
+        when Hash then
+          @conversions[component.to_sym] ||= {}
+          @conversions[component.to_sym].merge(conversion)
+        else conversion
+      end
+      @conversions[component.to_sym] = conversion
+    end
+
+    # Returns the value of a fact
+    #
+    # @param name String, Symbol name of the fact to retrieve
+    def get_fact(name)
+      retrieve_facts[name.to_sym]
+    end
+
+    # Adds a fact, either using a static value, or a Proc/Lambda
+    # for runtime determination of the value.
+    #
+    # @param name String, Symbol name of the fact to add
+    # @param value
+    def add_fact(name, value)
+      @facts[name.to_sym] = value
+    end
+
+    # Removes a fact from the list of facts.
+    def remove_fact(name)
+      @facts.delete(name.to_sym)
+    end
+
+    ### End of DSL Methods
+    # @!endgroup
+
+    # retreives all facts, optionally prefixing the name of each
+    # with a string value.
+    def retrieve_facts(prefix = '')
+      facts = @facts.merge(Hash[fqdn_components])
+
+      # build facts from components
+      @components.each do |name, value|
+        case value
+        when Hash then
+          data = facts[name].scan(Regexp.new(value.values.join)).flatten
+          value.keys.zip(data).each do |key, v|
+            if @conversions[name] && @conversions[name][key]
+              facts["#{name}_#{key}".to_sym] = @conversions[name][key].call(v)
+            else
+              facts["#{name}_#{key}".to_sym] = v
+            end
+          end
+        else
+          if @conversions[name]
+            facts[name] = @conversions[name].call(facts[name])
+          end
+          @facts.merge!(name.to_sym => value)
+        end
+      end
+
+      # handle conversions
+      facts.each do |key, value|
+        if value.is_a?(Proc)
+          value = value.arity == 1 ? value.call(facts) : value.call()
+        end
+        facts[key] = value.is_a?(Symbol) ? value.to_s : value
+      end
+
+      # add prefix
+      facts.replace(
+        facts.inject({}) { |h,(k,v)| h["#{prefix}_#{k}"] = v ; h }
+      ) unless prefix.empty?
+
+      facts.reject { |k,v| v.empty? }
+    end
+
+    # Checks to see if the fqdn matches this particular FQDN Fact Handler
+    def match?(fqdn)
+      parts = fqdn.split('.', @component_order.size)
+      return unless parts.size == @component_order.size
+
+      debug "Validating #{self.class}:"
+
+      test_data = @component_order.zip(parts)
+      debug "  test data -> #{test_data.inspect}"
+
+      test_data.all? do |name, value|
+        debug "  validating component '#{name}'"
+        validation = case @components[name]
+          when Hash then Regexp.new(@components[name].values.join)
+          when nil then %r:.+:
+          else @components[name]
+        end
+
+        case validation
+          when Regexp then
+            (value =~ validation).tap { |r|
+              debug "    Regexp -> #{value.inspect} =~ #{validation.inspect} == #{r.inspect}"
+            }
+          when Array  then
+            validation.include?(value).tap { |r|
+              debug "    Array -> #{validation.inspect}.include?(#{value.inspect}) == #{r.inspect}"
+            }
+          else
+            (value == validation).tap { |r|
+              debug "    #{validation.class} -> #{value.inspect} == #{validation.inspect} == #{r.inspect}"
+            }
+        end
+      end.tap { |r| debug " ---> validation #{r ? 'successful' : 'failed'} for #{self.class}"}
+    end
+
+    # Compares the priority of this handler to another handler
+    def <=>(other)
+      self.priority <=> other.priority
+    end
+
+    # Exports the internal state as a hash
+    def export
+      instance_variables.inject({}) do |exports, name|
+        varname = name.to_s.tr('@', '').to_sym
+        exports[varname] = begin
+          Marshal.load(Marshal.dump(instance_variable_get(name)))
+        rescue TypeError
+          instance_variable_get(name).dup
+        end
+        exports
+      end
+    end
+    alias_method :to_h, :export
+
+    private
+
+    # @api private
+    def fqdn_data
+      @fqdn.split('.', @component_order.size)
+    end
+
+    # @api private
+    def fqdn_components
+      @component_order.zip(fqdn_data)
+    end
+
+    # @api private
+    def debug(message)
+      if ENV.keys.collect(&:downcase).include? 'debug'
+        STDERR.puts message
+      end
+    end
+  end
+end

data/lib/fqdn_facts/core_ext.rb

@@ -0,0 +1,55 @@
+=begin
+    Copyright (C) 2015  Carl P. Corliss <rabbitt@gmail.com>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+=end
+
+# @see Object
+class Object
+  # provides an empty? check for all objects
+  # unless an object already has an empty? check
+  #
+  # @return false
+  def empty?
+    return false
+  end
+end
+
+# @see NilClass
+class NilClass
+  # provides an empty? check for nil
+  # @return true
+  def empty?
+    true
+  end
+end
+
+# @see String
+class String
+  # converts a camelized string to underscored
+  # @return String
+  def underscore
+    self.split(/([A-Z][a-z0-9]+)/).reject(&:empty?).collect(&:downcase).join('_')
+  end
+
+  # converts an underscored string to a camelized one
+  # @return String
+  def camelize
+    self.split('_').collect(&:capitalize).join
+  end
+end
+
+
+

data/lib/fqdn_facts/errors.rb

@@ -0,0 +1,28 @@
+=begin
+    Copyright (C) 2015  Carl P. Corliss <rabbitt@gmail.com>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+=end
+
+module FqdnFacts
+  # Base Error class for FqdnFacts
+  class Error < StandardError
+    # Error class emitted when a handler is requested that doesn't exist
+    class HandlerNotFound < Error; end
+
+    # Error class emitted when an FQDN is unable to be resolved to a Handler
+    class UnresolveableHandler < Error; end
+  end
+end

data/lib/fqdn_facts/version.rb

@@ -0,0 +1,22 @@
+=begin
+    Copyright (C) 2015  Carl P. Corliss <rabbitt@gmail.com>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+=end
+
+module FqdnFacts
+  # The current FqdnFacts version
+  VERSION = "0.0.1"
+end

data/lib/fqdn_facts.rb

@@ -0,0 +1,81 @@
+=begin
+    Copyright (C) 2015  Carl P. Corliss <rabbitt@gmail.com>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+=end
+
+require "fqdn_facts/version"
+require 'fqdn_facts/core_ext'
+
+#
+# Provides a DSL for generating Fact Handlers for different
+# fully qualified domain names.
+#
+module FqdnFacts
+  @registry = {}
+
+  autoload :BaseHandler, 'fqdn_facts/base_handler'
+  autoload :Error, 'fqdn_facts/errors'
+
+  class << self
+    attr_reader :registry
+
+    # Registers a FQDN Fact Handler
+    #
+    # @param klass   Symbol name of handler to register
+    # @param options Hash   options to pass
+    # @param block   Block  block of DSL code
+    #
+    # @return FqdnFacts::BaseHandler derived class
+    #
+    def register(klass, options={}, &block)
+      klass_const = klass.to_s.camelize
+      unless BaseHandler.const_defined? klass_const
+        BaseHandler.const_set(klass_const, Class.new(BaseHandler))
+      end
+
+      if other = options.delete(:copy)
+        unless other = @registry[other.to_sym]
+          fail Error::HandlerNotFound, other
+        end
+        @registry[klass.to_sym] = BaseHandler.const_get(klass_const).copy_from(other)
+      else
+        @registry[klass.to_sym] = BaseHandler.const_get(klass_const).new
+      end
+
+
+      if block.arity == 1
+        yield @registry[klass.to_sym]
+      else
+        @registry[klass.to_sym].instance_eval(&block)
+      end
+
+      @registry[klass.to_sym]
+    end
+
+    # Retrieves a handler that is capable of generating facts
+    # for the given FQDN
+    #
+    # @param fqdn String Fully qualified domain name to resolve into a handler
+    #
+    # @return FqdnFacts::BaseHandler derived class
+    def handler(fqdn)
+      if (handlers = @registry.values.select { |klass| klass.match?(fqdn) }).empty?
+        fail Error::UnresolveableHandler, "unable to find a handler for FQDN:#{fqdn}"
+      end
+      handlers.sort.first.tap { |handler| handler.fqdn = fqdn }
+    end
+  end
+end

data/spec/fqdn_facts_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe FqdnFacts do
+  before :all do
+    FqdnFacts.register(:baseline) do
+      priority 10
+
+      components :host, :sub, :tld
+
+      component :host, { type: %r'^([^\d]+)', id: %r'(\d+)', subtype: %r'([ms]?)'}
+      component :tld, 'example.com'
+
+      convert :host, {
+        subtype: ->(v) { v == 'm' ? 'master' : 'slave' },
+        id: ->(v) { v.to_i }
+      }
+
+      add_fact :hostname, ->(f) { f[:host] }
+      add_fact :domain, ->(f) { [f[:sub], f[:tld]].join('.') }
+    end
+  end
+
+  it 'has a version number' do
+    expect(FqdnFacts::VERSION).not_to be nil
+  end
+
+  it 'registers a handler named baseline' do
+    expect(FqdnFacts.registry).to include(:baseline)
+  end
+
+  context 'with fqdn "foo01m.bar.example.com"' do
+    before do
+      @fqdn     = 'foo01m.bar.example.com'
+      @handler  = FqdnFacts.handler(@fqdn)
+    end
+
+    it 'returns a valid hash' do
+      expect(@handler.retrieve_facts).to be_a Hash
+    end
+
+    describe 'facts' do
+      let(:facts) { @handler.retrieve_facts }
+      {
+        :host => 'foo01m',
+        :host_type => 'foo',
+        :host_id   => 1,
+        :host_subtype => 'master',
+        :hostname => 'foo01m',
+        :sub => 'bar',
+        :domain => 'bar.example.com',
+        :fqdn => 'foo01m.bar.example.com',
+        :handler_name => 'baseline'
+      }.each do |key, value|
+        it "sets #{key.inspect} to #{value.inspect}" do
+          expect(facts).to include(key)
+          expect(facts[key]).to eq(value)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'fqdn_facts'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: fqdn_facts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Carl P. Corliss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: FqdnFacts allows you to create fact handlers for different FQDN formats.
+  This is primarily intended for use with Puppet/Facter to facilitate dynamic fact
+  generation based on FQDNs.
+email:
+- rabbitt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fqdn_facts.gemspec
+- lib/fqdn_facts.rb
+- lib/fqdn_facts/base_handler.rb
+- lib/fqdn_facts/core_ext.rb
+- lib/fqdn_facts/errors.rb
+- lib/fqdn_facts/version.rb
+- spec/fqdn_facts_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rabbitt/fqdn_facts/
+licenses:
+- GPLv2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Provides a DSL for generating FQDN specific facts that can be used with Facter
+test_files:
+- spec/fqdn_facts_spec.rb
+- spec/spec_helper.rb