figobox 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 2c8f9ca65e07cda8bdd1d4cc614da8b6a6c6e218
4
+ data.tar.gz: b6019373f8d869a89b39f1fdc19812722f891305
5
+ SHA512:
6
+ metadata.gz: 61235d0ef8bd8c62f24e4d7aff154d65155800154009713240bfb85d2eec74aa0434aeae4cace8ee7ab4489cfb0d9ccda64d06e2f3e47b286eadf8d06e1cd577
7
+ data.tar.gz: a6cfe21763fc057777f5a7075ce19669433e6aa23da8753c39dd84248cd4417eb7a0fdcc3237ae5044468fc5bd0fc26522c2ff637fe2b8f59eb614fb8184626f
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.3
5
+ before_install: gem install bundler -v 1.15.4
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at brandoncc@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in figobox.gemspec
6
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Brandon Conway
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,77 @@
1
+ # Figobox
2
+
3
+ [Figaro](https://github.com/laserlemon/figaro) is an incredibly useful and popular tool in the Rails community. [Nanobox](https://nanobox.io/) is an up and coming app deployment platform that deploys dockerized app components to one or more VPS' on the provider of your choice. These are both great tools, so why shouldn't they work together?
4
+
5
+ This tool brings the convenience of the `figaro heroku:set` command to nanobox.
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'figobox'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install figobox
22
+
23
+ ## Usage
24
+
25
+ There is one method, which is `set`. You must provide either this method or the shorthand switch for it ("-s").
26
+
27
+ The `set` method accepts the following switches:
28
+
29
+ | Switch | Description |
30
+ |--------|-------------|
31
+ | <nobr>-d, --dry-run</nobr> | (optional) Do a dry run. This will display the nanobox `evar` command, but will not execute it. You should always make sure the correct values will be set before doing so in production! |
32
+ | <nobr>-e, --figaro-environment</nobr> | Specify the environment to use as the source from the application.yml file. |
33
+ | <nobr>-n, --nanobox-alias</nobr> | (optional) Specify the nanobox alias where the environment variables should be set. This can be "local", "dry-run", or a remote alias. |
34
+
35
+ ### Switch details:
36
+
37
+ #### --figaro-environment
38
+
39
+ This switch is required. The value should be the environment name from your application.yml file. Global values (top level values) in your application.yml file will be included, just as they are in Figaro.
40
+
41
+ #### --nanobox-alias
42
+
43
+ This switch is optional. The gem will use intelligent defaults to guess what the value should be, and will exit with an error message if it is unable to guess a value.
44
+
45
+ Here is a chart showing what values will be assumed if it is not provided:
46
+
47
+ | Figaro environment | Assumed value |
48
+ |--------------------|---------------|
49
+ | development | local |
50
+ | staging | dry-run |
51
+ | production | \<blank\> |
52
+
53
+ By leaving the production value blank, the app's remote will be used. If the app has more than one remote added, make sure you provide the one you want to set the values on.
54
+
55
+ ### Example usage
56
+
57
+ To set your development variables, simply execute:
58
+
59
+ ```
60
+ figobox set -e development
61
+ ```
62
+
63
+ ### Help
64
+
65
+ You can get more help by executing `figobox help` and `figobox help set`.
66
+
67
+ ## Contributing
68
+
69
+ Bug reports and pull requests are welcome on GitHub at https://github.com/brandoncc/figobox. 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.
70
+
71
+ ## License
72
+
73
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
74
+
75
+ ## Code of Conduct
76
+
77
+ Everyone interacting in the Figobox project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/brandoncc/figobox/blob/master/CODE_OF_CONDUCT.md).
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "figobox"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env ruby -U
2
+
3
+ require 'figobox'
@@ -0,0 +1,29 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "figobox/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "figobox"
8
+ spec.version = Figobox::VERSION
9
+ spec.authors = ["Brandon Conway"]
10
+ spec.email = ["brandoncc@gmail.com"]
11
+
12
+ spec.summary = "A tool which makes using figaro and nanobox for the same application easy"
13
+ spec.description = "For applications which already use figaro, this tool makes it easy to continue doing so when deploying the application using nanobox."
14
+ spec.homepage = "https://github.com/brandoncc/figobox"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_dependency "thor"
25
+ spec.add_development_dependency "pry"
26
+ spec.add_development_dependency "bundler", "~> 1.15"
27
+ spec.add_development_dependency "rake", "~> 10.0"
28
+ spec.add_development_dependency "rspec", "~> 3.0"
29
+ end
@@ -0,0 +1,6 @@
1
+ require "figobox/cli"
2
+ require "figobox/command_compiler"
3
+ require "figobox/config_parser"
4
+ require "figobox/version"
5
+
6
+ Figobox::Cli.start(ARGV)
@@ -0,0 +1,65 @@
1
+ require 'thor'
2
+
3
+ module Figobox
4
+ class Cli < Thor
5
+ package_name "figobox"
6
+ map "-s" => :set
7
+
8
+ desc "set -e development", "Apply environment variables for a figaro environment to a nanobox alias"
9
+ method_option :figaro_environment, aliases: "-e", banner: "development", desc: "Specify figaro environment to use as a source"
10
+ method_option :nanobox_alias, aliases: "-n", banner: "local", desc: "Specify nanobox alias to use as a target"
11
+ method_option :dry_run, aliases: "-d", type: :boolean, desc: "Display the command rather than executing it"
12
+ def set
13
+ with_environments do |figaro_environment, nanobox_alias|
14
+ parser = Figobox::ConfigParser.new
15
+ variables = parser.get_keys_for_environment(figaro_environment)
16
+ compiler = Figobox::CommandCompiler.new(nanobox_alias, variables)
17
+
18
+ if options.dry_run?
19
+ puts <<~OUTPUT
20
+ Command to be executed:
21
+ #{compiler.add}
22
+ OUTPUT
23
+ else
24
+ command = compiler.add
25
+ puts "Executing command:\n #{command}"
26
+ system command
27
+ end
28
+ end
29
+ end
30
+
31
+ private
32
+
33
+ def with_environments
34
+ figaro_environment = options.figaro_environment
35
+ figaro_environment = nil if figaro_environment == "figaro_environment"
36
+
37
+ unless figaro_environment
38
+ abort "You must specify a figaro environment to use as a source"
39
+ return
40
+ end
41
+
42
+ nanobox_alias = options.nanobox_alias
43
+ nanobox_alias = nil if nanobox_alias == "nanobox_alias"
44
+ nanobox_alias ||= default_nanobox_environment(figaro_environment)
45
+
46
+ unless nanobox_alias
47
+ abort "Unable to automatically determine the nanobox alias to use as a target. Please use the -n option to specify one."
48
+ return
49
+ end
50
+
51
+ yield(figaro_environment, nanobox_alias)
52
+ end
53
+
54
+ def default_nanobox_environment(figaro_environment)
55
+ case figaro_environment.to_s.downcase
56
+ when "development"
57
+ "local"
58
+ when "staging"
59
+ "dry-run"
60
+ when "production"
61
+ ""
62
+ end
63
+ end
64
+ end
65
+ end
@@ -0,0 +1,23 @@
1
+ module Figobox
2
+ class CommandCompiler
3
+ def initialize(target_alias, variables)
4
+ @alias = target_alias
5
+ @variables = variables || {}
6
+ end
7
+
8
+ def add
9
+ add_command || ""
10
+ end
11
+
12
+ private
13
+
14
+ def add_command
15
+ return unless @variables.any?
16
+
17
+ command = "nanobox evar add #{@alias}"
18
+ @variables.each { |k, v| command << " #{k}=#{v}" }
19
+
20
+ command
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,43 @@
1
+ require 'yaml'
2
+
3
+ module Figobox
4
+ class ConfigParser
5
+ def initialize
6
+ verify_config_exists
7
+ @yaml = YAML.load(File.read("config/application.yml"))
8
+ end
9
+
10
+ def get_keys_for_environment(environment)
11
+ verify_environment_exists(environment)
12
+
13
+ global_values = get_global_key_value_sets
14
+ env_values = get_environment_key_value_sets(environment)
15
+
16
+ global_values.merge(env_values)
17
+ end
18
+
19
+ private
20
+
21
+ attr_reader :yaml
22
+
23
+ def verify_config_exists
24
+ return if File.exists?("config/application.yml")
25
+ abort "No config file could be found at config/application.yml. Please see https://github.com/laserlemon/figaro for more details."
26
+ end
27
+
28
+ def verify_environment_exists(environment)
29
+ return unless get_environment_key_value_sets(environment) == {}
30
+ abort "'#{environment}' environment doesn't exist in the configuration file."
31
+ end
32
+
33
+ def get_global_key_value_sets
34
+ yaml.reject { |_, value| value.is_a?(Hash) }
35
+ end
36
+
37
+ def get_environment_key_value_sets(environment)
38
+ found = yaml.find { |key, _| key.casecmp(environment).zero? }
39
+ return found[1] if found
40
+ {}
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,3 @@
1
+ module Figobox
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,134 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: figobox
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Brandon Conway
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-11-15 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: thor
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: pry
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.15'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.15'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '3.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '3.0'
83
+ description: For applications which already use figaro, this tool makes it easy to
84
+ continue doing so when deploying the application using nanobox.
85
+ email:
86
+ - brandoncc@gmail.com
87
+ executables:
88
+ - figobox
89
+ extensions: []
90
+ extra_rdoc_files: []
91
+ files:
92
+ - ".gitignore"
93
+ - ".rspec"
94
+ - ".travis.yml"
95
+ - CODE_OF_CONDUCT.md
96
+ - Gemfile
97
+ - LICENSE.txt
98
+ - README.md
99
+ - Rakefile
100
+ - bin/console
101
+ - bin/setup
102
+ - exe/figobox
103
+ - figobox.gemspec
104
+ - lib/figobox.rb
105
+ - lib/figobox/cli.rb
106
+ - lib/figobox/command_compiler.rb
107
+ - lib/figobox/config_parser.rb
108
+ - lib/figobox/version.rb
109
+ homepage: https://github.com/brandoncc/figobox
110
+ licenses:
111
+ - MIT
112
+ metadata: {}
113
+ post_install_message:
114
+ rdoc_options: []
115
+ require_paths:
116
+ - lib
117
+ required_ruby_version: !ruby/object:Gem::Requirement
118
+ requirements:
119
+ - - ">="
120
+ - !ruby/object:Gem::Version
121
+ version: '0'
122
+ required_rubygems_version: !ruby/object:Gem::Requirement
123
+ requirements:
124
+ - - ">="
125
+ - !ruby/object:Gem::Version
126
+ version: '0'
127
+ requirements: []
128
+ rubyforge_project:
129
+ rubygems_version: 2.5.2.1
130
+ signing_key:
131
+ specification_version: 4
132
+ summary: A tool which makes using figaro and nanobox for the same application easy
133
+ test_files: []
134
+ has_rdoc: