rails_enterprise_setup 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38a7f8f7c050f535d8b8604f76f233ac584456e5
+  data.tar.gz: 50525de9b2522488d082066520b87f49e4f3996b
+SHA512:
+  metadata.gz: 5bccebec5e7813e37b3e943391ea9df8a140cc0b8eaf0d4180036f317c2278c839d614ec4268c5d83488616aa113eb8e23f2a6d3570d222060e403cd0fd6b522
+  data.tar.gz: 901f3bb5b6d7a4c740d3b4838d997b1169b04a794e76f9e3592f0516274203f00c0d113b19572be477afdea9861628dc820c51b462bffe3ddb2e7f25c8bc58d6

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.swp
+*.swo

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Mikhli, Uri
+
+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,37 @@
+# RailsSetup
+
+This is a collection of generators to help setup rails development in an enterprise environment.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_setup'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_setup
+
+## Usage
+
+```ruby
+rails generate setup_rails
+```
+Follow directions.
+
+Note: You can enter more then 1 letter.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rails_setup/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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/generators/db_connect/USAGE

@@ -0,0 +1,23 @@
+Description:
+    generates an abstract Database connection class that acts as the interface to the given database
+
+Example:
+    $ rails generate db_coonect <Name of Database>
+
+    This will create:
+      create  app/models/<name_of_database>_db.rb
+        -----
+        class NameofdatabaseDb < ActiveRecord::Base
+          self.abstract_class = true
+        ...
+        -----
+
+     Inside of which will be the appropriate configuration for that database's ActiveRecord connection.
+     All rails models representing tables in that database must inherit from this abstract class.
+
+     -----
+     rails model:  app/models/some_table.rb
+     -----
+        class SomeTable < NameofdatabaseDb
+        ...
+     -----

data/lib/generators/db_connect/db_connect_generator.rb

@@ -0,0 +1,63 @@
+class DbConnectGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+
+  def add_to_database_to_yml
+    #insert #EOF so inject will work.
+    unless File.open('config/database.yml').read().include? "#EOF"
+      File.open('config/database.yml', 'a') do |f1|
+        f1 << "\n#EOF"
+      end
+    end
+    #if entry doesnt exist inject it. Force:false means that it doesnt repeat
+    unless File.open('config/database.yml').read().include? "#{file_name}:"
+      say("Please enter some details about the (#{file_name}) database in the development environment:")
+
+      adapter = ask("adapter?[mysql2]:")
+      adapter = "mysql2" if adapter.blank?
+
+      host = ask("host?[localhost]:")
+      host = "localhost" if host.blank?
+
+      port = ask("port?[3307]:")
+      port = 3307 if port.blank?
+
+      sslca = ask("path to database ssl certificate if any[]")
+      unless sslca.blank?
+        sslca = "sslca: #{sslca}"
+      end
+
+      inject_into_file 'config/database.yml',"
+#{file_name}_default: &#{file_name}_default
+  adapter: #{adapter}
+  encoding: utf8
+  reconnect: false
+  pool: 5
+  #{sslca}
+
+#{Rails.env}_#{file_name}:
+  <<: *#{file_name}_default
+  host: #{host}
+  port: #{port}
+  database: #{file_name}
+
+"   , before: /^\#EOF/, verbose: true, force: false
+    end
+
+  end
+
+  def create_abstract_db_model
+      create_file "app/models/#{file_name}_db.rb", <<-FILE
+class #{class_name}Db < ActiveRecord::Base
+  self.abstract_class = true
+
+  config = ActiveRecord::Base.configurations["\#{Rails.env}_#{file_name}"]
+
+  establish_connection( config )
+
+end
+    FILE
+  end
+
+  
+end

data/lib/generators/db_credentials/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Create a database credentials yml file that holds the path to the username and password files.
+    Create an initializer that adds the credentilas to ActiveRecord.
+Example:
+    rails generate db_credentials database_name
+
+    This will create:
+      If they dont exist:
+        config/initializers/database_credentials.rb
+        config/database_credentials.yml
+
+    Otherwise for: 
+      config/database_credentials.yml
+        It will insert the entry for the named database, if one doesnt already exist. 

data/lib/generators/db_credentials/db_credentials_generator.rb

@@ -0,0 +1,47 @@
+class DbCredentialsGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  def create_database_credentials
+    unless File.exists?('config/database_credentials.yml')
+      #file doesnt exist... create it
+      create_file "config/database_credentials.yml", <<-FILE
+#Manage DB credentials
+#The section below is appropriate for the #{file_name} database. 
+#Any additions made by hand to this file should be in the following format:
+#environment:
+# db_name:
+#   home_path: <path to home dir>
+#   username: <path to username file>/environment_dbname_username.txt
+#   password: <path to password file>/environment_dbname_password.txt
+# other_db_name:
+#   home_path: ...
+#   username: ...
+#   password: ...
+#
+#{Rails.env}:
+  #{file_name}:
+    home_path: "#{Dir.home}"
+    username: "config/passwords/#{Rails.env}_#{file_name}_username.txt"
+    password: "config/passwords/#{Rails.env}_#{file_name}_password.txt"
+
+      FILE
+    else
+      unless File.open('config/database_credentials.yml').read().include? "#{file_name}:"
+        inject_into_file 'config/database_credentials.yml',"
+  #{file_name}:
+    home_path: \"#{Dir.home}\"
+    username: \"config/passwords/#{Rails.env}_#{file_name}_username.txt\"
+    password: \"config/passwords/#{Rails.env}_#{file_name}_password.txt\"
+
+", after: /#{Rails.env}:/, verbose: true, force: false
+      end
+    end
+
+  end
+
+  def load_credentials
+    unless File.exists?('config/initializers/database_credentials.rb')
+      copy_file("database_credentials.rb",'config/initializers/database_credentials.rb')
+    end
+  end
+
+end

data/lib/generators/db_credentials/templates/database_credentials.rb

@@ -0,0 +1,22 @@
+#
+Rails.application.config.after_initialize do
+  ActiveSupport.on_load(:active_record) do
+    database_credentials = YAML::load(File.open('config/database_credentials.yml'))
+    database_credentials[Rails.env].each do |db, credentials|
+      
+      #read credentials file for the location of the password files and then insert their contents
+      #into credentials hash 
+      if ActiveRecord::Base.configurations["#{Rails.env}_#{db}"].present?
+        user_path = credentials["home_path"] + credentials["username"]
+        pswd_path = credentials["home_path"] + credentials["password"]
+
+        credentials["username"] = File.read(user_path).strip if File.exists?(user_path)
+        credentials["password"] = File.read(pswd_path).strip if File.exists?(pswd_path)
+
+        #Finally, add credentials to ActiveRecord
+        #if password file doesnt exist, keep the path to it as the password. This will aid debugging
+        ActiveRecord::Base.configurations["#{Rails.env}_#{db}"].merge!(credentials)
+      end
+    end
+  end
+end

data/lib/generators/setup_rails/USAGE

@@ -0,0 +1,14 @@
+Description:
+    This generator will do a full rails setup.
+    Generators invoked:
+      * db_connect
+      * db_credentials
+      * ssl_mode generators
+    
+    You will have the option of choosing all or any of the setups. 
+
+Example:
+    rails generate setup_rails
+
+    you will be asked if you want all generators to run or specific generators to run.
+

data/lib/generators/setup_rails/setup_rails_generator.rb

@@ -0,0 +1,40 @@
+class SetupRailsGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def call_generators
+
+    say("
+        All Generators[Aa]:
+          * db_connect
+          * db_credentials
+          * ssl_mode
+
+        db_connect[Cc]:
+        db_credentials[Rr]:
+        ssl_mode[Ss]:
+
+        Hitting enter without an entry will NOT run any generators
+        ")
+    choice = ask("What setup would you like to run. (Default: none)[AaCcRsSs]:")
+
+    if choice =~ /[Aa]/ || choice =~ /[Cc]/ 
+      db_name = ask("db_connect -- What is the database name?:")
+      unless db_name.blank?
+        generate "db_connect", db_name
+      end
+    end
+
+    if choice =~ /[Aa]/ || choice =~ /[Rr]/ 
+      db_name = ask("db_credentials -- What is the database name?:")
+      unless db_name.blank?
+        generate "db_credentials", db_name
+      end
+    end
+
+    if choice =~ /[Aa]/ || choice =~ /[Ss]/ 
+      generate "ssl_mode"
+    end
+
+  end
+
+end

data/lib/generators/ssl_mode/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Setup Rails to run SSL mode in development. This will use port 3001 when running in ssl mode. 
+
+Example:
+    rails generate ssl_setup
+
+    This will:
+        * insert the config.force_ssl = true line into applicaton.rb
+        * insert code for starting rails development in SSL mode into bin/rails.
+        * create a certs/ directory that holds the self signed certs needed to run in ssl mode. You will need to create your own self signed certifications. Google "self signed certificate in rails".
+
+Run Time Invokation:
+  * None SSL mode: $> rails s     #note: this is the standard invokation.
+  * SSL mode: $> SSL=true rails s 
+

data/lib/generators/ssl_mode/ssl_mode_generator.rb

@@ -0,0 +1,29 @@
+class SslModeGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def ssl_config
+    # set application.rb config.
+    environment 'config.force_ssl = true if ENV[\'SSL\'] == true'
+  end
+
+  def create_local_certs
+    unless File.exists?('certs/server.key')
+      say("\nYou need to have a 'certs/' directory where your self signed certificates will be stored.  It will be populated with the correct file names, but these files will be empty. You will still need to generate your own:")
+      create_certs_dir = ask("Would you like to create certs/ directory?[y/N]:")
+      if create_certs_dir =~ /[Yy]/
+        run "cp -rf #{Gem.loaded_specs['rails_setup'].full_gem_path}/lib/generators/ssl_mode/templates/certs certs"
+      end
+    end
+  end
+
+  def set_ssl_rails
+    #add the contents of sslrails.rb file into bin/rails 
+
+    sentinal = /require\s\'rails\/commands\'/i
+
+    data = File.read(Gem.loaded_specs['rails_setup'].full_gem_path + "/lib/generators/ssl_mode/templates/sslrails.rb")
+
+    inject_into_file 'bin/rails', "\n#{data}\n",before: sentinal, verbose: true, force: false
+  end
+
+end

data/lib/generators/ssl_mode/templates/certs/server.crt

@@ -0,0 +1,3 @@
+-----BEGIN CERTIFICATE-----
+Create your OWN Certificate
+-----END CERTIFICATE-----

data/lib/generators/ssl_mode/templates/certs/server.csr

@@ -0,0 +1,3 @@
+-----BEGIN CERTIFICATE REQUEST-----
+Create your OWN Certificate
+-----END CERTIFICATE REQUEST-----

data/lib/generators/ssl_mode/templates/certs/server.key

@@ -0,0 +1,3 @@
+-----BEGIN PRIVATE KEY-----
+Create your own Certificate
+-----END PRIVATE KEY-----

data/lib/generators/ssl_mode/templates/certs/server.orig.key

@@ -0,0 +1,3 @@
+-----BEGIN RSA PRIVATE KEY-----
+Create your own Certificate
+-----END RSA PRIVATE KEY-----

data/lib/generators/ssl_mode/templates/sslrails.rb

@@ -0,0 +1,29 @@
+if ENV['RAILS_ENV'] == "development" || ENV['RAILS_ENV'].class == NilClass
+  require 'rails/commands/server'
+  require 'rack'
+  require 'webrick'
+  require 'webrick/https'
+  if ENV['SSL'] == "true"
+    module Rails
+      class Server < ::Rack::Server
+        def default_options
+          super.merge({
+            :Port => 3001,
+            :environment => (ENV['RAILS_ENV'] || "development").dup,
+            :daemonize => false,
+            :debugger => false,
+            :pid => File.expand_path("tmp/pids/server.pid"),
+            :config => File.expand_path("config.ru"),
+            :SSLEnable => true,
+            :SSLVerifyClient => OpenSSL::SSL::VERIFY_NONE,
+            :SSLPrivateKey => OpenSSL::PKey::RSA.new(
+              File.open("certs/server.key").read),
+            :SSLCertificate => OpenSSL::X509::Certificate.new(
+              File.open("certs/server.crt").read),
+            :SSLCertName => [["CN", "localhost.ssl"]],
+          })
+        end
+      end
+    end
+  end
+end

data/lib/rails_setup/version.rb

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

data/lib/rails_setup.rb

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

data/rails_setup.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_setup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_enterprise_setup"
+  spec.version       = RailsSetup::VERSION
+  spec.authors       = ["Mikhli, Uri"]
+  spec.email         = ["urimikhli@gmail.com"]
+  spec.summary       = %q{Generators for setting up common enterprise development needs for rails}
+  spec.description   = %q{Topics covered: \n Multiple DBs \n Database credential managment \n SSL in development \n Session Managment Via 3rd Party authentication service.}
+  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","lib/generators"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rails_enterprise_setup
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Mikhli, Uri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 'Topics covered: \n Multiple DBs \n Database credential managment \n
+  SSL in development \n Session Managment Via 3rd Party authentication service.'
+email:
+- urimikhli@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/db_connect/USAGE
+- lib/generators/db_connect/db_connect_generator.rb
+- lib/generators/db_credentials/USAGE
+- lib/generators/db_credentials/db_credentials_generator.rb
+- lib/generators/db_credentials/templates/database_credentials.rb
+- lib/generators/setup_rails/USAGE
+- lib/generators/setup_rails/setup_rails_generator.rb
+- lib/generators/ssl_mode/USAGE
+- lib/generators/ssl_mode/ssl_mode_generator.rb
+- lib/generators/ssl_mode/templates/certs/server.crt
+- lib/generators/ssl_mode/templates/certs/server.csr
+- lib/generators/ssl_mode/templates/certs/server.key
+- lib/generators/ssl_mode/templates/certs/server.orig.key
+- lib/generators/ssl_mode/templates/sslrails.rb
+- lib/rails_setup.rb
+- lib/rails_setup/version.rb
+- rails_setup.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/generators
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Generators for setting up common enterprise development needs for rails
+test_files: []