Matcher 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3b170469b6bb0fe730e24869a5fe3dac9f347ed
+  data.tar.gz: a091380e5c0dd4c700f405e49d3d8752051ef141
+SHA512:
+  metadata.gz: 13d9d953c23070e3aa531a57a72a296f4e909e7cfc938a74905ca901491a8411e837b0f0df0b2d97b1e2e263253c3b89a884a426bb36417b51b6fd54d10f56a7
+  data.tar.gz: 870351ee9732190197e250f5f7daca34286048f70445d40043b0d8330c69b446155275e74d8812673037d56f1776d7d2af6c47d7fdb8dcc75e2365c8e655cc76

data/lib/MockDb.rb

@@ -0,0 +1,158 @@
+require_relative 'Student'
+
+
+module MockDb
+    def self.tutors
+        return [
+            {
+                "headline" => "I am a tutor",
+                "description" => "i am a professional Javascript instructor",
+                "years_teaching" => "3",
+                "teaching_style" => "Fast",
+                "work_experience" => [
+                    {
+                        "company" => "Apple",
+                        "location" => "California",
+                        "title" => "Product Designer",
+                        "from" => "Tue, 05 Nov 2015",
+                        "to" => "Wed, 10 Sept 2017"
+                    }                  
+                ],
+                "education" => [
+                    {
+                        "school" => "National College of Ireland",
+                        "degree" => "MSc Cloud Computing",
+                        "graduated" => "Fri, 12 Nov 2014"
+                    }
+                    
+                ],
+                "subjects" => [
+                    "Javascript",
+                    "Computing",
+                    "Cloud Computing"
+                ],
+                "badge" => "3"
+            },
+            {
+                "headline" => "I am another tutor",
+                "description" => "i am a professional Rails instructor",
+                "years_teaching" => "5",
+                "teaching_style" => "Medium",
+                "work_experience" => [
+                    {
+                        "company" => "Intel",
+                        "location" => "Michigan",
+                        "title" => "Backend Developer",
+                        "from" => "Tue, 05 Nov 2012",
+                        "to" => "Wed, 10 Sept 2014"
+                    }                  
+                ],
+                "education" => [
+                    {
+                        "school" => "National College of Ireland",
+                        "degree" => "MSc Data Analytics",
+                        "graduated" => "Fri, 12 Nov 2014"
+                    }
+                    
+                ],
+                "subjects" => [
+                    "Ruby",
+                    "Computer Science",
+                    "Data Analytics"
+                ],
+                "badge" => "1"
+            },
+            {
+                "headline" => "Looking to impact lives",
+                "description" => "i am a Physics instructor with over 5 years in experience",
+                "years_teaching" => "10",
+                "teaching_style" => "Slow",
+                "work_experience" => [
+                    {
+                        "company" => "Facebook",
+                        "location" => "Palo Alto",
+                        "title" => "Data Scientist",
+                        "from" => "Tue, 05 Nov 2004",
+                        "to" => "Wed, 10 Sept 2012"
+                    }                  
+                ],
+                "education" => [
+                    {
+                        "school" => "Harvard University",
+                        "degree" => "MSc Physics",
+                        "graduated" => "Fri, 15 Sept 2002"
+                    }
+                    
+                ],
+                "subjects" => [
+                    "Physics",
+                    "Mathematics",
+                    "Computer Science"
+                ],
+                "badge" => "5"
+            },
+            {
+                "headline" => "A professional Finance instructor",
+                "description" => "i am a Finance intructor with over 8 years in the finance industry",
+                "years_teaching" => "6",
+                "teaching_style" => "Fast",
+                "work_experience" => [
+                    {
+                        "company" => "JP Morgan",
+                        "location" => "New York",
+                        "title" => "Financial Analyst",
+                        "from" => "Tue, 05 Nov 2006",
+                        "to" => "Wed, 10 Sept 2012"
+                    }                  
+                ],
+                "education" => [
+                    {
+                        "school" => "National University of Ireland",
+                        "degree" => "MSc Finance",
+                        "graduated" => "Fri, 15 Sept 2005"
+                    }
+                    
+                ],
+                "subjects" => [
+                    "Business Management",
+                    "Finance",
+                    "Accounting"
+                ],
+                "badge" => nil
+            },
+            {
+                "headline" => "Chemical Engineering tutor",
+                "description" => "i am a Chemical Engineer with a huge knowledge base in the subject",
+                "years_teaching" => "3",
+                "teaching_style" => "Medium",
+                "work_experience" => [
+                    {
+                        "company" => "Pfizer",
+                        "location" => "New York",
+                        "title" => "Chemical Engineer",
+                        "from" => "Tue, 05 Nov 2006",
+                        "to" => "Wed, 10 Sept 2012"
+                    }                  
+                ],
+                "education" => [
+                    {
+                        "school" => "National University of Ireland",
+                        "degree" => "MSc Chemical Engineering",
+                        "graduated" => "Fri, 15 Sept 2004"
+                    }
+                    
+                ],
+                "subjects" => [
+                    "Biochemistry",
+                    "Chemistry",
+                    "Sciences"
+                ],
+                "badge" => nil
+            },  
+        ]
+    end
+
+    def self.student
+        return MyUser;
+    end
+end

data/lib/Student.rb

@@ -0,0 +1,27 @@
+module MyUser
+    def self.student_props
+        return {
+            "id" => "3",
+            "email" => "timbrewer@gmail.com",
+            "firstname" => "Tim",
+            "lastname" => "Brewer",
+            "role" => "Student",
+            "gender" => "Male",
+            "has_profile" => "true",
+            "location" => "Dublin"
+        }
+    end
+
+    def self.student
+        return {
+            "education_level" => "University",
+            "description" => "A student ready to learn",
+            "subjects_of_interest" => [
+                {"subject" => "Mathematics", "competency" => "1"},
+                {"subject" => "Chemistry", "competency" => "2"},
+                {"subject" => "Finance" , "competency" => "3"}
+            ],
+            "student_id" => "3"
+        }
+    end
+end

data/lib/matcher.rb

@@ -0,0 +1,60 @@
+require_relative 'MockDb'
+
+class Matcher 
+#before_action :set_student
+    
+    def self.getRecommendation(student, tutors)
+        @profile = student.student()
+        #check subjects students are interested in and their competency level
+        @studentSubjects = @profile["subjects_of_interest"] 
+
+        #initialize an empty array to store list of recommended tutors
+        @recommendedTutors = []
+        
+        #loop tutors array
+        #match tutor subjects with student subjects
+        #create an array of all subjects that match
+        #create an array for every tutor that has at least one match
+        #store competency count to store the 
+        tutors.each do |d|
+            tutorSubjects = d["subjects"]
+            tutorStyle = d["teaching_style"]
+            subject_match = false
+            subject_match_array = []
+            competency_match_array = []
+            tutorSubjects.each do |t|
+                for i in @studentSubjects do
+                
+                    case i["competency"]
+                    when "1"
+                        subject_competency = "Slow"
+                    when "2"
+                        subject_competency = "Average"
+                    when "3"
+                        subject_competency = "Fast"
+                    end
+                    if(t == i["subject"])
+                        subject_match = true
+                        subject_match_array.push(t)
+                        if(tutorStyle == subject_competency)
+                            competency_match_array.push(t)   
+                        end
+                    end
+                end
+            end
+            @recommendedTutors.push({"tutor" => d, "subjects_matched" => subject_match_array, "competency_match" => competency_match_array}) if subject_match == true
+        end
+
+        return @recommendedTutors
+    end
+
+    def self.matchTutor(student, tutors)
+        return self.getRecommendation(student, tutors)    
+    end
+
+    def self.matchCompetency(student, tutors)
+        @recommendedTutors = self.getRecommendation(student, tutors)
+    end
+
+   
+end

data/lib/testCases.rb

@@ -0,0 +1,59 @@
+require_relative 'MockDb'
+
+module TestCases 
+#before_action :set_student
+    @student = MockDb.student()
+    @tutors = MockDb.tutors()
+    @studentrole = @student.student_props()
+    @profile = @student.student()
+
+
+    #return true if there is a student logged in
+    def self.get_student
+        true if @student
+    end
+
+    #return true if student has a role i.e student or tutor
+    def self.get_student_role
+        true if @studentrole["role"]
+    end
+
+    #return true if student role is "Student"
+    def self.is_student
+        true if @studentrole["role"] == "Student"
+    end
+
+    #return true if student has subjects of interests
+    def self.student_has_subject
+        true if @profile["subjects_of_interest"].length > 0
+    end
+
+    #return true if student has set a competeny level for all subjects
+    def self.student_subject_competency
+        all_competency_set = true
+        @profile["subjects_of_interest"].each do |s|
+            if s["competency"] == nil
+                all_competency_set = false
+            end
+        end
+        return all_competency_set
+    end
+
+    #check to see if tutor has set subjects
+    def self.tutor_subjects
+        all_subjects_set = true
+        @tutors.each do |t|
+            if t["subjects"].length <= 0
+                all_subjects_set = false
+            end
+        end
+        return all_subjects_set
+    end
+
+
+
+    private
+    # def set_student
+    #     @student = MockDb.student()
+    # end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: Matcher
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Femi Abdul
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-14 00:00:00.000000000 Z
+dependencies: []
+description: A library to match students with tutors on the bookatutor application
+email: femi.abdul67@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/MockDb.rb
+- lib/Student.rb
+- lib/matcher.rb
+- lib/testCases.rb
+homepage: http://rubygems.org/gems/matcher
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Match students with tutors
+test_files: []