open_trivia_db 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77aa97e8f9ab56cb8ab2bc4a9bcf85282dc4b87e6fb480a9f6a0459b2417cf45
+  data.tar.gz: cb21d1ff8f997467f2ca084cbba5ed949ff5e4d4b5fefff7eb1253144fe48f56
+SHA512:
+  metadata.gz: a09f7678ddf01d40f043feac3e3f6c9b07e822f4ed3fb09ecc157fca91b7fa97cdd2251d5ee85265a576753cdd36c739773547a304d6e86e77fb8f606345682b
+  data.tar.gz: d6d09c62480f9d4bbfcf6c1eafbe143f9b6f435d2a5f2d291b4a8d74b8a3f92deebcb84f8537b58193acdbf002f9f0a06b6e752ad54555840f57c9391a277a78

data/lib/category_text_key_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'generate_answer_key'
+
+#
+# Generate a key with location of the correct answer based length of the category text
+#
+class CategoryTextKeyGenerator
+	include GenerateAnswerKey
+
+	#
+	# Encrypt answer_key
+	#
+	# @param [hash] question question information
+	#
+	# @return [hash] answer key
+	#
+	def self.update_answer_key(question)
+		correct_answer = question[:answer_key].to_s
+		location = question[:category].length % 10
+		answer_key = GenerateAnswerKey.get_random_key(location) +
+                     correct_answer +
+                     GenerateAnswerKey.get_random_key(9 - location)
+		question[:answer_key] = answer_key
+	end
+
+	#
+	# Decrypt answer key
+	#
+	# @param [hash] question
+	#
+	# @return [integer] index of the correct answer from the answer array
+	#
+	def self.decrypt_answer_key(question)
+		location = question[:category].length % 10
+		question[:answer_key][location].to_i
+	end
+end

data/lib/generate_answer_key.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+#
+# Interface for generating a custom answer key
+#
+module GenerateAnswerKey
+
+	#
+	# Encrypt answer key
+	#
+	# @param [hash] question
+	#
+	def self.update_answer_key(question)
+		raise NoMethodError("generate method not implemented")
+	end
+
+	#
+	# Decrypt answer key.
+	#
+	# @param [hash] question
+	#
+	# @return [int] index of the correct answer
+	#
+	def self.decrypt_answer_key(question)
+		raise NoMethodError("decrypt method not implemented")
+	end
+	#
+	# Generate a random key of length 10 numbers
+	#
+	# @return [string] random key
+	#
+	def self.get_random_key(n = 10)
+		return '' if n.zero?
+		min = 10**n
+		max = 10**(n+1)-1
+		rand(min..max).to_s[0..n-1]
+	end
+
+	#
+	# Generate a random word
+	#
+	# @param [int] n specify length of word
+	#
+	# @return [string] generated word
+	#
+	def self.get_random_word(n = 7)
+		letters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+		word = ''
+		n.times do
+			word += letters[rand(52)]
+		end
+		word
+	end
+
+	#
+	# Generate a random phrase
+	#
+	# @param [integer] n number of words
+	#
+	# @return [string] phrase
+	#
+	def self.get_random_phrase(n = 4)
+		phrase = ''
+		n.times do
+			phrase += (phrase.length == 0 ? '': ' ') + self.get_random_word(rand(7)+3)
+		end
+		phrase
+	end
+end

data/lib/leading_digits_key_generator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'generate_answer_key'
+
+#
+# Generate a key with location of the correct answer based on the first two digits
+#
+class LeadingDigitsKeyGenerator
+	include GenerateAnswerKey
+
+	#
+	# Encrypt answer_key
+	#
+	# @param [hash] question question information
+	#
+	# @return [hash] answer key
+	#
+	def self.update_answer_key(question)
+		correct_answer = question[:answer_key].to_s
+		key = GenerateAnswerKey.get_random_key
+		location = key[0..1].to_i % 8
+		answer_key = key[0..(location + 1)] + correct_answer + key[location + 3..9]
+		question[:answer_key] = answer_key
+	end
+
+	#
+	# Decrypt answer key
+	#
+	# @param [hash] question
+	#
+	# @return [integer] index of the correct answer from the answer array
+	#
+	def self.decrypt_answer_key(question)
+		location = question[:answer_key].to_s[0..1].to_i % 8
+		question[:answer_key][location + 2].to_i
+	end
+end

data/lib/open_trivia_db.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+require_relative 'leading_digits_key_generator'
+
+#
+# Retrieve questions from {OpenTrivia DB}[https://opentdb.com/] with an encrypted
+# answer key
+#
+class OpenTriviaDB
+	# @return [class] Generator that implements the GenerateAnswerKey interface
+	attr_accessor :generator
+
+	# @return [string] url of the service; defaults to {https://opentdb.com/api.php}[https://opentdb.com/api.php]
+	attr_accessor :url
+
+	#
+	#
+	#
+	def initialize
+		@url = 'https://opentdb.com/api.php'
+	end
+
+	#
+	# Retrieve questions from OpenTrivia DB. See
+	# {Trivia API}[https://opentdb.com/api_config.php] for definition of parameters.
+	#
+	# @option params [hash] :params query parameters
+	#
+	# @return [hash] question list
+	#
+	def get(params = {})
+		# Ensure amount parameter passed
+		params = params.merge({ amount: 10 }, params)
+
+		uri = URI(@url)
+		uri.query = URI.encode_www_form(params)
+		res = Net::HTTP.get_response(uri)
+
+		out = {
+			response_code: 0,
+			response_message: 'OK',
+			params: params,
+			questions: {}
+		}
+
+		# rubocop:disable Style/ConditionalAssignment
+		case res.code.to_i
+		when 200
+			json = JSON.parse(res.body)
+			case json['response_code']
+			when 0
+				# Valid query
+				out = out.merge({
+					questions: process_questions(json['results'])
+				})
+			else
+				# Invalid, possibly parameters related
+				out = out.merge({
+					response_code: json['response_code'],
+					response_message: 'invalid query'
+				})
+			end
+		else
+			# Server error (ie 404, 503)
+			out = out.merge({
+				response_code: res.code.to_i,
+				response_message: res.message
+			})
+		end
+		# rubocop:enable Style/ConditionalAssignment
+		out
+	end
+
+	private
+
+	#
+	# Reformat questions and randomize answers
+	#
+	# @param [Array] list questions from the api
+	#
+	# @return [Array] reformated questions
+	#
+	def process_questions(list)
+		questions = []
+		list.each_with_index do |q, i|
+			question = {}
+			question[:id] = i + 1
+			question[:category] = q['category']
+			question[:difficulty] = q['difficulty']
+			question[:type] = q['type']
+			question[:question] = q['question']
+			question[:answer_key], question[:answers] = randomize_answers(q['correct_answer'], q['incorrect_answers'])
+
+			@generator&.update_answer_key(question)
+
+			questions.append(question)
+		end
+		questions
+	end
+
+	#
+	# Randomize the order of the correct and incorrect answers.
+	#
+	# @param [string] correct correct answer
+	# @param [array] incorrect incorrect answers
+	#
+	# @return [array] zero-based index of the correct answer and array of all answers
+	#
+	def randomize_answers(correct, incorrect)
+		answers = incorrect.append(correct).shuffle
+		location = answers.find_index(correct)
+		[location, answers]
+	end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: open_trivia_db
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Paul Seto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-06-24 00:00:00.000000000 Z
+dependencies: []
+description: Retrieve questions from Open Trivia DB
+email: pseto@openlava.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/category_text_key_generator.rb
+- lib/generate_answer_key.rb
+- lib/leading_digits_key_generator.rb
+- lib/open_trivia_db.rb
+homepage: https://github.com/paulseto/open_trivia_db
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Quiz questions based on the Open Trivia DB
+test_files: []