unixoid-challenge 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18d85ad45d8ef76a1b9dc886b0ed47394004a5b4
-  data.tar.gz: 3eb07e2b2596fbd41aa7eb369447619000108717
+  metadata.gz: fb0161cd90643076d4f2b453a48bfc1542916857
+  data.tar.gz: 2e3d355bc69d6d8efedb5c7b01173e02998d0f88
 SHA512:
-  metadata.gz: 0ef798ea0f8f701709a1748fa5db108fce1dc05c5fa1095dbff167c5fdd39cdd8704c25a3149a9cc13573a716e71ddf80d932e2efb6c79a156c17c4eac9698a1
-  data.tar.gz: f4cac2700e00c819f709078e90fd62d795acde897d2d7b9aa85be0f47199b89c14f7859437e9a0108212ccf49d2f61eeae705188295c08018ea4dd0068663f8d
+  metadata.gz: e674e0ff18ad0057dc87906755c72725f52b92e339309e5b73b91ddc7ebd45581368846c8ee32e3321d22c9f0c256aab50f3d81750353d9a0482baf2a65b20ee
+  data.tar.gz: ec67b362cd57303a8aa2c1abc6ef2bcfb7f9e04892ffcb5ba13483988cad250f8d3cfbd39f681c45a93bbf81b904bca25b40af450029b81df5a42586c6853e50

data/README.md

@@ -0,0 +1,62 @@
+Unixoid Challenge
+=================
+
+Instructions
+------------
+
+* Test time: 1 hour (you can take longer, don’t worry)
+* Feel free to use google, your notes, books, etc. but work on your own
+* Obviously don't use Sublime Text, Finder or similar tools – only the command-line
+* You'll almost certainly need to Google some things. This is deliberate.
+* Upon completion of this challenge (or any time you are taking a break), please use the `history` command to see a list of the commands you have made on the command line.  If you save these details into a text file they can be a useful reference.
+
+Tasks:
+------
+
+First navigate on the command line to your Desktop directory, and then create a temporary directory using the following command:
+
+```sh
+mkdir temp
+```
+
+Then change into that directory using this next command:
+
+```sh
+cd temp
+```
+
+Now use your command line skills to complete the following:
+
+1. Using one command, create a directory structure "my/private/files"
+2. Using one command, create a directory structure "my/public/files"
+3. Create an empty file 't-vars.env' in my/private/files
+4. Using command-line only add the line "List of env vars that begin with T" to the file, make sure it ends with a newline
+5. List all env variables that begin with "T" (hint: you'll need a regex that includes the marker of the start of the line) and append them to the end of the file
+6. Export a new variable TESTING_MAKERS=working in such a way that it is still available when you open a new shell
+7. Open a new terminal window, check that a new variable is available
+8. Output the count of the variables that begin with T to a new file my/public/files/t-vars.count, e.g. "Overall count: 5" (hint: you'll need to use 'command substitution' in bash)
+9. Change the permissions of the my/private/files/t-vars.env to make sure that only the owner can read and write the file
+10. Change the permissions of the my/private/files directory to make sure that only the owner can change into it
+11. Give read and write permissions to all users on my/public/files/t-vars.count
+12. Create another file my/public/files/text-files-count.txt and output the number of text files in your home directory (recursively) into that file
+13. Create another file my/private/files/first-three-env.txt and output the first three env variables from a list of all of them sorted alphabetically
+14. Create another file my/private/files/commands.txt and output the contents of the `history` command to that file
+
+Checking and submitting your progress
+-------------------------------------
+
+First, you will need to install the `unixoid-challenge` gem, like this:
+
+```sh
+gem install unixoid-challenge
+```
+
+At any point while going through the challenge you can check your progress by running:
+
+```sh
+unixoid-challenge
+```
+
+__(make sure you are in the same directory that you completed the challenge in)__
+
+This will tell you if you've completed the task, or which of the tasks above you still need to complete. It will also submit your results to GitHub (you'll need your username and password that you use to login to GitHub) so we can track your progress.

data/bin/unixoid-challenge

@@ -2,6 +2,6 @@
 
 require 'rubygems'
 require 'rspec'
-require 'unixoid_challenge'
+require 'unixoid'
 
-UnixoidChallenge.run
+Unixoid::Controller.run

data/bin/unixoid-debug

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'unixoid'
+
+Unixoid::Controller.debug

data/lib/unixoid/challenge.rb

@@ -0,0 +1,20 @@
+module Unixoid
+  class Challenge
+    
+    RESULTS_FILE = 'unixoid_results.txt'
+
+    def self.run_specs
+      new.run_specs
+    end
+
+    def run_specs
+      Runner.run("rspec --out #{RESULTS_FILE} -fp #{spec_file}", outcodes: [0,1])
+    end
+
+    private 
+
+    def spec_file
+      File.join(File.dirname(__FILE__), '..', '..','challenge_spec.rb')
+    end    
+  end
+end

data/lib/unixoid/challenge_result.rb

@@ -0,0 +1,59 @@
+class ChallengeResult
+  
+  STATUSES = [:complete, :attempted, :unattempted]
+
+  PASS_CHAR = '.'
+  
+  def initialize(challenge)
+    @result = parse(challenge)
+  end
+
+  def status 
+    STATUSES.find do |status|
+      send("#{status}?")
+    end
+  end
+  
+  def failures
+    failing_test_numbers.compact
+  end
+
+  private
+  
+  attr_reader :result
+
+  def complete?
+    passes.length == total_tests
+  end
+
+  def attempted?
+    passes.any?
+  end
+
+  def unattempted?
+    passes.empty?
+  end
+  
+  def parse(challenge)
+    challenge.split("\n").first.chars
+  end
+
+  def passes
+    result.select { |test| passed(test) } 
+  end
+
+  def passed(test)
+    test == PASS_CHAR
+  end
+
+  def total_tests
+    result.length
+  end
+
+  def failing_test_numbers
+    @result.map.with_index do |test, index|
+      next if passed(test)
+      index + 1
+    end
+  end
+end

data/lib/unixoid/colorize.rb

@@ -0,0 +1,17 @@
+class String
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    colorize(31)
+  end
+
+  def green
+    colorize(32)
+  end
+  
+  def yellow
+    colorize(33)
+  end
+end

data/lib/unixoid/controller.rb

@@ -0,0 +1,70 @@
+module Unixoid
+  class Controller
+
+    def self.run
+      results = run_challenge
+      final_result(results)
+      puts "Submitting your results to Makers Academy..."
+      push_to_github(Challenge::RESULTS_FILE)
+    end
+
+    def self.debug
+      puts "Submitting your history to Makers Academy so we can help you debug..."
+      create_history_file
+      push_to_github('commands.txt')
+    end
+
+    private
+
+    class << self
+
+      def push_to_github(file)
+        github = Github.create_repo
+        auth_fail! unless github.authenticated?
+        puts "Submitting..."
+        Git.submit(file, github)
+        puts "Submitted!"
+      end
+
+      def run_challenge
+        challenge = Challenge.run_specs
+        ChallengeResult.new(challenge)
+      end
+
+      def create_history_file
+        Runner.run('cp ~/.bash_history commands.txt')
+      end
+
+      def final_result(results)
+        puts render_results(results)
+      end
+
+      def auth_fail!
+        puts 'Incorrect login details. Please run unixoid-challenge again'.red 
+        exit 1
+      end
+
+      def render_results(results)
+        case results.status
+        when :complete
+          'Congratulations, you have successfully completed the Unixoid Challenge!'.green
+        when :attempted
+          attempted(results).yellow
+        when :unattempted
+          puts 'Looks like you have not tried the challenge. Give it a go and then re-submit'.red
+          exit 0
+        end
+      end
+
+      def attempted(results)
+        %{
+Almost there! Feel free to try again and re-submit
+
+The following answers need to be corrected:
+
+          #{results.failures.join(", ")}
+        }
+      end
+    end
+  end
+end

data/lib/unixoid/git.rb

@@ -0,0 +1,64 @@
+require 'forwardable'
+require 'uri'
+
+module Unixoid
+
+  class Git
+
+    extend Forwardable
+
+    delegate run: :@runner
+    
+    def initialize(github)
+      @github = github
+      @runner = Runner.new
+    end
+
+    def self.submit(file, github)
+      new(github).submit(file)
+    end
+
+    def submit(file)
+      create_repo
+      add(file)
+      commit_results
+      add_remote
+      push_results
+      remove_remote
+    end
+
+    def create_repo
+      run('git init')      
+    end
+
+    def add(file)
+      run("git add #{file}")
+    end
+
+    def commit_results
+      run("git commit -m 'Unixoid submission'")
+    end
+
+    def add_remote
+      run("git remote add origin https://#{username}:#{password}@github.com/#{username}/unixoid_submission.git")
+    end
+
+    def push_results
+      run('git push --force -u origin master')
+    end
+
+    def remove_remote
+      run('git remote rm origin')
+    end
+
+    private
+
+    def username
+      URI.encode(@github.username)
+    end
+
+    def password
+      URI.encode(@github.password)
+    end
+  end
+end

data/lib/unixoid/github.rb

@@ -0,0 +1,62 @@
+require 'io/console'
+require 'json'
+
+module Unixoid
+
+  class Github
+    
+    GITHUB_URL = 'https://api.github.com/user/repos'
+    REPO_NAME = 'unixoid_submission'
+
+    def initialize
+      @runner = Runner.new
+    end
+
+    def self.create_repo
+      new.create_repo
+    end
+
+    def create_repo
+      parse @runner.run(command)
+      self
+    end
+
+    def username
+      @username ||= ask_for_username
+    end
+
+    def password
+      @password ||= ask_for_password
+    end
+    
+    def authenticated?
+      @response && @response['message'] != "Bad credentials"
+    end
+
+    private
+
+    def command
+      %Q{curl -u "#{username}:#{password}" #{GITHUB_URL} -d '{"name": "#{REPO_NAME}"}'}
+    end
+ 
+    def parse(response)
+      @response = parse_json(response)
+    end
+
+    def parse_json(response)
+      begin
+        JSON.parse(response)
+      rescue JSON::ParseError; end
+    end
+
+    def ask_for_username
+      puts "Please enter your Github username:"
+      $stdin.gets.chomp
+    end
+  
+    def ask_for_password
+      puts "Please enter your Github password:"
+      $stdin.noecho(&:gets).chomp
+    end
+  end
+end

data/lib/unixoid/runner.rb

@@ -0,0 +1,32 @@
+require 'cocaine'
+require 'logger'
+
+module Unixoid
+
+  class Runner
+
+    LOG_FILE = 'logfile.log'
+
+    def initialize
+      @logger = Logger.new(LOG_FILE)
+    end
+
+    def self.run(command, opts = {})
+      new.run(command, opts)
+    end    
+
+    def run(command, outcodes: [0])
+      line = Cocaine::CommandLine.new(command, "", expected_outcodes: outcodes, swallow_stderr: true)
+      begin
+        log(:info, line.run)
+      rescue Cocaine::ExitStatusError => error
+        log(:error, error.message)
+      end
+    end
+
+    def log(level, message)
+      @logger.send(level, message)
+      message
+    end
+  end
+end

data/lib/unixoid.rb

@@ -0,0 +1,10 @@
+require 'unixoid/controller'
+require 'unixoid/runner'
+require 'unixoid/challenge'
+require 'unixoid/github'
+require 'unixoid/git'
+require 'unixoid/colorize'
+require 'unixoid/challenge_result'
+
+module Unixoid
+end

metadata

@@ -1,11 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: unixoid-challenge
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Sam Joseph
 - Dan Le Dosquet-Bergquist
+- Leo Allen
+- Spike Lindsey
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -15,28 +17,53 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: cocaine
+  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: A gem to assess your performance on the unixoid challenge
 email: sam@makersacademy.com
 executables:
 - unixoid-challenge
+- unixoid-debug
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/unixoid-challenge
-- lib/unixoid_challenge.rb
-- spec/unixoid_spec.rb
-homepage: http://makersacademy.com
-licenses: []
+- bin/unixoid-debug
+- challenge_spec.rb
+- lib/unixoid.rb
+- lib/unixoid/challenge.rb
+- lib/unixoid/challenge_result.rb
+- lib/unixoid/colorize.rb
+- lib/unixoid/controller.rb
+- lib/unixoid/git.rb
+- lib/unixoid/github.rb
+- lib/unixoid/runner.rb
+homepage: http://github.com/makersacademy/unixoid-challenge
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/lib/unixoid_challenge.rb

@@ -1,18 +0,0 @@
-class UnixoidChallenge
-  def self.run
-    puts "Running the Unixoid Challenge Assessor ..."
-    File.write 'unixoid_spec.rb', File.readlines(File.join(File.dirname(__FILE__), '..','spec','unixoid_spec.rb')).join
-    `rspec unixoid_spec.rb > unixoid_results.txt`
-    puts 'Please enter your github user name:'
-    username = gets.chomp
-    curl = %Q{curl -u #{username} https://api.github.com/user/repos -d '{"name":"unixoid_submission"}'}
-    %x[#{curl}]
-    `git init`
-    `git add unixoid_results.txt`
-    `git commit -am 'unixoid submission'`
-    add_remote = "git remote add origin git@github.com:#{username}/unixoid_submission.git"
-    %x[#{add_remote}]
-    `git push -f origin master`
-    puts "Completed Submission!"
-  end
-end