sandboxer 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+/*.gem

data/COPYING

@@ -0,0 +1,280 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin St, 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 Library 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

data/README.md

@@ -0,0 +1,36 @@
+# Sandbox
+
+Sandbox is a Ruby command line script to register domains that you sometimes use for remote or local development, and to quickly enable or disable development/host file entries for those domains. Only expected to work on OS X. Requires sudo access, as it is manipulating your hosts file.
+
+Available commands:
+
+* `sandbox add {domain}` — adds the specified domain using the default sandbox IP (system default is 127.0.0.1)
+* `sandbox add {domain} {ip}` — adds the specified domain pointing to the specified IP
+* `sandbox destination {ip}` - sets the default sandbox IP
+* `sandbox remove {domain}` — removes the specified domain
+* `sandbox on` — enables all saved entries
+* `sandbox off` — disables all saved entries
+* `sandbox status` — shows the current status of the tool (on/off status and current default destination IP)
+
+Note: if sandbox development is on, `add` and `remove` commands will immediately update the hosts file and trigger a DNS flush.
+
+## Installation
+
+To install Sandbox, use RubyGems:
+
+```bash
+sudo gem install sandbox
+```
+
+## Notes
+
+Your list of development domains is kept in `/etc/hosts-sandbox`.
+Your default destination IP is kept in `/etc/hosts-sandbox-destination`.
+
+## License & Copyright
+
+Sandbox is Copyright Justin Shreve 2011
+Based on Localdev Copyright Mark Jaquith 2011
+see https://github.com/markjaquith/Localdev
+
+Offered under the terms of the GNU General Public License, version 2, or any later version.

data/bin/sandbox

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+#
+# Sandbox - Hosts file tool for remote & local development
+#
+# Copyright 2011 Justin Shreve
+#
+# Based on https://github.com/markjaquith/Localdev Copyright Mark Jaquith 2011
+# Adds additional options for pointing hosts entries to other IP address
+# and setting a default IP address to 'sandbox' to
+#
+# 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 St, Fifth Floor, Boston, MA  02110-1301  USA
+
+require 'sandbox.rb';
+Sandbox.new

data/lib/sandbox.rb

@@ -0,0 +1,233 @@
+#
+# Sandbox - Hosts file tool for remote & local development
+#
+# Copyright Justin Shreve 2011
+#
+# Based on https://github.com/markjaquith/Localdev Copyright Mark Jaquith 2011
+# Adds additional options for pointing hosts entries to other IP address
+# and setting a default IP address to sandbox to
+#
+# 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 St, Fifth Floor, Boston, MA  02110-1301  USA
+
+require 'digest/md5'
+
+
+
+class Sandbox
+  VERSION = '0.1.0'
+  def initialize
+    @debug = false
+    @sandbox = '/etc/hosts-sandbox'
+    @destination_storage = '/etc/hosts-sandbox-destination'
+    @hosts = '/etc/hosts'
+    @default_destination = '127.0.0.1'
+    @start = '#==SANDBOX==#'
+    @end = '#/==SANDBOX==#'
+    if !ARGV.first.nil? && [:on, :off, :add, :remove, :destination].include?( ARGV.first.to_sym )
+      require_sudo
+      ensure_sandbox_exists
+    end
+    command = ARGV.shift
+    command = command.to_sym unless command.nil?
+    object = ARGV.shift
+    ip = ARGV.shift
+    case command
+    when :"--v", :"--version"
+      info
+    when :on, :off, :status
+      send command
+    when :add
+      require_sudo
+      object.nil? && exit_error_message("'sandbox add' requires you to provide a domain. optionally you can provide an IP/destination.")
+      ensure_sandbox_exists
+      if ip.nil?
+        ip = get_destination
+      end
+      send command, object, ip
+    when :remove
+      require_sudo
+      object.nil? && exit_error_message("'sandbox remove' requires you to provide a domain.")
+      ensure_sandbox_exists
+      send command, object
+    when :destination
+      require_sudo
+      object.nil? && exit_error_message("'sandbox setdefault' requires you to provide an IP/destination.")
+      ensure_sandbox_exists
+      send command, object
+    when nil, '--help', '-h'
+      exit_message "Usage: sandbox [on|off|status]\n       sandbox [destination] newdefault\n       sandbox [add|remove] domain destination"
+    else
+    exit_error_message "Invalid command"
+    end
+  end
+
+  def require_sudo
+    if ENV["USER"] != "root"
+      exec("sudo #{ENV['_']} #{ARGV.join(' ')}")
+    end
+  end
+
+  def info
+    puts "Sandbox #{self.class::VERSION}"
+  end
+
+  def debug message
+    puts message if @debug
+  end
+
+  def exit_message message
+    puts message
+    exit
+  end
+
+  def exit_error_message message
+    exit_message '[ERROR] ' + message
+  end
+
+  def flush_dns
+    %x{dscacheutil -flushcache}
+  end
+
+  def ensure_sandbox_exists
+    File.open( @sandbox, 'w' ) {|file| file.write('') } unless File.exists?( @sandbox )
+    File.open( @destination_storage, 'w' ) {|file| file.write('') } unless File.exists?( @destination_storage )
+  end
+
+  def enable
+    disable
+    entries = []
+    File.open( @sandbox, 'r' ) do |file|
+      entries = file.read.split("\n").uniq
+    end
+    File.open( @hosts, 'a' ) do |file|
+      file.puts "\n"
+      file.puts @start
+      file.puts "# The md5 dummy entries are here so that things like MAMP Pro don't"
+      file.puts "# discourtiously remove our entries"
+      entries.each do |entry|
+        pieces = entry.split( ' ' )
+        domain = pieces[0]
+        ip = pieces[1]
+        file.puts "#{ip} #{Digest::MD5.hexdigest(domain)}.#{domain} #{domain}"
+      end
+      file.puts @end
+    end
+  end
+
+  def on
+    enable
+    flush_dns
+    puts "Turning sandbox on"
+  end
+
+  def disable
+    hosts_content = []
+    File.open( @hosts, 'r' ) do |file|
+      started = false
+      while line = file.gets
+        started = true if line.include? @start
+        hosts_content << line unless started
+        started = false if line.include? @end
+      end
+    end
+    while "\n" == hosts_content.last
+      hosts_content.pop
+    end
+    File.open( @hosts, 'w' ) do |file|
+      file.puts hosts_content
+    end
+  end
+
+  def off
+    disable
+    flush_dns
+    puts "Turning Sandbox off"
+  end
+
+  def update_sandbox
+    entries = []
+    File.open( @sandbox, 'r' ) do |file|
+      entries = file.read.split( "\n" )
+      debug entries.inspect
+      yield entries
+      debug entries.inspect
+    end
+    File.open( @sandbox, 'w' ) do |file|
+      file.puts entries
+    end
+  end
+
+  def destination ip
+    File.open( @destination_storage, 'w' ) do |file|
+      file.puts ip
+    end
+    puts "Sandbox default destination set to #{ip}"
+  end
+
+  def add (domain, ip)
+    entry = ''
+    update_sandbox { |entries|
+      if entries.find { |entry| /^#{domain}/ =~ entry }
+      entries = entries.delete entry
+      end
+    }
+    update_sandbox { | entries | entries << "#{domain} #{ip}" }
+    enable if :on == get_status
+    puts "Added '#{domain} #{ip}'"
+    status
+  end
+
+  def remove domain
+    entry = ''
+    update_sandbox { |entries|
+      if entries.find { |entry| /^#{domain}/ =~ entry }
+      entries = entries.delete entry
+      end
+    }
+    enable if :on == get_status
+    puts "Removed '#{domain}'"
+    status
+  end
+
+  def get_destination
+    current_destination = @default_destination
+    File.open( @destination_storage, 'r' ) do |file|
+      dest = file.read.strip
+      current_destination = dest unless dest.empty? or dest.nil?
+    end
+    return current_destination
+  end
+
+  def get_status
+    # do magic
+    status = :off
+    return status unless File.readable? @hosts
+    File.open( @hosts, 'r' ) do |file|
+      while line = file.gets
+        if line.include? @start
+          status = :on
+        break
+        end
+      end
+    end
+    return status
+  end
+
+  def status
+    puts "Sandbox is #{get_status}"
+    puts "Current default sandbox destination is #{get_destination}"
+  end
+
+end

data/sandbox.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('./lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require './lib/sandbox.rb'
+
+Gem::Specification.new do |s|
+  s.name        = "sandboxer"
+  s.version     = Sandbox::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Justin Shreve"]
+  s.email       = ["justin.shreve@gmail.com"]
+  s.homepage    = "http://github.com/justinshreve/Sandbox"
+  s.summary     = %q{Add entries to your hosts file, and disable/enable their use}
+  s.description = %q{Sandbox manages part of your hosts file and lets you specify domains sandbox to point locally or remotely to. You can quickly enable or disable sandboxing of those domains.}
+  s.has_rdoc = false
+
+  s.files              = `git ls-files`.split("\n")
+  s.executables        = %w(sandbox)
+  s.require_paths      = ["lib"]
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: sandboxer
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Justin Shreve
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-01 00:00:00 Z
+dependencies: []
+
+description: Sandbox manages part of your hosts file and lets you specify domains sandbox to point locally or remotely to. You can quickly enable or disable sandboxing of those domains.
+email: 
+- justin.shreve@gmail.com
+executables: 
+- sandbox
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- COPYING
+- README.md
+- bin/sandbox
+- lib/sandbox.rb
+- sandbox.gemspec
+homepage: http://github.com/justinshreve/Sandbox
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Add entries to your hosts file, and disable/enable their use
+test_files: []
+