et 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f73dea1999d7fc46db767ea705e6022aceb45a24
-  data.tar.gz: 29df46b104d1484f458a5b9e60346a219544b4b7
+  metadata.gz: d678e6b3797d0340afda2997d3e23a8d4aad1a41
+  data.tar.gz: 00a791674220af78c744b9c7fff5a45f2e379c37
 SHA512:
-  metadata.gz: 4835233905faf16607d6fd5a37d264e814827b5be95b4477d43dd04588eaf3dfc03c6104be971f90a7e212a89c068e19dc51992c07582bcbd688c81f7694ac35
-  data.tar.gz: 14555a87bf0bd86fef92fcbb5256e7bd4cc82098c653d69566fc3f8aaae99f9dcf3232d34095228430b3e01c37eea759d63b8e7791f54dc59d9c29695cd66cd7
+  metadata.gz: 239edb45e57abd02f9f9a0df443ae39402b3fc985faa3e317b413ffda27fcb16f4cbd51a45d44495ceb5de118eb93bd82c81bbdf41aff7232aa52cf87a34274e
+  data.tar.gz: 055589ff2ea9ca2bf5c4fe0854ffbbc7622103bf8702fc11b3b0ec6854ea45006bc191639b885f781a896dfe31497f60f3c2b3227f5601b8a4bb1cde7d3ff26a

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    et (0.0.1)
+    et (0.2.0)
       gli (= 2.11.0)
-      rest-client (~> 1.7.2)
+      rest-client (~> 1.7)
 
 GEM
   remote: https://rubygems.org/
@@ -34,6 +34,6 @@ PLATFORMS
 
 DEPENDENCIES
   et!
-  rake (~> 10.3)
-  rspec (~> 3.0.0)
-  rspec-mocks (~> 3.0.0)
+  rake (~> 10)
+  rspec (~> 3.0)
+  rspec-mocks (~> 3.0)

data/lib/et/api.rb

@@ -41,17 +41,11 @@ module ET
       dest
     end
 
-    def submit_challenge(dir)
-      Dir.mktmpdir do |tmpdir|
-        slug = File.basename(dir)
-
-        submission_file = File.join(tmpdir, "submission.tar.gz")
-        if system("tar zcf #{submission_file} -C #{dir} .")
-          RestClient.post(submission_url(slug),
-            { submission: { archive: File.new(submission_file) }},
-            { "Authorization" => auth_header })
-        end
-      end
+    def submit_challenge(challenge)
+      submission_file = challenge.archive!
+      RestClient.post(submission_url(challenge.slug),
+        { submission: { archive: File.new(submission_file) }},
+        { "Authorization" => auth_header })
     end
 
     private

data/lib/et/challenge.rb

@@ -0,0 +1,69 @@
+require "securerandom"
+
+module ET
+  class Challenge
+    attr_reader :cwd
+
+    def initialize(cwd)
+      @cwd = cwd
+    end
+
+    def archive!
+      if exists?
+        filepath = random_archive_path
+
+        cmd = "tar zcf #{filepath} -C #{dir} . --exclude='.challenge'"
+
+        ignored_files.each do |file|
+          cmd += " --exclude='#{file}'"
+        end
+
+        if system(cmd)
+          filepath
+        else
+          nil
+        end
+      else
+        nil
+      end
+    end
+
+    def dir
+      @dir ||= find_challenge_dir(cwd)
+    end
+
+    def slug
+      File.basename(dir)
+    end
+
+    def exists?
+      !dir.nil?
+    end
+
+    def ignored_files
+      config["ignore"] || []
+    end
+
+    private
+
+    def config
+      @config ||= YAML.load(File.read(File.join(dir, ".challenge")))
+    end
+
+    def random_archive_path
+      File.join(Dir.mktmpdir, "#{SecureRandom.hex}.tar.gz")
+    end
+
+    def find_challenge_dir(current_dir)
+      path = File.join(current_dir, ".challenge")
+
+      if File.exists?(path)
+        current_dir
+      elsif current_dir == "/" || current_dir == "."
+        nil
+      else
+        find_challenge_dir(File.dirname(current_dir))
+      end
+    end
+  end
+end

data/lib/et/runner.rb

@@ -32,6 +32,8 @@ module ET
 
           settings = prompt_for_missing(settings)
           save_config(settings)
+
+          puts "Saved configuration to #{config.path}"
         end
       end
 
@@ -49,8 +51,13 @@ module ET
             challenge = api.get_challenge(slug)
             archive = api.download_file(challenge[:archive_url])
 
-            system("tar zxf #{archive} -C #{cwd}")
-            system("rm #{archive}")
+            if system("tar zxf #{archive} -C #{cwd}")
+              system("rm #{archive}")
+              challenge_dir = File.join(cwd, slug)
+              puts "Extracted challenge to #{challenge_dir}"
+            else
+              raise StandardError.new("Failed to extract the challenge archive.")
+            end
           end
         end
       end
@@ -58,7 +65,14 @@ module ET
       desc "Submit the challenge in this directory."
       command :submit do |c|
         c.action do |_global_options, _options, _cmdargs|
-          api.submit_challenge(cwd)
+          challenge = Challenge.new(cwd)
+
+          if challenge.exists?
+            api.submit_challenge(challenge)
+            puts "Challenge submitted"
+          else
+            raise StandardError.new("Not in a challenge directory.")
+          end
         end
       end
 

data/lib/et/version.rb

@@ -1,3 +1,3 @@
 module ET
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/et.rb

@@ -3,3 +3,4 @@ require "et/runner"
 require "et/api"
 require "et/config"
 require "et/formatter"
+require "et/challenge"

data/spec/cli/submit_challenge_spec.rb

@@ -10,7 +10,6 @@ describe "submit challenge" do
         challenge_dir = write_sample_challenge_to(tmpdir, "some-challenge")
 
         expect_any_instance_of(ET::API).to receive(:submit_challenge).
-          with(challenge_dir).
           and_return(true)
 
         runner = ET::Runner.new(challenge_dir)

data/spec/lib/challenge_spec.rb

@@ -0,0 +1,91 @@
+require "yaml"
+
+describe ET::Challenge do
+  let(:challenge_info) do
+    {
+      "title" => "Guess the Number",
+      "slug" => "guess-the-number",
+      "ignore" => ["README.md"]
+    }
+  end
+
+  describe "#dir" do
+    it "selects the directory containing the challenge file" do
+      Dir.mktmpdir do |challenge_dir|
+        challenge_path = File.join(challenge_dir, ".challenge")
+        File.write(challenge_path, challenge_info.to_yaml)
+
+        challenge = ET::Challenge.new(challenge_dir)
+        expect(challenge.dir).to eq(challenge_dir)
+      end
+    end
+
+    it "checks parent directories for the challenge file" do
+      Dir.mktmpdir do |parent_dir|
+        challenge_path = File.join(parent_dir, ".challenge")
+        File.write(challenge_path, challenge_info.to_yaml)
+
+        child_dir = File.join(parent_dir, "foobar")
+
+        challenge = ET::Challenge.new(child_dir)
+        expect(challenge.dir).to eq(parent_dir)
+      end
+    end
+
+    it "returns nil if no challenge file found" do
+      challenge = ET::Challenge.new(Dir.tmpdir)
+      expect(challenge.dir).to eq(nil)
+    end
+  end
+
+  describe "#archive" do
+    it "packages up files in the given directory" do
+      archive_path = nil
+
+      begin
+        Dir.mktmpdir do |challenge_dir|
+          challenge_path = File.join(challenge_dir, ".challenge")
+          File.write(challenge_path, challenge_info.to_yaml)
+
+          file_path = File.join(challenge_dir, "file.rb")
+          File.write(file_path, "2 + 2 == 5")
+
+          challenge = ET::Challenge.new(challenge_dir)
+          archive_path = challenge.archive!
+
+          contents = read_file_from_gzipped_archive(archive_path, "./file.rb")
+          expect(contents).to eq("2 + 2 == 5")
+        end
+      ensure
+        if archive_path && File.exist?(archive_path)
+          FileUtils.rm(archive_path)
+        end
+      end
+    end
+
+    it "excludes files in the ignore array" do
+      archive_path = nil
+
+      begin
+        Dir.mktmpdir do |dir|
+          File.write(File.join(dir, ".challenge"), challenge_info.to_yaml)
+          File.write(File.join(dir, "file.rb"), "2 + 2 == 5")
+          File.write(File.join(dir, "README.md"), "Ignore me!")
+
+          challenge = ET::Challenge.new(dir)
+          archive_path = challenge.archive!
+
+          files = list_files_in_gzipped_archive(archive_path)
+
+          expect(files).to include("./file.rb")
+          expect(files).to_not include("./README.md")
+          expect(files).to_not include("./.challenge")
+        end
+      ensure
+        if archive_path && File.exist?(archive_path)
+          FileUtils.rm(archive_path)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -48,6 +48,7 @@ RSpec.configure do |config|
   config.include OutputCatcher
   config.include SampleFiles
   config.include PathHelper
+  config.include ArchiveHelper
 
   config.before :each do
     allow(RestClient).to receive(:get)

data/spec/support/helpers/archive_helper.rb

@@ -0,0 +1,28 @@
+require "zlib"
+require "rubygems/package"
+
+module ArchiveHelper
+  def read_file_from_gzipped_archive(archive_path, filename)
+    Zlib::GzipReader.open(archive_path) do |gz|
+      contents = nil
+
+      Gem::Package::TarReader.new(gz) do |tar|
+        contents = tar.seek(filename) { |f| f.read }
+      end
+
+      contents
+    end
+  end
+
+  def list_files_in_gzipped_archive(archive_path)
+    file_names = nil
+
+    Zlib::GzipReader.open(archive_path) do |gz|
+      Gem::Package::TarReader.new(gz) do |tar|
+        file_names = tar.entries.map { |entry| entry.full_name }
+      end
+    end
+
+    file_names
+  end
+end

data/spec/support/helpers/sample_files.rb

@@ -17,12 +17,14 @@ module SampleFiles
   end
 
   def write_sample_challenge_to(working_dir, slug)
-    challenge_dir = File.join(working_dir, slug)
-    system("mkdir #{challenge_dir}")
+    options = { "title" => slug.capitalize, "slug" => slug }
 
-    readme_path = File.join(challenge_dir, "README.md")
-    File.write(readme_path, "# README")
+    dir = File.join(working_dir, slug)
+    system("mkdir #{dir}")
 
-    challenge_dir
+    File.write(File.join(dir, "README.md"), "# README")
+    File.write(File.join(dir, ".challenge"), options.to_yaml)
+
+    dir
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: et
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Sheehan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-13 00:00:00.000000000 Z
+date: 2014-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -102,6 +102,7 @@ files:
 - et.gemspec
 - lib/et.rb
 - lib/et/api.rb
+- lib/et/challenge.rb
 - lib/et/config.rb
 - lib/et/formatter.rb
 - lib/et/runner.rb
@@ -113,8 +114,10 @@ files:
 - spec/data/challenges.json
 - spec/data/some-challenge.tar.gz
 - spec/lib/api_spec.rb
+- spec/lib/challenge_spec.rb
 - spec/lib/config_spec.rb
 - spec/spec_helper.rb
+- spec/support/helpers/archive_helper.rb
 - spec/support/helpers/output_catcher.rb
 - spec/support/helpers/path_helper.rb
 - spec/support/helpers/sample_files.rb