et 0.5.9 → 0.7.3

data/lib/et/version.rb

@@ -1,3 +1,3 @@
 module ET
-  VERSION = "0.5.9"
+  VERSION = "0.7.3"
 end

data/spec/cli/get_lesson_spec.rb

@@ -1,38 +1,38 @@
-describe "get lesson" do
+describe 'get lesson' do
   let(:lesson_info) do
     {
-      title: "Some Challenge",
-      slug: "some-challenge",
-      archive_url: "http://localhost:3000/some-challenge.tar.gz"
+      'title' => 'Some Challenge',
+      'slug'  => 'some-challenge',
+      'archive_url' => "http://localhost:3000/some-challenge.tar.gz"
     }
   end
 
   let(:sample_archive_path) do
-    project_root.join("spec/data/some-challenge.tar.gz")
+    project_root.join('spec/data/some-challenge.tar.gz')
   end
 
-  context "when in a working area" do
-    it "downloads and extracts the lesson" do
-      tmp_archive_path = File.join(Dir.tmpdir, "some-challenge.tar.gz")
-      system("cp", sample_archive_path.to_s, tmp_archive_path)
+  context 'when in a working area' do
+    it 'downloads and extracts the lesson' do
+      tmp_archive_path = File.join(Dir.tmpdir, 'some-challenge.tar.gz')
+      system('cp', sample_archive_path.to_s, tmp_archive_path)
 
       expect_any_instance_of(ET::API).to receive(:get_lesson).
-        with("some-challenge").
+        with('some-challenge').
         and_return(lesson_info)
 
       expect_any_instance_of(ET::API).to receive(:download_file).
-        with("http://localhost:3000/some-challenge.tar.gz").
+        with('http://localhost:3000/some-challenge.tar.gz').
         and_return(tmp_archive_path)
 
-      Dir.mktmpdir("test") do |tmpdir|
+      Dir.mktmpdir('test') do |tmpdir|
         write_sample_config_to(tmpdir)
 
         runner = ET::Runner.new(tmpdir)
          _, _ = capture_output do
-          expect(runner.go(["get", "some-challenge"])).to eq(0)
+          expect(runner.go(['get', 'some-challenge'])).to eq(0)
         end
 
-        ["some-challenge/README.md", "some-challenge/sample.rb"].each do |filename|
+        ['some-challenge/README.md', 'some-challenge/sample.rb'].each do |filename|
           path = File.join(tmpdir, filename)
           expect(File.exist?(path)).to eq(true)
         end

data/spec/cli/list_lessons_spec.rb

@@ -2,7 +2,7 @@ describe "list lessons" do
   let(:sample_lessons_file) { project_root.join("spec/data/lessons.json") }
 
   let(:sample_lessons) do
-    JSON.parse(File.read(sample_lessons_file), symbolize_names: true)[:lessons]
+    JSON.parse(File.read(sample_lessons_file))['lessons']
   end
 
   it "prints the titles and slug" do

data/spec/data/.et

@@ -0,0 +1 @@
+#required for et to do its thing

data/spec/data/bloated-challenge/.etignore

@@ -0,0 +1,4 @@
+bloated-challenge.md
+
+# Here's a comment
+/rando_folder

data/spec/data/bloated-challenge/bloated-challenge.md

@@ -0,0 +1,3 @@
+### Instructions
+
+Do something.

data/spec/data/bloated-challenge/node_modules/boo/somefile.js

@@ -0,0 +1 @@
+alert('please do not include this file');

data/spec/data/bloated-challenge/problem.rb

@@ -0,0 +1 @@
+# YOUR CODE GOES HERE

data/spec/data/bloated-challenge/rando_folder/rando_file.js

@@ -0,0 +1 @@
+console.log('I am random');

data/spec/data/sample-challenge/.etignore

@@ -0,0 +1 @@
+sample-challenge.md

data/spec/data/sample-exercise/.etignore

@@ -0,0 +1 @@
+sample-exercise.md

data/spec/lib/api_spec.rb

@@ -10,26 +10,24 @@ describe ET::API do
 
   describe "lessons" do
     it "queries for a list of lessons" do
-      request = {}
-      response = double
-      http = double
-      expect(Net::HTTP::Get).to receive(:new).
-        with(lessons_uri).
-        and_return(request)
-      expect(Net::HTTP).to receive(:start).with(
-        lessons_uri.host,
-        lessons_uri.port,
-        use_ssl: lessons_uri.scheme == "https").
-        and_yield(http)
-      expect(http).to receive(:request).and_return(response)
-      expect(response).to receive(:body).and_return(lessons_response)
+      client = Faraday.new do |builder|
+        builder.response :json
+
+        builder.adapter :test do |stubs|
+          stubs.get("/lessons.json") do
+            [200, {}, lessons_response]
+          end
+        end
+      end
+
+      allow_any_instance_of(ET::FallbackConnection).to receive(:open).and_yield(client)
 
       results = api.list_lessons
 
       expect(results.count).to eq(3)
-      expect(results[0][:title]).to eq("Max Number")
-      expect(results[0][:slug]).to eq("max-number")
-      expect(results[0][:type]).to eq("exercise")
+      expect(results[0]['title']).to eq("Max Number")
+      expect(results[0]['slug']).to eq("max-number")
+      expect(results[0]['type']).to eq("exercise")
     end
 
     let(:lesson_response) do
@@ -37,99 +35,67 @@ describe ET::API do
     end
 
     it "queries for a single lesson" do
-      request = {}
-      response = double
-      http = double
-
-      lesson_uri = URI("http://localhost:3000/lessons/rock-paper-scissors.json?submittable=1")
-      expect(Net::HTTP::Get).to receive(:new).
-        with(lesson_uri).
-        and_return(request)
-      expect(Net::HTTP).to receive(:start).with(
-        lesson_uri.host,
-        lesson_uri.port,
-        use_ssl: lesson_uri.scheme == "https").
-        and_yield(http)
-      expect(http).to receive(:request).and_return(response)
-      expect(response).to receive(:body).and_return(lesson_response)
-
-      result = api.get_lesson("rock-paper-scissors")
+      client = Faraday.new do |builder|
+        builder.response :json
 
-      expect(result[:title]).to eq("Rock, Paper, Scissors")
-      expect(result[:archive_url]).to eq("http://example.com/rock-paper-scissors.tar.gz")
-    end
-  end
+        builder.adapter :test do |stubs|
+          stubs.get("/lessons/rock-paper-scissors.json") do
+            [200, {}, lesson_response]
+          end
+        end
+      end
 
-  context 'ssl verification' do
-    it 're-raises an exception for non Windows machines' do
-      dbl_os = double
-      allow(dbl_os).to receive(:platform_family?).with(:windows).and_return(false)
-      expect(ET::OperatingSystem).to receive(:new).and_return(dbl_os)
+      allow_any_instance_of(ET::FallbackConnection).
+        to receive(:open).and_yield(client)
 
-      expect(Net::HTTP).to receive(:start).and_raise(OpenSSL::SSL::SSLError)
-      expect{ api.list_lessons }.to raise_error(OpenSSL::SSL::SSLError)
-    end
+      result = api.get_lesson("rock-paper-scissors")
 
-    it 'swallows the exception for windows machines and reissues' do
-      http = double
-      allow(http).to receive(:start).and_yield(http)
-      allow(http).to receive(:verify_mode=)
-      allow(http).to receive(:use_ssl=)
-      response = double
-
-      allow(http).to receive(:request).and_return(response)
-      allow(response).to receive(:body).and_return(lessons_response)
-
-      allow(Net::HTTP).to receive(:start).
-        with(
-          lessons_uri.host,
-          lessons_uri.port,
-          use_ssl: lessons_uri.scheme == 'https').
-            and_raise(OpenSSL::SSL::SSLError)
-
-      expect(Net::HTTP).to receive(:new).with(
-          lessons_uri.host,
-          lessons_uri.port).
-          and_return(http)
-
-      dbl_os = double
-      allow(dbl_os).to receive(:platform_family?).and_return(:windows)
-      allow(ET::OperatingSystem).to receive(:new).and_return(dbl_os)
-
-      api.list_lessons
+      expect(result['title']).to eq("Rock, Paper, Scissors")
+      expect(result['archive_url']).to   eq('http://example.com/rock-paper-scissors.tar.gz')
     end
   end
 
   context 'downloading files' do
     it 'returns nil when a 404 is encountered' do
+      filename = 'somefile.tar.gz'
+      client = Faraday.new do |builder|
+        builder.response :json
+
+        builder.adapter :test do |stubs|
+          stubs.get("/#{filename}") do
+            [404, {}, '']
+          end
+        end
+      end
 
-      http = double
-      response = double
-      allow(response).to receive(:code).and_return("404")
-      allow(http).to receive(:request).and_return(response)
-      allow(Net::HTTP).to receive(:start).and_yield(http)
+      allow_any_instance_of(ET::FallbackConnection).
+        to receive(:open).and_yield(client)
 
-      expect(api.download_file("http://example.com/somefile.tar.gz")).to be_nil
+      expect(api.download_file("http://example.com/#{filename}")).to be_nil
     end
+
     it 'returns a local file when a challenge is successfully downloaded' do
       path = '/tmp/et'
-      filename = 'fab'
+      filename = 'some-challenge.tar.gz'
 
       FileUtils.rm_rf(File.join(path, filename))
       FileUtils.mkdir_p(path)
 
+      filename = 'somefile.tar.gz'
+      client = Faraday.new do |builder|
+        builder.adapter :test do |stubs|
+          stubs.get("/#{filename}") do
+            [200, {}, '']
+          end
+        end
+      end
+
+      allow_any_instance_of(ET::FallbackConnection).
+        to receive(:open).and_yield(client)
       allow(Dir).to receive(:mktmpdir).and_return(path)
       allow(SecureRandom).to receive(:hex).and_return(filename)
 
-      http = double
-      response = double
-      file_contents = File.read(File.join(File.dirname(__FILE__), "../data/some-challenge.tar.gz"))
-      allow(response).to receive(:body).and_return(file_contents)
-      allow(response).to receive(:code).and_return("200")
-      allow(http).to receive(:request).and_return(response)
-      allow(Net::HTTP).to receive(:start).and_yield(http)
-
-      url = 'http://example.com/some-challenge.tar.gz'
+      url = "http://example.com/#{filename}"
 
       expect(api.download_file(url)).to eql(File.join(path, filename))
     end

data/spec/lib/fallback_connection_spec.rb

@@ -0,0 +1,42 @@
+describe ET::FallbackConnection do
+  let(:cnn) do
+    ET::FallbackConnection.new(:url => 'http://localhost')
+  end
+
+  context 'ssl verification' do
+    it 're-raises an exception for non Windows machines' do
+      dbl_os = double
+      allow(dbl_os).to receive(:platform_family?).with(:windows).and_return(false)
+      expect(ET::OperatingSystem).to receive(:new).and_return(dbl_os)
+
+      allow_any_instance_of(Faraday::Connection).
+        to receive(:get).and_raise(Faraday::SSLError.new(OpenSSL::SSL::SSLError))
+
+      expect{ cnn.open {|client| client.get('/') }}.
+        to raise_error(Faraday::SSLError)
+    end
+
+    it 'swallows the exception for windows machines and reissues' do
+      dbl_os = double
+      allow(dbl_os).to receive(:platform_family?).and_return(:windows)
+      allow(ET::OperatingSystem).to receive(:new).and_return(dbl_os)
+
+      called_twice = false
+      allow_any_instance_of(Faraday::Connection).to receive(:get) do |*args|
+        if args[0].ssl.verify != false
+          #simulate a windows SSL verification failed
+          raise Faraday::SSLError.new(OpenSSL::SSL::SSLError.new)
+        elsif args[0].ssl.verify == false
+          #flip the switch that the request was reissued without SSL verification
+          called_twice = true
+          double(:body => '{}')
+        end
+      end
+
+      cnn.open do |client|
+        client.get('/')
+      end
+      expect(called_twice).to be(true)
+    end
+  end
+end

data/spec/lib/lesson_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe ET::Lesson do
   context "archive! method" do
     it "creates a tar.gz file" do
-      path = '/tmp/et'
+      path = Dir.mktmpdir
       filename = 'fab'
 
       FileUtils.rm_rf(File.join(path, filename))

data/spec/lib/submission_file_list_spec.rb

@@ -0,0 +1,31 @@
+describe ET::SubmissionFileList do
+  let(:file_list) do
+    path = File.expand_path(File.join(
+      File.dirname(__FILE__), "../data/bloated-challenge"))
+    ET::SubmissionFileList.new(path)
+  end
+
+  it 'includes a relevant file' do
+    expect(file_list).to include('problem.rb')
+  end
+
+  it 'does not include .etignore' do
+    expect(file_list).to_not include('.etignore')
+  end
+
+  it 'ignores a standard file' do
+    expect(file_list).to_not include('sample-challenge.md')
+  end
+
+  it 'ignores a file included in the default globs' do
+    expect(file_list).to_not include('node_modules/somefile.js')
+  end
+
+  it 'ignores a file included in a glob' do
+    expect(file_list).to_not include('node_modules/boo/somefile.js')
+  end
+
+  it 'ignores a file included in .etignore' do
+    expect(file_list).to_not include('rando_folder/rando_file.js')
+  end
+end

data/spec/spec_helper.rb

@@ -49,9 +49,4 @@ RSpec.configure do |config|
   config.include SampleFiles
   config.include PathHelper
   config.include ArchiveHelper
-
-  config.before :each do
-    allow(Net::HTTP).to receive(:start)
-    allow(Net::HTTP).to receive(:get)
-  end
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: et
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.7.3
 platform: ruby
 authors:
 - Adam Sheehan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-15 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '3.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.11.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: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 description: |
   Users can download challenges and submit their solutions via the command-line
   interface.
@@ -103,8 +131,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
@@ -117,36 +148,41 @@ files:
 - lib/et.rb
 - lib/et/api.rb
 - lib/et/archive_manager.rb
-- lib/et/challenge.rb
 - lib/et/config.rb
-- lib/et/exercise.rb
+- lib/et/fallback_connection.rb
 - lib/et/formatter.rb
 - lib/et/lesson.rb
 - lib/et/operating_system.rb
 - lib/et/runner.rb
+- lib/et/submission_file_list.rb
 - lib/et/version.rb
 - spec/cli/get_lesson_spec.rb
 - spec/cli/init_spec.rb
 - spec/cli/list_lessons_spec.rb
-- spec/cli/run_exercise_test_suite_spec.rb
 - spec/cli/submit_lesson_spec.rb
+- spec/data/.et
+- spec/data/bloated-challenge/.etignore
+- spec/data/bloated-challenge/bloated-challenge.md
+- spec/data/bloated-challenge/node_modules/boo/somefile.js
+- spec/data/bloated-challenge/problem.rb
+- spec/data/bloated-challenge/rando_folder/rando_file.js
 - spec/data/challenge.json
 - spec/data/lessons.json
-- spec/data/sample-challenge/.lesson.yml
+- spec/data/sample-challenge/.etignore
 - spec/data/sample-challenge/problem.rb
 - spec/data/sample-challenge/sample-challenge.md
-- spec/data/sample-exercise/.lesson.yml
+- spec/data/sample-exercise/.etignore
 - spec/data/sample-exercise/lib/sample_exercise.rb
 - spec/data/sample-exercise/sample-exercise.md
 - spec/data/sample-exercise/test/sample_exercise_test.rb
 - spec/data/some-challenge.tar.gz
 - spec/lib/api_spec.rb
 - spec/lib/archive_manager_spec.rb
-- spec/lib/challenge_spec.rb
 - spec/lib/config_spec.rb
-- spec/lib/exercise_spec.rb
+- spec/lib/fallback_connection_spec.rb
 - spec/lib/lesson_spec.rb
 - spec/lib/operating_system_spec.rb
+- spec/lib/submission_file_list_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers/archive_helper.rb
 - spec/support/helpers/output_catcher.rb
@@ -172,8 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Command-line interface for the event horizon.