frecon 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1753ce0da52b68eee609e44cdd93d62a063d6728
-  data.tar.gz: dc9277e50cf48a1cff8b1429151b810b05b80712
+  metadata.gz: 81f4fffe7a3472db021811019f754872f050fe01
+  data.tar.gz: 36accb11f3e90cf5a10a76bf42d178609afb5f80
 SHA512:
-  metadata.gz: 3a07b211ec464b371ab2cfd5b0cbe3809ecd78318054929d680e0739139d02004cbf056271f40fc486a827a445fccf6ff768ef10555c999cd044499d44ea197d
-  data.tar.gz: f4e2d91ad1766d12cfb27c3dadc0762f454fd2f03233ed85cedee66cab8b929dd0b7379133f6e46061029722065f20536606b730b37fb2aefa92776b552d55c0
+  metadata.gz: d45db224b7de1a264ae077633672d792b1570df83ef9ff514ded0db86fe69f28d975f45f79376733215500a60de1f2bb37215993ad80fefc2ac5c39e36c824bd
+  data.tar.gz: 273a7d1ee9d0e7556f6f74de074e8c384e9c5e784053942f5516d81c47fb6e065a3394a6103c879b964b0eb316ef04aad34ea98a6695d85c16e4ece665c89616

data/bin/frecon

@@ -10,8 +10,8 @@
 # <http://opensource.org/licenses/MIT>.
 
 # Include rel-path ../lib/ in the $LOAD_PATH if it's not there already.
-lib_directory = File.join(File.dirname(__FILE__), "..", "lib")
-$LOAD_PATH.unshift(lib_directory) unless $LOAD_PATH.include?(lib_directory)
+lib_directory = File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+$LOAD_PATH.unshift(lib_directory) unless $LOAD_PATH.map { |directory| File.expand_path(directory) }.include?(lib_directory)
 
 require "frecon"
 

data/lib/frecon/base/variables.rb

@@ -8,7 +8,7 @@
 # <http://opensource.org/licenses/MIT>.
 
 module FReCon
-	VERSION = "0.1.4"
+	VERSION = "0.2.0"
 
 	@environment_variable = :development
 

data/lib/frecon/controller.rb

@@ -23,13 +23,19 @@ module FReCon
 			self.name.gsub(/Controller\Z/, "").singularize.constantize
 		end
 
+		# Some models have to find themselves in special ways,
+		# so this can be overridden with those ways.
+		def self.find_model(params)
+			model.find params[:id]
+		end
+
 		# The 404 error message.
 		def self.could_not_find(value, attribute = "id", model = model_name.downcase)
-			"Could not find #{model_name.downcase} of #{attribute} #{value}!"
+			"Could not find #{model} of #{attribute} #{value}!"
 		end
 
 		# Processes a POST/PUT request and returns the post data.
-		def self.process_request(request)
+		def self.process_json_object_request(request)
 			# Rewind the request body (an IO object)
 			# in case someone else has already played
 			# through it.
@@ -49,8 +55,8 @@ module FReCon
 			post_data
 		end
 
-		def self.create(request, params)
-			post_data = process_request request
+		def self.create(request, params, post_data = nil)
+			post_data ||= process_json_object_request request
 
 			@model = model.new
 			@model.attributes = post_data
@@ -61,13 +67,13 @@ module FReCon
 				raise RequestError.new(422, @model.errors.full_messages)
 			end
 		end
+		
+		def self.update(request, params, post_data = nil)
+			raise RequestError.new(400, "Must supply a #{model_name.downcase} id!") unless params[:id]
 
-		def self.update(request, params)
-			raise RequestError.new(400, "Must supply a #{model_name.downcase}!") unless params[:id]
+			post_data ||= process_json_object_request request
 
-			post_data = process_request request
-
-			@model = model.find params[:id]
+			@model = find_model params
 
 			raise RequestError.new(404, could_not_find(params[:id])) unless @model
 
@@ -79,7 +85,7 @@ module FReCon
 		end
 
 		def self.delete(params)
-			@model = model.find params[:id]
+			@model = find_model params
 
 			if @model
 				if @model.destroy
@@ -93,7 +99,7 @@ module FReCon
 		end
 
 		def self.show(params)
-			@model = model.find params[:id]
+			@model = find_model params
 
 			if @model
 				@model.to_json
@@ -111,7 +117,7 @@ module FReCon
 		end
 
 		def self.show_attribute(params, attribute)
-			@model = model.find params[:id]
+			@model = find_model params
 
 			if @model
 				@model.send(attribute).to_json
@@ -133,5 +139,49 @@ module FReCon
 				end
 			end
 		end
+
+		# This supports match_number and competition_name
+		# or match_number and competition (which is a Hash).
+		def self.match_number_and_competition_to_match_id(post_data)
+			if post_data["match_number"] && !post_data["match_id"]
+				if post_data["competition_name"] && (competition = Competition.find_by name: post_data["competition_name"])
+					# Try to set the match to the already existing match.
+					begin
+						match = competition.matches.find_by number: post_data["match_number"]
+					rescue ArgumentError, TypeError => e
+						raise RequestError.new(422, e.message)
+					end
+
+					# Create the match if necessary.
+					begin
+						match ||= Match.create(number: post_data["match_number"], competition_id: competition.id)
+					rescue ArgumentError, TypeError => e
+						raise RequestError.new(422, e.message)
+					end
+
+					post_data["match_id"] = match.id
+
+					post_data.delete("match_number")
+					post_data.delete("competition_name")
+				elsif post_data["competition"] && post_data["competition"]["_id"] && post_data["competition"]["_id"]["$oid"] && (competition = Competition.find_by(id: post_data["competition"]["_id"]["$oid"]))
+					# Try to set the match to the already existing match.
+					match = competition.matches.find_by number: post_data["match_number"]
+
+					# Create the match if necessary.
+					begin
+						match ||= Match.create(number: post_data["match_number"], competition_id: competition.id)
+					rescue ArgumentError, TypeError => e
+						raise RequestError.new(422, e.message)
+					end
+
+					post_data["match_id"] = match.id
+
+					post_data.delete("match_number")
+					post_data.delete("competition")
+				else
+					raise RequestError.new(422, "A current competition is not set.  Please set it.")
+				end
+			end
+		end
 	end
 end

data/lib/frecon/controllers/dump_controller.rb

@@ -13,17 +13,13 @@ require "frecon/models"
 module FReCon
 	class DumpController
 		def self.full(params)
-			competitions = Competition.all
-			teams = Team.all
-			matches = Match.all
-			records = Record.all
+			dump = {}
 
-			{
-				"competitions" => competitions,
-				"teams" => teams,
-				"matches" => matches,
-				"records" => records
-			}.to_json
+			Model.descendants.each do |child|
+				dump[child.name.gsub(/FReCon::/, "").downcase.pluralize] = child.all
+			end
+
+			dump.to_json
 		end
 	end
 end

data/lib/frecon/controllers/participations_controller.rb

@@ -10,25 +10,13 @@
 module FReCon
 	class ParticipationsController < Controller
 		def self.create(request, params)
-			post_data = process_request request
-			
-			# Convert team number to team_id.
-			post_data = team_number_to_team_id(post_data)
-
-			@model = model.new
-			@model.attributes = post_data
-
-			if @model.save
-				[201, @model.to_json]
-			else
-				raise RequestError.new(422, @model.errors.full_messages)
-			end
+			super(request, params, team_number_to_team_id(process_json_object_request(request)))
 		end
-		
+
 		def self.competition(params)
 			show_attribute params, :competition
 		end
-		
+
 		def self.team(params)
 			show_attribute params, :team
 		end

data/lib/frecon/controllers/records_controller.rb

@@ -14,62 +14,7 @@ require "frecon/models"
 module FReCon
 	class RecordsController < Controller
 		def self.create(request, params)
-			post_data = process_request request
-
-			# Change special post_data attributes.
-			# Convert team number to team id.
-			post_data = team_number_to_team_id(post_data)
-
-			# Convert match number and competition name to match id.
-			if post_data["match_number"] && !post_data["match_id"]
-				if post_data["competition_name"] && (competition = Competition.find_by name: post_data["competition_name"])
-					# Try to set the match to the already existing match.
-					begin
-						match = competition.matches.find_by number: post_data["match_number"]
-					rescue ArgumentError, TypeError => e
-						raise RequestError.new(422, e.message)
-					end
-
-					# Create the match if necessary.
-					begin
-						match ||= Match.create(number: post_data["match_number"], competition_id: competition.id)
-					rescue ArgumentError, TypeError => e
-						raise RequestError.new(422, e.message)
-					end
-
-					post_data["match_id"] = match.id
-
-					post_data.delete("match_number")
-					post_data.delete("competition_name")
-				elsif post_data["competition"] && post_data["competition"]["_id"] && post_data["competition"]["_id"]["$oid"] && (competition = Competition.find_by(id: post_data["competition"]["_id"]["$oid"]))
-					# Try to set the match to the already existing match.
-					match = competition.matches.find_by number: post_data["match_number"]
-
-					# Create the match if necessary.
-					begin
-						match ||= Match.create(number: post_data["match_number"], competition_id: competition.id)
-					rescue ArgumentError, TypeError => e
-						raise RequestError.new(422, e.message)
-					end
-
-					post_data["match_id"] = match.id
-
-					post_data.delete("match_number")
-					post_data.delete("competition")
-				else
-					raise RequestError.new(422, "A current competition is not set.  Please set it.")
-				end
-			end
-
-			@record = Record.new
-			@record.attributes = post_data
-
-			if @record.save
-				# Use to_json for now; we can filter it later.
-				[201, @record.to_json]
-			else
-				raise RequestError.new(422, @record.errors.full_messages)
-			end
+			super(request, params, match_number_and_competition_to_match_id(team_number_to_team_id(process_json_object_request(request))))
 		end
 
 		def self.competition(params)

data/lib/frecon/controllers/robots_controller.rb

@@ -12,6 +12,10 @@ require "frecon/models/robot"
 
 module FReCon
 	class RobotsController < Controller
+		def self.create(request, params)
+			super(request, params, team_number_to_team_id(process_json_object_request(request)))
+		end
+
 		def self.competition(params)
 			show_attribute params, :competition
 		end

data/lib/frecon/controllers/teams_controller.rb

@@ -13,61 +13,23 @@ require "frecon/models"
 
 module FReCon
 	class TeamsController < Controller
-		def self.create(request, params)
-			post_data = process_request request
-
-			@team = Team.new
-			@team.attributes = post_data
-
-			if @team.save
-				# Use to_json for now; we can filter it later.
-				[201, @team.to_json]
-			else
-				raise RequestError.new(422, @team.errors.full_messages)
-			end
-		end
-
-		def self.update(request, params)
-			raise RequestError.new(400, "Must supply a team number!") unless params[:number]
-
-			post_data = process_request request
-
-			@team = Team.find_by number: params[:number]
-			raise RequestError.new(404, could_not_find(params[:number], "number")) if @team.nil?
-
-			if @team.update_attributes(post_data)
-				@team.to_json
-			else
-				raise RequestError.new(422, @team.errors.full_messages)
-			end
+		# The `id` param will be a number or id.
+		def self.find_model(params)
+			(Team.find_by id: params[:id]) || (Team.find_by number: params[:id])
 		end
 
-		def self.delete(params)
-			@team = Team.find_by number: params[:number]
-
-			if @team
-				if @team.destroy
-					204
-				else
-					raise RequestError.new(422, @team.errors.full_messages)
-				end
-			else
-				raise RequestError.new(404, could_not_find(params[:number], "number"))
-			end
-		end
-
-		def self.show(params)
-			@team = Team.find_by number: params[:number]
-
-			if @team
-				@team.to_json
+		# Since Team has a special way of finding itself, we can make
+		# the error message reflect this.
+		def self.could_not_find(value, attribute = "id", model = model_name.downcase)
+			if attribute == "id" && model == "team"
+				"Could not find team of id or number #{value}!"
 			else
-				raise RequestError.new(404, could_not_find(params[:number], "number"))
+				"Could not find #{model} of #{attribute} #{value}!"
 			end
 		end
 
 		def self.records(params)
-			@team = Team.find_by number: params[:number]
+			@team = find_model params
 
 			if @team
 				if params[:competition_id]
@@ -82,12 +44,12 @@ module FReCon
 					@team.records.to_json
 				end
 			else
-				raise RequestError.new(404, could_not_find(params[:number], "number"))
+				raise RequestError.new(404, could_not_find(params[:id], "id or number"))
 			end
 		end
 
 		def self.matches(params)
-			@team = Team.find_by number: params[:number]
+			@team = find_model params
 
 			if @team
 				# Ensure that the competition ID is valid.
@@ -99,17 +61,17 @@ module FReCon
 
 				@team.matches(params[:competition_id]).to_json
 			else
-				raise RequestError.new(404, could_not_find(params[:number], "number"))
+				raise RequestError.new(404, could_not_find(params[:id], "id or number"))
 			end
 		end
 
 		def self.competitions(params)
-			@team = Team.find_by number: params[:number]
+			@team = find_model params
 
 			if @team
 				@team.competitions.to_json
 			else
-				raise RequestError.new(404, could_not_find(params[:number], "number"))
+				raise RequestError.new(404, could_not_find(params[:id], "id or number"))
 			end
 		end
 	end

data/lib/frecon/database.rb

@@ -28,11 +28,13 @@ module FReCon
 				Mongoid.load!(File.join(File.dirname(__FILE__), "mongoid.yml"), environment)
 			end
 			
-			Mongoid.logger.level = Logger::DEBUG
-			Mongoid.logger = Logger.new($stdout)
+			if environment == :development
+				Mongoid.logger.level = Logger::DEBUG
+				Mongoid.logger = Logger.new($stdout)
 
-			Moped.logger.level = Logger::DEBUG
-			Moped.logger = Logger.new($stdout)
+				Moped.logger.level = Logger::DEBUG
+				Moped.logger = Logger.new($stdout)
+			end
 		end
 	end
 end

data/lib/frecon/model.rb

@@ -21,6 +21,11 @@ module FReCon
 			end
 		end
 
+		def self.descendants
+			# Basically lists all of the models in this database.
+			ObjectSpace.each_object(Class).select { |possibleChild| possibleChild < self }
+		end
+
 		def no_invalid_relations
 			# Get all of the belongs_to fields (ends with "_id" and not "_id" because that is the id).
 			attributes.keys.select { |attribute| attribute.end_with?("_id") && attribute != "_id" }.each do |relation|

data/lib/frecon/models/robot.rb

@@ -11,9 +11,13 @@ require "frecon/model"
 
 module FReCon
 	class Robot < Model
+		# This is an optional field we included for organization.
 		field :name, type: String
 
 		belongs_to :competition
 		belongs_to :team
+
+		validates :competition_id, :team_id, presence: true
+		validates :team_id, uniqueness: { scope: :competition_id }
 	end
 end

data/lib/frecon/request_error.rb

@@ -26,4 +26,13 @@ class RequestError < StandardError
 			JSON.generate({ errors: message })
 		end
 	end
+
+	# A Sinatra-compliant return value.
+	def return_value
+		if @message
+			[@code, @message]
+		else
+			@code
+		end
+	end
 end

data/lib/frecon/routes.rb

@@ -17,7 +17,7 @@ module FReCon
 					begin
 						controller.create request, params
 					rescue RequestError => e
-						[e.code, e.message]
+						e.return_value
 					end
 				end
 			end
@@ -27,7 +27,7 @@ module FReCon
 					begin
 						controller.update request, params
 					rescue RequestError => e
-						[e.code, e.message]
+						e.return_value
 					end
 				end
 			end
@@ -37,7 +37,7 @@ module FReCon
 					begin
 						controller.delete params
 					rescue RequestError => e
-						[e.code, e.message]
+						e.return_value
 					end
 				end
 			end
@@ -47,7 +47,7 @@ module FReCon
 					begin
 						controller.show params
 					rescue RequestError => e
-						[e.code, e.message]
+						e.return_value
 					end
 				end
 			end
@@ -57,60 +57,36 @@ module FReCon
 					begin
 						controller.index params
 					rescue RequestError => e
-						[e.code, e.message]
+						e.return_value
 					end
 				end
 			end
 		end
 		
 		def self.included(base)
-			resource_routes base, "teams", TeamsController, [:create, :index]
+			resource_routes base, "teams", TeamsController
 
-			base.put "/teams/:number" do
-				begin
-					TeamsController.update request, params
-				rescue RequestError => e
-					[e.code, e.message]
-				end
-			end
-
-			base.delete "/teams/:number" do
-				begin
-					TeamsController.delete params
-				rescue RequestError => e
-					[e.code, e.message]
-				end
-			end
-
-			base.get "/teams/:number" do
-				begin
-					TeamsController.show params
-				rescue RequestError => e
-					[e.code, e.message]
-				end
-			end
-
-			base.get "/teams/:number/records/?:competition_id?" do
+			base.get "/teams/:id/records/?:competition_id?" do
 				begin
 					TeamsController.records params
 				rescue RequestError => e
-					[e.code, e.message]
+					e.return_value
 				end
 			end
 
-			base.get "/teams/:number/matches/?:competition_id?" do
+			base.get "/teams/:id/matches/?:competition_id?" do
 				begin
 					TeamsController.matches params
 				rescue RequestError => e
-					[e.code, e.message]
+					e.return_value
 				end
 			end
 
-			base.get "/teams/:number/competitions" do
+			base.get "/teams/:id/competitions" do
 				begin
 					TeamsController.competitions params
 				rescue RequestError => e
-					[e.code, e.message]
+					e.return_value
 				end
 			end
 
@@ -120,7 +96,7 @@ module FReCon
 				begin
 					CompetitionsController.teams params
 				rescue RequestError => e
-					[e.code, e.message]
+					e.return_value
 				end
 			end
 
@@ -128,7 +104,7 @@ module FReCon
 				begin
 					CompetitionsController.matches params
 				rescue RequestError => e
-					[e.code, e.message]
+					e.return_value
 				end
 			end
 
@@ -136,7 +112,7 @@ module FReCon
 				begin
 					CompetitionsController.records params
 				rescue RequestError => e
-					[e.code, e.message]
+					e.return_value
 				end
 			end
 
@@ -146,7 +122,7 @@ module FReCon
 				begin
 					MatchesController.records params
 				rescue RequestError => e
-					[e.code, e.message]
+					e.return_value
 				end
 			end
 
@@ -154,7 +130,7 @@ module FReCon
 				begin
 					MatchesController.competition params
 				rescue RequestError => e
-					[e.code, e.message]
+					e.return_value
 				end
 			end
 
@@ -164,7 +140,7 @@ module FReCon
 				begin
 					RecordsController.competition params
 				rescue RequestError => e
-					[e.code, e.message]
+					e.return_value
 				end
 			end
 
@@ -174,7 +150,7 @@ module FReCon
 				begin
 					RobotsController.competition params
 				rescue RequestError => e
-					[e.code, e.message]
+					e.return_value
 				end
 			end
 
@@ -182,7 +158,7 @@ module FReCon
 				begin
 					RobotsController.team params
 				rescue RequestError => e
-					[e.code, e.message]
+					e.return_value
 				end
 			end
 
@@ -192,7 +168,7 @@ module FReCon
 				begin
 					ParticipationsController.competition params
 				rescue RequestError => e
-					[e.code, e.message]
+					e.return_value
 				end
 			end
 
@@ -200,7 +176,7 @@ module FReCon
 				begin
 					ParticipationsController.team params
 				rescue RequestError => e
-					[e.code, e.message]
+					e.return_value
 				end
 			end
 
@@ -208,7 +184,7 @@ module FReCon
 				begin
 					DumpController.full params
 				rescue RequestError => e
-					[e.code, e.message]
+					e.return_value
 				end
 			end
 		end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frecon
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Sam Craig