conflux 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c5540b770d89a463b4daae814ded06fad60bb36
+  data.tar.gz: 1d33b3c82346b50c158c4fd8786db7ebdd52a1b5
+SHA512:
+  metadata.gz: 309f765210426259abd625aba293e4e268e89a59cdb43f58601f9fd1c8a38e575a2b7356ea029c7a5a907295b9b8668a4a8d9bd7082e6c9c6de1a929375255dc
+  data.tar.gz: 0e23eb9ef81a73b8721850099ed57ad889f68eb06db4e0a20a668c975b2a5f00da4d5e8a0bcf485f2207ed07b1034a40d8b78512c5d7b5ab91364ea6a9041ea9

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+/configs.yml
+/release.rb

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 GoConflux
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ben Whittle
+
+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,22 @@
+# Conflux Ruby gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'conflux'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself with:
+
+    $ gem install conflux
+
+## License
+
+[MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "conflux"
+
+# 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

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/conflux.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'conflux/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "conflux"
+  spec.version       = Conflux::VERSION
+  spec.authors       = ["Ben Whittle"]
+  spec.email         = ["benwhittle31@gmail.com"]
+  spec.summary       = "Gem to fetch and make available Conflux configs on Rails boot."
+  spec.homepage      = "https://www.github.com/GoConflux/conflux-rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client"
+
+  spec.add_development_dependency "rails", "~> 4.0"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/conflux.rb

@@ -0,0 +1,130 @@
+require 'conflux/version'
+require 'rest-client'
+require 'json'
+
+module Conflux
+  require 'conflux/railtie' if defined?(Rails)
+  extend self
+
+  config_vars_path = File.join(Dir.pwd, 'configs.yml')
+
+  if File.exists?(config_vars_path)
+    require 'yaml'
+    configs = YAML::load_file(config_vars_path) rescue {}
+    configs.each { |key, val|
+      ENV[key] = val if !ENV.key?(key)
+    }
+  end
+
+  APPLICATION_YAML_PATH = File.join(Dir.pwd, 'config', 'application.yml')
+  MANIFEST_PATH = File.join(Dir.pwd, '.conflux', 'manifest.json')
+  CONFLUX_YAML_PATH = File.join(Dir.pwd, '.conflux', 'conflux.yml')
+  CONFLUX_USER = 'CONFLUX_USER'
+  CONFLUX_APP = 'CONFLUX_APP'
+
+  def start!
+    fetch_configs if configured_for_conflux
+  end
+
+  private
+
+  def configured_for_conflux
+    if ENV[CONFLUX_USER] && ENV[CONFLUX_APP]
+      @creds_preset = true
+
+      @credentials = {
+        'CONFLUX_USER' => ENV[CONFLUX_USER],
+        'CONFLUX_APP' => ENV[CONFLUX_APP]
+      }
+    else
+      @credentials = File.exists?(MANIFEST_PATH) ? manifest_creds : {}
+    end
+
+    @credentials[CONFLUX_USER] && @credentials[CONFLUX_APP]
+  end
+
+  def manifest_creds
+    manifest = JSON.parse(File.read(MANIFEST_PATH)) rescue {}
+    configs = manifest['configs'] || {}
+
+    {
+      'CONFLUX_USER' => configs[CONFLUX_USER],
+      'CONFLUX_APP' => configs[CONFLUX_APP]
+    }
+  end
+
+  def fetch_configs
+    RestClient.get("#{conflux_url}/api/keys", headers) do |response|
+      if response.code == 200
+        configs = JSON.parse(response.body) rescue []
+        set_configs(configs, !@creds_preset)
+      end
+    end
+  end
+
+  def set_configs(configs_map, add_to_yml)
+    # Get application.yml file to make sure config vars aren't already there
+    @app_configs = YAML::load_file(APPLICATION_YAML_PATH) rescue {}
+
+    if add_to_yml
+      File.open(CONFLUX_YAML_PATH, 'w+') do |f|
+        f.write(yaml_header)
+
+        configs_map.each { |addon_name, configs|
+          f.write("\n\n# #{addon_name}") if !configs.empty?
+
+          configs.each { |config|
+            key = config['name']
+            value = config['value']
+            description = config['description']
+
+            # if the key already exists, let the developer know that it has
+            # been overwritten and to what value
+            if key_already_set?(key)
+              description = description.nil? ? '' : " ... #{description}"
+              line = "\n# #{key}  <-- (Overwritten) #{description}"
+            else
+              description = description.nil? ? '' : " # #{description}"
+              line = "\n#{key}#{description}"
+              ENV[key] = value
+            end
+
+            f.write(line)
+          }
+        }
+      end
+    else
+      configs_map.each { |addon_name, configs|
+        configs.each { |config|
+          key = config['name']
+          value = config['value']
+
+          ENV[key] = value if !key_already_set?(key)
+        }
+      }
+    end
+  end
+
+  def key_already_set?(key)
+    ENV.key?(key) || @app_configs.key?(key) || (@app_configs[Rails.env] || {}).key?(key)
+  end
+
+  def headers
+    {
+      'Conflux-User' => @credentials[CONFLUX_USER],
+      'Conflux-App' => @credentials[CONFLUX_APP]
+    }
+  end
+
+  def conflux_url
+    ENV['CONFLUX_HOST'] || 'http://api.goconflux.com'
+  end
+
+  def yaml_header
+    "\n# CONFLUX CONFIG VARS:\n\n" \
+    "# All config vars seen here are in use and pulled from Conflux.\n" \
+    "# If any are ever overwritten, they will be marked with \"Overwritten\"\n" \
+    "# If you ever wish to overwrite any of these, do so inside of a config/application.yml file."
+  end
+
+end

data/lib/conflux/helpers.rb

@@ -0,0 +1,154 @@
+module Conflux
+  module Helpers
+    extend self
+
+    def ask_for_basic_creds
+      # Ask for Conflux Credentials
+      puts 'Enter your Conflux credentials.'
+
+      # Email:
+      print 'Email: '
+      email = allow_user_response
+
+      # Password
+      print 'Password (typing will be hidden): '
+
+      password = running_on_windows? ? ask_for_password_on_windows : ask_for_password
+
+      { email: email, password: password }
+    end
+
+    def ask_for_password_on_windows
+      require 'Win32API'
+      char = nil
+      password = ''
+
+      while char = Win32API.new('msvcrt', '_getch', [ ], 'L').Call do
+        break if char == 10 || char == 13 # received carriage return or newline
+        if char == 127 || char == 8 # backspace and delete
+          password.slice!(-1, 1)
+        else
+          # windows might throw a -1 at us so make sure to handle RangeError
+          (password << char.chr) rescue RangeError
+        end
+      end
+
+      puts
+      password
+    end
+
+    def ask_for_password
+      begin
+        echo_off  # make the password input hidden
+        password = allow_user_response
+        puts
+      ensure
+        echo_on  # flip input visibility back on
+      end
+
+      password
+    end
+
+    # Hide user input
+    def echo_off
+      with_tty do
+        system 'stty -echo'
+      end
+    end
+
+    # Show user input
+    def echo_on
+      with_tty do
+        system 'stty echo'
+      end
+    end
+
+    def with_tty(&block)
+      return unless $stdin.isatty
+      begin
+        yield
+      rescue
+        # fails on windows
+      end
+    end
+
+    def allow_user_response
+      $stdin.gets.to_s.strip
+    end
+
+    def running_on_windows?
+      RUBY_PLATFORM =~ /mswin32|mingw32/
+    end
+
+    def url(route)
+      "#{host_url}/api#{route}"
+    end
+
+    def host_url
+      ENV['CONFLUX_HOST'] || 'http://api.goconflux.com'
+    end
+
+    def prompt_user_to_select_app(apps_map)
+      answer = nil
+      question = "\nWhich Conflux app does this project belong to?\n"
+
+      # Keep asking until the user responds with one of the possible answers
+      until !answer.nil?
+        count = 0
+        app_slugs = []
+
+        puts question
+
+        apps_map.each { |team, apps|
+          puts "\n#{team}:\n\n"   # separate apps out by team for easier selection
+
+          apps.each { |slug|
+            count += 1
+            puts "(#{count}) #{slug}"
+            app_slugs << slug
+          }
+        }
+
+        puts "\n"
+
+        response = allow_user_response
+
+        # it's fine if the user responds with an exact app slug
+        if app_slugs.include?(response)
+          answer = response
+
+          # otherwise, they can just respond with the number next to the app they wish to choose
+        else
+          response_int = response.to_i rescue 0
+          answer = app_slugs[response_int - 1 ]if response_int > 0
+        end
+
+        question = "\nSorry I didn't catch that. Can you respond with the number that appears next to your answer?"
+      end
+
+      answer
+    end
+
+    def error(msg = '')
+      $stderr.puts(msg)
+      exit(1)
+    end
+
+    def handle_json_response(response, error_message)
+      if response.code == 200
+        JSON.parse(response.body) rescue {}
+      else
+        error(error_message)
+      end
+    end
+
+    def conflux_folder_path
+      "#{Dir.pwd}/.conflux/"
+    end
+
+    def conflux_manifest_path
+      File.join(conflux_folder_path, 'manifest.json')
+    end
+
+  end
+end

data/lib/conflux/railtie.rb

@@ -0,0 +1,20 @@
+require 'conflux'
+require 'rails'
+
+module Conflux
+  class Railtie < ::Rails::Railtie
+    railtie_name :conflux
+    # Hooking into `to_prepare` because it runs BEFORE the config/initializers
+    # files but AFTER any other railties hooking into `before_configuration` - which
+    # is what the popular gem "figaro" uses. This allows for Conflux config vars to be
+    # more easily overwritten if desired, by simply using figaro and manually specifying
+    # config vars in your config/application.yml file.
+    config.before_configuration do
+      Conflux.start!
+    end
+
+    rake_tasks do
+      load 'tasks/conflux.rake'
+    end
+  end
+end

data/lib/conflux/version.rb

@@ -0,0 +1,3 @@
+module Conflux
+  VERSION = '1.0.0'
+end

data/lib/tasks/conflux.rake

@@ -0,0 +1,40 @@
+require 'json'
+require 'rest-client'
+require 'fileutils'
+require 'conflux/helpers'
+
+namespace :conflux do
+
+  desc 'Set which conflux app to use for the current directory'
+  task :set_app do
+    helpers = Conflux::Helpers
+    creds = helpers.ask_for_basic_creds
+
+    RestClient.post(helpers.url('/users/apps_basic_auth'), creds) do |response|
+      body = helpers.handle_json_response(response, 'Authentication failed.')
+
+      # Ask which app user wants to use:
+      app_slug = helpers.prompt_user_to_select_app(body['apps_map'])
+
+      RestClient.get(helpers.url("/apps/manifest?app_slug=#{app_slug}"), { 'Conflux-User' => body['token'] }) do |response|
+        resp = helpers.handle_json_response(response, 'Request failed.')
+        manifest_json = resp['manifest']
+
+        # Create .conflux/ folder if doesn't already exist
+        FileUtils.mkdir_p(helpers.conflux_folder_path) if !File.exists?(helpers.conflux_folder_path)
+
+        puts 'Configuring manifest.json...'
+
+        # Write this app info to a new manifest.json file for the user
+        File.open(helpers.conflux_manifest_path, 'w+') do |f|
+          f.write(JSON.pretty_generate(manifest_json))
+        end
+
+        puts "Successfully connected project to conflux app: #{app_slug}"
+        puts "The 'conflux' ruby gem wasn't automatically installed...Make sure it's installed if you haven't already done so."
+      end
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: conflux
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ben Whittle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- benwhittle31@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- conflux.gemspec
+- lib/conflux.rb
+- lib/conflux/helpers.rb
+- lib/conflux/railtie.rb
+- lib/conflux/version.rb
+- lib/tasks/conflux.rake
+homepage: https://www.github.com/GoConflux/conflux-rb
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Gem to fetch and make available Conflux configs on Rails boot.
+test_files: []