cm_quiz 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b05cd24b052e990f291c22473aef0e934b97036c
+  data.tar.gz: 5b36e76983e7e4c0b6e8fce097d2c4a9ceee5da2
+SHA512:
+  metadata.gz: b17e359ef50450552ea190d5715092a42680caae1c5e4d0f736c0eb8569319d1255ca9ab62be8c007787f82ec8e8f45fe3c10cdc9721dd3f8070d235dbe0941b
+  data.tar.gz: a22c7ecb03e6fa494aec8aad9bd56683c00339c7aea06a284a60171c2b1aa79f52fce9f5f230bcc75eaf15f1ba51e8f907c88eb6c6fe85e91ef5353ce6a4052e

data/.rspec

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'pry'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    cm_quiz (0.0.1)
+      httparty
+      rspec
+      thor (~> 0.19.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.6)
+    httparty (0.15.6)
+      multi_xml (>= 0.5.2)
+    method_source (0.8.2)
+    multi_xml (0.6.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    public_suffix (3.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    thor (0.19.4)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cm_quiz!
+  pry
+  webmock
+
+BUNDLED WITH
+   1.15.0

data/README.md

@@ -0,0 +1 @@
+# cm-quiz

data/bin/cm-quiz

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+$LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+require 'cm_quiz/cli'
+
+CmQuiz::CLI.start(ARGV)

data/cm_quiz.gemspec

@@ -0,0 +1,24 @@
+lib_dir = File.join(File.dirname(__FILE__),'lib')
+$LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+require 'cm_quiz/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'cm_quiz'
+  s.version =  CmQuiz::VERSION
+  s.date        = '2017-09-12'
+  s.summary     = "Review your codementor quiz"
+  s.description = "Review your codementor quiz1"
+  s.authors     = ["ben"]
+  s.email       = 'ben@codementor.ios'
+  s.executables = ["cm-quiz"]
+  s.files = `git ls-files`.split($/)
+  s.homepage    =
+  'https://github.com/codementordev/cm_quiz'
+  s.license       = 'MIT'
+  s.required_ruby_version = '>= 2.3'
+
+  s.add_dependency('thor', ["~> 0.19.4"])
+  s.add_dependency("rspec", ["~> 3.6"])
+  s.add_dependency("httparty", ["~> 0.15.6"])
+  s.add_development_dependency("webmock", ["~> 3.0"])
+end

data/lib/cm_quiz/cli.rb

@@ -0,0 +1,22 @@
+require 'thor'
+require 'cm_quiz'
+
+module CmQuiz
+  class CLI< Thor
+    map '--version' => :version
+
+    desc 'version', 'Prints the cm_quiz version'
+    def version
+      puts "#{File.basename($0)} #{VERSION}"
+    end
+
+    desc 'test', 'Test your api implement'
+    option :endpoint, required: true, banner: "your-test-endpoint.com"
+    def test
+      endpoint = options[:endpoint]
+      puts "Start test #{endpoint}"
+      message = CmQuiz::ReviewQuiz.new('http://localhost:6000').perform
+      puts message
+    end
+  end
+end

data/lib/cm_quiz/factory/idea.rb

@@ -0,0 +1,32 @@
+require 'securerandom'
+
+module CmQuiz
+  module Factory
+    class Idea
+      def initialize(project_api:, jwt:, idea_params: {})
+        @project_api = project_api
+        @jwt = jwt
+        @idea_params = idea_params
+      end
+
+      def create
+        default_idea_params = {
+          content: 'the-content',
+          impact: 7,
+          ease: 8,
+          confidence: 9
+        }
+
+        options = {
+          headers: {
+            'x-access-token' => @jwt
+          },
+          body: default_idea_params.merge(@idea_params)
+        }
+
+        res = @project_api.request(:post, '/ideas', options)
+        JSON.parse(res.body)
+      end
+    end
+  end
+end

data/lib/cm_quiz/factory/user.rb

@@ -0,0 +1,28 @@
+require 'securerandom'
+
+module CmQuiz
+  module Factory
+    class User
+      def initialize(project_api:, name: nil, email: nil, password: nil)
+        @project_api = project_api
+        @name = name || "codementor-test-#{SecureRandom.hex(5)}"
+        @email = email || "#{@name}@codementor.io"
+        @password = password || "pAssw0rd!"
+      end
+
+      def create
+        options = {
+          body: {
+            email: @email,
+            name: @name,
+            password: @password
+          }
+        }
+
+        res = @project_api.request(:post, '/users', options)
+        payload = JSON.parse(res.body)
+        [payload['jwt'], payload['refresh_token']]
+      end
+    end
+  end
+end

data/lib/cm_quiz/project_api.rb

@@ -0,0 +1,40 @@
+require 'httparty'
+
+module CmQuiz
+  class ProjectAPI
+    REQUEST_TIMEOUT = 5
+
+    class PerformFailed < StandardError
+      attr_reader :response
+
+      def initialize(message, response)
+        @response = response
+        super(message)
+      end
+    end
+
+    def initialize(endpoint)
+      @endpoint = endpoint
+    end
+
+    def request(verb, path, options = {})
+      url = @endpoint + path
+
+      query = options[:query]
+      body = options[:body].to_json
+      headers = { 'Content-Type' => 'application/json' }.merge(options[:headers] || {})
+
+      http_options = {
+        query: query,
+        body: body,
+        headers: headers,
+        timeout: REQUEST_TIMEOUT
+      }
+      res = HTTParty.send(verb, url, http_options)
+
+      raise PerformFailed.new("[#{res.code}]: #{res.body}", res) unless res.success?
+
+      res
+    end
+  end
+end

data/lib/cm_quiz/review/base_review.rb

@@ -0,0 +1,30 @@
+require 'cm_quiz/review_helper'
+
+module CmQuiz
+  module Review
+    class BaseReview
+      include ReviewHelper
+
+      def perform
+        run
+        build_test_result(test_request)
+      rescue RSpec::Expectations::ExpectationNotMetError => e
+        build_test_result(test_request, false, e.message)
+      rescue => e
+        build_test_result(test_request, false, e.message)
+      end
+
+      def run
+        raise "Method `run` should be implemented on class #{self.class}"
+      end
+
+      def test_request
+        {
+          verb: @verb,
+          path: @path,
+          options: @options
+        }
+      end
+    end
+  end
+end

data/lib/cm_quiz/review/create_idea.rb

@@ -0,0 +1,49 @@
+module CmQuiz
+  module Review
+    class CreateIdea < BaseReview
+      def initialize(project_api:)
+        @project_api = project_api
+        @verb = :post
+        @path = '/ideas'
+      end
+
+      def run
+        jwt, _ = Factory::User.new({
+          project_api: @project_api
+        }).create
+
+        res = send_create_idea_request({
+          jwt: jwt,
+          content: 'test-content',
+          impact: 7,
+          ease: 8,
+          confidence: 9
+        })
+        payload = JSON.parse(res.body)
+
+        expect(payload['impact']).to eq(7), "expect impact equal 7, but got #{payload['impact']}"
+        expect(payload['ease']).to eq(8), "expect ease equal 8, but got #{payload['ease']}"
+        expect(payload['confidence']).to eq(9), "expect confidence equal 9, but got #{payload['confidence']}"
+        expect(payload['average_score']).to eq(8.0), "expect average_score equal 8, but got #{payload['average_score']}"
+      end
+
+      private
+
+      def send_create_idea_request(jwt:, content:, impact:, ease:, confidence:)
+        options = {
+          headers: {
+            'x-access-token' => jwt
+          },
+          body: {
+            content: content,
+            impact: impact,
+            ease: ease,
+            confidence: confidence
+          }
+        }
+
+        @project_api.request(@verb, @path, options)
+      end
+    end
+  end
+end

data/lib/cm_quiz/review/delete_idea.rb

@@ -0,0 +1,50 @@
+module CmQuiz
+  module Review
+    class DeleteIdea < BaseReview
+      def initialize(project_api:)
+        @project_api = project_api
+        @verb = :delete
+        @path = '/ideas/:idea_id'
+      end
+
+      def run
+        jwt, _ = Factory::User.new({
+          project_api: @project_api
+        }).create
+        idea_payload = Factory::Idea.new({
+          project_api: @project_api,
+          jwt: jwt
+        }).create
+        idea_id = idea_payload['id']
+
+        send_delete_idea_request(jwt: jwt, idea_id: idea_id)
+
+        res = send_get_ideas_request(jwt: jwt)
+        res_hash = JSON.parse(res.body)
+        expect(res_hash.size).to eq(0)
+      end
+
+      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:)
+        options = {
+          headers: {
+            'x-access-token' => jwt
+          }
+        }
+
+        @project_api.request(:get, "/ideas", options)
+      end
+    end
+  end
+end

data/lib/cm_quiz/review/get_ideas.rb

@@ -0,0 +1,73 @@
+require 'date'
+
+module CmQuiz
+  module Review
+    class GetIdeas < BaseReview
+      VALID_TIME_DIFF = 60 * 5
+
+      def initialize(project_api:)
+        @project_api = project_api
+        @verb = :get
+        @path = '/ideas'
+        @now = Time.now
+      end
+
+      def run
+        jwt, _ = Factory::User.new({
+          project_api: @project_api
+        }).create
+        idea_payloads = 3.times.map do |i|
+          Factory::Idea.new({
+            project_api: @project_api,
+            jwt: jwt,
+            idea_params: {
+              confidence: (3 + i) % 10 + 1
+            }
+          }).create
+        end
+
+        res = send_get_ideas_request(jwt: jwt)
+        res_hash = JSON.parse(res.body)
+
+        idea_payloads.each do |idea_payload|
+          item = res_hash.find { |item| item['id'] == idea_payload['id'] }
+          raise StandardError, "idea not found" unless item
+
+          expect(item['content']).to eq(idea_payload['content'])
+          expect(item['impact']).to eq(idea_payload['impact'])
+          expect(item['ease']).to eq(idea_payload['ease'])
+          expect(item['confidence']).to eq(idea_payload['confidence'])
+          average_score = (idea_payload['impact'] + idea_payload['ease'] + idea_payload['confidence'])/ 3.0
+          expect(item['average_score']).to be_within(0.1).of(average_score)
+          diff = Time.now - Time.new(item['created_at'])
+          expect(diff).to be <= VALID_TIME_DIFF
+        end
+      end
+
+      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 = {
+          headers: {
+            'x-access-token' => jwt
+          },
+          query: {
+            page: page
+          }
+        }
+
+        @project_api.request(@verb, @path, options)
+      end
+    end
+  end
+end

data/lib/cm_quiz/review/get_user_info.rb

@@ -0,0 +1,43 @@
+require 'securerandom'
+
+module CmQuiz
+  module Review
+    class GetUserInfo < BaseReview
+      def initialize(project_api:)
+        @project_api = project_api
+        @verb = :get
+        @path = '/me'
+      end
+
+      def run
+        name = "codementor-test-#{SecureRandom.hex(5)}"
+        email = "#{name}@codementor.io"
+        password = "pAssw0rd!"
+        jwt, _refresh_token = Factory::User.new({
+          project_api: @project_api,
+          name: name,
+          email: email,
+          password: password
+        }).create
+
+        res = send_get_user_info_request(jwt: jwt)
+        payload = JSON.parse(res.body)
+
+        expect(payload['email']).to eq(email)
+        expect(payload['name']).to eq(name)
+      end
+
+      private
+
+      def send_get_user_info_request(jwt:)
+        options = {
+          headers: {
+            'x-access-token' => jwt
+          }
+        }
+
+        @project_api.request(@verb, @path, options)
+      end
+    end
+  end
+end

data/lib/cm_quiz/review/login_user.rb

@@ -0,0 +1,47 @@
+require 'securerandom'
+
+module CmQuiz
+  module Review
+    class LoginUser < BaseReview
+      def initialize(project_api:)
+        @project_api = project_api
+        @verb = :post
+        @path = '/access-tokens'
+      end
+
+      def run
+        name = "codementor-test-#{SecureRandom.hex(5)}"
+        email = "#{name}@codementor.io"
+        password = "pAssw0rd!"
+        Factory::User.new({
+          project_api: @project_api,
+          name: name,
+          email: email,
+          password: password
+        }).create
+
+        @options = build_options(email: email, password: password)
+        res = send_request(@options)
+        payload = JSON.parse(res.body)
+
+        expect(payload['jwt'].class).to eq(String), '`jwt` should be string'
+        expect(payload['refresh_token'].class).to eq(String), '`refresh_token` should be string'
+      end
+
+      private
+
+      def build_options(email:, password:)
+        options = {
+          body: {
+            email: email,
+            password: password
+          }
+        }
+      end
+
+      def send_request(options)
+        @project_api.request(@verb, @path, options)
+      end
+    end
+  end
+end

data/lib/cm_quiz/review/sign_up_user.rb

@@ -0,0 +1,43 @@
+require 'securerandom'
+
+module CmQuiz
+  module Review
+    class SignUpUser < BaseReview
+      def initialize(project_api:)
+        @project_api = project_api
+        @verb = :post
+        @path = '/users'
+      end
+
+      def run
+        name = "codementor-test-#{SecureRandom.hex(5)}"
+        email = "#{name}@codementor.io"
+        password = "pAssw0rd!"
+        res = send_sign_up_user_request(email: email, name: name, password: password)
+        payload = JSON.parse(res.body)
+
+        expect(payload['jwt'].class).to eq(String), '`jwt` should be string'
+        expect(payload['refresh_token'].class).to eq(String), '`refresh_token` should be string'
+        build_test_result(self.class)
+      rescue RSpec::Expectations::ExpectationNotMetError => e
+        build_test_result(self.class, false, e.message)
+      rescue => e
+        build_test_result(self.class, false, e.message)
+      end
+
+      private
+
+      def send_sign_up_user_request(email:, name:, password:)
+        options = {
+          body: {
+            email: email,
+            name: name,
+            password: password
+          }
+        }
+
+        @project_api.request(@verb, @path, options)
+      end
+    end
+  end
+end

data/lib/cm_quiz/review/update_idea.rb

@@ -0,0 +1,69 @@
+module CmQuiz
+  module Review
+    class UpdateIdea < BaseReview
+      def initialize(project_api:)
+        @project_api = project_api
+        @verb = :put
+        @path = '/ideas/:idea_id'
+      end
+
+      def run
+        jwt, _ = Factory::User.new({
+          project_api: @project_api
+        }).create
+        idea_payload = Factory::Idea.new({
+          project_api: @project_api,
+          jwt: jwt
+        }).create
+        idea_id = idea_payload['id']
+
+        res = send_update_idea_request({
+          jwt: jwt,
+          idea_id: idea_id,
+          content: 'test-new-content',
+          impact: 6,
+          ease: 7,
+          confidence: 8
+        })
+
+        payload = JSON.parse(res.body)
+        expect(payload['content']).to eq('test-new-content')
+        expect(payload['impact']).to eq(6)
+        expect(payload['ease']).to eq(7)
+        expect(payload['confidence']).to eq(8)
+        expect(payload['average_score']).to eq(7.0)
+      end
+
+      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 = {
+          headers: {
+            'x-access-token' => jwt
+          },
+          body: {
+            content: content,
+            impact: impact,
+            ease: ease,
+            confidence: confidence
+          }
+        }
+
+        @project_api.request(:put, "/ideas/#{idea_id}", options)
+      end
+
+    end
+  end
+end

data/lib/cm_quiz/review_helper.rb

@@ -0,0 +1,25 @@
+require 'rspec'
+
+module CmQuiz
+  module ReviewHelper
+    def expect(target)
+      RSpec::Expectations::ExpectationTarget.new(target)
+    end
+
+    def eq(obj)
+      RSpec::Matchers::BuiltIn::Eq.new(obj)
+    end
+
+    def be
+      RSpec::Matchers::BuiltIn::Be.new
+    end
+
+    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