stubby 0.0.10 → 0.0.11

data/README.md

@@ -1,17 +1,55 @@
 # Stubby
 
-A local DNS and HTTP server combo that provides a package manager
-solution to configuring network systems on a development machine. 
-
-Use it to:
-
-* manage your .dev domains
-
-* distribute a spec for your API so developers can run basic tests without
-hitting your dev server.
+Stubby makes your development environment act more like your
+production environment. 
+
+A local DNS and HTTP server combo that provides a declarative 
+environment based configuration for talking to servers that
+act exactly like production but aren't. 
+
+## Philosophy
+
+Centralized configuration systems instruct your application how to 
+function on the host environment. Stubby prefers that your application ask
+the environment to mold itself to the needs of the application. 
+
+Consider your app is a manager sent to Germany to lead an automotive 
+operation. The manager has a language dictionary and translates each order
+to German before giving it to the team. Consider the following interaction:
+
+	"Where's the screwdriver?"
+	"Wo ist der Schraubenzieher?"
+	
+	=>
+	
+	"Im roten Feld über die Straße"
+	"In the red box down the street"
+	
+	# Get screwdriver from red box,
+	# screw bolt into metal
+	
+This is what we tell our applications to do when we use a centralized
+configuration:
+
+	"Where's the database?"
+	ENV["DATABASE_URI"]
+	"mysql://blah/"
+	
+	# Connect to database
+	# Execute query
+	
+Stubby is a translator in this instance. Since Stubby knows that you need 
+a screwdriver, and it knows where you look for it, Stubby will make sure 
+that the screwdriver your manager needs is where your manager expects it to be.
+
+## Uses
+
+* manage your .dev domains (or any random old TLD)
+
+* stub APIs so you can run tests locally
 
 * get your team on the right system with the proper hosts settings. 
- 
+
 ## Development Status
 
 The Stubfile.json format and the extension / adapter

data/lib/stubby.rb

@@ -2,8 +2,10 @@ STUBBY_MASTER="172.16.123.1"
 
 require 'rubygems'
 
+
 require 'oj'
 require 'multi_json'
+
 require 'stubby/extensions/dns/osx'
 require 'stubby/extensions/dns'
 require 'stubby/extensions/http'

data/lib/stubby/cli/application.rb

@@ -50,6 +50,37 @@ module Stubby
         master.run!
       end
 
+      desc "halt", "Shut down if running, restore if not"
+      def halt
+        if master_running?
+          stop
+        else
+          restore
+        end
+      end
+
+      desc "stop", "Stops a running stubby process"
+      def stop
+        if master_running?
+          Process.kill("INT", File.read(pidfile).to_i)
+
+          while master_running?
+            puts "." and sleep 1
+          end 
+        end
+      end
+
+      desc "restore", "Restore defaults"
+      def restore
+        if master_running?
+          puts "[ERROR] Stubby needs to be shut down first"
+          exit
+        end
+
+        master = Stubby::Master.new({})
+        master.restore!
+      end
+
       desc "env NAME", "Switch stubby environment"
       long_desc <<-LONGDESC
         > $ sudo stubby env test
@@ -95,7 +126,11 @@ module Stubby
 
       private
       def pidfile
-        @pidfile ||= File.expand_path("~/.stubby/pid")
+        @pidfile ||= (
+          home = File.expand_path("~/.stubby")
+          FileUtils.mkdir_p(home) unless File.exists?(home)
+          File.join(home, "pid")
+        )
       end
 
       def master_running?

data/lib/stubby/extensions/default.rb

@@ -1,72 +1,78 @@
-module Extensions
-  class Default
-    def initialize
+module Stubby
+  module Extensions
+    class Default
+      def initialize
 
-    end    
+      end    
 
-    def run!(*args)
+      def run!(*args)
 
-    end
+      end
 
-    def stop!(*args)
+      def stop!(*args)
 
-    end
+      end
+
+      def restore!(*args)
 
-    def expand_rule(trigger, instruction)
-      # Default expansion:
-      #     "example.com": "localhost:3000"
-      #
-      # => 
-      #     "dns://example.com":    "@"
-      #     "http://example.com":   "http-redirect://blank?to=https://example.com&code=302"
-      #     "https://example.com":  "http-proxy://localhost:3000"
-      #    
-      #     "example.com:4000": "localhost:3000"
-      #     
-      # => 
-      #     ERROR: port in trigger unsupported
-      #
-      #     "dns://example.com":      "@"
-      #     "http://example.com:4000" 
-      #
-      #     "example.com": "http-redirect://localhost:3000"
-      #
-      # =>
-      #     "dns://example.com":    "@"
-      #     "http://example.com":   "http-redirect://?blank?to=http://localhost:3000&code=302"
-      # =====================================
-      #
-      #   ".*\\.stubby.dev": "file:///var/www/tmp
-      #
-      #     =>
-      #
-      #   "dns://.*\\.stubby.dev": "@",
-      #   "http://.*\\.stubby.dev": "file:///var/www/tmp",
-      #   "https://.*\\.stubby.dev": "file:///var/www/tmp",
-      scheme, remains = instruction.split("://")
-      scheme, remains = remains, scheme if remains.nil?
- 
-      if scheme.nil?
-        expand_bare(trigger, instruction)
-      else
-        expand_with_protocol(trigger, instruction)
       end
-    end
 
-    def expand_bare(trigger, instruction)
-      {
-        "dns://#{trigger}/a" => "dns-a://#{STUBBY_MASTER}",
-        "http://#{trigger}" => "http-redirect://blank?to=https://#{trigger}&code=302",
-        "https://#{trigger}" => "http-proxy://#{instruction}" 
-      }
-    end
+      def expand_rule(trigger, instruction)
+        # Default expansion:
+        #     "example.com": "localhost:3000"
+        #
+        # => 
+        #     "dns://example.com":    "@"
+        #     "http://example.com":   "http-redirect://blank?to=https://example.com&code=302"
+        #     "https://example.com":  "http-proxy://localhost:3000"
+        #    
+        #     "example.com:4000": "localhost:3000"
+        #     
+        # => 
+        #     ERROR: port in trigger unsupported
+        #
+        #     "dns://example.com":      "@"
+        #     "http://example.com:4000" 
+        #
+        #     "example.com": "http-redirect://localhost:3000"
+        #
+        # =>
+        #     "dns://example.com":    "@"
+        #     "http://example.com":   "http-redirect://?blank?to=http://localhost:3000&code=302"
+        # =====================================
+        #
+        #   ".*\\.stubby.dev": "file:///var/www/tmp
+        #
+        #     =>
+        #
+        #   "dns://.*\\.stubby.dev": "@",
+        #   "http://.*\\.stubby.dev": "file:///var/www/tmp",
+        #   "https://.*\\.stubby.dev": "file:///var/www/tmp",
+        scheme, remains = instruction.split("://")
+        scheme, remains = remains, scheme if remains.nil?
+   
+        if scheme.nil?
+          expand_bare(trigger, instruction)
+        else
+          expand_with_protocol(trigger, instruction)
+        end
+      end
 
-    def expand_with_protocol(trigger, instruction)
-      {
-        "dns://#{trigger}/a" => "dns-a://#{STUBBY_MASTER}",
-        "http://#{trigger}" => instruction,
-        "https://#{trigger}" => instruction
-      }
+      def expand_bare(trigger, instruction)
+        {
+          "dns://#{trigger}/a" => "dns-a://#{STUBBY_MASTER}",
+          "http://#{trigger}" => "http-redirect://blank?to=https://#{trigger}&code=302",
+          "https://#{trigger}" => "http-proxy://#{instruction}" 
+        }
+      end
+
+      def expand_with_protocol(trigger, instruction)
+        {
+          "dns://#{trigger}/a" => "dns-a://#{STUBBY_MASTER}",
+          "http://#{trigger}" => instruction,
+          "https://#{trigger}" => instruction
+        }
+      end
     end
   end
 end

data/lib/stubby/extensions/dns.rb

@@ -1,131 +1,136 @@
 require 'rubydns'
 require 'ipaddress'
 require 'uri'
-require 'pry'
-
-module Extensions
-  module DNS
-    class UnsupportedOS < Exception; end
-
-    class Server < RubyDNS::Server
-      UPSTREAM = RubyDNS::Resolver.new([[:udp, "8.8.8.8", 53], [:tcp, "8.8.8.8", 53]])
-	    IN = Resolv::DNS::Resource::IN
-
-      case RbConfig::CONFIG['host_os']
-      when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-        raise UnsupportedOS, "Sorry, Windows is not currently supported"
-      when /darwin|mac os/
-        include Extensions::DNS::OSX
-      when /linux/
-        raise UnsupportedOS, "Sorry, Linux is not currently supported"
-      else
-        raise UnsupportedOS, "Sorry, #{RbConfig::CONFIG['host_os']} wasn't recognized"
-      end
 
-      def process(name, resource_class, transaction)
-          body = HTTPI.post("http://#{STUBBY_MASTER}:9000/rules/search.json", 
-            trigger: "dns://#{name}/#{symbol_from_resource_class(resource_class)}").body
+module Stubby
+  module Extensions
+    module DNS
+      class UnsupportedOS < Exception; end
+
+      class Server < RubyDNS::Server
+        UPSTREAM = RubyDNS::Resolver.new([[:udp, "8.8.8.8", 53], [:tcp, "8.8.8.8", 53]])
+              IN = Resolv::DNS::Resource::IN
+
+        case RbConfig::CONFIG['host_os']
+        when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+          raise UnsupportedOS, "Sorry, Windows is not currently supported"
+        when /darwin|mac os/
+          include Stubby::Extensions::DNS::OSX
+        when /linux/
+          raise UnsupportedOS, "Sorry, Linux is not currently supported"
+        else
+          raise UnsupportedOS, "Sorry, #{RbConfig::CONFIG['host_os']} wasn't recognized"
+        end
 
-          instruction = MultiJson.load(body)
+        def process(name, resource_class, transaction)
+            body = HTTPI.post("http://#{STUBBY_MASTER}:9000/rules/search.json", 
+              trigger: "dns://#{name}/#{symbol_from_resource_class(resource_class)}").body
 
-          if instruction.nil? or instruction == "@"
-            transaction.passthrough!(UPSTREAM)
-            return
-          end
+            instruction = MultiJson.load(body)
 
-          url = URI.parse(instruction)
+            if instruction.nil? or instruction == "@"
+              transaction.passthrough!(UPSTREAM)
+              return
+            end
 
-          response_resource_class = resource url.scheme.gsub('dns-', '')
+            url = URI.parse(instruction)
 
-          if !IPAddress.valid?(url.host) and response_resource_class == IN::A
-            response_resource_class = IN::CNAME
-          end
+            response_resource_class = resource url.scheme.gsub('dns-', '')
 
-          response = url.host
+            if !IPAddress.valid?(url.host) and response_resource_class == IN::A
+              response_resource_class = IN::CNAME
+            end
 
-          if [IN::CNAME, IN::MX].include? response_resource_class
-            response = Resolv::DNS::Name.create(url.host)
-          end
+            response = url.host
 
-          puts "DNS: #{name} => #{response}-#{resource_class.name})"
+            if [IN::CNAME, IN::MX].include? response_resource_class
+              response = Resolv::DNS::Name.create(url.host)
+            end
 
-          if response_resource_class == IN::MX
-            transaction.respond!(10, response,
-              :resource_class => response_resource_class,
-              :ttl => 0)
-          else
-            transaction.respond!(response, 
-              :resource_class => response_resource_class, 
-              :ttl => 0)
-          end
-      end
+            puts "DNS: #{name} => #{response}-#{resource_class.name})"
 
-      def run!(session, options)
-        return if options[:dns] == false
-        trap("INT"){ stop! }
+            if response_resource_class == IN::MX
+              transaction.respond!(10, response,
+                :resource_class => response_resource_class,
+                :ttl => 0)
+            else
+              transaction.respond!(response, 
+                :resource_class => response_resource_class, 
+                :ttl => 0)
+            end
+        end
 
-        @session = session
-        setup_references and run_dns_server
-      end
+        def run!(session, options)
+          return if options[:dns] == false
+          trap("INT"){ stop! }
 
-      def stop!
-        teardown_references and stop_dns_server
-      end
+          @session = session
+          setup_references and run_dns_server
+        end
 
-      def expand_rule(trigger, instruction)
-        i = URI.parse(instruction)
-        t = URI.parse(trigger)
+        def stop!
+          teardown_references and stop_dns_server
+        end
 
-        # If not specifying a record type, match a
-        t.path = "/a" if t.path.empty?
-    
-        if i.scheme.nil?
-          { t.to_s => "dns-a://#{instruction}" }
-        else
-          { t.to_s => instruction }
+        def restore!
+          restore_references
         end
-      end
+
+        def expand_rule(trigger, instruction)
+          i = URI.parse(instruction)
+          t = URI.parse(trigger)
+
+          # If not specifying a record type, match a
+          t.path = "/a" if t.path.empty?
       
-      private
+          if i.scheme.nil?
+            { t.to_s => "dns-a://#{instruction}" }
+          else
+            { t.to_s => instruction }
+          end
+        end
+        
+        private
 
-      def resource(pattern)
-        return IN::A unless pattern.respond_to? :to_sym
-        symbol_to_resource_class[pattern.to_sym] || IN::A
-      end
+        def resource(pattern)
+          return IN::A unless pattern.respond_to? :to_sym
+          symbol_to_resource_class[pattern.to_sym] || IN::A
+        end
 
-      def symbol_from_resource_class(klass)
-        symbol_to_resource_class.invert[klass] || :a
-      end
+        def symbol_from_resource_class(klass)
+          symbol_to_resource_class.invert[klass] || :a
+        end
 
-      def symbol_to_resource_class
-        {
-          a:      IN::A,
-          aaaa:   IN::AAAA,
-          srv:    IN::SRV,
-          wks:    IN::WKS,
-          minfo:  IN::MINFO,
-          mx:     IN::MX,
-          ns:     IN::NS,
-          ptr:    IN::PTR,
-          soa:    IN::SOA,
-          txt:    IN::TXT,
-          cname:  IN::CNAME
-        }
-      end
+        def symbol_to_resource_class
+          {
+            a:      IN::A,
+            aaaa:   IN::AAAA,
+            srv:    IN::SRV,
+            wks:    IN::WKS,
+            minfo:  IN::MINFO,
+            mx:     IN::MX,
+            ns:     IN::NS,
+            ptr:    IN::PTR,
+            soa:    IN::SOA,
+            txt:    IN::TXT,
+            cname:  IN::CNAME
+          }
+        end
 
-      def run_dns_server
-        logger.level = Logger::INFO
+        def run_dns_server
+          logger.level = Logger::INFO
 
-        EventMachine.run do
-          run(:listen => [[:tcp, STUBBY_MASTER, 53],
-            [:udp, STUBBY_MASTER, 53]])
+          EventMachine.run do
+            run(:listen => [[:tcp, STUBBY_MASTER, 53],
+              [:udp, STUBBY_MASTER, 53]])
+          end
         end
-      end
 
-      def stop_dns_server
-        fire :stop
-        EventMachine::stop_event_loop
-      rescue
+        def stop_dns_server
+          fire :stop
+          EventMachine::stop_event_loop
+        rescue
+        end
       end
     end
   end