dumptruck 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53f9e06243949b735c0cbee908cf0608ef41d191
+  data.tar.gz: 67dcfa5cc690aeea22c4eb8a9056376fb94e50b9
+SHA512:
+  metadata.gz: e4beac2750e5638b4044c161dd4adab1a6d64e1e636410767cdc8a67d786607b0b102ef33712ba6dfb0b4449090d6cd3ed370692dbf4f89c23c7fa953a412fc8
+  data.tar.gz: ade146bdf3cd952276cc831e2c7b8dde59cd01beda7748e790cdaeaae62276fbd3db59310f23b9eb6c04ca31c83ebad1ff131aff20df17602ca561a19e916e99

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+=======
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3
+notifications:
+  email: false

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 delianides
+
+MIT License
+
+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,73 @@
+Dumptruck
+=========
+[![Build Status](https://travis-ci.org/delianides/Dumptruck.svg?branch=master)](https://travis-ci.org/delianides/Dumptruck)
+[![Coverage Status](https://coveralls.io/repos/delianides/Dumptruck/badge.png?branch=master)](https://coveralls.io/r/delianides/Dumptruck?branch=master)
+
+Ruby wrapper for the mysqldump executable
+
+Requirements
+------------
+
+- Ruby 1.9.3 or higher
+- mysqldump executable
+
+Installation
+------------
+
+    gem 'dumptruck'
+
+or install the gem manually
+
+    gem install dumptruck
+
+**Note:** The gem hasn't been submitted to Rubygems yet.
+
+Usage
+-----
+
+The purpose of this gem is make `mysqldump` be as simple as possible. The `mysqldump` command can be pretty tricky and more than likely, if you're attempting a pretty elaborate dump, you'll have to run the command more than once. Thats what this gem attempts to automate. The gem will run multiple interations of `mysqldump` to an output file and directory you choose. To start, create a truck object:
+
+```ruby
+truck = Dumptruck::Truck.new({
+  username: "username",
+  password: "password",
+  host: "127.0.0.1", #localhost is default
+  port: 3306, #default
+  output_dir: "/tmp", #where the dump files go
+  filename: "output", #default, can be changed
+  mysqldump_cmd: "/path/to/bin/mysqldump",
+})
+```
+
+You don't need to know or specify where the `mysqldump` executable is as long as it can be found in your environment `PATH`. Otherwise you can specify it in the params hash. If you don't specifiy it and an executable isn't found, an error will be raised.
+
+Once you have the truck object created you can load it with your configuration.
+
+```ruby
+truck.load({
+  database: 'db', #required for now, raises an error if not set
+  ignored_tables: ['table1','table2','table3'], # optional
+  options: ['--single-transaction', '--quick'], # default values
+})
+```
+
+Or you can create the load object independently and pass it to the `truck.load` method separately.
+
+```ruby
+load = Dumptruck::Load.new({
+  database: 'db', #required for now, raises an error if not set
+  ignored_tables: ['table1','table2','table3'], # optional
+  options: ['--single-transaction', '--quick'], # default values
+})
+
+truck.load(load)
+```
+
+You can add as many loads as needed in order to get the output file you want. When you have everything set just call `truck.dump` and it will run the `mysqldump` command and create a single gzipped output file. The `truck.dump` method returns a hash of the time (in seconds) it took to run and the output files location.
+
+    { time: 8.0992, file: /tmp/output_01-01-02-1534.sql.gz }
+
+Contribution
+------------
+
+Please do. This is my first 'real' gem and probably could use some refactoring. So any help is appreciated.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/dumptruck.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dumptruck/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dumptruck"
+  spec.version       = Dumptruck::VERSION
+  spec.authors       = ["delianides"]
+  spec.email         = ["drew@delianides.com"]
+  spec.summary       = %q{Ruby Wrapper for the mysqldump command}
+  spec.description   = %q{Wraps the mysqldump command into a ruby library}
+	spec.homepage      = "https://github.com/delianides/dumptruck"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency "rspec", "~> 0"
+  spec.add_development_dependency "rspec-nc", "~> 0"
+	spec.add_development_dependency "guard", "~> 0"
+  spec.add_development_dependency "guard-rspec", "~> 0"
+  spec.add_development_dependency "pry", "~> 0"
+  spec.add_development_dependency "coveralls", "~> 0"
+end

data/lib/dumptruck/load.rb

@@ -0,0 +1,58 @@
+module Dumptruck
+  class Load
+    #Specify a Database [TODO] if database isn't specified then --all-databases is used
+    attr_accessor :database
+
+    def initialize(params)
+      defaults = {
+        options: ["--single-transaction", "--quick"],
+      }.merge!(params)
+
+      @options  = defaults[:options]
+
+      #database needs to be defined
+      raise ArgumentError.new("Database not defined!") if params[:database].nil?
+      @database = params[:database]
+
+      unless params[:options].nil?
+        params[:options].each do |o|
+          add_option(o)
+        end
+      end
+
+      unless params[:ignored_tables].nil?
+        params[:ignored_tables].each do |t|
+          add_ignored_table(t)
+        end
+      end
+    end
+
+    def add_ignored_table(table)
+      @ignored_tables = [] unless @ignored_tables
+      @ignored_tables << table
+    end
+
+    def add_option(option)
+      @options = [] unless @options
+      @options << option
+    end
+
+    def options
+      cmd = ""
+      @options.each do |o|
+        cmd << "#{o} "
+      end
+      cmd.strip
+    end
+
+    def ignored_tables
+      return nil unless @ignored_tables
+      tables = ""
+      @ignored_tables.each do |e|
+        tables << "--ignore-table=#{@database}.#{e} "
+      end
+      tables.strip
+    end
+  end
+end
+

data/lib/dumptruck/truck.rb

@@ -0,0 +1,116 @@
+require "benchmark"
+
+module Dumptruck
+  class Truck
+    #mysqldump needs to be installed locally, you can pass in the location if Ruby doesn't find it
+    attr_accessor :mysqldump_cmd
+
+    #host, hostname where you are connecting too, defaults too localhost
+    attr_accessor :host
+
+    #port, other than 3306
+    attr_accessor :port
+
+    #filename, default is `output`, the filename will have a time/date string appended to it.
+    attr_accessor :filename
+
+    #username for the host
+    attr_accessor :username
+
+    #password for host
+    attr_accessor :password
+
+    #output_dir is where you'd like the output file to live after its run
+    attr_accessor :output_dir
+
+    def initialize(params)
+      defaults = {
+        output_dir: "/tmp",
+        filename: "output",
+        port: 3306,
+        host: "localhost"
+      }.merge!(params)
+
+      @username      = defaults[:username]
+      @password      = defaults[:password]
+      @host          = defaults[:host]
+      @port          = defaults[:port]
+      @filename      = defaults[:filename]
+      @output_dir    = defaults[:output_dir]
+      @mysqldump_cmd = find_mysqldump_cmd(params[:mysqldump_cmd])
+    end
+
+    def credentials
+      creds = "-u #{@username} "
+      creds += "--password=#{@password} " unless @password.nil?
+      creds += "-h #{@host} "
+      creds += "-P #{@port}" unless @port.nil?
+      creds
+    end
+
+    def output
+      "#{@output_dir}/#{@filename}_#{Time.now.strftime("%Y-%m-%d-%H%M")}.sql.gz"
+    end
+
+    def load( input )
+      @loads = [] unless @loads
+      if input.instance_of? Dumptruck::Load #created separate from the truck
+        @loads << input
+      else
+        input = Dumptruck::Load.new(input)
+        @loads << input
+      end
+
+      input
+    end
+
+    def loads
+      @loads.map
+    end
+
+    def dump
+      time = Benchmark.realtime do
+        filename = self.output
+        @loads.each_with_index do |l,i|
+          #[REFACTOR]
+          if i == 0
+            gzip = "gzip -c >"
+          else
+            gzip = "gzip -c >>"
+          end
+
+          cmd = "#{self.mysqldump_cmd} "
+          cmd += "#{self.credentials} "
+          cmd += "#{l.options} "
+          cmd += "#{l.ignore_tables} " unless @ignore_tables.nil?
+          cmd += "#{l.database} "
+          cmd += "| #{gzip} #{filename}"
+          begin
+            system(cmd)
+          rescue SystemCallError
+            raise "Error Running Dump!"
+          end
+        end
+      end
+
+      {time: time, file: "#{File.expand_path(filename)}"}
+    end
+
+    private
+
+    def find_mysqldump_cmd(cmd = nil)
+      begin
+        if(cmd)
+          if(`#{cmd} -V`)
+            cmd
+          end
+        else
+          `which mysqldump`.strip
+        end
+      rescue SystemCallError
+        raise "Mysqldump is not found!"
+      end
+    end
+  end
+end
+

data/lib/dumptruck/version.rb

@@ -0,0 +1,3 @@
+module Dumptruck
+  VERSION = "0.1.2"
+end

data/lib/dumptruck.rb

@@ -0,0 +1,3 @@
+require "dumptruck/version"
+require "dumptruck/truck"
+require "dumptruck/load"

data/spec/load_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Dumptruck::Load do
+  describe '.new' do
+    let(:dump) { Dumptruck::Load.new({ database: "test" }) }
+      it "has a database" do
+        expect(dump.database).to eq("test")
+      end
+
+      it "can add tables to ignore" do
+        dump.add_ignored_table("fake_table")
+        expect(dump.ignored_tables).to eq("--ignore-table=test.fake_table")
+      end
+
+      it "adds option to array" do
+        expect(dump.options).to eq("--single-transaction --quick")
+
+        dump.add_option("--lock-tables")
+        expect(dump.options).to eq("--single-transaction --quick --lock-tables")
+      end
+
+      it "raises an error if no database is defined" do
+        expect{Dumptruck::Load.new({})}.to raise_error("Database not defined!")
+      end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'coveralls'
+Coveralls.wear!
+require 'pry'
+require 'dumptruck'

data/spec/truck_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Dumptruck::Truck do
+  describe '.new' do
+    cmd = `which mysqldump`.strip
+
+    let(:dump) { Dumptruck::Truck.new({
+      :username => "drew",
+      :password => "pw",
+    })}
+
+    it 'has a username' do
+      expect(dump.username).to eq("drew")
+    end
+
+    it 'has a password' do
+      expect(dump.password).to eq("pw")
+    end
+
+    it 'has an output directory' do
+      expect(dump.output_dir).to eq("/tmp")
+    end
+
+    it 'has a filename' do
+      expect(dump.filename).not_to eq(nil)
+    end
+
+    it 'has a mysqldump executable' do
+      expect(dump.mysqldump_cmd).to eq(cmd)
+      dump.mysqldump_cmd = "/usr/local/bin/mysqldump"
+      expect(dump.mysqldump_cmd).not_to be(nil)
+    end
+
+    it "no mysqldump raises error" do
+      expect{
+        Dumptruck::Truck.new(
+          {:mysqldump_cmd => "/fake/loc/mysqldump"})
+      }.to raise_error("Mysqldump is not found!")
+    end
+
+    it "creates a Load object" do
+      dump.load({database: "test"})
+    end
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: dumptruck
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- delianides
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wraps the mysqldump command into a ruby library
+email:
+- drew@delianides.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dumptruck.gemspec
+- lib/dumptruck.rb
+- lib/dumptruck/load.rb
+- lib/dumptruck/truck.rb
+- lib/dumptruck/version.rb
+- spec/load_spec.rb
+- spec/spec_helper.rb
+- spec/truck_spec.rb
+homepage: https://github.com/delianides/dumptruck
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby Wrapper for the mysqldump command
+test_files:
+- spec/load_spec.rb
+- spec/spec_helper.rb
+- spec/truck_spec.rb