openbanana 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Lookout, Inc.
+
+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,62 @@
+# Open Banana
+
+[![Build Status](https://buildhive.cloudbees.com/job/lookout/job/openbanana/badge/icon)](https://buildhive.cloudbees.com/job/lookout/job/openbanana/)
+
+Openbanana is a gem that, currently, provides a `db:grant` rake task for Rails
+projects.
+
+What this `db:grant` task does is creates the database and sets up the initial grants for the database
+configured in the `config/database.yml` file
+
+To use Openbanana, include it in your `Rakefile`:
+
+    require 'openbanana/tasks'
+
+And in your `Gemfile`:
+
+    gem "openbanana", "~> 0.2"
+
+
+Make sure you have a source for either `maestro` or `dogwood` in your Gemfile.```
+
+### Environment variables
+
+* `DB_USER` overrides the default user (root) to grant privileges
+* `DB_PASSWORD` overrides the default password (*empty*) to grant privileges
+* `DB_HOST` overrides the hostname for the database server (defaults to
+  *localhost*)
+
+
+For sharded configurations using a shards.yml file (such as using the octopus gem,
+see https://github.com/tchandy/octopus) or with extra sharded entries in database.yml
+(named *production* or *development*, etc.; such as using the data_fabric gem,
+see https://github.com/bpot/data_fabric), adds a `db:grant_shards` task to create
+and grant for a set of shard databases.
+
+An example shard.yml looks like:
+
+    octopus:
+      ...
+      production:
+        ungrouped_shard:
+          adapter: mysql2
+          database: foo
+          .... also specify username, password, host, etc.
+        shard_group:
+          shard1:
+            database: bar_1
+            ....
+          shard2:
+            database: bar_2
+            ....
+       ...
+
+or entries in database.yml that look like:
+
+    ...
+    shard_1_production:
+      adapter: mysql2
+      database: foo_prod_s1
+      .. etc.
+    shard_2_production:
+      ...

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:test)
+
+
+task :default => [:test, :build]

data/lib/openbanana.rb

@@ -0,0 +1,101 @@
+require "openbanana/version"
+require 'rake'
+
+module Openbanana
+  extend Rake::DSL
+
+  # Defining this just to make stubbing in rspec easier
+  def self.env
+    ENV
+  end
+
+  # load config YML file
+  def self.load_yml(filename = 'database.yml')
+    YAML.load_file(File.join(Rails.root, 'config', filename))
+  end
+
+  # read config YML for environment
+  def self.config
+    config = Openbanana.load_yml
+    return config[Rails.env]
+  end
+
+  # read config for sharded case using octopus shards.yml
+  def self.shard_config
+    config = Openbanana.load_yml('shards.yml')
+    config = config['octopus'] if config.keys == ['octopus']
+    config = config[Rails.env]
+    config = config['shards'] if config.keys == ['shards']
+    return config
+  rescue Errno::ENOENT => e
+    puts 'No shards.yml, using shards in database.yml'
+    config = Openbanana.load_yml
+    return Hash[config.select {|k,v| k.include?(Rails.env) && k != Rails.env}]
+  end
+
+  # generate SQL statements for DB creation, permission grant
+  def self.grant_for(config)
+    grants = []
+
+    unless config['database']
+      return nil
+    end
+
+    grants << "CREATE DATABASE #{config['database']};"
+
+    if config['username']
+      identify_by = ''
+      if config['password']
+        identify_by = "IDENTIFIED BY '#{config['password']}'"
+      end
+
+      unless config['networks']
+        grants << "GRANT ALL PRIVILEGES ON #{config['database']}.* TO '#{config['username']}'@'%' #{identify_by};"
+      else
+        config['networks'].each do |network|
+          grants << "GRANT ALL PRIVILEGES ON #{config['database']}.* TO '#{config['username']}'@'#{network}' #{identify_by};"
+        end
+      end
+    end
+
+    return grants
+  end
+
+  # run block on all contained hashes which have the key 'database'
+  def self.traverse(obj, &block)
+    case obj
+    when Hash
+      if obj['database']
+        block.call(obj)
+      else
+        obj.each {|k,v| traverse(v, &block)}
+      end
+    when Array
+      obj.each {|v| traverse(v, &block)}
+    end
+  end
+
+  # generate grants
+  def self.grants(args = {})
+    config = args[:sharded] ? Openbanana.shard_config : Openbanana.config
+    grants = []
+    Openbanana.traverse(config) do |leaf_config|
+      grants += Openbanana.grant_for(leaf_config)
+    end
+    return grants
+  end
+
+  # run task (here for DRY-ness)
+  def self.grants_task(args = {})
+    username = ENV['DB_USER'] || 'root'
+    password = ENV['DB_PASSWORD'] || ''
+    host = nil
+    if ENV['DB_HOST']
+      host = "--host=#{ENV['DB_HOST']}"
+    end
+
+    Openbanana.grants(args).each do |grant|
+      sh "mysql #{host} --user=#{username} --password=\"#{password}\" -e \"#{grant}\" || true"
+    end
+  end
+end

data/lib/openbanana/tasks.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'rake'
+
+require 'openbanan'
+
+namespace :db do
+  desc "Set up the appropriate user grants for this project based on config/database.yml"
+  task :grant do
+    Openbanana.grants_task
+  end
+
+  desc "Set up the appropriate user grants for this project based on config/shards.yml and shards in config/database.yml"
+  task :grant_shards do
+    Openbanana.grants_task(:sharded => true)
+  end
+end

data/lib/openbanana/version.rb

@@ -0,0 +1,3 @@
+module Openbanana
+  VERSION = "1.0.0"
+end

data/openbanana.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/openbanana/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["R. Tyler Croy"]
+  gem.email         = ["tyler@monkeypox.org"]
+  gem.description   = %q{Simple gem to handle creating DB grans}
+  gem.summary       = %q{Simple gem to handle creating DB grans}
+  gem.homepage      = "https://github.com/lookout/openbanana"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "openbanana"
+  gem.require_paths = ["lib"]
+  gem.version       = Openbanana::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require "rake"
+
+shared_context "rake" do
+  let(:rake)      { Rake::Application.new }
+  let(:task_name) { self.class.top_level_description }
+  let(:task_path) { File.expand_path("./lib/openbanana/tasks/#{task_name.split(":").first}.rake") }
+  subject         { rake[task_name] }
+
+  before do
+    Rake.application = rake
+    Rake.application.rake_require(File.expand_path('./lib/openbanana/tasks'))
+    Rake::Task.define_task(:environment)
+  end
+end
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+require 'openbanana'

data/spec/tasks_spec.rb

@@ -0,0 +1,131 @@
+
+require 'spec_helper'
+
+describe 'db:grant' do
+end
+
+describe Openbanana do
+  before :each do
+    Rails = double('rails')
+    Rails.stub(:root).and_return('dummy_root')
+  end
+
+  describe '#load_yml' do
+    it 'should load the database.yml file on Rails.root/config' do
+      YAML.should_receive(:load_file).with(Rails.root + '/config/database.yml').and_return({})
+      Openbanana.load_yml
+    end
+
+    it 'should load the shards.yml file on Rails.root/config' do
+      YAML.should_receive(:load_file).with(Rails.root + '/config/shards.yml').and_return({})
+      Openbanana.load_yml('shards.yml')
+    end
+  end
+
+  describe '#config' do
+    let(:config) do
+      { 'database' => 'test_db',
+        'username' => 'test_user',
+        'password' => 'test_password'}
+    end
+
+    context 'with development configuration' do
+      before :each do
+        Openbanana.should_receive(:load_yml).and_return({'development' => config})
+        Rails.stub(:env).and_return('development')
+      end
+
+      it 'should return the proper configuration for this environment' do
+        result = Openbanana.config
+        result.should == config
+      end
+    end
+  end
+
+  describe '#shard_config' do
+    let(:config) do
+      { 'database' => 'test_db',
+        'username' => 'test_user',
+        'password' => 'test_password'}
+    end
+
+    context 'with development configuration' do
+      before :each do
+        Openbanana.should_receive(:load_yml).and_return({'octopus' => {'development' => {'shards' => config}}})
+        Rails.stub(:env).and_return('development')
+      end
+
+      it 'should return the proper configuration for this environment' do
+        result = Openbanana.shard_config
+        result.should == config
+      end
+    end
+  end
+
+  describe '#grants' do
+    before :each do
+      Openbanana.should_receive(:config).and_return(config)
+    end
+
+    context 'in production' do
+      describe 'with networks' do
+        let(:config) do
+          { 'database' => 'test_db',
+            'username' => 'test_user',
+            'password' => 'test_password',
+            'networks' => ['127.0.0.0/24']}
+        end
+
+        it 'should have networks' do
+          result = Openbanana.grants
+          result.should include("GRANT ALL PRIVILEGES ON test_db.* TO 'test_user'@'127.0.0.0/24' IDENTIFIED BY 'test_password';")
+        end
+      end
+    end
+
+    context 'on shards' do
+      describe 'with multiple shards' do
+        let(:config) do
+          {
+            'shard1' => {
+              'database' => 'test_db1',
+              'username' => 'test_user',
+              'password' => 'test_password'
+            },
+            'shard2' => {
+              'database' => 'test_db2',
+              'username' => 'test_user',
+              'password' => 'test_password'
+            }
+          }
+        end
+
+        it 'should have both shards' do
+          result = Openbanana.grants
+          result.should include("GRANT ALL PRIVILEGES ON test_db1.* TO 'test_user'@'%' IDENTIFIED BY 'test_password';")
+          result.should include("GRANT ALL PRIVILEGES ON test_db2.* TO 'test_user'@'%' IDENTIFIED BY 'test_password';")
+        end
+      end
+    end
+
+    context 'grants should' do
+      let(:config) do
+        { 'database' => 'test_db',
+          'username' => 'test_user',
+          'password' => 'test_password'}
+      end
+
+      it 'generate a create database call' do
+        result = Openbanana.grants
+        result.should include('CREATE DATABASE test_db;')
+      end
+
+      it 'generate a grant for the user on that database' do
+        result = Openbanana.grants
+        result.should include("GRANT ALL PRIVILEGES ON test_db.* TO 'test_user'@'%' IDENTIFIED BY 'test_password';")
+      end
+    end
+  end
+end
+
+

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: openbanana
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- R. Tyler Croy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &11245520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11245520
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &11245080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11245080
+description: Simple gem to handle creating DB grans
+email:
+- tyler@monkeypox.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/openbanana.rb
+- lib/openbanana/tasks.rb
+- lib/openbanana/version.rb
+- openbanana.gemspec
+- spec/spec_helper.rb
+- spec/tasks_spec.rb
+homepage: https://github.com/lookout/openbanana
+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.10
+signing_key: 
+specification_version: 3
+summary: Simple gem to handle creating DB grans
+test_files:
+- spec/spec_helper.rb
+- spec/tasks_spec.rb