learn-doctor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2668c052b700cd3553430dd1e17576aeaeea06f
+  data.tar.gz: 38668dc800bd9a17ac5dcce0fe1858581a14974b
+SHA512:
+  metadata.gz: 3988baba9fbda7bea8d2eee8fb1959a79d9297b226bfb261a9b4370c3ca275167f9d0736e58daa6a6086db555daa5d5e3030de168436514eb1c93a88babc272e
+  data.tar.gz: 60ce2fb547b3f2cdf2176e70817f915bb9319ec757cfb428aa8bd2ac9b906d203c9f8535dcb35531dd334b7fd4df191487475080a0aab36360ec9ac01ad38ce6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Flatiron School
+
+MIT License
+
+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,37 @@
+# learn-doctor
+
+Check and fix your environment based on Learn.co's defaults.
+
+## Installation
+
+Install with:
+
+```
+$ gem install learn-doctor
+```
+
+Alternatively, add this line to your application's Gemfile:
+
+```ruby
+gem 'learn-doctor'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Run:
+
+```
+$ learn-doctor
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/flatiron-labs/learn-doctor/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/learn-doctor

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'learn_doctor'
+
+# To prevent weird errors when random command line args are passed in
+KNOWN_COMMANDS = []
+
+ARGV.map! do |arg|
+  KNOWN_COMMANDS.include?(arg) ? arg : nil
+end.compact!
+
+LearnDoctor::HealthCheck.diagnose

data/learn-doctor.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'learn_doctor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "learn-doctor"
+  spec.version       = LearnDoctor::VERSION
+  spec.authors       = ["Flatiron School"]
+  spec.email         = ["learn@flatironschool.com"]
+  spec.summary       = %q{Check your environment setup against Learn.co's defaults}
+  spec.homepage      = "https://learn.co"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib", "bin"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "netrc"
+  spec.add_runtime_dependency "faraday", "~> 0.9"
+  spec.add_runtime_dependency "colorize"
+  spec.add_runtime_dependency "learn-web", ">= 1.0.5"
+end

data/lib/learn_doctor/health_check/file.rb

@@ -0,0 +1,48 @@
+module LearnDoctor
+  class HealthCheck
+    class File
+      attr_reader   :step, :check_or_install, :conn
+      attr_accessor :file
+
+      def initialize(step, check_or_install)
+        @step             = step
+        @check_or_install = check_or_install
+        @conn             = Faraday.new
+
+        prepare_file!
+
+        return self
+      end
+
+      def unlink!
+        self.file.unlink
+      end
+
+      def path
+        file.path
+      end
+
+      private
+
+      def prepare_file!
+        create_file!
+        write_to_file!
+        make_executable!
+      end
+
+      def create_file!
+        self.file = Tempfile.new(step[:title])
+      end
+
+      def write_to_file!
+        response = conn.get(step[check_or_install])
+        file.write(response.body)
+        file.rewind
+      end
+
+      def make_executable!
+        FileUtils.chmod('+x', file.path)
+      end
+    end
+  end
+end

data/lib/learn_doctor/health_check/step_checker.rb

@@ -0,0 +1,45 @@
+module LearnDoctor
+  class HealthCheck
+    class StepChecker
+      attr_reader   :step, :title
+      attr_accessor :file, :result
+
+      def initialize(step)
+        @step = step
+        @title = step[:title]
+      end
+
+      def execute
+        set_file
+        run_check_for_step
+        print_result
+        unlink_file!
+
+        self
+      end
+
+      private
+
+      def set_file
+        self.file = LearnDoctor::HealthCheck::File.new(step, :check)
+      end
+
+      def run_check_for_step
+        print "#{title}..."
+        self.result = Open3.popen3('bash', file.path)[1].read.strip.to_i
+      end
+
+      def print_result
+        if result == 1
+          puts 'ok'
+        else
+          puts 'error'.red
+        end
+      end
+
+      def unlink_file!
+        file.unlink!
+      end
+    end
+  end
+end

data/lib/learn_doctor/health_check/step_installer.rb

@@ -0,0 +1,45 @@
+module LearnDoctor
+  class HealthCheck
+    class StepInstaller
+      attr_reader   :step, :title
+      attr_accessor :file, :result
+
+      def initialize(step)
+        @step = step
+        @title = step[:title]
+      end
+
+      def execute
+        set_file
+        run_install_for_step
+        print_result
+        unlink_file!
+
+        self
+      end
+
+      private
+
+      def set_file
+        self.file = LearnDoctor::HealthCheck::File.new(step, :install)
+      end
+
+      def run_install_for_step
+        print "Installing #{title}..."
+        self.result = Open3.popen3('bash', file.path)[1].read.strip
+      end
+
+      def print_result
+        if result.match(/Done/)
+          puts 'done'.green
+        else
+          puts 'error'.red
+        end
+      end
+
+      def unlink_file!
+        file.unlink!
+      end
+    end
+  end
+end

data/lib/learn_doctor/health_check.rb

@@ -0,0 +1,98 @@
+require 'learn_doctor/health_check/file'
+require 'learn_doctor/health_check/step_checker'
+require 'learn_doctor/health_check/step_installer'
+
+module LearnDoctor
+  class HealthCheck
+    attr_reader   :client, :passed_steps, :failed_steps
+    attr_accessor :setup_step_list
+
+    def self.diagnose
+      new.diagnose
+    end
+
+    def initialize
+      _login, token = Netrc.read['learn-config']
+      @client       = LearnWeb::Client.new(token: token)
+      @passed_steps = []
+      @failed_steps = []
+    end
+
+    def diagnose
+      get_setup_step_list!
+      run_checks!
+      install_failures!
+    end
+
+    private
+
+    def get_setup_step_list!
+      puts 'Getting latest environment environment setup data from Learn...'
+      self.setup_step_list = client.environment_setup_list
+    end
+
+    def run_checks!
+      setup_step_list.steps.each do |key, step|
+        step_check = LearnDoctor::HealthCheck::StepChecker.new(step).execute
+
+        case step_check.result
+        when 1
+          self.passed_steps << step
+        when 0
+          self.failed_steps << step
+        end
+      end
+    end
+
+    def install_failures!
+      if failed_steps.any?
+        response = prompt_to_fix
+
+        if response
+          run_installations!
+          recheck_failures
+        else
+          exit
+        end
+      end
+    end
+
+    def prompt_to_fix
+      failed_checks = failed_steps.map{|s| s[:title] }.join(', ')
+
+      puts "It looks like the following things aren't configured correctly: #{failed_checks}"
+      print "Automatically try to fix? [yN]: "
+
+      response = gets.chomp.downcase
+
+      ['yes', 'y'].include?(response) ? true : false
+    end
+
+    def run_installations!
+      failed_steps.each do |step|
+        LearnDoctor::HealthCheck::StepInstaller.new(step).execute
+      end
+    end
+
+    def recheck_failures
+      puts "Rechecking environment..."
+      reinstallation_results = failed_steps.map do |step|
+        step_check = LearnDoctor::HealthCheck::StepChecker.new(step).execute
+
+        case step_check.result
+        when 1
+          nil
+        else
+          step[:title]
+        end
+      end.compact
+
+      if reinstallation_results.any?
+        puts "Unfortunately, there were problems trying to fix the following: #{reinstallation_results.join(', ')}"
+        puts "Please send an email to support@learn.co to get help."
+      else
+        exit
+      end
+    end
+  end
+end

data/lib/learn_doctor/version.rb

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

data/lib/learn_doctor.rb

@@ -0,0 +1,13 @@
+require 'netrc'
+require 'faraday'
+require 'colorize'
+require 'fileutils'
+require 'tempfile'
+require 'open3'
+require 'learn_web'
+
+require 'learn_doctor/version'
+require 'learn_doctor/health_check'
+
+module LearnDoctor
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: learn-doctor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Flatiron School
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: netrc
+  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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: learn-web
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+description: 
+email:
+- learn@flatironschool.com
+executables:
+- learn-doctor
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/learn-doctor
+- learn-doctor.gemspec
+- lib/learn_doctor.rb
+- lib/learn_doctor/health_check.rb
+- lib/learn_doctor/health_check/file.rb
+- lib/learn_doctor/health_check/step_checker.rb
+- lib/learn_doctor/health_check/step_installer.rb
+- lib/learn_doctor/version.rb
+homepage: https://learn.co
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- bin
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Check your environment setup against Learn.co's defaults
+test_files: []