roro 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 542ed0fa8900bd48c2a6e083bc03bfc04ea2790a9450931d4ac758f34dc6b207
-  data.tar.gz: 2ccbeffc388e66f8cd16e6d1a126700ead483e8fb0bc55165447728deb690977
+  metadata.gz: 639ba3036903d8a486608ec5b07f79bf4330e05823b21d7eab7f9f3fde803c62
+  data.tar.gz: 06bb7ab5697e76eba09a77586b21eb213352df9fd971662ee893c211ed364ae1
 SHA512:
-  metadata.gz: 7c84d257097d23ca51b699aedd4bccae407c3e7616498db693e65e68c8159931dadc9c9ffbcc03ef5338e0996a7a3a1c7624c98bfe0bf0f744436512a8435b18
-  data.tar.gz: fb68201335f823da29658242942057aaf32e736d12d25ea32eba66d6f1c1f47ca97679e7c9b7d6c623251f46b80429f7fb15701d2051e40aa19af7f6b4ec8400
+  metadata.gz: 72b53d0e0cd9cf98914a9dc00921106fbfd68b2ab5452608722a3ee090bc384e74b8e275f5034480fa9f99667fac10912ae4e6c6a2004be28bcf317ddd5f5809
+  data.tar.gz: 7afa2da9a34364e493457d239ddff73b9791ad519993237fcc779140d90f21d6edd31c91de6878af66896df6a8907bf160bc8104d082ab4e937558c7bdb014ae

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    roro (0.2.0)
+    roro (0.2.3)
       handsome_fencer-crypto (= 0.1.6)
-      os
-      sshkit
-      thor
+      os (= 1.0.0)
+      sshkit (= 1.18.2)
+      thor (= 0.20.3)
 
 GEM
   remote: https://rubygems.org/
@@ -156,8 +156,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
-  handsome_fencer-test
+  bundler
+  handsome_fencer-test (= 0.1.1)
   rake (~> 10.0)
   roro!
 

data/README.md

@@ -1,43 +1,143 @@
 # Roro
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/roro`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Roro gives developers a handsome way to create, test, integrate, and deploy Ruby on Rails applications using Guard, CircleCI, Docker, Docker Compose.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```bash
+$ gem install roro
+```
+
+## Usage
 
-```ruby
-gem 'roro'
+Once installed, Roro provides a CLI:
+
+```bash
+$ roro --help
+Commands:
+  roro expose          # Expose encrypted files
+  roro generate_key    # Generate a key for each environment
+  roro generate_keys   # Generates keys for all environments. If you have .en...
+  roro greenfield      # Greenfield a brand new rails app using Docker's inst...
+  roro help [COMMAND]  # Describe available commands or one specific command
+  roro obfuscate       # obfuscates any files matching the pattern ./docker/*...
+  roro rollon          # Generates files necessary to greenfield a new app wi...
+  roro ruby_gem        # Generate files for containerized gem testing, Circle...
 ```
 
-And then execute:
+## Installing Docker and Docker Compose 
 
-    $ bundle
+Before using Roro's 'greenfield' and 'rollon' commands, you'll need Docker and Docker Compose. To see if Docker is installed:
 
-Or install it yourself as:
+```bash
+$ docker -v
+Docker version 18.03.1-ce, build 9ee9f40
+```
 
-    $ gem install roro
+Instructions for installing [Docker](https://docs.docker.com/install/). To see if Docker Compose is installed:
 
-## Usage
+```bash
+$ docker-compose -v
+docker-compose version 1.21.0, build 5920eb0
+```
+
+Instructions for installing [Docker Compose](https://docs.docker.com/compose/install/).
+
+## Greenfielding a dockerized app:
+
+```bash
+$ mkdir -p handsome_app
+$ cd handsome_app
+$ roro greenfield
+$ docker-compose up
+```
+
+You should now be able to see the Rails welcome screen upon clicking [http://localhost:3000/](http://localhost:3000/). 
 
-TODO: Write usage instructions here
+If you're on a linux machine and run into issues, please see the
+[linux notes](#linux-notes).
 
-## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Rolling onto an existing app:
+
+Using your own app or one generated using the 'greenfield' instructions above: 
+
+```bash
+$ docker-compose down
+$ roro rollon
+$ docker-compose up
+```
+
+You should now be able to see the Rails welcome screen upon clicking [http://localhost:3000/](http://localhost:3000/). 
+
+## Securing environment files 
+
+Roro gives provides conventions for securing your environment files. To store a variable for use in your development environment, create a file with that variable, name it "development.env," and store it in docker/env_files like so:
+
+```bash 
+$ echo "export export EXplace to put environment files for use in dockerized environments. AMPLE_KEY=example_value" > docker/env_files/development.env
+$ roro generate_key development
+$ roro obfuscate development
+```
+
+You should now see an environment file and its encrypted counterpart in docker/env_files: 
+
+```bash 
+$ ls docker/env_files
+development.env  development.env.enc
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To expose a previously obfuscated file:
+
+```bash 
+$ mv docker/env_files/development.env docker/env_files/backup.env
+$ roro expose development
+```
+
+To verify the newly decrypted file contents match its backup:
+
+```bash 
+$ diff docker/env_files/development.env docker/env_files/backup.env 
+```
+
+## Linux notes
+
+If you're on a linux machine, you may need to change ownership of the newly created files:
+
+```bash
+$ sudo chown <username><user group> -R .
+```
+
+If that doesn't work, Docker's [documentation](https://docs.docker.com/install/linux/linux-postinstall/#manage-docker-as-a-non-root-user) should get you pointed in the right direction.
+
+## Troubleshooting 
+
+Sometimes the port is in use. This could be because you have a server running on your host machine, or because Docker is running a server and piping it to the host. To shut down a server running in Docker, do:
+
+```
+$ docker-compose down 
+``` 
+
+Sometimes shutting down all servers doesn't work, because Rails still thinks a server is already running, which is usuall because there's a .pid file somewhere. 
+
+$ rm /tmp/pids/server.pid
+
+Sometimes you just need a fresh start. To remove all images, containers, and volumes from your system:
+
+$ docker system prune -af --volumes
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/roro. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+This gem and the associated practices are just a way of deploying your application, not the canonical or best way. If you have suggestions on how to make it easier, more secure, quicker or better, please share them. If you have specific ideas, please fork the repo, make your changes, write your tests, and send me a pull request.    
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
 
-Everyone interacting in the Roro project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/roro/blob/master/CODE_OF_CONDUCT.md).
+ should get you pointed in the right direction. , you may need to prepend 'sudo' to the above command, or chown newly created files:
+
+```bash
+$ sudo chown <username><user group> -R .
+```
+
+If that doesn't work, Docker's [documentation](https://docs.docker.com/install/linux/linux-postinstall/#manage-docker-as-a-non-root-user) should get you pointed in the right direction.

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-dinky

data/lib/roro/cli/base.rb

@@ -14,12 +14,11 @@ module Roro
       end
 
       def own_if_required
-        # case
-        # when ENV['CIRCLECI']
-        #    return
-        # when OS.linux?
-          system 'sudo chown -R $USER .'
-        # end
+        system 'sudo chown -R $USER .'
+      end
+
+      def comment_out_ruby_in_gemfile 
+
       end
 
 
@@ -109,10 +108,6 @@ module Roro
 
       def copy_ruby_gem_files
         copy_file 'ruby_gem/config.yml', '.circleci/config.yml'
-        # copy_file 'greenfield/Gemfile.lock', 'Gemfile.lock'
-        # copy_file 'greenfield/docker-compose.yml', 'docker-compose.yml'
-        # copy_file 'greenfield/Dockerfile', 'Dockerfile'
-        # copy_file 'greenfield/config/database.yml.example', 'config/database.yml.example'
       end
     end
 

data/lib/roro/version.rb

@@ -1,3 +1,3 @@
 module Roro
-  VERSION = "0.2.2"
+  VERSION = "0.2.4"
 end

data/roro.gemspec

@@ -37,9 +37,9 @@ Gem::Specification.new do |spec|
   # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "thor"
-  spec.add_dependency "os"
-  spec.add_dependency "sshkit"
+  spec.add_dependency "thor", "0.20.3"
+  spec.add_dependency "os", "1.0.0"
+  spec.add_dependency "sshkit", "1.18.2"
   spec.add_dependency "handsome_fencer-crypto", "0.1.6"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: roro
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - schadenfred
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-15 00:00:00.000000000 Z
+date: 2019-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.20.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.20.3
 - !ruby/object:Gem::Dependency
   name: os
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: sshkit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.18.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.18.2
 - !ruby/object:Gem::Dependency
   name: handsome_fencer-crypto
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +131,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- _config.yml
 - bin/console
 - bin/roro
 - bin/setup
@@ -144,7 +145,6 @@ files:
 - lib/roro.rb
 - lib/roro/cli.rb
 - lib/roro/cli/base.rb
-- lib/roro/cli/dockerize.rb
 - lib/roro/cli/expose.rb
 - lib/roro/cli/generate_keys.rb
 - lib/roro/cli/greenfield.rb

data/lib/roro/cli/dockerize.rb

@@ -1,30 +0,0 @@
-# module Roro
-#
-#   class CLI < Thor
-#
-#     desc "dockerize", "Generates files necessary to dockerize your existing Rails project, along with a set of files for continuous deployment using CircleCI and deployment ussing sshkit."
-#
-#     def dockerize
-#       configurate
-#       copy_base_files
-#       append_to_existing_files
-#     end
-#
-#     desc "greenfield", "Generates files necessary to greenfield a new app within a dockerized rails container, along with a set of files necessary for continuous deployment using CircleCI"
-#     method_option :interactive, desc: "Set up your environment variables as you go."
-#     method_option :env_vars, type: :hash, default: {}, desc: "Pass a list of environment variables like so: env:var", banner: "key1:value1 key2:value2"
-#
-#     def greenfield(app=nil)
-#       configurate
-#       self.destination_root = self.destination_root + "/#{app}" unless app.nil?
-#       if app.nil? && !Dir.empty?('.')
-#         raise Roro::Error.new("Oops -- Roro can't greenfield unless the current directory is empty.")
-#       end
-#       copy_base_files
-#       copy_file "gitignore", ".gitignore"
-#       copy_file "Gemfile"
-#       copy_file "Gemfile.lock"
-#       append_to_existing_files
-#     end
-#   end
-# end