et 0.5.8 → 0.7.2

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.6.3

data/Gemfile.lock

@@ -1,39 +1,44 @@
 PATH
   remote: .
   specs:
-    et (0.5.8)
+    et (0.6.2)
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.10)
       gli (= 2.11.0)
       multipart-post (~> 2.0)
+      rake (~> 10)
       rspec (~> 3.0)
       rspec-mocks (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.1)
-    diff-lcs (1.2.5)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.14.0)
+      faraday (>= 0.7.4, < 1.0)
     gli (2.11.0)
-    method_source (0.8.2)
-    multipart-post (2.0.0)
-    pry (0.10.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (10.5.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    slop (3.6.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
 
 PLATFORMS
   ruby
@@ -41,7 +46,6 @@ PLATFORMS
 DEPENDENCIES
   et!
   pry (~> 0)
-  rake (~> 10)
 
 BUNDLED WITH
-   1.12.5
+   1.17.2

data/README.md

@@ -28,3 +28,20 @@ COMMANDS
     submit - Submit the lesson in this directory.
     test   - Run an exercise test suite.
 ```
+
+### Releasing New Versions
+
+Bundler provided `gem_tasks` have been incorporated into this libraries
+`Rakefile`. Thankfully these tasks make releasing new gem versions a snap!
+
+To release a new version of this gem:
+
+1. Bump the version according to [semantic versioning](http://semver.org/)
+2. Perform a git commit
+3. Run `rake release` from the project root
+
+Bundler's provided rake task will appropriately push a tag to GitHub and the gem
+itself to [rubygems.org](https://rubygems.org)
+
+_Note:_ in order to release the gem you must be an authorized owner of it on
+[rubygems.org](https://rubygems.org)

data/et.gemspec

@@ -15,14 +15,15 @@ DESC
 
   s.files = `git ls-files`.split("\n")
   s.require_paths << "lib"
-  s.has_rdoc = false
   s.bindir = "bin"
   s.executables << "et"
   s.license = "MIT"
-  s.add_development_dependency("rake", "~> 10")
   s.add_development_dependency("pry", '~> 0')
   s.add_runtime_dependency("rspec", "~> 3.0")
+  s.add_runtime_dependency("rake", "~> 10")
   s.add_runtime_dependency("rspec-mocks", "~> 3.0")
   s.add_runtime_dependency("multipart-post", "~> 2.0")
   s.add_runtime_dependency("gli", "2.11.0")
+  s.add_runtime_dependency("faraday", "~> 0.9")
+  s.add_runtime_dependency("faraday_middleware", "~> 0.10")
 end

data/lib/et.rb

@@ -3,6 +3,7 @@ require_relative "et/version"
 require_relative "et/runner"
 require_relative "et/operating_system"
 require_relative "et/api"
+require_relative "et/submission_file_list"
 require_relative "et/config"
 require_relative "et/formatter"
 require_relative "et/lesson"

data/lib/et/api.rb

@@ -1,9 +1,9 @@
-require "net/http/post/multipart"
 require "securerandom"
 require "base64"
 require "json"
 require "openssl"
 
+require_relative "fallback_connection"
 module ET
   class API
     attr_reader :host, :username, :token
@@ -15,30 +15,29 @@ module ET
     end
 
     def list_lessons
-      request = Net::HTTP::Get.new(lessons_url)
-      request["Authorization"] = auth_header
-
-      response = issue_request(request)
-      JSON.parse(response.body, symbolize_names: true)[:lessons]
+      response = nil
+      api_client.open do |client|
+        response = client.get('/lessons.json', :submittable => 1)
+      end
+      response.body['lessons']
     end
 
     def get_lesson(slug)
-      request = Net::HTTP::Get.new(lesson_url(slug))
-      request["Authorization"] = auth_header
-
-      response = issue_request(request)
-
-      body = JSON.parse(response.body, symbolize_names: true)
-      body[:lesson]
+      resp = nil
+      api_client.open do |client|
+        resp = client.get(lesson_url(slug), :submittable => 1)
+      end
+      resp.body['lesson']
     end
 
     def download_file(url)
-      uri = URI(url)
+      response = nil
       dest = random_filename
 
-      request = Net::HTTP::Get.new(uri.path)
-      response = issue_request(request, url)
-      if response.code == "200"
+      download_client(url).open do |client|
+        response = client.get(URI(url).path)
+      end
+      if response.status == 200
         open(dest, 'wb') do |file|
           file.write(response.body)
         end
@@ -50,66 +49,47 @@ module ET
 
     def submit_lesson(lesson)
       submission_file = lesson.archive!
-      url = submission_url(lesson.slug)
-
-      File.open(submission_file) do |f|
-        request = Net::HTTP::Post::Multipart.new(url.path,
-          "submission[archive]" => UploadIO.new(f, "application/x-tar", "archive.tar.gz"))
-        request["Authorization"] = auth_header
-
-        issue_request(request)
+      io = Faraday::UploadIO.new(submission_file, "application/x-tar")
+      resp = nil
+      api_client.open do |client|
+        resp = client.post(submission_url(lesson.slug),
+          "submission" => { "archive" => io})
       end
+      resp
     end
 
     private
-    def issue_request(request, url = nil)
-      uri = URI.parse(url || @host)
-      begin
-        Net::HTTP.start(uri.host, uri.port,
-          use_ssl: uri.scheme == "https") do |http|
-
-          http.request(request)
-        end
-      rescue OpenSSL::SSL::SSLError => e
-        if operating_system.platform_family?(:windows)
-          https = Net::HTTP.new(uri.host, uri.port)
-          https.verify_mode = OpenSSL::SSL::VERIFY_NONE
-          https.use_ssl = uri.scheme == 'https'
-          https.start do |http|
-            http.request(request)
-          end
-        else
-          raise e
-        end
-      end
-    end
-
     def lesson_url(slug)
-      URI.join(host, "lessons/#{slug}.json?submittable=1")
-    end
-
-    def lessons_url
-      URI.join(host, "lessons.json?submittable=1")
+      "/lessons/#{slug}.json"
     end
 
     def submission_url(slug)
-      URI.join(host, "lessons/#{slug}/submissions.json")
+      "/lessons/#{slug}/submissions.json"
     end
 
     def random_filename
       File.join(Dir.mktmpdir, SecureRandom.hex)
     end
 
-    def credentials
-      Base64.strict_encode64("#{username}:#{token}")
-    end
+    def api_client
+      @api_client ||= ET::FallbackConnection.new(:url => @host) do |client|
+        client.request :multipart
 
-    def auth_header
-      "Basic #{credentials}"
+        client.request :url_encoded
+        client.request :basic_auth, username, token
+
+        client.response :json, :content_type => /\bjson$/
+
+        client.adapter  Faraday.default_adapter
+      end
     end
 
-    def operating_system
-      @os ||= ET::OperatingSystem.new
+    def download_client(url)
+      uri = URI(url)
+      scheme_and_host = [uri.scheme, uri.host].join('://')
+      ET::FallbackConnection.new(:url => scheme_and_host) do |client|
+        client.adapter  Faraday.default_adapter
+      end
     end
   end
 end

data/lib/et/fallback_connection.rb

@@ -0,0 +1,29 @@
+require "faraday"
+require "faraday_middleware"
+
+module ET
+  class FallbackConnection
+    def initialize(opts = {}, &block)
+      @connection = Faraday.new(opts, &block)
+
+      @fallback_connection = Faraday.new(opts.merge(:ssl => {:verify => false}), &block)
+    end
+
+    def open(&block)
+      begin
+        block.call(@connection)
+      rescue Faraday::SSLError => e
+        if operating_system.platform_family?(:windows)
+          block.call(@fallback_connection)
+        else
+          raise e
+        end
+      end
+    end
+
+    private
+    def operating_system
+      @os ||= ET::OperatingSystem.new
+    end
+  end
+end

data/lib/et/lesson.rb

@@ -17,16 +17,16 @@ module ET
         File.open(filepath, "wb") do |file|
           Zlib::GzipWriter.wrap(file) do |gz|
             Gem::Package::TarWriter.new(gz) do |tar|
-              Dir.glob(File.join(dir, "**/*")).each do |file|
-                relative_path = file.gsub(dir + "/", "")
-                if !ignored_files.include?(relative_path)
-                  if FileTest.directory?(file)
-                    tar.mkdir(relative_path, 0755)
-                  else
-                    file_contents = File.read(file)
-                    tar.add_file_simple("./" + relative_path, 0555, file_contents.length) do |io|
-                      io.write(file_contents)
-                    end
+              ET::SubmissionFileList.new(dir).each do |file|
+                relative_path = file
+                absolute_path = File.join(dir, file)
+
+                if FileTest.directory?(absolute_path)
+                  tar.mkdir(relative_path, 0755)
+                else
+                  file_contents = File.read(absolute_path)
+                  tar.add_file_simple("./" + relative_path, 0555, file_contents.bytesize) do |io|
+                    io.write(file_contents)
                   end
                 end
               end
@@ -51,10 +51,6 @@ module ET
       !dir.nil?
     end
 
-    def ignored_files
-      (config["ignore"] || []) + [".lesson.yml"]
-    end
-
     protected
 
     def config

data/lib/et/runner.rb

@@ -40,7 +40,7 @@ module ET
       desc "List available lessons."
       command :list do |c|
         c.action do |_global_options, _options, _cmdargs|
-          Formatter.print_table(api.list_lessons, :slug, :title, :type)
+          Formatter.print_table(api.list_lessons, 'slug', 'title', 'type')
         end
       end
 
@@ -49,7 +49,7 @@ module ET
         c.action do |_global_options, _options, cmdargs|
           cmdargs.each do |slug|
             lesson = api.get_lesson(slug)
-            archive = api.download_file(lesson[:archive_url])
+            archive = api.download_file(lesson['archive_url'])
             archive_manager = ET::ArchiveManager.new(archive, cwd)
             archive_manager.unpack
 

data/lib/et/submission_file_list.rb

@@ -0,0 +1,57 @@
+require "rake/file_list"
+
+module ET
+  class SubmissionFileList
+    include Enumerable
+    DEFAULT_IGNORE_GLOBS = [
+      '.lesson.yml',
+      'node_modules/'
+    ]
+
+    def initialize(path)
+      @path = path
+    end
+
+    def files
+      unless @files
+        @files = Rake::FileList[File.join(@path, "**/*"), File.join(@path, ".etignore")]
+        ignore_globs.each do |glob|
+          filename = File.join(@path, glob)
+
+          if File.directory?(filename)
+            filename += glob.end_with?("/") ? "**/*" : "/**/*"
+          end
+
+          @files = @files.exclude(filename)
+        end
+        @files = @files.sub(File.join(@path, "/"), "")
+      end
+
+      @files
+    end
+
+    def each(&block)
+      files.each do |file|
+        block.call(file)
+      end
+    end
+
+    protected
+    def ignore_globs
+      etignore_globs + [] + DEFAULT_IGNORE_GLOBS
+    end
+
+    def etignore_globs
+      unless @etignore_globs
+        etignore = File.join(@path, '.etignore')
+        if FileTest.exists?(etignore)
+          @etignore_globs = File.read(etignore).split(/\n/)
+          @etignore_globs.delete_if { | string | string.start_with?("#") || string.empty?}
+        else
+          @etignore_globs = []
+        end
+      end
+      @etignore_globs
+    end
+  end
+end

data/lib/et/version.rb

@@ -1,3 +1,3 @@
 module ET
-  VERSION = "0.5.8"
+  VERSION = "0.7.2"
 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