dbsync 0.1.2 → 0.2.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.2.0
+* Internal refactoring.
+* Updated gem dependencies.

data/README.markdown

@@ -3,31 +3,36 @@
 A set of rake tasks to help you sync your production 
 data with your local database for development.
 
-Currently only supports:
-* Rails
-* MySQL
+Currently only supports MySQL. The Rake tasks are written for Rails-only,
+but the Sync class can be used with ruby framework, as long as you pass in the
+correct database configuration.
 
 Support for more things will happen if anybody needs it.
 
+
 ## Usage
 
 Add to your gemfile for the groups that will need it:
 
-    group :development, :staging do
-      gem 'dbsync'
-    end
-    
+```ruby
+group :development, :staging do
+  gem 'dbsync'
+end
+```
+
 Add the following to your `config/environments/development.rb` 
 file. Depending on your staging setup, it may also be useful 
 to you to add some `dbsync` config to your `staging.rb` 
 environment file. **Note** `dbsync` will not run in production.
 
-    config.dbsync = ActiveSupport::OrderedOptions.new
-
-    config.dbsync.filename    = "yourapp_production_data.dump" # The name of the remote dumpfile
-    config.dbsync.local_dir   = "#{Rails.root}/../dbsync"      # The local directory to store the dump file. No trailing slash
-    config.dbsync.remote_host = "66.123.4.567"                 # Remote server where the dumpfile is
-    config.dbsync.remote_dir  = "~dbsync"                      # The directory on the remote server where the dumpfile is
+```ruby
+config.dbsync = {
+  :filename    => "yourapp_production_data.dump", # The name of the remote dumpfile.
+  :local_dir   => "#{Rails.root}/../dbsync",   # The local directory to store the dump file.
+  :remote_host => "66.123.4.567",              # Remote server where the dumpfile is located.
+  :remote_dir  => "~dbsync"                    # The directory on the remote server where the dumpfile is.
+}
+```
 
 Now just make sure you have something on the remote 
 server updating that dumpfile. I recommend a cronjob:
@@ -42,18 +47,21 @@ Run `rake -T dbsync` for all of the available tasks. The
 tasks are named after `git` commands mostly, so they
 should be pretty straight-forward for those who use `git`:
 
-    rake dbsync             # Alias for dbsync:pull
-    rake dbsync:clone       # Copy the remote dump file, reset the local database, and load in the dump file
-    rake dbsync:clone_dump  # Copy the remote dump file to a local destination
-    rake dbsync:config      # Show the dbsync configuration
-    rake dbsync:fetch       # Update the local dump file from the remote source
-    rake dbsync:merge       # Merge the local dump file into the local database
-    rake dbsync:pull        # Update the local dump file, and merge it into the local database
-    rake dbsync:reset       # Drop & Create the database, then load the dump file.
-    
+```
+rake dbsync             # Alias for dbsync:pull
+rake dbsync:clone       # Copy the remote dump file, reset the local database, and load in the dump file
+rake dbsync:clone_dump  # Copy the remote dump file to a local destination
+rake dbsync:config      # Show the dbsync configuration
+rake dbsync:fetch       # Update the local dump file from the remote source
+rake dbsync:merge       # Update the local database with the local dump file
+rake dbsync:pull        # Update the local dump file, and merge it into the local database
+rake dbsync:reset       # Drop and Create the database, then load the dump file
+```
+
 ### TODO
 
-- Specs!
+- Support postgres, sqlite, and anything else.
+
 
 ### Copyright
 

data/dbsync.gemspec

@@ -1,27 +1,25 @@
-# -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "dbsync/version"
 
-Gem::Specification.new do |gem|
-  gem.name        = "dbsync"
-  gem.version     = Dbsync::VERSION
-  gem.authors     = ["Bryan Ricker"]
-  gem.email       = ["bricker88@gmail.com"]
-  gem.description = %q{A set of rake tasks to help you sync your remote production data with your local database for development.}
-  gem.summary     = %q{Easy syncing from remote to development database in Rails.}
-  gem.homepage    = "http://github.com/bricker/dbsync"
+Gem::Specification.new do |s|
+  s.name        = "dbsync"
+  s.version     = Dbsync::VERSION
+  s.authors     = ["Bryan Ricker"]
+  s.email       = ["bricker88@gmail.com"]
+  s.homepage    = "https://github.com/bricker/dbsync"
+  s.license     = 'MIT'
+  s.description = "A set of rake tasks to help you sync your remote " \
+                  "production data with your local database for development."
+  s.summary     = "Easy syncing from remote to development database in Rails."
 
-  gem.rubyforge_project = "dbsync"
+  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", "lib/tasks"]
 
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.require_paths = ["lib", "lib/tasks"]
-
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  gem.add_runtime_dependency "activesupport", ">= 3.2.8"
-  gem.add_runtime_dependency "activerecord", ">= 3.2.8"
-  gem.add_runtime_dependency "railties", ">= 3.2.8"
+  s.add_dependency "activerecord", [">= 3.2.8", "< 5"]
+  s.add_dependency "railties", [">= 3.2.8", "< 5"]
+  s.add_dependency "cocaine", "~> 0.5.3"
 
+  s.add_development_dependency "rspec"
 end

data/lib/dbsync.rb

@@ -1,4 +1,5 @@
 require "dbsync/version"
+require 'dbsync/sync'
 
 module Dbsync
   class Railtie < Rails::Railtie

data/lib/dbsync/sync.rb

@@ -0,0 +1,99 @@
+require 'cocaine'
+
+module Dbsync
+  class Sync
+    class << self
+      def notify(message="")
+        $stdout.puts "[#{Time.now.strftime('%T')}] [dbsync] #{message}"
+      end
+    end
+
+
+    def initialize(ssh_config, db_config, options={})
+      ssh_config  = ssh_config.with_indifferent_access
+      db_config   = db_config.with_indifferent_access
+
+      @verbose = !!options[:verbose]
+
+      @remote_host  = ssh_config[:remote_host] || raise_missing("remote_host")
+      @remote_dir   = ssh_config[:remote_dir]  || raise_missing("remote_dir")
+      @local_dir    = ssh_config[:local_dir]   || raise_missing("local_dir")
+      @filename     = ssh_config[:filename]    || raise_missing("filename")
+
+      @db_username  = db_config[:username]
+      @db_password  = db_config[:password]
+      @db_host      = db_config[:host]
+      @db_database  = db_config[:database]
+
+      @remote_file = "#{@remote_host}:" + File.join(@remote_dir, @filename)
+      @local_file  = File.expand_path(File.join(@local_dir, @filename))
+    end
+
+
+    # Update the local dump file from the remote source (using rsync).
+    def fetch
+      notify "Updating '#{@local_file}' from '#{@remote_file}' via rsync..."
+
+      line = Cocaine::CommandLine.new('rsync', '-v :remote :local')
+      line.run({
+        :remote => @remote_file,
+        :local  => @local_file
+      })
+    end
+
+
+    # Update the local database with the local dump file.
+    def merge
+      notify "Dumping data from '#{@local_file}' into '#{@db_database}'..."
+
+      options = ""
+      options += "-u :username " if @db_username.present?
+      options += "-p:password "  if @db_password.present?
+      options += "-h :host "     if @db_host.present?
+
+      line = Cocaine::CommandLine.new('mysql', "#{options} :database < :local")
+      line.run({
+        :username   => @db_username,
+        :password   => @db_password,
+        :host       => @db_host,
+        :database   => @db_database,
+        :local      => @local_file
+      })
+    end
+
+
+    # Update the local dump file, and update the local database.
+    def pull
+      fetch
+      merge
+    end
+
+
+    # Copy the remote dump file to a local destination.
+    # This does a full copy (using scp), so it will take longer than
+    # fetch (which uses rsync).
+    def clone_dump
+      notify "Copying '#{@remote_file}' into '#{@local_dir}' via scp..."
+
+      line = Cocaine::CommandLine.new('scp', ':remote :local_dir')
+      line.run({
+        :remote    => @remote_file,
+        :local_dir => @local_dir
+      })
+    end
+
+
+    private
+
+    def raise_missing(config="")
+      raise "Missing Configuration: '#{config}'. " \
+            "See README for required config."
+    end
+
+    def notify(*args)
+      if @verbose
+        Sync.notify(*args)
+      end
+    end
+  end
+end

data/lib/dbsync/version.rb

@@ -1,3 +1,3 @@
 module Dbsync
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/tasks/dbsync.rake

@@ -2,116 +2,70 @@
 
 desc "Alias for dbsync:pull"
 task :dbsync do
-  Rake::Task["dbsync:pull"].invoke
+  Rake::Task['dbsync:pull'].invoke
 end
 
 namespace :dbsync do
   task :setup => :environment do
-    module Dbsync
-      LOGGER  = $stdout
-      CONFIG  = Rails.application.config.dbsync
-      
-      CONFIG['remote']  = "#{CONFIG['remote_host']}:" + File.join(CONFIG['remote_dir'], CONFIG['filename'])
-      CONFIG['local']   = File.join CONFIG['local_dir'], CONFIG['filename']
-    end
-    
-    # ---------------
-    
-    Dbsync::LOGGER.puts "Environment: #{Rails.env}"
-    
+    Dbsync::Sync.notify "Environment: #{Rails.env}"
+
     if Rails.env == 'production'
-      raise "These tasks are destructive and shouldn't be used in the production environment."
+      raise "These tasks are destructive and shouldn't " \
+            "be used in the production environment."
     end
 
-    #-----------------
-    
-    if Dbsync::CONFIG['filename'].blank?
-      raise "No dump filename specified."
-    elsif Dbsync::CONFIG['remote'].blank?
-      raise "No remote dump file specified."
-    end
-    
-    #-----------------
-    
-    VERBOSE = %w{1 true}.include? ENV['VERBOSE']
-    DB      = ActiveRecord::Base.configurations[Rails.env]
+    @dbsync = Dbsync::Sync.new(
+      Rails.application.config.dbsync,
+      ActiveRecord::Base.configurations[Rails.env],
+      verbose: true
+    )
   end
-  
-  #-----------------------
-  
+
+
   desc "Show the dbsync configuration"
   task :config => :setup do
-    Dbsync::LOGGER.puts "Config:"
-    Dbsync::LOGGER.puts Dbsync::CONFIG.to_yaml
+    # We don't use Sync.notify here because we don't want or need
+    # the extra output that comes with it.
+    $stdout.puts Rails.application.config.dbsync.to_yaml
   end
-    
-  #-----------------------
-    
+
+
   desc "Update the local dump file, and merge it into the local database"
-  task :pull => [:fetch, :merge]
-  
-  desc "Copy the remote dump file, reset the local database, and load in the dump file"
-  task :clone => [:clone_dump, :reset]
-  
-  #-----------------------
-  
-  desc "Update the local dump file from the remote source"
+  task :pull => :setup do
+    @dbsync.pull
+  end
+
+
+  desc  "Copy the remote dump file, reset the local database, " \
+        "and load in the dump file"
+  task :clone => :setup do
+    @dbsync.clone_dump
+    Rake::Task['dbsync:reset'].invoke
+  end
+
+
+  desc "Update the local dump file from the remote source."
   task :fetch => :setup do
-    Dbsync::LOGGER.puts "Fetching #{Dbsync::CONFIG['remote']} using rsync"
-    output = %x{ rsync -v #{Dbsync::CONFIG['remote']} #{Dbsync::CONFIG['local']} }
-    
-    if VERBOSE
-      Dbsync::LOGGER.puts output
-    end
-    
-    Dbsync::LOGGER.puts "Finished."
+    @dbsync.fetch
   end
 
-  #-----------------------
 
   desc "Copy the remote dump file to a local destination"
   task :clone_dump => :setup do
-    Dbsync::LOGGER.puts "Fetching #{Dbsync::CONFIG['remote']} using scp"
-    output = %x{ scp #{Dbsync::CONFIG['remote']} #{Dbsync::CONFIG['local_dir']}/ }
-    
-    if VERBOSE
-      Dbsync::LOGGER.puts output
-    end
-    
-    Dbsync::LOGGER.puts "Finished."
+    @dbsync.clone_dump
   end
 
-  #-----------------------
-  
-  desc "Merge the local dump file into the local database"
+
+  desc "Update the local database with the local dump file."
   task :merge => :setup do
-    Dbsync::LOGGER.puts "Dumping data from #{Dbsync::CONFIG['local']} into #{DB['database']}"
-
-    command =  "mysql "
-    command += "-u #{DB['username']} " if DB['username'].present?
-    command += "-p#{DB['password']} "  if DB['password'].present?
-    command += "-h #{DB['host']} "     if DB['host'].present?
-    command += "#{DB['database']} < #{Dbsync::CONFIG['local']}"
-    
-    output = %x{#{command}}
-    
-    if VERBOSE
-      Dbsync::LOGGER.puts output
-    end
-    
-    Dbsync::LOGGER.puts "Finished."
+    @dbsync.merge
   end
 
-  #-----------------------
-  
-  desc "Drop & Create the database, then load the dump file."
+
+  desc "Drop and Create the database, then load the dump file."
   task :reset => :setup do
-    if VERBOSE
-      Dbsync::LOGGER.puts "Resetting database..."
-    end
-    
     Rake::Task["db:drop"].invoke
     Rake::Task["db:create"].invoke
-    Rake::Task["dbsync:merge"].invoke
+    @dbsync.merge
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+Bundler.require
+
+RSpec.configure do |config|
+end

data/spec/sync_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Dbsync::Sync do
+  let(:ssh_config) do
+  end
+
+  let(:db_config) do
+  end
+
+
+  describe "::notify" do
+  end
+
+  describe '#fetch' do
+  end
+
+  describe '#merge' do
+  end
+
+  describe '#clone_dump' do
+  end
+
+  describe '#pull' do
+  end
+end

metadata

@@ -1,57 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: dbsync
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
+  prerelease: 
 platform: ruby
 authors:
 - Bryan Ricker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-03 00:00:00.000000000 Z
+date: 2014-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  name: activerecord
+  requirement: &70160586951120 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.2.8
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.2.8
+  version_requirements: *70160586951120
 - !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
+  name: railties
+  requirement: &70160586945980 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.2.8
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.2.8
+  version_requirements: *70160586945980
 - !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
+  name: cocaine
+  requirement: &70160586961540 !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: 0.5.3
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *70160586961540
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70160586961120 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70160586961120
 description: A set of rake tasks to help you sync your remote production data with
   your local database for development.
 email:
@@ -61,36 +70,44 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
 - README.markdown
 - Rakefile
 - dbsync.gemspec
 - lib/dbsync.rb
+- lib/dbsync/sync.rb
 - lib/dbsync/version.rb
 - lib/tasks/dbsync.rake
-homepage: http://github.com/bricker/dbsync
-licenses: []
-metadata: {}
+- spec/spec_helper.rb
+- spec/sync_spec.rb
+homepage: https://github.com/bricker/dbsync
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 - lib/tasks
 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: dbsync
-rubygems_version: 2.0.2
+rubyforge_project: 
+rubygems_version: 1.8.11
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Easy syncing from remote to development database in Rails.
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/sync_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjJhN2M5OTY4OGQ4MjE2MzY1NjU5OWEyZDMxMTVhMmYxZDZlMzUwMQ==
-  data.tar.gz: !binary |-
-    MWI5MWUwOTU4NGVhMjI1ZjY1OGE0MWEwYmVlYmY2ZTQ0MDcyZTM4Yg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MGI4MjJmYmIxNTdhZWI1M2JlNTdlMjI0ZmY5YjQyYWRjN2QyM2YzNmU4NDI5
-    Y2UyMjhkNTZjYTIxNGVhZDI0MGZmMDNhY2RiODJiYTIwZWZmZjNmYWUzNjBj
-    ZWVlNDEyYWQzYjA5ZGU2OTU3MDRkYTNhYzc5NTY5NzkzNmViNTQ=
-  data.tar.gz: !binary |-
-    YWRjOWQ4MWI0ODNhOWNmYTI1YWQ1Y2UzYjVmYTkwNGJiZmJjM2NmNWMwYjRj
-    OTgwYTZiNDZlMjNmMDliMjFlZmRkOTEwNGIyODAxZjU4YjViMDhkNThlNzUy
-    ODY2MGNhMjIyZjI0ZjBhNTQ5NjViOWQ5Yzk5MDEzZmQyZmRjMmM=