data_sync 1.0.0

data/Readme.markdown

@@ -0,0 +1,74 @@
+Data sync
+=======
+
+Rails plugin for syncing database and files between production and local development server.
+
+Requirements
+============
+
+ * Rails 3
+ * Capistrano
+
+Install
+=======
+
+To install this gem, add the gem to your Gemfile
+
+    gem 'data_sync'
+
+And then add this line to your Capfile
+
+    require 'data_sync_recipes'
+
+Usage
+=====
+
+For pulling the database of the remote server
+
+    rake db:pull
+
+For pushing the local database to the remote server
+
+    rake db:push
+
+For pulling the database and the files of the remote server
+
+    rake data:pull
+
+MongoDB
+====
+
+If you're planning to use this with MongoDB your config/database.yml should use mongodb as adapter value.
+
+* development:
+*   adapter: mongodb
+*   database: surveys-development
+*   host: localhost
+* ...
+
+And initalizer for MongoDB in config/initializers/mongo.rb
+    default_mongodb_port = 27107
+
+    database_configurations = YAML::load(File.read(Rails.root.join('config', 'database.yml')))
+
+    if database_configurations[Rails.env] && database_configurations[Rails.env]['adapter'] == 'mongodb'
+        database = database_configurations[Rails.env]
+        database['port'] ||= default_mongodb_port
+
+        MongoMapper.connection = Mongo::Connection.new(database['hostname'], database['port'])
+        MongoMapper.database = database['database']
+
+        if defined?(PhusionPassenger)
+            PhusionPassenger.on_event(:starting_worker_process) do |forked|
+                MongoMapper.connection.connect_to_master if forked
+            end
+        end
+    end
+
+TODO
+====
+* Prompt ("All files will be overwritten..")
+* database and files push
+* change usage to "push:files", "push:db", "push:data", "pull:files", "pull:db", "pull:files"
+* refactor rake task, duplicate code
+

data/data_sync.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'data_sync'
+  s.version     = '1.0.0'
+  s.date        = '2012-12-10'
+  s.summary     = "Data sync rake tasks."
+  s.description = "Rake tasks to sync data between development and production environments (servers)."
+  s.authors     = ["Tomislav Car", "Nikica Kapraljević", "Josip Bišćan"]
+  s.email       = ["tomislav@infinum.hr", "nikola@infinum.hr", "josip@infinum.hr"]
+  s.homepage    = 'https://github.com/infinum/data_sync'
+
+  s.add_dependency 'capistrano'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+end

data/lib/data_sync/railtie.rb

@@ -0,0 +1,12 @@
+require 'data_sync'
+require 'rails'
+
+module DataSync
+  class Railtie < Rails::Railtie
+    railtie_name :data_sync
+
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__), '../tasks/*.rake')].each {|task| load task}
+    end
+  end
+end

data/lib/data_sync.rb

@@ -0,0 +1,3 @@
+module DataSync
+  require 'data_sync/railtie' if defined?(Rails)
+end

data/lib/data_sync_recipes.rb

@@ -0,0 +1 @@
+Dir.glob(File.join(File.dirname(__FILE__), '/recipes/*.rb')).each {|recipe| load recipe}

data/lib/recipes/data_sync.rb

@@ -0,0 +1,60 @@
+Capistrano::Configuration.instance.load do
+  desc 'Dumps the production database to db/production_data.sql on the remote server'
+  task :remote_db_dump, :roles => :db, :only => { :primary => true } do
+    commands = [
+      "cd #{deploy_to}/#{current_dir}",
+      "bundle exec rake RAILS_ENV=production db:database_dump --trace"
+    ]
+
+    run commands.join(" && ")
+  end
+
+  desc 'Restores the database from db/production_data.sql on the remote server'
+  task :remote_db_restore, :roles => :db, :only => { :primary => true } do
+    commands = [
+      "cd #{deploy_to}/#{current_dir}",
+      "bundle exec rake RAILS_ENV=production db:database_load --trace"
+    ]
+
+    run commands.join(" && ")
+  end
+
+  desc 'Downloads db/production_data.tar.bz2 from the remote production environment to your local machine'
+  task :remote_db_download, :roles => :db, :only => { :primary => true } do
+    execute_on_servers(options) do |servers|
+      self.sessions[servers.first].sftp.connect do |tsftp|
+        tsftp.download! "#{deploy_to}/#{current_dir}/db/production_data.tar.bz2", "db/production_data.tar.bz2"
+      end
+    end
+  end
+
+  desc 'Uploads db/production_data.tar.bz2 from local environment to your production machine'
+  task :local_db_upload, :roles => :db, :only => { :primary => true } do
+    execute_on_servers(options) do |servers|
+      self.sessions[servers.first].sftp.connect do |tsftp|
+        tsftp.upload! "db/production_data.tar.bz2", "#{deploy_to}/#{current_dir}/db/production_data.tar.bz2"
+      end
+    end
+  end
+
+  desc 'Cleans up data dump file'
+  task :remote_db_cleanup, :roles => :db, :only => { :primary => true } do
+    run "rm #{deploy_to}/#{current_dir}/db/production_data.tar.bz2"
+  end
+
+  desc 'Dumps, downloads and then cleans up the production data dump'
+  task :remote_db_runner do
+    remote_db_dump
+    remote_db_download
+    remote_db_cleanup
+  end
+
+  desc "Downloads the files in public/system"
+  task :download_files, :roles => :db, :only => { :primary => true } do
+    `mkdir -p public/system`
+    execute_on_servers(options) do |servers|
+      logger.info "Pulling public/system via rsync"
+      `rsync --delete -r #{user}@#{servers.first}:#{deploy_to}/#{current_dir}/public/system/* public/system`
+    end
+  end
+end

data/lib/tasks/data.rake

@@ -0,0 +1,7 @@
+namespace :data do
+  desc "Refreshes your local development database and files to the production environment"
+  task(:pull => :environment) do
+    `bundle exec rake db:pull`
+    `cap download_files`
+  end
+end

data/lib/tasks/data_sync.rake

@@ -0,0 +1,93 @@
+# encoding: utf-8
+namespace :db do
+  desc "Refreshes your local development environment to the current production database"
+  task :pull do
+    `cap remote_db_runner`
+    `bundle exec rake db:database_load`
+  end
+
+  desc "Refreshes your production database to the current local development database"
+  task :push do
+   `bundle exec rake db:database_dump`
+   `cap local_db_upload`
+   `cap remote_db_restore`
+  end
+
+  desc "Dump the current database to a MySQL file"
+  task :database_dump => :environment do
+    databases = YAML::load(File.open(Rails.root.join('config', 'database.yml')))
+
+    if (databases[Rails.env]["adapter"] == 'mysql' || databases[Rails.env]["adapter"] == 'mysql2')
+      commands = []
+
+      mysql_dump_command = []
+      mysql_dump_command << "mysqldump"
+      mysql_dump_command << "-h #{databases[Rails.env]["host"].blank? ? 'localhost' : databases[Rails.env]["host"]}"
+      mysql_dump_command << "-u #{databases[Rails.env]["username"]}"
+      mysql_dump_command << "-p#{databases[Rails.env]["password"]}" if databases[Rails.env]["password"].present?
+      mysql_dump_command << "#{databases[Rails.env]["database"]}"
+      mysql_dump_command << " > #{Rails.root.join('db', 'production_data.sql')}"
+
+      commands << mysql_dump_command.join(' ')
+      commands << "cd #{Rails.root.join('db')}"
+      commands << "tar -cjf #{Rails.root.join('db', 'production_data.tar.bz2')} production_data.sql"
+      commands << "rm -fr #{Rails.root.join('db', 'production_data.sql')}"
+
+      `#{commands.join(' && ')}`
+    elsif databases[Rails.env]["adapter"] == 'mongodb'
+      port = databases[Rails.env]['port']
+      port ||= 27017 # default mongodb port
+
+      commands = []
+      commands << "rm -fr #{Rails.root.join('db', 'dump')}"
+      commands << "mongodump --host #{databases[Rails.env]['host']} --port #{port} --db #{databases[Rails.env]['database']} --out #{Rails.root.join('db', 'dump')}"
+      commands << "cd #{Rails.root.join('db')}"
+      commands << "tar -cjf #{Rails.root.join('db', 'production_data.tar.bz2')} dump/#{databases[Rails.env]['database']}"
+      commands << "rm -fr #{Rails.root.join('db', 'dump')}"
+
+      `#{commands.join(' && ')}`
+    else
+      raise "Task doesn't work with '#{databases[Rails.env]['adapter']}'"
+    end
+  end
+
+  desc "Loads the production data downloaded into db/production_data into your local development database"
+  task :database_load => :environment do
+    databases = YAML::load(File.open(Rails.root.join('config', 'database.yml')))
+
+    database_folder = Rails.env == 'production' ? databases['development']['database'] : databases['production']['database']
+
+    unless File.exists? Rails.root.join('db', 'production_data.tar.bz2')
+      raise 'Unable to find database dump in db/production_data.tar.bz2'
+    end
+
+    if databases[Rails.env]["adapter"] == 'mysql' || databases[Rails.env]["adapter"] == 'mysql2'
+      commands = []
+      commands << "cd #{Rails.root.join('db')}"
+      commands << "tar -xjf #{Rails.root.join('db', 'production_data.tar.bz2')}"
+
+      mysql_dump_command = []
+      mysql_dump_command << "mysql"
+      mysql_dump_command << "-h #{databases[Rails.env]["host"]}" if databases[Rails.env]["host"].present?
+      mysql_dump_command << "-u #{databases[Rails.env]["username"]}"
+      mysql_dump_command << "-p#{databases[Rails.env]["password"]}" if databases[Rails.env]["password"].present?
+      mysql_dump_command << "#{databases[Rails.env]["database"]}"
+      mysql_dump_command << " < production_data.sql"
+      commands << mysql_dump_command.join(' ')
+
+      commands << "rm -fr #{Rails.root.join('db', 'production_data.tar.bz2')} #{Rails.root.join('db', 'production_data.sql')}"
+
+      `#{commands.join(' && ')}`
+    elsif databases[Rails.env]["adapter"] == 'mongodb'
+      commands = []
+      commands << "cd #{Rails.root.join('db')}"
+      commands << "tar -xjvf #{Rails.root.join('db', 'production_data.tar.bz2')}"
+      commands << "mongorestore --drop --db #{databases[Rails.env]['database']} #{Rails.root.join('db', 'dump', database_folder)}"
+      commands << "rm -fr #{Rails.root.join('db', 'dump')} #{Rails.root.join('db', 'production_data.tar.bz2')}"
+
+      `#{commands.join(' && ')}`
+    else
+      raise "Task not supported by '#{databases[Rails.env]['adapter']}'"
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: data_sync
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Tomislav Car
+- Nikica Kapraljević
+- Josip Bišćan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rake tasks to sync data between development and production environments
+  (servers).
+email:
+- tomislav@infinum.hr
+- nikola@infinum.hr
+- josip@infinum.hr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Readme.markdown
+- data_sync.gemspec
+- lib/data_sync.rb
+- lib/data_sync/railtie.rb
+- lib/data_sync_recipes.rb
+- lib/recipes/data_sync.rb
+- lib/tasks/data.rake
+- lib/tasks/data_sync.rake
+homepage: https://github.com/infinum/data_sync
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Data sync rake tasks.
+test_files: []