bonethug 0.0.1 → 0.0.5

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in bonethug.gemspec
 gemspec
+
+# tell bundler to get stuff from git hub
+gem 'mina',           github: 'nadarei/mina'
+gem 'astrails-safe',  github: 'astrails/safe'
+gem 'whenever',       github: 'javan/whenever' 

data/Rakefile

@@ -1 +1,3 @@
 require "bundler/gem_tasks"
+
+Dir.glob('lib/tasks/*.rake').each { |r| import r }

data/bin/bonethug

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+root_path = File.expand_path(File.dirname(__FILE__)) + '/..'
+puts root_path
+
+require 'rubygems' unless Object.const_defined?(:Gem)
+require root_path +'/lib/bonethug'
+require 'rake'
+
+ARGV.each do|a|
+  puts "Argument: #{a}"
+end
+
+Bonethug::call_rake('setup:silverstripe31-dev')

data/bonethug.gemspec

@@ -4,13 +4,14 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'bonethug/version'
 
 Gem::Specification.new do |spec|
+
   spec.name          = "bonethug"
   spec.version       = Bonethug::VERSION
   spec.authors       = ["azt3k"]
   spec.email         = ["breaks.nz@gmail.com"]
   spec.description   = %q{Project Skeleton Manager}
-  spec.summary       = %q{Project Skeleton Manager}
-  spec.homepage      = ""
+  spec.summary       = %q{Bonethug}
+  spec.homepage      = "https://github.com/azt3k/bonethug"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -20,4 +21,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+
+  spec.add_dependency 'mina'
+  spec.add_dependency 'astrails-safe'
+  spec.add_dependency 'whenever' 
+
 end

data/lib/bonethug/setup.rake

@@ -0,0 +1,19 @@
+require 'rake'
+
+namespace :setup do
+
+  desc "setup ss3.1-dev project"
+  task :silverstripe31dev => :environment do
+
+    puts "just pretending"
+
+  end
+
+  desc "setup silverstripe 3 project"
+  task :silverstripe => :environment do
+
+    puts "just pretending 2"
+    
+  end
+
+end

data/lib/bonethug/utils.rb

@@ -0,0 +1,15 @@
+module Bonethug
+
+  #arguments can be for example db:migrate
+  def self.call_rake(arguments)
+    if RUBY_PLATFORM =~ /mswin/
+      rake_cmd = "rake.bat" #very important because windows will break with just "rake"
+    else
+      rake_cmd = "rake"
+    end
+    puts "calling #{rake_cmd} " + arguments
+    puts system("#{rake_cmd} " + arguments)
+    puts $?
+  end
+
+end

data/lib/bonethug/version.rb

@@ -1,3 +1,3 @@
 module Bonethug
-  VERSION = "0.0.1"
+  VERSION = "0.0.5"
 end

data/lib/bonethug.rb

@@ -1,5 +1,17 @@
 require "bonethug/version"
 
 module Bonethug
-  # Your code goes here...
+
+  #arguments can be for example db:migrate
+  def self.call_rake(arguments)
+    if RUBY_PLATFORM =~ /mswin/
+      rake_cmd = "rake.bat" #very important because windows will break with just "rake"
+    else
+      rake_cmd = "rake"
+    end
+    puts "calling #{rake_cmd} " + arguments
+    puts system("#{rake_cmd} " + arguments)
+    puts $?
+  end
+
 end

data/lib/tasks/setup.rake

@@ -0,0 +1,19 @@
+require 'rake'
+
+namespace :setup do
+
+  desc "setup ss3.1-dev project"
+  task :silverstripe31dev => :environment do
+
+    puts "just pretending"
+
+  end
+
+  desc "setup silverstripe 3 project"
+  task :silverstripe => :environment do
+
+    puts "just pretending 2"
+    
+  end
+
+end

data/skel/base/.gitignore

@@ -0,0 +1,22 @@
+# project framework
+.bundle
+vendor
+bin
+logs/*
+backups/*
+db_dumps
+tmp/*
+composer.phar
+
+# components tracked by composer
+public/silverstripe-cache
+public/themes/simple
+public/vendor
+public/assets/*
+public/bootstrap_forms
+public/cms
+public/framework
+public/html5
+public/widgets
+public/compass
+composer.phar

data/skel/base/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem 'bonethug'

data/skel/base/README.md

@@ -0,0 +1,105 @@
+Insight Report Framework
+========================
+
+
+
+Requirements
+------------
+
+-   Ruby 1.9.3 +
+
+-   PHP 5.3 +
+
+-   Linux / OSX
+
+-   Apache
+
+-   MySQL 5.5 +
+
+
+
+Overview
+--------
+
+-   Deployment handled with mina. see [https://github.com/nadarei/mina]
+
+-   Cron handled wtih whenever. [https://github.com/javan/whenever]
+
+-   Backups handled with astrails-safe. see https://github.com/astrails/safe
+
+-   Ruby dependency management handled with bundler. see
+
+-   Built on the Silverstripe framework, CMS and Installer - 3.1.x dev branch.
+
+-   PHP dpendency management handled with composer. see [https://packagist.org/]
+
+
+
+Set Up
+------
+
+
+
+### Pre-requisites
+
+
+
+1.  If you are windows you'll need some better unix command support this helps:
+    http://www.robvanderwoude.com/unixports.php
+
+2.  Firstly you need an MAMP / LAMP / WAMP etc stack, ruby 1.9.3 and curl for
+    composer, if you're on windows there's an installer for composer
+
+3.  You need to have bundler and composer installed
+
+
+
+**bundler**
+
+`gem install bundler`
+
+
+
+**composer**
+
+`cd /path/to/project/root && curl -s http://getcomposer.org/installer | php`
+
+
+
+### Development
+
+
+
+1.  clone the repo, create the db, update config/cnf.yml if needed
+
+2.  Setup a vhost - look at the one defined in deploy.rb
+
+3.  run:
+
+`bundle install –path vendor –binstubs `
+
+`php composer.phar install`
+
+
+
+### Deployment
+
+
+
+This only works on \*nix based OSes
+
+
+
+1.  Setup the project
+
+`export to={staging|production} && bundle exec mina setup`
+
+
+
+1.  Deploy the project
+
+`export to={staging|production} && bundle exec mina deploy`
+
+
+
+

data/skel/base/composer.json

@@ -0,0 +1,31 @@
+{
+  "name" : "insight/report-framework",
+  "require" : {
+    "symfony/yaml"                  : "2.3.*@dev",     
+    "silverstripe/framework"        : "3.1.*@dev",
+    "silverstripe/cms"              : "3.1.*@dev",
+    "silverstripe-themes/simple"    : "dev-master",
+    "silverstripe/installer"        : "3.1.*@dev",
+    "silverstripe/bootstrap-forms"  : "dev-master",
+    "silverstripe/html5"            : "dev-master",
+    "silverstripe/widgets"          : "dev-master",
+    "silverstripe/compass"          : "dev-master"
+  },
+  "extra": {
+    "installer-paths": {
+        "public/vendor/{$name}": [
+      ],
+      "public/themes/{$name}": [
+        "silverstripe-themes/simple"
+      ],      
+      "public/{$name}": [
+        "silverstripe/framework",
+        "silverstripe/cms",
+        "silverstripe/bootstrap-forms",        
+        "silverstripe/html5",
+        "silverstripe/widgets",
+        "silverstripe/compass"
+      ]
+    }
+  }
+}

data/skel/base/config/backup.rb

@@ -0,0 +1,105 @@
+# astrails-safe config file - you can generate a template with
+# bundle exec astrails-safe CONFIG_FILE
+# more info: https://github.com/astrails/safe
+
+# Load some data
+# --------------------------------
+
+# get some info about the environemnt
+exec_path   = File.expand_path(File.dirname(__FILE__))
+env         = ENV['to']
+
+# load config
+require exec_path + '/lib/conf'
+conf = Conf.new.add(exec_path + '/config/cnf.yml').add(exec_path + '/config/database.yml' => { root: 'dbs.default' })
+
+# do a check
+raise 'could not find deployment environment' unless conf.get('deploy.environments').has_key? env
+
+# process config
+deploy      = conf.node_merge('deploy.common','deploy.environments.'+env)
+resources   = conf.get('resources','Array')
+log_dirs    = conf.get('log_dirs','Array')
+backup      = conf.get('backup')
+backup_slug = deploy.get('project_slug') + "_" + env + "_backup"
+
+# add in any standard folders
+log_dirs.push('log') unless log_dirs.include? 'log'
+
+# back up script
+# --------------------------------  
+
+# safe
+safe do
+
+  verbose true
+
+  local :path => "#{exec_path}/backups/:kind/:id"  
+
+  # use ftp to back stuff up
+  if backup.get('ftp')  
+    ftp do
+      host      backup.get('ftp.host')
+      user      backup.get('ftp.user')
+      password  backup.get('ftp.pass')
+      path      backup_slug
+    end
+  end
+
+  # use sftp to back stuff up
+  if backup.get('sftp')
+    sftp do
+      host      backup.get('sftp.host')
+      user      backup.get('sftp.user')
+      password  backup.get('sftp.pass')
+      path      backup_slug
+    end 
+  end
+
+  # use s3 to back stuff up
+  if backup.get('s3')
+    s3 do
+      key     backup.get('s3.key')
+      secret  backup.get('s3.secret')
+      bucket  backup.get('s3.bucket')
+      path    backup_slug
+    end 
+  end
+
+  # how many days are we holding on to backups?
+  keep do
+    local backup.get('local.keep')
+    ftp   backup.get('ftp.keep')
+    sftp  backup.get('sftp.keep')
+    s3    backup.get('s3.keep')    
+  end  
+
+  # backup mysql databases with mysqldump
+  mysqldump do
+
+    # dbs
+    conf.get('dbs').each do |name,envs|
+
+      # select the db config
+      db = envs.get(env)
+
+      database  db.get('name').to_sym do
+        user      db.get('user')
+        password  db.get('pass')
+        host      db.get('host')
+        port      db.get('port')
+      end
+
+    end
+
+  end
+
+  # acrchive shared files
+  tar do
+    options "-h" 
+    archive "shared_files" do
+      files (resources + log_dirs)
+    end 
+  end  
+
+end

data/skel/base/config/cnf.yml

@@ -0,0 +1,59 @@
+deploy:
+  common:
+    project_type:
+    base_dir: /var/www
+    repository: git@gitlab.....
+    project_slug: tradespot
+    default_branch: master
+    domain: domain.com
+    user: root
+    port: 22
+  environments:
+    development:
+    staging:
+      domain: staging.domain.com
+    production:
+      domain: production.cdomain.com
+dbs:
+  default:
+    development:
+    staging:
+    production:
+backup:
+  local:
+    keep:2
+  ftp:
+    keep: 10
+    host: backup-host.com
+    user: remote_backup
+    pass: passw0rd
+apache:
+  development:
+  staging:
+    server_name: staging.domain.com
+    server_aliases:
+      - www.staging.domain.com
+    env_vars:
+      SS_ENVIRONMENT_TYPE: test
+      RAILS_ENV: staging
+      APPLICATION_ENV: staging
+  production:
+    server_name: production.domain.com
+    server_aliases:
+      - www.production.domain.com
+    server_admin: dev@domain.com
+    env_vars:
+      SS_ENVIRONMENT_TYPE: live
+      RAILS_ENV: production
+      APPLICATION_ENV: production
+resources:
+permissions:
+  development:
+  staging:
+    www_executable:
+      - vendor/bin
+  production:
+    www_executable:
+      - vendor/bin  
+log_dirs:
+  - log

data/skel/base/config/deploy.rb

@@ -0,0 +1,213 @@
+# Todo
+# - implement a restore from backup task
+# - implement a cleanup task when a deploy fails - its not good if the apache conf gets malformed
+# - review directory permissions
+# - passenger executes rails as the user that owns evironment.rb - if root owns it it runs as nobody
+
+# Requires
+# ---------------------------------------------------------------
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'conf')
+require 'mina/bundler'
+require 'mina/rails'
+require 'mina/git'
+require 'mina/rbenv'
+require 'mina/whenever'
+
+# Config
+# ---------------------------------------------------------------
+
+# load the conf
+conf = Conf.new
+cnf = conf.to_hash
+
+# pull config from environment vars
+env = ENV['to']
+raise 'could not find deployment environment' unless conf.get('deploy.environments').has_key? env
+
+# build config
+deploy    = conf.node_merge('deploy.common','deploy.environments.'+env)
+resources = conf.get('resources','Array') || []
+log_dirs  = conf.get('log_dirs','Array') || []
+
+# vhost name
+vhost = deploy.get('project_slug') + '_' + env
+
+# composer?
+use_composer = ['silverstripe','drupal','php'].include? deploy.get('project_type')
+
+# directories we need to track
+resources += ['backups']
+resources.push 'vendor' if use_composer
+
+# logs
+log_dirs.push 'log' unless log_dirs.include? 'log'
+
+# shared paths
+shared = resources + log_dirs + ['tmp']
+shared.push 'composer.phar' if use_composer
+
+# shared config
+set :deploy_to,     deploy.get('base_dir') + '/' + vhost
+set :repository,    deploy.get('repository')
+set :branch,        ENV['branch'] || deploy.get('default_branch')
+set :domain,        deploy.get('domain')
+set :user,          deploy.get('user')
+set :port,          deploy.get('port')
+set :rails_env,     env
+set :shared_paths,  shared
+ 
+
+# Tasks
+# ---------------------------------------------------------------
+
+desc "Load Environment"
+task :environment do
+  # invoke :'rbenv:load'
+end
+
+desc "Sets up the Project"
+task :setup => :environment do
+
+  # make shared resource dirs
+  (resources + log_dirs).each do |path|
+    queue! %[mkdir -p "#{deploy_to}/shared/#{path}"]
+  end
+
+  # set appropriate permissions on the logs
+  log_dirs.each do |path|
+    queue! %[chown -R www-data:www-data "#{deploy_to}/shared/#{path}"]
+    queue! %[chmod -R 0666 "#{deploy_to}/shared/#{path}"]
+  end
+
+  # make sure the vhost exists
+  queue! %[touch /etc/apache2/sites-available/#{vhost}]
+
+  # set up the tmp dir (rails only?)
+  queue! %[mkdir -p "#{deploy_to}/shared/tmp"]
+  queue! %[touch "#{deploy_to}/shared/tmp/restart.txt"]
+  queue! %[cd #{deploy_to}/shared/tmp && chown -R www-data:www-data . && chmod -R 775 .]
+ 
+  # init composer
+  if use_composer
+    queue! %[mkdir -p "#{deploy_to}/shared/vendor"]
+    queue! %[cd #{deploy_to}/shared && curl -s http://getcomposer.org/installer | php] 
+  end
+
+  # create the backup folder
+  queue! %[mkdir -p "#{deploy_to}/shared/backups"]
+
+end
+
+desc "Updates bundled dependencies"
+task :update_packages => :environment do
+  invoke :'bundle:update'
+  queue! %[php #{deploy_to}/shared/composer.phar update] if use_composer
+  queue! %[php #{deploy_to}/current/public/framework/cli-script.php dev/build] if deploy.get('project_type') == 'silverstripe'
+end
+
+desc "Restores application state to the most recent backup"
+task :init_db => :environment do
+  queue! %[cd #{deploy_to}/current && bundle exec rake db:reset RAILS_ENV="#{env}"] if deploy.get('project_type') == 'rails'
+end
+
+desc "Restores application state to the most recent backup"
+task :restore_backup => :environment do
+  # to be implemented
+end
+
+desc "Deploys the current version to the server."
+task :deploy => :environment do
+  deploy do
+
+    # common deployment tasks
+    invoke :'git:clone'
+    invoke :'deploy:link_shared_paths'
+    invoke :'bundle:install'
+
+    # rails deploy tasks
+    if deploy.get('project_type') == 'rails'
+      invoke :'rails:db_migrate'
+      invoke :'rails:assets_precompile'
+    end
+
+    # update composer
+    queue! %[php #{deploy_to}/shared/composer.phar update] if use_composer
+
+    # build the vhosts
+    vh_cnf = conf.get('apache.'+env)
+
+    # server aliases
+    server_aliases = ''
+    aliases = vh_cnf.get('server_aliases')
+    if aliases
+      aliases.each do |index, server_alias|
+        server_aliases += 'ServerAlias '+server_alias + "\n"
+      end
+    end
+
+    # environment variables
+    env_vars = ''
+    vars = vh_cnf.get('env_vars')
+    if vars
+      vars.each do |k, v|
+        env_vars += 'SetEnv ' + k + ' ' + v + "\n"
+      end
+    end
+
+    # server admin
+    admin = vh_cnf.get('server_admin')
+    server_admin = admin ? 'ServerAdmin '+admin : ''
+
+    vh = "
+<VirtualHost *:80>
+
+  ServerName  #{vh_cnf.get('server_name')}
+  #{server_aliases}
+
+  #{server_admin}
+
+  DocumentRoot #{deploy_to}/current/public
+
+  #{env_vars}          
+
+  CustomLog #{deploy_to}/shared/log/bytes.log bytes
+  CustomLog #{deploy_to}/shared/log/combined.log combined
+  ErrorLog  #{deploy_to}/shared/log/error.log
+
+  <Directory #{deploy_to}/current/public>
+
+    Options Indexes MultiViews FollowSymLinks
+    AllowOverride All
+    Order allow,deny
+    Allow from all
+    
+  </Directory>
+
+</VirtualHost>
+    "
+
+    # install the vhost
+    queue 'rm /etc/apache2/sites-available/'+vhost
+    queue 'echo "'+vh+'" > /etc/apache2/sites-available/'+vhost    
+
+    to :launch do
+
+      # ensure that the correct directory permissions are set
+      queue! %[cd #{deploy_to}/current/public && chown -R www-data:www-data . && chmod -R 775 .]
+      queue! %[cd #{deploy_to}/shared/tmp && chown -R www-data:www-data . && chmod -R 775 .]      
+      queue! %[touch #{deploy_to}/current/tmp/restart.txt]
+
+      (conf.get('permissions.'+env+'.www_executable','Array') || []).each do |dir|
+        queue! %[cd #{deploy_to}/current/#{dir} && chown -R www-data:www-data . && chmod -R 775 .]
+      end
+
+      queue! %[a2ensite "#{vhost}"]
+      queue! %[/etc/init.d/apache2 reload]
+      invoke :'whenever:update'
+
+      queue! %[php #{deploy_to}/current/public/framework/cli-script.php dev/build] if deploy.get('project_type') == 'silverstripe'
+
+    end
+  end
+end