satorix-common 1.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b9ccf26bc69123cd3eb6ac5d31fcff948856ebc2f2f8dbd41dc8bb381f6d99f
+  data.tar.gz: de54faed6d36638dc44a0b89d9b9a08566c604210b42daab6cfaea046a4b131e
+SHA512:
+  metadata.gz: 4c5beb573b3b58aed5cee2755e1e6d5bfa2be2e2c0a5364358173f903d921cc5e86a7b969a27ad68bab1d4be309104a79cdbad773ef1ba165803f04403274102
+  data.tar.gz: 8384f64de67396d560f99ab6ee66995b6ff44cd56ae5b0d1d599f9b46cd9d505dc444e07c9002874372dbbaaae1a32a14a1ce37decc8747e75b0563ed4b97501

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Rubymine
+.idea

data/.gitlab-ci.yml

@@ -0,0 +1,26 @@
+image: 'satorix/base'
+
+cache:
+  key: "$CI_PROJECT_ID"
+  paths:
+    - 'tmp/satorix/cache' # To cache buildpack gems between runs.
+
+
+.satorix: &satorix
+  script:
+    - gem install satorix --source https://gems.iexposure.com --no-document
+    - satorix
+
+
+rspec:
+  <<: *satorix
+
+
+# This is a custom job, defined at satorix/CI/deploy/rubygems.rb
+deploy_to_rubygems:
+  stage: deploy
+  only:
+    - tags
+  except:
+    - schedules
+  <<: *satorix

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.5

data/Gemfile

@@ -0,0 +1,6 @@
+ruby File.open("#{ File.dirname(__FILE__) }/.ruby-version", &:gets).strip[/ruby-(.+)/i, 1]
+
+source 'https://gems.iexposure.com'
+
+# Specify your gem's dependencies in satorix-common.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    satorix-common (1.1.5)
+      rake
+
+GEM
+  remote: https://gems.iexposure.com/
+  specs:
+    rake (13.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  satorix-common!
+
+RUBY VERSION
+   ruby 2.6.5p114
+
+BUNDLED WITH
+   1.17.3

data/Procfile

@@ -0,0 +1 @@
+# This is an empty file, to silence an buildpack warning during testing.

data/README.md

@@ -0,0 +1,50 @@
+# Satorix::Common
+
+By [Internet Exposure](https://www.iexposure.com/)
+
+[![build](http://gitlab.iexposure.com/satorix/satorix-commmon/badges/master/build.svg)](http://gitlab.iexposure.com/satorix/satorix-commmon/pipelines)
+[![coverage](http://gitlab.iexposure.com/satorix/satorix-commmon/badges/master/coverage.svg)](http://gitlab.iexposure.com/satorix/satorix-commmon/pipelines)
+
+
+This gem contains code shared between two or more separate Satorix applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'satorix-common'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install satorix-common
+
+## Usage
+
+Include the gem in a relevant project to access shared logic.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## CI/CD
+
+Satorix is used to provide continuous integration and continuous deployment for this application.
+
+CI is run against every push. 
+
+CD is used to automatically build and deploy the gem for the master branch.
+To initiate the deploy, first ensure you have advanced the version number appropriately. Then, create a new version tag
+on the master branch. The tag should follow the format of v# (If we were releasing version 1.0.3, the tag should be v1.0.3).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/satorix-common.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "satorix/common"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/satorix/common/console.rb

@@ -0,0 +1,180 @@
+module Satorix
+  module Common
+    module Console
+
+      require 'benchmark'
+      require 'English' # http://ruby-doc.org/stdlib-2.0.0/libdoc/English/rdoc/English.html
+      require 'shellwords'
+
+      extend self
+
+
+      def colorize(text, color = nil)
+        "\033[#{ colors[color] }m#{ text }\033[0m"
+      end
+
+
+      def colors
+        Hash.new(39).merge(red: '0;31', light_red: '1;31',
+                           green: '0;32', light_green: '1;32',
+                           yellow: '0;33', light_yellow: '1;33',
+                           blue: '0;34', light_blue: '1;34',
+                           magenta: '0;35', light_magenta: '1;35',
+                           cyan: '0;36', light_cyan: '1;36',
+                           white: '0;37', light_white: '1;37')
+      end
+
+
+      def humanize_time(seconds)
+        return 'less than 1 second' if seconds < 1
+        [[60, :second], [60, :minute], [24, :hour], [1000, :day]].map do |count, name|
+          if seconds > 0
+            seconds, n = seconds.divmod(count)
+            n = n.to_i
+            "#{ n } #{ name }#{ 's' if n > 1 }" if n > 0
+          end
+        end.compact.reverse.join(' ')
+      end
+
+
+      def log(text, color = nil)
+        puts color ? colorize(text, color) : text
+      end
+
+
+      def log_command(text)
+        log text, :cyan
+      end
+
+
+      def log_duration(text)
+        log text, :light_cyan
+      end
+
+
+      def log_header(text)
+        log("\n#{ text }", :light_green)
+      end
+
+
+      def log_error(text)
+        log text, :light_red
+      end
+
+
+      def log_error_and_abort(text)
+        log_error text
+        abort text
+      end
+
+
+      def log_bench(message)
+        log_header message
+        result = nil
+        log_duration "Time elapsed: #{ humanize_time Benchmark.realtime { result = yield } }."
+        result
+      end
+
+
+      # The preferred way to use this method is by passing an array containing the command.
+      # This will ensure that items are properly escaped.
+      # It is also possible to use nested arrays. See tests for example use cases.
+      #
+      # If you want to see how your string command translates into an arry, you can use shellsplit method.
+      #
+      # For example:
+      # 'ruby -v'.shellsplit
+      #  => ["ruby", "-v"]
+      #
+      # If, for some reason, you need to supply a string that is already escaped or should not be escaped, it is
+      # possible to supply a string argument instead of an array. If you do this, you will need to supply
+      # an additional parameter of string_verified_safe, to ensure that the operation is deliberate.
+      def run_command(command, filtered_text: [], quiet: false, string_verified_safe: false)
+        # This method is used *EVERYWHERE*.
+        # Seemingly small changes can have far-ranging and extreme consequences.
+        # Modify only with extreme caution.
+        #
+        # Note: Many applications (like echo and the Flynn CLI) append a newline to their output.
+        #       If you are using the command result, it may be desirable to chomp the trailing
+        #       newline. It is left to the implementing call to handle this, as it proved
+        #       cumbersome to handle in this method in a way that worked perfectly in all cases.
+        raise('Potentially unsafe or problematic command. Please refer to the method documentation for more information.') if command.is_a?(String) && !string_verified_safe
+
+        command = normalized_command(command)
+        logged_command = logged_command(command, filtered_text)
+        log_command(logged_command) unless quiet
+
+        ''.tap do |output|
+          IO.popen(bash(command)) do |io|
+            until io.eof?
+              line = io.gets
+              puts line unless quiet || line.empty?
+              $stdout.flush
+              output.concat line
+            end
+          end
+
+          handle_run_command_error(logged_command, quiet) unless $CHILD_STATUS.success?
+        end
+      end
+
+
+      # http://stackoverflow.com/questions/1197224/source-shell-script-into-environment-within-a-ruby-script
+      # TODO : reduce / consolidate?
+      # Find variables changed as a result of sourcing the given file, and update in ENV.
+      def source_env_from(file)
+        bash_source(file).each { |k, v| ENV[k] = v }
+      end
+
+
+      private
+
+
+        def bash(command)
+          ['bash -c', escaped_command(command), '2>&1'].join(' ')
+        end
+
+
+        def logged_command(command, filtered_text)
+          filtered_text = [filtered_text].flatten.delete_if { |text| text.nil? || text.strip.empty? }
+          unescaped_command = command.shellsplit.join(' ')
+          unescaped_command.gsub(Regexp.union(filtered_text.sort_by(&:length).reverse), '[MASKED]')
+        end
+
+
+        def escaped_command(command)
+          command.shellescape
+        end
+
+
+        def normalized_command(command)
+          command.is_a?(Array) ? command.flatten.shelljoin : command
+        end
+
+
+        def handle_run_command_error(logged_command, quiet)
+          error_message = "\nAn error has occurred while running the following command:\n#{ logged_command }\n"
+          quiet ? abort : log_error_and_abort(error_message)
+        end
+
+
+      # http://stackoverflow.com/questions/1197224/source-shell-script-into-environment-within-a-ruby-script
+      # TODO : reduce / consolidate?
+      # Read in the bash environment, after an optional command. Returns Array of key/value pairs.
+        def bash_env(cmd = nil)
+          env_cmd = bash("#{ cmd + ';' if cmd } printenv")
+          env = `#{ env_cmd }`
+          env.split(/\n/).map { |l| l.split(/=/, 2) }
+        end
+
+
+      # http://stackoverflow.com/questions/1197224/source-shell-script-into-environment-within-a-ruby-script
+      # TODO : reduce / consolidate?
+      # Source a given file, and compare environment before and after. Returns Hash of any keys that have changed.
+        def bash_source(file)
+          Hash[bash_env("source #{ File.realpath file }") - bash_env]
+        end
+
+    end
+  end
+end

data/lib/satorix/common/pricing.rb

@@ -0,0 +1,149 @@
+module Satorix
+  module Common
+    module Pricing
+
+      class MissingApplicationConfigurationSettings < StandardError
+      end
+
+      class MissingPricingConfigurationElement < StandardError
+      end
+
+      class InvalidNegativeTotalPrice < StandardError
+      end
+
+
+      class << self
+
+
+        def package_defaults(package)
+          default_defaults.merge overrides_for(package)
+        end
+
+
+        def packages
+          overrides.keys
+        end
+
+
+        def pricing
+          # Different Rails versions use different types for keys.
+          pricing = ::Rails.application.secrets.satorix['pricing_in_cents'] ||
+            ::Rails.application.secrets.satorix[:pricing_in_cents]
+
+          raise(MissingApplicationConfigurationSettings, 'No pricing information configured.') if pricing.nil? || pricing.empty?
+
+          pricing = Hash[pricing.map { |key, value| [key.to_sym, value] }]
+
+          pricing
+        end
+
+
+        def pricing_for(attribute)
+          price = pricing[secrets_key_for_attribute(attribute)]
+
+          raise(MissingApplicationConfigurationSettings, "No pricing information configured for the '#{ attribute }' atttribute.") if price.nil?
+
+          price
+        end
+
+
+        def starting_price_for(package)
+          settings = package_defaults(package)
+          total_price settings
+        end
+
+
+        def secrets_key_for_attribute(attribute)
+          {
+            base_cost: :base_cost,
+            runners: :per_runner,
+            gitlab_storage: :per_gb_of_gitlab_storage,
+            staging_hosts: :per_staging_cluster_host,
+            staging_storage: :per_staging_gb_of_storage_per_host,
+            production_hosts: :per_production_cluster_host,
+            production_storage: :per_production_gb_of_storage_per_host,
+            premium_support: :support_package_premium,
+            free_support: :support_package_free
+          }[attribute]
+        end
+
+
+        def total_price(configuration)
+          raise(MissingPricingConfigurationElement) if configuration.keys.to_set != default_defaults.keys.to_set
+
+          cost = pricing[:base_cost]
+          configuration.each do |attribute, quantity|
+            price = pricing[secrets_key_for_attribute(attribute)]
+            cost += price * quantity * scaling_modifier(attribute, configuration)
+          end
+
+          raise(InvalidNegativeTotalPrice) if cost.negative?
+
+          cost
+        end
+
+
+        def scaling_modifier(attribute, configuration)
+          modifying_attribute = scaled_attributes[attribute]
+          modifying_attribute ? configuration[modifying_attribute] : 1
+        end
+
+
+        def scaled_attributes
+          # The key is the scaled attribute, the value is the attribute that modfies the scaled attribute.
+          { staging_storage: :staging_hosts,
+            production_storage: :production_hosts }
+        end
+
+
+        private
+
+
+        def overrides
+          { 'starter' => starter_defaults,
+            'cluster' => cluster_defaults,
+            'custom' => custom_defaults }
+        end
+
+
+        def overrides_for(package)
+          overrides[package] || starter_defaults # default to starter options, for invalid selections
+        end
+
+
+        def default_defaults
+          { runners: 1,
+            gitlab_storage: 100,
+            staging_hosts: 1,
+            staging_storage: 50,
+            production_hosts: 3,
+            production_storage: 100,
+            free_support: 1,
+            premium_support: 0 }
+        end
+
+
+        def starter_defaults
+          { production_hosts: 1 }
+        end
+
+
+        def cluster_defaults
+          { runners: 2,
+            free_support: 0,
+            premium_support: 1 }
+        end
+
+
+        def custom_defaults
+          { free_support: 0,
+            premium_support: 1 }
+        end
+
+
+      end
+
+
+    end
+  end
+end

data/lib/satorix/common/version.rb

@@ -0,0 +1,5 @@
+module Satorix
+  module Common
+    VERSION = '1.1.5'
+  end
+end

data/lib/satorix/common.rb

@@ -0,0 +1,13 @@
+require 'satorix/common/console'
+require 'satorix/common/pricing'
+require 'satorix/common/version'
+
+
+module Satorix
+  module Common
+    class Error < StandardError;
+    end
+
+
+  end
+end

data/satorix/CI/deploy/rubygems.rb

@@ -0,0 +1,77 @@
+module Satorix
+  module CI
+    module Deploy
+      module Rubygems
+
+        require 'fileutils'
+
+        include Satorix::Shared::Console
+
+        extend self
+
+
+        def go
+          log_bench('Generating rubygems.org configuration_file...') { generate_rubygems_configuration_file }
+          log_bench('Preparing gem build directory...') { prepare_gem_build_directory }
+          log_bench('Building gem...') { build_gem }
+          built_gems.each { |gem| log_bench("Publishing #{ File.basename gem }...") { publish_gem gem } }
+        end
+
+
+        private
+
+
+          def build_gem
+            Dir.chdir(Satorix.app_dir) do
+              run_command(%w[bundle exec rake build])
+            end
+          end
+
+
+          def built_gems
+            Dir.glob(File.join(gem_build_directory, '*.gem')).select { |e| File.file? e }
+          end
+
+
+          def gem_build_directory
+            File.join(Satorix.app_dir, 'pkg')
+          end
+
+
+          def generate_rubygems_configuration_file
+            path = File.join(Dir.home, '.gem')
+            FileUtils.mkdir_p(path) unless File.exist?(path)
+
+            file = File.join(path, 'credentials')
+            File.open(file, 'w') { |f| f.write rubygems_configuration_file_contents }
+            FileUtils.chmod 0600, file
+          end
+
+
+          def prepare_gem_build_directory
+            run_command(['rm', '-rf', gem_build_directory])
+            FileUtils.mkdir_p gem_build_directory
+          end
+
+
+          def publish_gem(gem)
+            run_command(['gem', 'push', gem, '--config-file', File.join(Dir.home, '.gem', 'credentials')])
+          rescue RuntimeError
+            # To prevent the display of an ugly stacktrace.
+            abort "\nGem was not published!"
+          end
+
+
+          def rubygems_api_key
+            ENV['SATORIX_CI_RUBYGEMS_API_KEY']
+          end
+
+
+          def rubygems_configuration_file_contents
+            "---\n:rubygems_api_key: #{ rubygems_api_key }"
+          end
+
+      end
+    end
+  end
+end

data/satorix/custom.rb

@@ -0,0 +1,21 @@
+module Satorix
+  module Custom
+
+
+    require_relative 'CI/deploy/rubygems.rb'
+
+
+    extend self
+
+
+    def available_jobs
+      {
+        deploy: {
+          deploy_to_rubygems: Satorix::CI::Deploy::Rubygems
+        }
+      }
+    end
+
+
+  end
+end

data/satorix-common.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "satorix/common/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "satorix-common"
+  spec.version = Satorix::Common::VERSION
+  spec.authors = ['Internet Exposure']
+  spec.email = ['info@iexposure.com']
+
+  spec.summary = %q{Common library for Satorix}
+  spec.description = %q{This gem contains code shared between two or more separate Satorix applications.}
+  spec.homepage = "http://gitlab.iexposure.com/satorix/satorix-common"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rake'
+
+end
+

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: satorix-common
+version: !ruby/object:Gem::Version
+  version: 1.1.5
+platform: ruby
+authors:
+- Internet Exposure
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: This gem contains code shared between two or more separate Satorix applications.
+email:
+- info@iexposure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- Procfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/satorix/common.rb
+- lib/satorix/common/console.rb
+- lib/satorix/common/pricing.rb
+- lib/satorix/common/version.rb
+- satorix-common.gemspec
+- satorix/CI/deploy/rubygems.rb
+- satorix/custom.rb
+homepage: http://gitlab.iexposure.com/satorix/satorix-common
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: http://gitlab.iexposure.com/satorix/satorix-common
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Common library for Satorix
+test_files: []