cm_quiz 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 585a0921ebed80326688cb91ff8013ff6ddc4ed9
-  data.tar.gz: cd95c080f6df5609da4e8143bf0078a07d6a9ea9
+  metadata.gz: 05e2c72f987b0c04158a61993591da384cd1f0e5
+  data.tar.gz: 847897a6eab4c72fc4f84f12a4af4a80187b281e
 SHA512:
-  metadata.gz: b830953bf369a52a64ea2589ffe8f82e8a27ae969e099879377ddc7053154dc9d4b58ffe42a7da4889951e17191b22aac6c80a447e7a9d2e2551eb59963a8bcb
-  data.tar.gz: fd20b47a3ba61678153cd8a0c44f935cc70d1565a42716d346aa5f80f3a1695824b6aa319f509aba09492523fb57657ed1b0bb44d361c80195f3f674738ed26c
+  metadata.gz: f6e1caeeb432906d67a89bb1d4a8a493e1de93d854d89923e74014602e825de3ec86aa8352f88f9b1bdcce7dfbf42492fea95df20e90c1439467c4249132d60c
+  data.tar.gz: 087e45d145073f562af0f6be931ee5b1ecee092c9bc31417521da847292614f398f2318532aa4b436833c7cf61681901f276923317735492ab25371dc1732cb4

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    cm_quiz (0.0.1)
-      httparty
-      rspec
+    cm_quiz (0.0.2)
+      httparty (~> 0.15.6)
+      rspec (~> 3.6)
       thor (~> 0.19.4)
 
 GEM
@@ -52,7 +52,7 @@ PLATFORMS
 DEPENDENCIES
   cm_quiz!
   pry
-  webmock
+  webmock (~> 3.0)
 
 BUNDLED WITH
    1.15.0

data/README.md

@@ -1,15 +1,32 @@
 # cm-quiz
+> A CLI tool to review your CodementorX project
 
-## How to install
+## Installation💻
+Make sure you have a working Ruby environment (2.3 or later is required).
 
+### Install Ruby using [RVM](https://rvm.io/) (for those with older versions of Ruby)
 ```sh
 $ ruby -v
-# Make sure your ruby version is at least 2.3.0
+# Make sure your Ruby version is at least 2.3.0, below will demo how to install required Ruby version
 
+$ curl -sSL https://get.rvm.io | bash -s stable
+
+# restart your terminal
+
+$ rvm install 2.3.0
+$ rvm use 2.3.0
+```
+
+
+### Install `cm-quiz`
+```sh
 $ gem install cm_quiz
 ```
 
-## How to use
+
+## Start review your quiz🕵️
 ```sh
-$ cm-quiz test --endpoint=your-test-endpoint.com
-```
+$ cm-quiz test --endpoint=https://your-test-endpoint.com
+```
+
+

data/lib/cm_quiz/cli.rb

@@ -15,7 +15,9 @@ module CmQuiz
     def test
       endpoint = options[:endpoint]
       puts "Start test #{endpoint}"
+      puts "please wait..."
       message = CmQuiz::ReviewQuiz.new(endpoint).perform
+
       puts message
     end
   end

data/lib/cm_quiz/factory/idea.rb

@@ -26,6 +26,8 @@ module CmQuiz
 
         res = @project_api.request(:post, '/ideas', options)
         JSON.parse(res.body)
+      rescue => e
+        raise StandardError, "Create test idea failed, reason: #{e.message}"
       end
     end
   end

data/lib/cm_quiz/factory/user.rb

@@ -22,6 +22,8 @@ module CmQuiz
         res = @project_api.request(:post, '/users', options)
         payload = JSON.parse(res.body)
         [payload['jwt'], payload['refresh_token']]
+      rescue => e
+        raise StandardError, "Create test user failed, reason: #{e.message}"
       end
     end
   end

data/lib/cm_quiz/review/base_review.rb

@@ -3,6 +3,7 @@ require 'cm_quiz/review_helper'
 module CmQuiz
   module Review
     class BaseReview
+      attr_reader :verb, :path, :options
       include ReviewHelper
 
       def perform
@@ -18,6 +19,10 @@ module CmQuiz
         raise "Method `run` should be implemented on class #{self.class}"
       end
 
+      def build_test_result(test_case, passed = true, message = nil)
+        [test_case, passed, message]
+      end
+
       def test_request
         {
           verb: @verb,

data/lib/cm_quiz/review/create_idea.rb

@@ -30,7 +30,7 @@ module CmQuiz
       private
 
       def send_create_idea_request(jwt:, content:, impact:, ease:, confidence:)
-        options = {
+        @options = {
           headers: {
             'x-access-token' => jwt
           },
@@ -42,7 +42,7 @@ module CmQuiz
           }
         }
 
-        @project_api.request(@verb, @path, options)
+        @project_api.request(@verb, @path, @options)
       end
     end
   end

data/lib/cm_quiz/review/delete_idea.rb

@@ -27,13 +27,14 @@ module CmQuiz
       private
 
       def send_delete_idea_request(jwt:, idea_id:)
-        options = {
+        @options = {
           headers: {
             'x-access-token' => jwt
           }
         }
 
-        @project_api.request(:delete, "/ideas/#{idea_id}", options)
+        @path = "/ideas/#{idea_id}"
+        @project_api.request(:delete, @path, @options)
       end
 
       def send_get_ideas_request(jwt:)

data/lib/cm_quiz/review/get_ideas.rb

@@ -46,18 +46,8 @@ module CmQuiz
 
       private
 
-      def send_delete_idea_request(jwt:, idea_id:)
-        options = {
-          headers: {
-            'x-access-token' => jwt
-          }
-        }
-
-        @project_api.request(:delete, "/ideas/#{idea_id}", options)
-      end
-
       def send_get_ideas_request(jwt:, page: 1)
-        options = {
+        @options = {
           headers: {
             'x-access-token' => jwt
           },
@@ -66,7 +56,7 @@ module CmQuiz
           }
         }
 
-        @project_api.request(@verb, @path, options)
+        @project_api.request(@verb, @path, @options)
       end
     end
   end

data/lib/cm_quiz/review/get_user_info.rb

@@ -30,13 +30,13 @@ module CmQuiz
       private
 
       def send_get_user_info_request(jwt:)
-        options = {
+        @options = {
           headers: {
             'x-access-token' => jwt
           }
         }
 
-        @project_api.request(@verb, @path, options)
+        @project_api.request(@verb, @path, @options)
       end
     end
   end

data/lib/cm_quiz/review/login_user.rb

@@ -26,6 +26,8 @@ module CmQuiz
 
         expect(payload['jwt'].class).to eq(String), '`jwt` should be string'
         expect(payload['refresh_token'].class).to eq(String), '`refresh_token` should be string'
+      rescue => e
+        build_test_result(self.class, false, e.message)
       end
 
       private

data/lib/cm_quiz/review/sign_up_user.rb

@@ -28,7 +28,7 @@ module CmQuiz
       private
 
       def send_sign_up_user_request(email:, name:, password:)
-        options = {
+        @options = {
           body: {
             email: email,
             name: name,
@@ -36,7 +36,7 @@ module CmQuiz
           }
         }
 
-        @project_api.request(@verb, @path, options)
+        @project_api.request(@verb, @path, @options)
       end
     end
   end

data/lib/cm_quiz/review/update_idea.rb

@@ -36,20 +36,10 @@ module CmQuiz
 
       private
 
-      def send_delete_idea_request(jwt:, idea_id:)
-        options = {
-          headers: {
-            'x-access-token' => jwt
-          }
-        }
-
-        @project_api.request(:delete, "/ideas/#{idea_id}", options)
-      end
-
       def send_update_idea_request(jwt:, idea_id:, content: nil, impact: nil,
         ease: nil, confidence: nil)
 
-        options = {
+        @options = {
           headers: {
             'x-access-token' => jwt
           },
@@ -60,8 +50,9 @@ module CmQuiz
             confidence: confidence
           }
         }
+        @path = "/ideas/#{idea_id}"
 
-        @project_api.request(:put, "/ideas/#{idea_id}", options)
+        @project_api.request(:put, @path, @options)
       end
 
     end

data/lib/cm_quiz/review_helper.rb

@@ -17,9 +17,5 @@ module CmQuiz
     def be_within(delta)
       RSpec::Matchers::BuiltIn::BeWithin.new(delta)
     end
-
-    def build_test_result(test_case, passed = true, message = nil)
-      [test_case, passed, message]
-    end
   end
 end

data/lib/cm_quiz/review_quiz.rb

@@ -29,11 +29,17 @@ module CmQuiz
     def build_message(test_results, endpoint)
       score, failed_results = arrange_results(test_results)
       example_messages = failed_results.map do |result|
-        # m = (result[0].to_s + ": " + result[2].to_s)
         verb = result[0][:verb].upcase
         path = result[0][:path]
         options = result[0][:options]
-        messages = ["#{verb} #{@endpoint}#{path}"]
+        passed = result[1]
+        messages = ["===#{verb} #{@endpoint}#{path}==="]
+        messages << ""
+        messages << "HTTP method:"
+        messages << verb
+        messages << ""
+        messages << "Url:"
+        messages << "#{@endpoint}#{path}"
         messages << ""
         messages << "Request options:"
         messages << ""
@@ -43,7 +49,7 @@ module CmQuiz
         messages << ""
         error_message = result[2].to_s
         error_message = error_message.truncate(500) + '...' if error_message.size > 500
-        messages << error_message
+        messages << error_message + "\n"
 
         messages.join("\n")
       end

data/lib/cm_quiz/version.rb

@@ -1,3 +1,3 @@
 module CmQuiz
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/lib/cm_quiz/review/create_idea_spec.rb

@@ -31,20 +31,7 @@ RSpec.describe CmQuiz::Review::CreateIdea do
     it "should pass test" do
       test_result = service.perform
 
-      expect(test_result).to eq(["post /ideas", true, nil])
-      options = {
-        headers: {
-          'x-access-token' => 'jwt'
-        },
-        body: {
-          content: mock_idea[:content],
-          impact: mock_idea[:impact],
-          ease: mock_idea[:ease],
-          confidence: mock_idea[:confidence]
-        }
-      }
-      args = [:post, '/ideas', options]
-      expect(project_api).to have_received(:request).with(*args)
+      assert_test_case(service, test_result)
     end
   end
 end

data/spec/lib/cm_quiz/review/delete_idea_spec.rb

@@ -34,14 +34,7 @@ RSpec.describe CmQuiz::Review::DeleteIdea do
     it "should pass test" do
       test_result = service.perform
 
-      expect(test_result).to eq(["delete /ideas/:idea_id", true, nil])
-      options = {
-        headers: {
-          'x-access-token' => 'jwt'
-        }
-      }
-      args = [:delete, "/ideas/#{idea_id}", options]
-      expect(project_api).to have_received(:request).with(*args)
+      assert_test_case(service, test_result)
     end
   end
 end

data/spec/lib/cm_quiz/review/get_ideas_spec.rb

@@ -49,17 +49,7 @@ RSpec.describe CmQuiz::Review::GetIdeas do
     it "should pass test" do
       test_result = service.perform
 
-      expect(test_result).to eq(["get /ideas", true, nil])
-      options = {
-        headers: {
-          'x-access-token' => 'jwt'
-        },
-        query: {
-          page: 1
-        }
-      }
-      args = [:get, "/ideas", options]
-      expect(project_api).to have_received(:request).with(*args)
+      assert_test_case(service, test_result)
     end
   end
 end

data/spec/lib/cm_quiz/review/get_user_info_spec.rb

@@ -26,14 +26,7 @@ RSpec.describe CmQuiz::Review::GetUserInfo do
     it "should pass test" do
       test_result = service.perform
 
-      expect(test_result).to eq(["get /me", true, nil])
-      options = {
-        headers: {
-          'x-access-token' => 'jwt'
-        }
-      }
-      args = [:get, '/me', options]
-      expect(project_api).to have_received(:request).with(*args)
+      assert_test_case(service, test_result)
     end
   end
 end

data/spec/lib/cm_quiz/review/login_user_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe CmQuiz::Review::LoginUser do
     it "should pass test" do
       test_result = service.perform
 
-      expect(test_result).to eq(["post /access-tokens", true, nil])
+      assert_test_case(service, test_result)
     end
   end
 end

data/spec/lib/cm_quiz/review/sign_up_user_spec.rb

@@ -18,7 +18,7 @@ describe CmQuiz::Review::SignUpUser do
     it "should pass test" do
       test_result = service.perform
 
-      expect(test_result).to eq(["post /users", true, nil])
+      assert_test_case(service, test_result)
     end
   end
 end

data/spec/lib/cm_quiz/review/update_idea_spec.rb

@@ -39,20 +39,7 @@ RSpec.describe CmQuiz::Review::UpdateIdea do
     it "should pass test" do
       test_result = service.perform
 
-      expect(test_result).to eq(["put /ideas/:idea_id", true, nil])
-      options = {
-        headers: {
-          'x-access-token' => 'jwt'
-        },
-        body: {
-          content: mock_idea[:content],
-          impact: mock_idea[:impact],
-          ease: mock_idea[:ease],
-          confidence: mock_idea[:confidence]
-        }
-      }
-      args = [:put, "/ideas/#{idea_id}", options]
-      expect(project_api).to have_received(:request).with(*args)
+      assert_test_case(service, test_result)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,13 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../support', __FILE__)
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 require 'rubygems'
 require 'webmock/rspec'
 require 'cm_quiz'
-require 'pry'
+require 'pry'
+
+RSpec.configure do |config|
+  config.include AssertTestCase
+end

data/spec/support/assert_test_case.rb

@@ -0,0 +1,12 @@
+module AssertTestCase
+  def assert_test_case(service, test_result)
+    test_case = {
+      verb: service.verb,
+      path: service.path,
+      options: service.options
+    }
+    expect(test_result).to eq([test_case, true, nil])
+    args = [service.verb, service.path, service.options]
+    expect(project_api).to have_received(:request).with(*args)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cm_quiz
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - ben
@@ -108,6 +108,7 @@ files:
 - spec/lib/cm_quiz/review/sign_up_user_spec.rb
 - spec/lib/cm_quiz/review/update_idea_spec.rb
 - spec/spec_helper.rb
+- spec/support/assert_test_case.rb
 homepage: https://github.com/codementordev/cm_quiz
 licenses:
 - MIT