db_automate 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a1975eb98778aa55cf7bbeb9d34533a6f17d8f6
+  data.tar.gz: 55d6b63bd970236c69a7c27d10f10e7f4bb7ad89
+SHA512:
+  metadata.gz: a09d84bb2f6d33080fc5caf3c0151f62391bf5ae1be503d0ff244f0bbdfbc4fb7dfc6579733454e48e4b6decd2c2844a04e27c13a9d8dd36e5d119d37d2ea29f
+  data.tar.gz: faad753e59f808a48c40c2ecc72afeaaf0bb2f8526390735b5d7a7b74ce2b9d2199e24076a97286ee2b6b81f56c5654e5c6c892a7ccbe3d87098b063b1837919

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Dave Rowan
+
+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,121 @@
+# DBAutomate
+
+If you actually happened upon this, please note that this project is in its earliest stages and has not been developed much yet.
+The README found here is mainly for the purposes of [Readme Driven Development][rdd] so that I can try to get the API right
+first, and hopefully eliminate lots of churn along the way. 
+
+If you dare to read on, your suggestions are welcome if you believe
+you have an idea that would make the API and project as a whole better. Just drop me a line, or better yet fork the project and 
+create a pull request showing your thoughts. 
+
+Let it be known that I have many ideas swarming on how to expand this project to do
+more, but I want to start small and get some basics right first. So for now, it is what it is, or more accurately,
+it will be what it is below.
+
+Yes, I know what is below is quite messy at this stage, and there is a lot of stuff which will quickly become too much stuff
+and need to be moved to a wiki somewhere with dense digital vegetation. Bare with me!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'db_automate'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install db_automate
+
+## Usage
+
+Initialize a query object with a sql statement and run the query against database 'my_db'
+
+	my_query = Query.new(:sql => 'select first_name, last_name, email from users')
+	my_query.run(:db => :my_db)
+
+Give your query a name to make it more
+	my_query.name = 'user info'
+
+Most query attributes are able to be set in an initialization block
+
+	my_query = Query.new do |qry|
+		qry.name = 'user info'
+		qry.db = :my_db
+		qry.sql = 'select first_name, last_name, email from users'
+		qry.export 'my_query_results', :csv, :xlsx, :export_dir => 'Desktop/query_data'
+	end
+
+The key passed to #db should be a top-level key in your YAML config file.
+
+	my_db:
+		adapter: mysql
+		server: localhost
+		username: dave
+		password: parties
+
+Tell DBAutomate where to find your config file:
+
+	DBAutomate.config_file = 'my/db/configs.yml'
+
+For more complex SQL, pass in the path (relative or absolute) to a file containing your sql
+
+	my_query.sql = 'sql/my_select_query.sql'
+
+By default if only a file name is given and no path, then DBAutomate will search in the current directory and in a subdirectory named 'sql' if it exists.
+You may change the default search path of DBAutomate:
+
+	DBAutomate.sql_dir = 'relative_path/'
+	DBAutomate.sql_dir = '/Users/me/store/all/my/sql/here/absolutely'
+
+And execute the query
+
+	my_query.run
+
+Check for results and do stuff with them
+	
+	if my_query.results?
+		# do things. . .
+	end
+
+	results = my_query.results
+	puts 'query #{my_query.name} returned #{results.length} rows'
+	puts 'columns: #{results.headers.join(", ")}'
+
+Export your results
+
+	my_query.export_csv
+	# => creates user_info.csv in the current directory
+
+	my_query.export_xlsx :export_dir => '/home/users/me'
+	# => create user_info.xlsx in /home/users/me
+
+For a more configurable multi format export, you may like the #export method. Pass it a configuration hash. . .
+
+	my_query.export :format => [:csv, :xlsx], :file_name => 'user info query results', :export_dir => DESKTOP_PATH
+
+. . . Or a block
+	
+	my_query.export do |exp|
+		exp.format = :csv, :xlsx
+		exp.headers = false
+		exp.file_name = 'user info query results'
+		exp.export_dir = DESKTOP_PATH
+	end
+
+Or configure a default export directory for DBAutomate
+	
+	DBAutomate.export_dir = '/my/given/export/path'
+
+
+## Contributing
+
+1. Fork it ( https://github.com/DRowan99/db_automate/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[rdd]: http://tom.preston-werner.com/2010/08/23/readme-driven-development.html

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+
+task :console do
+	exec "irb -r db_automate -I ./lib"
+end
+
+task :c => :console

data/db_automate.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'db_automate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "db_automate"
+  spec.version       = DBAutomate::VERSION
+  spec.authors       = ["Dave Rowan"]
+  spec.email         = ["drowan99@gmail.com"]
+  spec.summary       = 'An easy way to automate database queries and export the results with Ruby.'
+  spec.homepage      = ""
+  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.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/db_automate.rb

@@ -0,0 +1,5 @@
+require "db_automate/version"
+
+module DBAutomate
+  # Your code goes here...
+end

data/lib/db_automate/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+require 'db_automate'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: db_automate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dave Rowan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: 
+email:
+- drowan99@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- db_automate.gemspec
+- lib/db_automate.rb
+- lib/db_automate/version.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+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: An easy way to automate database queries and export the results with Ruby.
+test_files:
+- spec/spec_helper.rb