aldagai 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e917d3ec68a53ba215f1080b22ffaa0c9ee4662f2c99b5c13428d26bc4777481
-  data.tar.gz: ed3a1f9d97801ba3ba9f4b138e8603b30132e3e0a198578b317029b5a7e12a47
+  metadata.gz: fb870504be79756afb9a198fb22d7a3f70159c6b7c748a94f159c534689e0b1e
+  data.tar.gz: 8e834230479e131361e3f502c667d4c00f203d4b438df9a9731a326d71500bbf
 SHA512:
-  metadata.gz: 88e09d7e8b09b0924d6ff7e41c1caf504374dd6018e243dde033e78432768dc4b37cec86c5217faa9b6985df7675db5a17a6a8d8f6363fbebd0ef0cece461faf
-  data.tar.gz: 59b56c09cd0f72a091aa9ebec38c00a50c4ffb686b9795a559d8f2006fd05ec268be5b13a341c4e97f3eb0218d0f575a32f7ddc9e68f2fd3bdb4ecc6fb0a047c
+  metadata.gz: 536b96db6c9b648697cf3a1854600fd452f3bcad36b712525f3e0bb1074158f57e65db6fbf180da7a16d00740683f33fc8d588dfea873d92db4cfc4894961a32
+  data.tar.gz: bea9d7b28248de1e0c4d31c9775c398cb5e6ffed4a302121728e2fec92e02060c90bd798afc2dc9f2d5f402eb506b98c83a25363c75b88ef84c0e685d6afeb44

data/.rspec

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

data/README.md

@@ -1,35 +1,93 @@
-# Aldagai
+The aim of this gem is to help developers promoting heroku variables during the deployment process.
 
-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/aldagai`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Getting Started
 
-TODO: Delete this and the text above, and describe your gem
+* Add aldagai to you Gemfile
 
-## Installation
+    ```
+    source 'https://rubygems.org'
 
-Add this line to your application's Gemfile:
+    # More gems
 
-```ruby
-gem 'aldagai'
-```
+    gem 'aldagai', '0.1.1'
+    ```
 
-And then execute:
+* Run the following command to install aldagai in your application
 
-    $ bundle
+    $ bundle exec aldagai install
 
-Or install it yourself as:
+    This command will create the file `.aldagai.secret` with the secret used to encrypt your
+    variables, and one file for each of the environments. This command will also add the
+    `.aldagai.secret` to your `.gitignore` file.
 
-    $ gem install aldagai
+* Add a new environment variable to each of your applications on the pipeline (by default we assume
+  that you have 3 different environments development, staging, and production) with the name
+  `ALDAGAI_SECRET` containing the same string that you have on the file `.aldagai.secret`
 
-## Usage
+    $ heroku config:set ALDAGAI_SECRET="MySuperSecretPasswordUsingForEncryptTheMessage" -a yourapp
 
-TODO: Write usage instructions here
+* Generate a new api token to intereact with heroku api
 
-## Development
+    $ heroku plugins:install heroku-cli-oauth
+    $ heroku authorizations:create -d "YouApp"
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+* Add a new environment variables to intereact with heroku api. One of those variables should be
+  named `ALDAGAI_HEROKU_TOKEN` with the value that was generated by the previous command, and the
+  other one should be named `ALDAGAI_APP_NAME` with the name of the application in heroku, and
+  then another one named `ALDAGAI_PIPELINE_ENV` indicating the envrionment of the PIPELINE for
+  example `development`.
 
-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).
+### Aldagai Generators
 
-## Contributing
+#### install
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/aldagai.
+    $ bundle exec aldagai install
+
+Install aldagai on your application
+
+### Aldagai Commands
+
+A list of all commands available through aldagai with their different options
+
+#### add
+
+*Normal Mode*
+
+    $ bundle exec aldagai add VARIABLE_NAME --values 1 2 3
+
+Values are the variables that are going to be promoted to the different environments (by default we
+use 3 environments development, staging, and production)
+
+*Interactive Mode*
+
+    $ export EDITOR=vim
+    $ bundle exec aldagai add VARIABLE_NAME -i
+
+Variables values are obtained from what you type on your prefered editor, values are separated by a
+blank line.
+
+#### show
+
+    $ bundle exec aldagai show VARIABLE_NAME
+
+Show the VARIABLE_NAME if that variable is going to be deployed (either if is going to be removed or
+modified, this is checked locally)
+
+#### list
+
+    $ bundle exec aldagai list
+
+Show all variables that are going to be deployed (either if is going to be removed or modified, this
+is checked locally)
+
+#### delete
+
+    $ bundle exec aldagai delete
+
+Enqueue a variable to be deleted.
+
+#### clear
+
+Clear all file, creating a new start point for the next deploy.
+
+Note: Variables that are already and are identicall to what heroku has are not being promoted.

data/aldagai.gemspec

@@ -1,25 +1,29 @@
 # coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "aldagai/version"
+require 'aldagai/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "aldagai"
+  spec.name          = 'aldagai'
   spec.version       = Aldagai::VERSION
-  spec.authors       = ["Pablo Ifran"]
-  spec.email         = ["pabloifran@gmail.com"]
+  spec.authors       = ['Pablo Ifran']
+  spec.email         = ['pabloifran@gmail.com']
 
-  spec.summary       = "Promote environment variables on heroku"
+  spec.summary       = 'Promote environment variables on heroku'
   spec.description   = 'Make zero downtime deployments easier allowing developers to promote environment variables'
   spec.homepage      = 'https://github.com/elpic/aldagai'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency 'platform-api', '~> 2.1.0'
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
 end

data/exe/aldagai

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'aldagai'
+require 'aldagai/cli'
+
+Aldagai::CLI.start

data/lib/aldagai.rb

@@ -1,5 +1,6 @@
-require "aldagai/version"
-
-module Aldagai
-  # Your code goes here...
-end
+require 'openssl'
+require 'digest'
+require 'aldagai/version'
+require 'aldagai/version'
+require 'aldagai/config'
+require 'aldagai/encryptor'

data/lib/aldagai/cli.rb

@@ -0,0 +1,65 @@
+require 'thor'
+require 'aldagai/colors'
+require 'aldagai/variable_manager_facade'
+require 'aldagai/generators/install'
+require 'aldagai/exceptions/base_exception'
+require 'aldagai/exceptions/not_enoght_variables_exception'
+
+module Aldagai
+  class CLI < Thor
+    using Aldagai::Colors
+
+    desc 'install', 'Install aldagai in your application'
+    def install
+      Aldagai::Generators::Install.start
+    end
+
+    desc 'add NAME', 'Add a variable with NAME to be promoted to all environments'
+    method_option :values, type: :array, required: false, default: []
+    method_option :interactive, type: :boolean, default: false, aliases: '-i'
+    def add(name)
+      @manager = Aldagai::VariableManagerFacade.build_for(options[:interactive])
+
+      @manager.add(name, options[:values])
+    rescue Aldagai::BaseException => exception
+      puts exception.to_s.red
+      exit(1)
+    end
+
+    desc 'clear', 'Clear all the variables that were deployed usefull after a deploy'
+    def clear
+      @manager = Aldagai::NormalVariableManager.new
+
+      @manager.clear
+    end
+
+    desc 'delete NAME', 'Delete the variable with NAME, this will be promoted to all environments'
+    def delete(name)
+      @manager = Aldagai::NormalVariableManager.new
+
+      @manager.delete(name)
+    end
+
+    desc 'show NAME', 'Show the variable NAME that is going to be promoted to all environments'
+    def show(name)
+      @manager = Aldagai::NormalVariableManager.new
+
+      @manager.show(name)
+    end
+
+    desc 'list', 'Show all variables that are going to be promoted'
+    def list
+      @manager = Aldagai::NormalVariableManager.new
+
+      @manager.list
+    end
+
+    desc 'set', 'set'
+    def set
+      @manager = Aldagai::NormalVariableManager.new
+
+      @manager.set
+    end
+
+  end
+end

data/lib/aldagai/colors.rb

@@ -0,0 +1,37 @@
+module Aldagai
+  module Colors
+
+    refine String do
+
+      def red
+        colorize(31)
+      end
+
+      def green
+        colorize(32)
+      end
+
+      def yellow
+        colorize(33)
+      end
+
+      def blue
+        colorize(34)
+      end
+
+      def pink
+        colorize(35)
+      end
+
+      def light_blue
+        colorize(36)
+      end
+
+      def colorize(color_code)
+        "\e[#{color_code}m#{self}\e[0m"
+      end
+
+    end
+
+  end
+end

data/lib/aldagai/config.rb

@@ -0,0 +1,21 @@
+module Aldagai
+  class Config
+
+    def secret
+      ENV['ALDAGAI_SECRET'] || read_secret_from_file
+    end
+
+    private
+
+    def read_secret_from_file
+      path = File.expand_path('./.aldagai.secret')
+
+      if File.exists?(path)
+        File.read(path)
+      else
+        nil
+      end
+    end
+
+  end
+end

data/lib/aldagai/encryptor.rb

@@ -0,0 +1,25 @@
+module Aldagai
+  class Encryptor
+
+    def initialize(secret)
+      @secret = secret
+    end
+
+    def encrypt(plain)
+      cipher = OpenSSL::Cipher::AES256.new(:CBC).encrypt
+      cipher.key = Digest::SHA256.digest(@secret)
+
+      (cipher.update(plain) + cipher.final).unpack('H*')[0].upcase
+    end
+
+    def decrypt(encrypted)
+      cipher = OpenSSL::Cipher::AES256.new(:CBC).decrypt
+      cipher.key = Digest::SHA256.digest(@secret)
+
+      string = [encrypted].pack('H*').unpack('C*').pack('c*')
+
+      cipher.update(string) + cipher.final
+    end
+
+  end
+end

data/lib/aldagai/exceptions/base_exception.rb

@@ -0,0 +1,4 @@
+module Aldagai
+  class BaseException < StandardError
+  end
+end

data/lib/aldagai/exceptions/editor_not_present_exception.rb

@@ -0,0 +1,17 @@
+require_relative './base_exception'
+
+module Aldagai
+  class EditorNotPresentException < Aldagai::BaseException
+
+    def to_s
+      message = <<-MESSAGE
+        In order to access interactive mode you neet to set an environment variable with the editor
+        you want to use. For example you can run the following command on a terminal
+        export EDITOR=vim. This will use vim to enter your variables.
+      MESSAGE
+
+      message.gsub(/\s+/, ' ').strip
+    end
+
+  end
+end

data/lib/aldagai/exceptions/not_enoght_variables_exception.rb

@@ -0,0 +1,20 @@
+require_relative './base_exception'
+
+module Aldagai
+  class NotEnoghtVariablesException < Aldagai::BaseException
+
+    def initialize(required_variables)
+      @required_variables = required_variables
+    end
+
+    def to_s
+      message = <<-MESSAGE
+        Not enoght variables, #{@required_variables} are required. You can set them
+        using --values (-v) for normal mode or your preferred editor using interactive mode (-i)
+      MESSAGE
+
+      message.gsub(/\s+/, ' ').strip
+    end
+
+  end
+end

data/lib/aldagai/generators/install.rb

@@ -0,0 +1,47 @@
+require 'thor/group'
+require 'securerandom'
+
+module Aldagai
+  module Generators
+    class Install < Thor::Group
+
+      include Thor::Actions
+
+      def self.source_root
+        File.dirname(__FILE__) + '/install'
+      end
+
+      def copy_secret
+        template('.aldagai.secret', '.aldagai.secret')
+      end
+
+      def copy_environments
+        template('.development', '.development')
+        template('.staging',     '.staging')
+        template('.production',  '.production')
+      end
+
+      def ignore_secret
+        create_file '.gitignore', '', skip: true
+        append_to_file '.gitignore', '.aldagai.secret'
+      end
+
+      def say_next_instructions
+        say ''
+        say 'What is next:', :blue
+        say ''
+        say '* Run `$ heroku plugins:install heroku-cli-oauth`', :blue
+        say '* Run `$ heroku authorizations:create -d "YouApp"` and copy the Token', :blue
+        say '* Set ALDAGAI_HEROKU_TOKEN on heroku with the Token that was just generated', :blue
+        say '* Set ALDAGAI_APP_NAME on heroku with the name of the application', :blue
+        say '* Set ALDAGAI_PIPELINE_ENV on heroku with the name of the environment on the pipeline', :blue
+        say '* Add `bundle exec aldagai set` to release part on the Procfile', :blue
+        say ''
+        say 'For more information about release phase go to ' +
+          'https://devcenter.heroku.com/articles/release-phase', :green
+        say ''
+      end
+
+    end
+  end
+end

data/lib/aldagai/generators/install/.aldagai.secret

@@ -0,0 +1 @@
+<%= SecureRandom.hex %>

data/lib/aldagai/variable_manager_facade.rb

@@ -0,0 +1,17 @@
+require 'aldagai/variable_managers/base'
+require 'aldagai/variable_managers/interactive'
+require 'aldagai/variable_managers/normal'
+
+module Aldagai
+  class VariableManagerFacade
+
+    def self.build_for(interactive)
+      if interactive
+        Aldagai::InteractiveVariableManager.new
+      else
+        Aldagai::NormalVariableManager.new
+      end
+    end
+
+  end
+end

data/lib/aldagai/variable_managers/base.rb

@@ -0,0 +1,199 @@
+require 'platform-api'
+require 'aldagai/colors'
+
+module Aldagai
+  class VariableManager
+    using Aldagai::Colors
+
+    DEFAULT_ENVIRONMENTS = [
+      'development',
+      'staging',
+      'production',
+    ]
+
+    def initialize
+      @config    = Aldagai::Config.new
+      @encryptor = Aldagai::Encryptor.new(@config.secret)
+    end
+
+    def add(name, variables)
+      if environments.length == variables.length
+        environments.zip(variables).each do |environment, value|
+          lines = lines_for_environment_without(environment, name)
+
+          rewrite_file_with_lines(environment, lines) do |file|
+            file.puts @encryptor.encrypt("#{name.upcase}=#{value}")
+          end
+        end
+      else
+        raise Aldagai::NotEnoghtVariablesException.new(environments.length)
+      end
+    end
+
+    def delete(name)
+      environments.each do |environment|
+        lines = lines_for_environment_without(environment, name)
+
+        rewrite_file_with_lines(environment, lines) do |file|
+          file.puts @encryptor.encrypt("#{name.upcase}=")
+        end
+      end
+    end
+
+    def show(name)
+      puts "\n  ==== Variable actions ====\n".blue
+
+      environments.each do |environment|
+        line = line_for_environment_with(environment, name)
+
+        if line
+          name, value = line.split('=')
+          value = value_presence(value)
+
+          log_variable_will_be_added_or_removed(name, value, environment)
+        else
+          log_no_variables_promoted(environment)
+        end
+      end
+
+      log_empty_line
+    end
+
+    def list
+      puts "\n  ==== Variable actions ====\n".blue
+
+      environments.each do |environment|
+        lines = lines_for_environment(environment)
+
+        if lines.empty?
+          log_no_variables_promoted(environment)
+        else
+          lines.each do |line|
+            name, value = line.split('=')
+            value = value_presence(value)
+
+            log_variable_will_be_added_or_removed(name, value, environment)
+          end
+
+          log_empty_line
+        end
+      end
+
+      log_empty_line
+    end
+
+    def clear
+      environments.each do |environment|
+        rewrite_file_with_lines(environment, [])
+      end
+    end
+
+    def set
+      heroku = PlatformAPI.connect_oauth(ENV['ALDAGAI_HEROKU_TOKEN'])
+      lines  = lines_for_environment(ENV['ALDAGAI_PIPELINE_ENV'])
+
+      if lines.empty?
+        log_no_variables_promoted(environment)
+      else
+        variables = {}
+
+        lines.each do |line|
+          name, value = line.split('=')
+          value = value_presence(value)
+
+          log_variable_was_added_or_removed(name, value)
+
+          variables.merge!({name => value})
+        end
+
+        heroku.config_var.update(ENV['ALDAGAI_APP_NAME'], variables)
+      end
+    end
+
+    private
+
+    def environments
+      DEFAULT_ENVIRONMENTS
+    end
+
+    def rewrite_file_with_lines(environment, lines, &block)
+      open(environment_file(environment), 'w') do |file|
+        file.truncate(0)
+
+        lines.each do |line|
+          file.puts line
+        end
+
+        block.call(file) if block_given?
+      end
+    end
+
+    def log_empty_line
+      puts ''
+    end
+
+    def log_variable_will_be_added_or_removed(name, value, environment)
+      if value
+        puts "  ➥ add variable \"#{name}\" with value \"#{value}\" in #{environment}".green
+      else
+        puts "  ➥ remove variable \"#{name}\" from #{environment}".red
+      end
+    end
+
+    def log_variable_was_added_or_removed(name, value)
+      if value
+        puts "  ➥ variable \"#{name}\" was added".green
+      else
+        puts "  ➥ variable \"#{name}\" was removed".red
+      end
+    end
+
+    def log_no_variables_promoted(environment)
+      puts "  ✘ no variable/s are not going to be promoted to #{environment}".red
+    end
+
+    def lines_for_environment(environment)
+      file  = environment_file(environment)
+      lines = File.exists?(file) && File.readlines(file) || []
+
+      lines.map(&decrypt_line_proc)
+    end
+
+    def lines_for_environment_without(environment, name)
+      lines_for_environment(environment).select(&does_not_match_line_proc(name))
+    end
+
+    def lines_for_environment_with(environment, name)
+      lines_for_environment(environment).select(&match_line_proc(name))
+    end
+
+    def line_for_environment_with(environment, name)
+      lines_for_environment(environment).find(&match_line_proc(name))
+    end
+
+    def decrypt_line_proc
+      proc { |line| (decrypt_line(line)) }
+    end
+
+    def match_line_proc(name)
+      proc { |line| (line.start_with?("#{name.upcase}=")) }
+    end
+
+    def does_not_match_line_proc(name)
+      proc { |line| !(line.start_with?("#{name.upcase}=")) }
+    end
+
+    def environment_file(environment)
+      File.expand_path("./.#{environment}")
+    end
+
+    def decrypt_line(line)
+      @encryptor.decrypt(line.gsub("\n", ''))
+    end
+
+    def value_presence(value)
+      value && value.strip != '' ? value : nil
+    end
+
+  end
+end

data/lib/aldagai/variable_managers/interactive.rb

@@ -0,0 +1,38 @@
+require 'tempfile'
+
+module Aldagai
+  class InteractiveVariableManager < VariableManager
+
+    def add(name, _variables)
+      if ENV['EDITOR'].nil?
+        raise Aldagai::EditorNotPresentException.new
+      end
+
+      super(name, process_variables)
+    end
+
+    private
+
+    def process_variables
+      @read_variables ||= read_variables
+    end
+
+    def read_variables
+      file = nil
+
+      begin
+        file = Tempfile.new('variables')
+
+        system("#{ENV['EDITOR']} #{file.path}")
+
+        (file.read || '').split("\n")
+      ensure
+        if file
+          file.close
+          file.unlink
+        end
+      end
+    end
+
+  end
+end

data/lib/aldagai/variable_managers/normal.rb

@@ -0,0 +1,5 @@
+module Aldagai
+  class NormalVariableManager < VariableManager
+
+  end
+end

data/lib/aldagai/version.rb

@@ -1,3 +1,3 @@
 module Aldagai
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: aldagai
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Pablo Ifran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-28 00:00:00.000000000 Z
+date: 2018-05-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: platform-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,22 +66,55 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: Make zero downtime deployments easier allowing developers to promote
   environment variables
 email:
 - pabloifran@gmail.com
-executables: []
+executables:
+- aldagai
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - README.md
 - Rakefile
 - aldagai.gemspec
 - bin/console
 - bin/setup
+- exe/aldagai
 - lib/aldagai.rb
+- lib/aldagai/cli.rb
+- lib/aldagai/colors.rb
+- lib/aldagai/config.rb
+- lib/aldagai/encryptor.rb
+- lib/aldagai/exceptions/base_exception.rb
+- lib/aldagai/exceptions/editor_not_present_exception.rb
+- lib/aldagai/exceptions/not_enoght_variables_exception.rb
+- lib/aldagai/generators/install.rb
+- lib/aldagai/generators/install/.aldagai.secret
+- lib/aldagai/generators/install/.development
+- lib/aldagai/generators/install/.production
+- lib/aldagai/generators/install/.staging
+- lib/aldagai/variable_manager_facade.rb
+- lib/aldagai/variable_managers/base.rb
+- lib/aldagai/variable_managers/interactive.rb
+- lib/aldagai/variable_managers/normal.rb
 - lib/aldagai/version.rb
 homepage: https://github.com/elpic/aldagai
 licenses: []