foundry_wordpress_tool 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Foundry Interactive
+
+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/README.md

@@ -0,0 +1,74 @@
+# Foundry Wordpress Tool #
+
+## The problem ##
+
+Wordpress is a fast tool for building a certain kind of website, but boy oh boy is deployment & dealing with multiple environments a pain in the ass.
+
+## The (beginning of a) solution ##
+
+Introducing Foundry Wordpress Tool: standardizing deployments of Wordpress over a variety of hosts & environments.  First, install the gem:
+
+```sh
+$ gem install 'fwt'
+```
+
+Next, add a config file called `.fwt.yml` to the root of your local wordpress installation.  The file should define as many environments as you want, each with the site root directory as "deploy_to" and ssh info as "username" and "hostname".  Currently, specifying a password or an identiy file is not supported, so make sure your ssh config allows you to connect without specifying either.  Here's an example:
+
+```yaml
+beta:
+  deploy_to: /srv/beta
+  host: beta.example.com
+  username: deploy
+production:
+  deploy_to: /srv/beta
+  host: www.example.com
+  username: deploy
+```
+
+Finally, you should be able to run the following command to get a list of available tasks & usage:
+
+```sh
+$ fwt
+```
+
+## Some assumptions ##
+
+We made a few assumptions to keep this tool simple:
+
+#### The Wordpress server... ####
+
+* You can SSH to it without specifying a password or an identity file.
+* Has a MySQL server running and accessible as the deploy user.
+
+#### The development machine... ####
+
+* Is running a local build of the wordpress site.
+* Has a MySQL server running and accessible as you.
+
+## What this is *not* ##
+
+* A tool for installing or configuring software packages
+* A deployment tool
+* A replacement for a versioning system
+
+## Some alternatives ##
+
+In choosing a toolset for dealing with wordpress, you might consider replacing or supplimenting FWT with one of these:
+
+* [wordpress-capistrano](https://github.com/jestro/wordpress-capistrano)
+
+## Contribute! ##
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright ##
+
+Copyright (c) 2012 Foundry Interactive. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/fwt

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'foundry_wordpress_tool'
+FoundryWordpressTool::Base.start

data/foundry_wordpress_tool.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "foundry_wordpress_tool/version"
+
+Gem::Specification.new do |s|
+  s.name        = "foundry_wordpress_tool"
+  s.version     = FoundryWordpressTool::VERSION
+  s.authors     = ["Jonathan Fuchs"]
+  s.email       = ["jon@foundryinteractive.com"]
+  s.homepage    = "http://github.com/foundryinteractive/foundry_wordpress_tool"
+  s.summary     = %q{A simple Wordpress tool}
+  s.description = %q{Helps manage Wordpress environments}
+
+  s.rubyforge_project = "foundry_wordpress_tool"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "thor"
+end

data/lib/foundry_wordpress_tool/base.rb

@@ -0,0 +1,34 @@
+require 'foundry_wordpress_tool/uploads'
+require 'foundry_wordpress_tool/database'
+
+module FoundryWordpressTool
+  class Base < ::Thor
+    include Thor::Actions
+    include FoundryWordpressTool::Uploads  
+    include FoundryWordpressTool::Database
+
+    class_option :env,
+      :desc => 'Name of the remote environment (as found in .fwt.yml).',
+      :required => false,
+      :aliases => '-e'
+
+    def initialize(*args)
+      say "** Welcome to Foundry Wordpress Tool! **\n", Thor::Shell::Color::CYAN
+      super(*args)
+    end
+
+    no_tasks do
+      
+      def load_environment_config
+        config_yaml = YAML.load_file('.fwt.yml')
+        env = options.env
+        until config_yaml.keys.include? env
+          env = ask("Please select an environment (#{config_yaml.keys.join(', ')}):", Thor::Shell::Color::YELLOW)
+        end
+        @config = config_yaml[env]
+      end
+      
+    end # end no_tasks
+  
+  end
+end

data/lib/foundry_wordpress_tool/database.rb

@@ -0,0 +1,78 @@
+module FoundryWordpressTool
+  module Database
+    FORWARDED_MYSQL_PORT = 33334
+    SNAPSHOT_TEMP_FILENAME = '/tmp/fwd_snapshot.sql'
+    def self.included(thor)
+      thor.class_eval do
+
+        desc "db_pull", "Dump the remote database & import it locally"
+        def db_pull
+          load_environment_config()
+          load_database_configs()
+          say_status :db, "Exporting remote database to temporary snapshot"
+          database_tunnel do
+            dump_command = "mysqldump -u #{@remote_db[:username]} -h 127.0.0.1 -P #{FORWARDED_MYSQL_PORT} -p#{@remote_db[:password]} #{@remote_db[:name]} > #{SNAPSHOT_TEMP_FILENAME}"
+            run dump_command
+          end
+          say_status :db, 'Importing temporary snapshot to local database'
+          import_command = "cat #{SNAPSHOT_TEMP_FILENAME} | mysql -u #{@local_db[:username]} -h #{@local_db[:host]} -P #{@local_db[:port]} -p#{@local_db[:password]} #{@local_db[:name]}"
+          run import_command
+        end
+      
+        desc "db_push", "Dump the local database & import it remotely"
+        def db_push
+          load_environment_config()
+          load_database_configs()
+          say_status :db, 'Exporting local database to temporary snapshot'
+          import_command = "mysqldump -u #{@local_db[:username]} -h #{@local_db[:host]} -P #{@local_db[:port]} -p#{@local_db[:password]} #{@local_db[:name]} > #{SNAPSHOT_TEMP_FILENAME}"
+          run import_command
+          say_status :db, "Importing temporary snapshot to remote database"
+          database_tunnel do
+            dump_command = "cat #{SNAPSHOT_TEMP_FILENAME} | mysql -u #{@remote_db[:username]} -h 127.0.0.1 -P #{FORWARDED_MYSQL_PORT} -p#{@remote_db[:password]} #{@remote_db[:name]}"
+            run dump_command
+          end
+        end
+        
+        no_tasks do
+    
+          def load_database_configs
+            say_status :db, 'Pulling remote & local MySQL settings from wp-config.php files'
+            # read the remote SSH config:
+            Net::SSH.start(@config['host'], @config['username']) do |ssh|
+              ssh.exec! "cat #{File.join(@config['deploy_to'], 'wp-config.php')}" do |ch, stream, data|
+                @remote_db = parse_db_settings_from_wordpress_config(data)
+              end
+            end    
+            # read the local SSH config:
+            @local_db = parse_db_settings_from_wordpress_config(File.open("wp-config.php", "rb").read)
+          end
+    
+          def database_tunnel(&block)
+            say_status :db, 'Opening SSH tunnel for MySQL'
+            gateway = Net::SSH::Gateway.new(@config['host'], @config['username'])
+            port = gateway.open(@remote_db[:host], @remote_db[:port], FORWARDED_MYSQL_PORT)
+      
+            begin
+              yield
+            ensure
+              say_status :db, 'Closing SSH tunnel for MySQL'
+              gateway.shutdown!
+            end      
+          end
+    
+          def parse_db_settings_from_wordpress_config(config_file_content)
+            remote_db = {}
+            remote_db[:name] = /define\(\'DB_NAME\'\,\s*\'([^']*)\'\)\;/.match(config_file_content)[1]
+            remote_db[:username] = /define\(\'DB_USER\'\,\s*\'([^']*)\'\)\;/.match(config_file_content)[1]
+            remote_db[:password] = /define\(\'DB_PASSWORD\'\,\s*\'([^']*)\'\)\;/.match(config_file_content)[1]
+            remote_db[:host] = /define\(\'DB_HOST\'\,\s*\'([^']*)\'\)\;/.match(config_file_content)[1]
+            remote_db[:port] = /define\(\'DB_PORT\'\,\s*\'([^']*)\'\)\;/.match(data)[1] rescue '3306'
+            return remote_db
+          end
+    
+        end # end no_tasks
+        
+      end
+    end
+  end
+end

data/lib/foundry_wordpress_tool/uploads.rb

@@ -0,0 +1,23 @@
+module FoundryWordpressTool
+  module Uploads
+    def self.included(thor)
+      thor.class_eval do
+      
+        desc "uploads_pull", "Pull wp-content/uploads from the remote"
+        def uploads
+          load_environment_config()
+          rsync_command = "rsync -avz --delete #{@config['username']}@#{@config['host']}:#{@config['deploy_to']}/wp-content/uploads/ wp-content/uploads/"
+          run(rsync_command)
+        end
+  
+        desc "uploads_push", "Push wp-content/uploads to the remote host"
+        def uploads_push
+          load_environment_config()
+          rsync_command = "rsync -avz --delete wp-content/uploads/ #{@config['username']}@#{@config['host']}:#{@config['deploy_to']}/wp-content/uploads/"
+          run(rsync_command)
+        end
+      
+      end
+    end
+  end
+end

data/lib/foundry_wordpress_tool/version.rb

@@ -0,0 +1,3 @@
+module FoundryWordpressTool
+  VERSION = "0.0.1"
+end

data/lib/foundry_wordpress_tool.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'thor'
+require 'yaml'
+require 'net/ssh'
+require 'net/ssh/gateway'  
+
+require 'foundry_wordpress_tool/base'
+require "foundry_wordpress_tool/version"
+
+module FoundryWordpressTool
+
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: foundry_wordpress_tool
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan Fuchs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70169921932700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70169921932700
+description: Helps manage Wordpress environments
+email:
+- jon@foundryinteractive.com
+executables:
+- fwt
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/fwt
+- foundry_wordpress_tool.gemspec
+- lib/foundry_wordpress_tool.rb
+- lib/foundry_wordpress_tool/base.rb
+- lib/foundry_wordpress_tool/database.rb
+- lib/foundry_wordpress_tool/uploads.rb
+- lib/foundry_wordpress_tool/version.rb
+homepage: http://github.com/foundryinteractive/foundry_wordpress_tool
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: foundry_wordpress_tool
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A simple Wordpress tool
+test_files: []