learn-web 1.4.2 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cc308f49592f2e41a32e55ca66775179c0005229
-  data.tar.gz: d0aeda72be382ddefe580305da9f74980cc12f3a
+SHA256:
+  metadata.gz: ec078990d4dcddf3adef7d79ce20173b3fceefa8d532a233815b201a7e438981
+  data.tar.gz: 60c81b6a5376959e57bc203435feeab2c6dd67fbbe11c7105165b8c51ec77a5d
 SHA512:
-  metadata.gz: 6e8734904056d93f9577dbe8e1abe6f469820196de4c22861a248fe6505b5648946510a345f78843beeacbc42c9f4c445143d73d5de766df2e197982d1e5ec72
-  data.tar.gz: 2a96746b4ddd6b8d03bc32585cb20ed2030488421a5863e157c8ec647fd5c4f5bba997b8fde51a59c66077f4c19be3b11c249310d759089d9316d8c18c75549a
+  metadata.gz: c61fb11426b1d65f09fc352546faad5cc5f4dbad39c295cfdb9cb7361cdc5004fb8de84713e7409f054d6053fdf05c04a06b2411bb068bd54b23c50ce4b21742
+  data.tar.gz: 14e1e45098299de376b206b162286620f93c6e1ae26fecf2c34aa95f4a42195a03a216369dd548c2b12af7d338b0669f5ff149ad58d298f1654ce37c92c790e9

data/.gitignore

@@ -12,3 +12,6 @@
 *.o
 *.a
 mkmf.log
+
+# built copies of the gem
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Guardfile

@@ -0,0 +1,42 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/Rakefile

@@ -1,2 +1,7 @@
 require "bundler/gem_tasks"
 
+task :console do
+  require 'pry'
+  load 'lib/learn_web.rb'
+  Pry.start
+end

data/learn-web.gemspec

@@ -19,7 +19,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.11.3"
+  spec.add_development_dependency "rspec", "~> 3.8.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.7.0"
 
   spec.add_runtime_dependency "faraday", "~> 0.9"
-  spec.add_runtime_dependency "oj", "~> 2.9"
+  spec.add_runtime_dependency "oj", "~> 3.10"
 end

data/lib/learn_web/client.rb

@@ -6,12 +6,14 @@ require 'learn_web/client/lesson'
 require 'learn_web/client/validate_repo'
 require 'learn_web/client/fork'
 require 'learn_web/client/environment'
+require 'learn_web/client/event'
+require 'learn_web/client/ssh_keys'
 
 module LearnWeb
   class Client
     attr_reader :token, :conn, :silent_output
 
-    LEARN_URL = 'https://learn.co'
+    LEARN_URL = ENV.fetch('LEARN_CO_URL', 'https://learn.co').freeze
     API_ROOT  = '/api/v1'
 
     include LearnWeb::Client::Request
@@ -22,6 +24,8 @@ module LearnWeb
     include LearnWeb::Client::Fork
     include LearnWeb::Client::User
     include LearnWeb::Client::Environment
+    include LearnWeb::Client::Event
+    include LearnWeb::Client::SshKeys
 
     def initialize(token:, silent_output: false)
       @token = token

data/lib/learn_web/client/event.rb

@@ -0,0 +1,31 @@
+require 'learn_web/client/event/submission'
+
+module LearnWeb
+  class Client
+    module Event
+      attr_reader :client
+
+      IRONBROKER_URL = 'http://ironbroker-v2.flatironschool.com'
+
+      def client
+        @client ||= Faraday.new(url: IRONBROKER_URL) do |faraday|
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+
+      def submission_endpoint
+        '/e/learn_gem'
+      end
+
+      def submit_event(params)
+        response = post(
+          submission_endpoint,
+          body: params,
+          client: client
+        )
+
+        LearnWeb::Client::Event::Submission.new(response)
+      end
+    end
+  end
+end

data/lib/learn_web/client/event/submission.rb

@@ -0,0 +1,19 @@
+module LearnWeb
+  class Client
+    module Event
+      class Submission
+        attr_reader   :response
+        attr_accessor :data
+
+        include LearnWeb::AttributePopulatable
+        include LearnWeb::ResponseParsable
+
+        def initialize(response)
+          @response = response
+
+          parse!
+        end
+      end
+    end
+  end
+end

data/lib/learn_web/client/lesson/current_lesson.rb

@@ -4,7 +4,7 @@ module LearnWeb
       class CurrentLesson
         attr_reader   :response
         attr_accessor :data, :id, :title, :link, :github_repo, :forked_repo,
-                      :assessments, :lab
+                      :clone_repo, :assessments, :lab, :dot_learn
 
         include LearnWeb::AttributePopulatable
         include LearnWeb::ResponseParsable

data/lib/learn_web/client/lesson/next_lesson.rb

@@ -4,7 +4,7 @@ module LearnWeb
       class NextLesson
         attr_reader   :response
         attr_accessor :data, :id, :title, :link, :github_repo, :forked_repo,
-                      :assessments, :lab
+                      :clone_repo, :assessments, :lab, :dot_learn
 
         include LearnWeb::AttributePopulatable
         include LearnWeb::ResponseParsable

data/lib/learn_web/client/request.rb

@@ -6,7 +6,8 @@ module LearnWeb
 
       def request(method, url, options = {})
         begin
-          @conn.send(method) do |req|
+          connection = options[:client] || @conn
+          connection.send(method) do |req|
             req.url url
             build_request(req, options)
           end
@@ -18,6 +19,7 @@ module LearnWeb
       def build_request(request, options)
         build_headers(request, options[:headers])
         build_params(request, options[:params])
+        build_body(request, options[:body])
       end
 
       def build_headers(request, headers)
@@ -35,6 +37,12 @@ module LearnWeb
           end
         end
       end
+
+      def build_body(request, body)
+        if body
+          request.body = Oj.dump(body, mode: :compat)
+        end
+      end
     end
   end
 end

data/lib/learn_web/client/ssh_keys.rb

@@ -0,0 +1,22 @@
+require 'learn_web/client/ssh_keys/add'
+
+module LearnWeb
+  class Client
+    module SshKeys
+      def add_ssh_key_endpoint
+        "#{API_ROOT}/ssh_keys"
+      end
+
+      def add_ssh_key(key:, key_title: nil, client: nil)
+        response = post(
+          add_ssh_key_endpoint,
+          headers: { 'Authorization' => "Bearer #{token}" },
+          params: { 'key' => key, key_title: key_title }.reject { |_, v| v.nil? },
+          client: client
+        )
+
+        LearnWeb::Client::SshKeys::Add.new(response).parse!
+      end
+    end
+  end
+end

data/lib/learn_web/client/ssh_keys/add.rb

@@ -0,0 +1,35 @@
+module LearnWeb
+  class Client
+    module SshKeys
+      class Add
+        attr_reader :response
+        attr_accessor :data
+
+        include LearnWeb::AttributePopulatable
+
+        def initialize(response)
+          @response = response
+        end
+
+        def parse!
+          if response.status == 200
+            self.data = Oj.load(response.body, symbol_keys: true)
+
+            populate_attributes!
+            self
+          else
+            case response.status
+            when 304
+              puts "This key is already in use."
+            when 422
+              puts "Something went wrong. Please try again."
+            else
+              puts "Something went wrong. Please try again."
+            end
+            :error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/learn_web/client/validate_repo/slug.rb

@@ -2,7 +2,8 @@ module LearnWeb
   class Client
     module ValidateRepo
       class Slug
-        attr_accessor :data, :repo_slug, :lab, :lesson_id, :later_lesson
+        attr_accessor :data, :repo_slug, :lab, :lesson_id, :later_lesson,
+                      :repo_name, :dot_learn
         attr_reader   :response
 
         include AttributePopulatable

data/lib/learn_web/version.rb

@@ -1,3 +1,3 @@
 module LearnWeb
-  VERSION = '1.4.2'
+  VERSION = '1.5.4'
 end

data/spec/learn_web/client_spec.rb

@@ -0,0 +1,73 @@
+require 'json'
+
+RSpec.describe LearnWeb::Client do
+  context "Constants" do
+    it "sets the LEARN_URL to learn.co" do
+      expect(LearnWeb::Client::LEARN_URL).to eq("https://learn.co")
+    end
+
+    it "sets the API_ROOT to the root" do
+      expect(LearnWeb::Client::API_ROOT).to eq("/api/v1")
+    end
+  end
+
+  context "Adding an ssh key" do
+    let(:headers) { {} }
+    let(:params) { {} }
+    let(:req_double) { double("request double", headers: headers, params: params) } # Faraday's weird api 
+    let(:web_client) { double }
+    let(:client) { LearnWeb::Client.new(token: "mytoken") }
+
+    before do
+      allow(req_double).to receive(:url).with("/api/v1/ssh_keys")
+    end
+
+    it "correctly makes the request" do
+      expect(web_client).to receive(:post)
+        .and_yield(req_double)
+        .and_return(double(status: 200, body: {message: "Success"}.to_json))
+      client.add_ssh_key(key: "a valid ssh key", key_title: "LearnWeb Test Suite", client: web_client)
+
+      expect(headers).to eq({"Authorization"=>"Bearer mytoken"})
+      expect(params).to eq({"key"=>"a valid ssh key", :key_title=>"LearnWeb Test Suite"})
+    end
+
+    it "does not send a key title if not provided" do
+      expect(web_client).to receive(:post)
+        .and_yield(req_double)
+        .and_return(double(status: 200, body: {message: "Success"}.to_json))
+
+      client.add_ssh_key(key: "a valid ssh key", client: web_client)
+
+      expect(headers).to eq({"Authorization"=>"Bearer mytoken"})
+      expect(params).to eq({"key"=>"a valid ssh key"})
+    end
+    
+    it "prints info on 304" do
+      expect(web_client).to receive(:post)
+        .and_yield(req_double)
+        .and_return(double(status: 304, body: {message: "womp"}.to_json))
+      expect do
+        client.add_ssh_key(key: "a valid ssh key", client: web_client)
+      end.to output("This key is already in use.\n").to_stdout
+
+    end
+    it "prints info on 422" do
+      expect(web_client).to receive(:post)
+        .and_yield(req_double)
+        .and_return(double(status: 422, body: {message: "womp"}.to_json))
+      expect do
+        client.add_ssh_key(key: "a valid ssh key", client: web_client)
+      end.to output("Something went wrong. Please try again.\n").to_stdout
+    end
+
+    it "prints info on anything else" do
+      expect(web_client).to receive(:post)
+        .and_yield(req_double)
+        .and_return(double(status: 418, body: {message: "womp"}.to_json))
+      expect do
+        client.add_ssh_key(key: "a valid ssh key", client: web_client)
+      end.to output("Something went wrong. Please try again.\n").to_stdout
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$: << '.'
+require 'lib/learn_web'
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: learn-web
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.4
 platform: ruby
 authors:
 - Flatiron School
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-09-28 00:00:00.000000000 Z
+date: 2020-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -58,15 +100,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
-description: 
+        version: '3.10'
+description:
 email:
 - learn@flatironschool.com
 executables: []
@@ -74,7 +116,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -86,6 +130,8 @@ files:
 - lib/learn_web/client/environment.rb
 - lib/learn_web/client/environment/setup_list.rb
 - lib/learn_web/client/environment/verification.rb
+- lib/learn_web/client/event.rb
+- lib/learn_web/client/event/submission.rb
 - lib/learn_web/client/fork.rb
 - lib/learn_web/client/fork/request.rb
 - lib/learn_web/client/lesson.rb
@@ -95,17 +141,21 @@ files:
 - lib/learn_web/client/pull_request.rb
 - lib/learn_web/client/pull_request/response.rb
 - lib/learn_web/client/request.rb
+- lib/learn_web/client/ssh_keys.rb
+- lib/learn_web/client/ssh_keys/add.rb
 - lib/learn_web/client/user.rb
 - lib/learn_web/client/user/me.rb
 - lib/learn_web/client/validate_repo.rb
 - lib/learn_web/client/validate_repo/slug.rb
 - lib/learn_web/response_parsable.rb
 - lib/learn_web/version.rb
+- spec/learn_web/client_spec.rb
+- spec/spec_helper.rb
 homepage: https://learn.co
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,9 +170,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: An interface to Learn.co
-test_files: []
+test_files:
+- spec/learn_web/client_spec.rb
+- spec/spec_helper.rb