frecon 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57bd9b7c1164b8eb8fd9e832ac615281a0ae0921
-  data.tar.gz: 3c24af5efdef6fc97d60148a7daceb0d8f61c4f8
+  metadata.gz: 53470115c1a7a01b3b7850dd9f803951bd3cb407
+  data.tar.gz: 820d7bc082d1bad50aac2aed9ea3c9b422fb8508
 SHA512:
-  metadata.gz: 632ff7d628bfafa97051643b7553939598a84d3aacd84927d5393b5ec18e8b980ee00379204b0a6dd45ef7c1ef9628019d2f698511e1656b13c5c2ef5ec17c2c
-  data.tar.gz: a39cf27d21e8747472bbfcfe98fd153e67473977f248baf65ab1723c587c52135a69ed1bf4070cce990978d50e4e6a0de6b7b6934d2398cfc4701a015da3f262
+  metadata.gz: edc0bebe5fbda796d7e4689db9cceff2eb4f91869e5ec38bf441eed9237ab51709cd065775cb6dd95d6729d8e28e87c55f20d46a03c2cec75a53e3fde86f8476
+  data.tar.gz: 82e6c63b5d4b6650bc85ba1119ea565c7b82f7c1c24acc7ba5eb00dde28d18fcc4eb1b6b25690e656c834fbc1e3f02adfd804a2a346bf3982000b6d243da661c

data/lib/frecon/base/variables.rb

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

data/lib/frecon/console.rb

@@ -15,23 +15,9 @@ module FReCon
 		def self.start
 			Database.setup(FReCon.environment)
 
-			# Use pry if it is installed.
-			# Use the context of the FReCon module;
-			# this allows for writing "Team" instead of "FReCon::Team".
-			begin
-				require "pry"
+			require "pry"
 
-				FReCon.pry
-			rescue LoadError
-				require "irb"
-
-				IRB.setup nil
-				IRB.conf[:MAIN_CONTEXT] = IRB::Irb.new.context
-
-				require "irb/ext/multi-irb"
-
-				IRB.irb nil, FReCon
-			end
+			FReCon.pry
 		end
 	end
 end

data/lib/frecon/controller.rb

@@ -26,7 +26,7 @@ module FReCon
 		# 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]
+			model.find params.delete("id")
 		end
 
 		# The 404 error message.
@@ -126,87 +126,16 @@ module FReCon
 		end
 
 		def self.index(params)
-			params.delete("_")
-
-			@models = params.empty? ? model.all : model.where(params)
-
-			@models.to_json
-		end
-
-		def self.show_attribute(params, attribute)
-			@model = find_model params
-
-			if @model
-				@model.send(attribute).to_json
+			if params.empty?
+				@models = model.all
 			else
-				raise RequestError.new(404, could_not_find(params[:id]), {params: params, attribute: attribute})
-			end
-		end
-
-		def self.team_number_to_team_id(post_data)
-			return post_data unless post_data.is_a?(Hash)
-
-			if post_data["team_number"] && !post_data["team_id"]
-				unless (team = Team.number post_data["team_number"]).nil?
-					post_data["team_id"] = team.id
+				params.delete("splat")
+				params.delete("captures")
 
-					post_data.delete("team_number")
-
-					post_data
-				else
-					raise RequestError.new(404, could_not_find(post_data["team_number"], "number", "team"), {post_data: post_data})
-				end
+				@models = model.all.psv_filter(params)
 			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)
-			return post_data unless post_data.is_a?(Hash)
-
-			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, {post_data: post_data})
-					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, {post_data: post_data, competition_id: competition.id})
-					end
-
-					post_data["match_id"] = match.id
-
-					post_data.delete("match_number")
-					post_data.delete("competition_name")
-
-					post_data
-				elsif post_data["competition"] && post_data["competition"]["_id"] && (competition = Competition.find_by(id: post_data["competition"]["_id"]))
-					# 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, {post_data: post_data, competition_id: competition.id})
-					end
-
-					post_data["match_id"] = match.id
-
-					post_data.delete("match_number")
-					post_data.delete("competition")
-
-					post_data
-				else
-					raise RequestError.new(422, "A current competition is not set.  Please set it.", {post_data: post_data})
-				end
-			end
+			@models.to_json
 		end
 	end
 end

data/lib/frecon/controllers/competitions_controller.rb

@@ -8,20 +8,9 @@
 # <http://opensource.org/licenses/MIT>.
 
 require "json"
-require "frecon/models"
+require "frecon/models/competition"
 
 module FReCon
 	class CompetitionsController < Controller
-		def self.teams(params)
-			show_attribute params, :teams
-		end
-
-		def self.matches(params)
-			show_attribute params, :matches
-		end
-
-		def self.records(params)
-			show_attribute params, :records
-		end
 	end
 end

data/lib/frecon/controllers/matches_controller.rb

@@ -8,16 +8,9 @@
 # <http://opensource.org/licenses/MIT>.
 
 require "json"
-require "frecon/models"
+require "frecon/models/match"
 
 module FReCon
 	class MatchesController < Controller
-		def self.competition(params)
-			show_attribute params, :competition
-		end
-
-		def self.records(params)
-			show_attribute params, :records
-		end
 	end
 end

data/lib/frecon/controllers/participations_controller.rb

@@ -7,18 +7,10 @@
 # license with this program.  If not, please see
 # <http://opensource.org/licenses/MIT>.
 
+require "json"
+require "frecon/models/participation"
+
 module FReCon
 	class ParticipationsController < Controller
-		def self.create(request, params, post_data = nil)
-			super(request, params, post_data || team_number_to_team_id(process_json_request(request)))
-		end
-
-		def self.competition(params)
-			show_attribute params, :competition
-		end
-
-		def self.team(params)
-			show_attribute params, :team
-		end
 	end
 end

data/lib/frecon/controllers/records_controller.rb

@@ -8,17 +8,9 @@
 # <http://opensource.org/licenses/MIT>.
 
 require "json"
-require "frecon/base"
-require "frecon/models"
+require "frecon/models/record"
 
 module FReCon
 	class RecordsController < Controller
-		def self.create(request, params, post_data = nil)
-			super(request, params, post_data || match_number_and_competition_to_match_id(team_number_to_team_id(process_json_request(request))))
-		end
-
-		def self.competition(params)
-			show_attribute params, :competition
-		end
 	end
 end

data/lib/frecon/controllers/robots_controller.rb

@@ -12,16 +12,5 @@ require "frecon/models/robot"
 
 module FReCon
 	class RobotsController < Controller
-		def self.create(request, params, post_data = nil)
-			super(request, params, post_data || team_number_to_team_id(process_json_request(request)))
-		end
-
-		def self.competition(params)
-			show_attribute params, :competition
-		end
-
-		def self.team(params)
-			show_attribute params, :team
-		end
 	end
 end

data/lib/frecon/controllers/teams_controller.rb

@@ -9,70 +9,9 @@
 
 require "json"
 require "frecon/base"
-require "frecon/models"
+require "frecon/models/team"
 
 module FReCon
 	class TeamsController < Controller
-		# 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
-
-		# 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
-				"Could not find #{model} of #{attribute} #{value}!"
-			end
-		end
-
-		def self.records(params)
-			@team = find_model params
-
-			if @team
-				if params[:competition_id]
-					@competition = Competition.find params[:competition_id]
-
-					if @competition
-						@team.records.in(match_id: @competition.matches.map { |match| match.id }).to_json
-					else
-						raise RequestError.new(404, could_not_find(params[:competition_id], "id", "competition"), {params: params, team: @team})
-					end
-				else
-					@team.records.to_json
-				end
-			else
-				raise RequestError.new(404, could_not_find(params[:id], "id or number"), {params: params})
-			end
-		end
-
-		def self.matches(params)
-			@team = find_model params
-
-			if @team
-				# Ensure that the competition ID is valid.
-				if params[:competition_id]
-					@competition = Competition.find params[:competition_id]
-
-					raise RequestError.new(404, could_not_find(params[:competition_id], "id", "competition"), {params: params, team: @team}) if @competition.nil?
-				end
-
-				@team.matches(params[:competition_id]).to_json
-			else
-				raise RequestError.new(404, could_not_find(params[:id], "id or number"), {params: params})
-			end
-		end
-
-		def self.competitions(params)
-			@team = find_model params
-
-			if @team
-				@team.competitions.to_json
-			else
-				raise RequestError.new(404, could_not_find(params[:id], "id or number"), {params: params})
-			end
-		end
 	end
 end

data/lib/frecon/database.rb

@@ -8,7 +8,9 @@
 # <http://opensource.org/licenses/MIT>.
 
 require "logger"
+
 require "mongoid"
+require "frecon/mongoid/criteria"
 
 require "tempfile"
 require "yaml"
@@ -27,7 +29,7 @@ module FReCon
 			else
 				Mongoid.load!(File.join(File.dirname(__FILE__), "mongoid.yml"), environment)
 			end
-			
+
 			if environment == :development
 				Mongoid.logger.level = Logger::DEBUG
 				Mongoid.logger = Logger.new($stdout)

data/lib/frecon/model.rb

@@ -8,6 +8,7 @@
 # <http://opensource.org/licenses/MIT>.
 
 require "mongoid"
+require "frecon/mongoid/criteria"
 
 module FReCon
 	class Model
@@ -18,6 +19,16 @@ module FReCon
 				include Mongoid::Attributes::Dynamic
 
 				validate :no_invalid_relations
+
+				self.class_variable_set(:@@attributes, [])
+
+				def self.register_routable_relation(method, attribute)
+					self.class_variable_get(:@@attributes) << {method: method, type: :relation, attribute: attribute}
+				end
+
+				def self.register_routable_attribute(method, attribute)
+					self.class_variable_get(:@@attributes) << {method: method, type: :attribute, attribute: attribute}
+				end
 			end
 		end
 

data/lib/frecon/models/competition.rb

@@ -21,15 +21,21 @@ module FReCon
 		validates :name, uniqueness: true
 
 		def records
-			matches = self.matches
-
 			Record.in match_id: matches.map(&:id)
 		end
 
-		def teams
-			participations = self.participations
+		def robots
+			Robot.in id: participations.map(&:robot_id)
+		end
 
-			Team.in id: participations.map(&:team_id)
+		def teams
+			Team.in id: robots.map(&:team_id)
 		end
+
+		register_routable_relation :matches, "matches"
+		register_routable_relation :participations, "participations"
+		register_routable_relation :records, "records"
+		register_routable_relation :robots, "robots"
+		register_routable_relation :teams, "teams"
 	end
 end

data/lib/frecon/models/match.rb

@@ -21,5 +21,23 @@ module FReCon
 		has_many :records, dependent: :destroy
 
 		validates :number, :competition_id, presence: true
+
+		def participations
+			Participation.in id: records.map(&:participation_id)
+		end
+
+		def robots
+			Robot.in id: participations.map(&:robot_id)
+		end
+
+		def teams
+			Team.in id: robots.map(&:team_id)
+		end
+
+		register_routable_relation :competition, "competition"
+		register_routable_relation :records, "records"
+		register_routable_relation :participations, "participations"
+		register_routable_relation :robots, "robots"
+		register_routable_relation :teams, "teams"
 	end
 end

data/lib/frecon/models/participation.rb

@@ -11,10 +11,24 @@ require "frecon/model"
 
 module FReCon
 	class Participation < Model
+		belongs_to :robot
 		belongs_to :competition
-		belongs_to :team
+		has_many :records, dependent: :destroy
 
-		validates :competition_id, :team_id, presence: true
-		validates :team_id, uniqueness: { scope: :competition_id }
+		validates :robot_id, :competition_id, presence: true
+
+		def team
+			robot.team
+		end
+
+		def matches
+			competition.matches
+		end
+
+		register_routable_relation :robot, "robot"
+		register_routable_relation :team, "team"
+		register_routable_relation :competition, "competition"
+		register_routable_relation :matches, "matches"
+		register_routable_relation :records, "records"
 	end
 end

data/lib/frecon/models/record.rb

@@ -16,12 +16,26 @@ module FReCon
 		field :position, type: Position
 
 		belongs_to :match
-		belongs_to :team
+		belongs_to :participation
 
-		validates :position, :match_id, :team_id, presence: true
+		validates :position, :match_id, :participation_id, presence: true
 
 		def competition
-			self.match.competition
+			match.competition
 		end
+
+		def robot
+			participation.robot
+		end
+
+		def team
+			participation.robot.team
+		end
+
+		register_routable_relation :match, "match"
+		register_routable_relation :competition, "competition"
+		register_routable_relation :participation, "participation"
+		register_routable_relation :robot, "robot"
+		register_routable_relation :team, "team"
 	end
 end

data/lib/frecon/models/robot.rb

@@ -14,10 +14,27 @@ module FReCon
 		# This is an optional field we included for organization.
 		field :name, type: String
 
-		belongs_to :competition
 		belongs_to :team
+		has_many :participations, dependent: :destroy
 
-		validates :competition_id, :team_id, presence: true
-		validates :team_id, uniqueness: { scope: :competition_id }
+		validates :team_id, presence: true
+
+		def competitions
+			Competition.in id: participations.map(&:competition_id)
+		end
+
+		def records
+			Record.in participation_id: participations.map(&:id)
+		end
+
+		def matches
+			Match.in id: records.map(&:match_id).uniq
+		end
+
+		register_routable_relation :team, "team"
+		register_routable_relation :participations, "participations"
+		register_routable_relation :competitions, "competitions"
+		register_routable_relation :records, "records"
+		register_routable_relation :matches, "matches"
 	end
 end

data/lib/frecon/models/team.rb

@@ -16,9 +16,8 @@ module FReCon
 		field :location, type: String
 		field :logo_path, type: String
 		field :name, type: String
-		
-		has_many :participations, dependent: :destroy
-		has_many :records, dependent: :destroy
+
+		has_many :robots, dependent: :destroy
 
 		validates :number, presence: true, uniqueness: true, numericality: { greater_than: 0 }
 
@@ -27,20 +26,28 @@ module FReCon
 			find_by number: team_number
 		end
 
+		def participations
+			Participation.in robot_id: robots.map(&:id)
+		end
+
 		def competitions
 			Competition.in id: participations.map(&:competition_id)
 		end
 
-		# Returns all of the matches that this team has been in.
-		# Optionally, returns the matches that this team has played
-		# in a certain competition.
-		def matches(competition_id = nil)
-			matches = Match.in record_id: self.records.map(&:id)
-			matches = matches.where competition_id: competition_id unless competition_id.nil?
+		def records
+			Record.in participation_id: participations.map(&:id)
+		end
 
-			matches
+		def matches
+			Match.in competition_id: competitions.map(&:id)
 		end
-		
+
+		register_routable_relation :robots, "robots"
+		register_routable_relation :participations, "participations"
+		register_routable_relation :competitions, "competitions"
+		register_routable_relation :records, "records"
+		register_routable_relation :matches, "matches"
+
 		# alias_method works by default solely on instance
 		# methods, so change context to the metaclass of
 		# Team and do aliasing there.
@@ -48,6 +55,5 @@ module FReCon
 			alias_method :with_number, :number
 			alias_method :that_has_number, :number
 		end
-
 	end
 end

data/lib/frecon/mongoid/criteria.rb

@@ -0,0 +1,43 @@
+# lib/frecon/mongoid/criteria.rb
+#
+# Copyright (C) 2015 Christopher Cooper, Sam Craig, Tiger Huang, Vincent Mai, Sam Mercier, and Kristofer Rye
+#
+# This file is part of FReCon, an API for scouting at FRC Competitions, which is
+# licensed under the MIT license.  You should have received a copy of the MIT
+# license with this program.  If not, please see
+# <http://opensource.org/licenses/MIT>.
+
+require "mongoid"
+
+module Mongoid
+	class Criteria
+		def psv_filter(psv_parameters = {})
+			collection = self
+
+			psv_parameters.each do |psv_string, comparison_value|
+				psv_keys = psv_string.split(" ").map do |psv_key|
+					psv_key.to_sym
+				end.reverse
+
+				comparison_key = psv_keys.shift
+
+				if comparison_value.length == 0 || comparison_value == "__nil__"
+					comparison_hash = {comparison_key => nil}
+				else
+					comparison_hash = {comparison_key => comparison_value}
+				end
+
+				psv_keys.each do |model|
+					model_id = (model.to_s + '_id').to_sym
+					model_class = ("FReCon::" + model.to_s.capitalize).constantize
+
+					comparison_hash = {model_id => model_class.in(comparison_hash).map(&:id)}
+				end
+
+				collection = collection.in(comparison_hash)
+			end
+
+			collection
+		end
+	end
+end

data/lib/frecon/routes.rb

@@ -11,180 +11,111 @@ require "frecon/controllers"
 
 module FReCon
 	module Routes
-		def self.resource_routes(base, name, controller, methods = [:create, :update, :delete, :show, :index])
-			if methods.include?(:create)
-				base.post "/#{name}" do
-					begin
-						controller.create request, params
-					rescue RequestError => e
-						e.return_value
-					end
-				end
-			end
-
-			if methods.include?(:update)
-				base.put "/#{name}/:id" do
-					begin
-						controller.update request, params
-					rescue RequestError => e
-						e.return_value
-					end
-				end
-			end
-
-			if methods.include?(:delete)
-				base.delete "/#{name}/:id" do
-					begin
-						controller.delete params
-					rescue RequestError => e
-						e.return_value
-					end
-				end
-			end
-
-			if methods.include?(:show)
-				base.get "/#{name}/:id" do
-					begin
-						controller.show params
-					rescue RequestError => e
-						e.return_value
-					end
-				end
-			end
-
-			if methods.include?(:index)
-				base.get "/#{name}" do
-					begin
-						controller.index params
-					rescue RequestError => e
-						e.return_value
-					end
-				end
-			end
-		end
-		
-		def self.included(base)
-			resource_routes base, "teams", TeamsController
-
-			base.get "/teams/:id/records/?:competition_id?" do
+		def self.resource_routes(base, name, controller)
+			base.post "/#{name}" do
 				begin
-					TeamsController.records params
+					controller.create request, params
 				rescue RequestError => e
 					e.return_value
 				end
 			end
 
-			base.get "/teams/:id/matches/?:competition_id?" do
+			base.put "/#{name}/:id" do
 				begin
-					TeamsController.matches params
+					controller.update request, params
 				rescue RequestError => e
 					e.return_value
 				end
 			end
 
-			base.get "/teams/:id/competitions" do
+			base.delete "/#{name}/:id" do
 				begin
-					TeamsController.competitions params
+					controller.delete params
 				rescue RequestError => e
 					e.return_value
 				end
 			end
 
-			resource_routes base, "competitions", CompetitionsController
-
-			base.get "/competitions/:id/teams" do
+			base.get "/#{name}/:id" do
 				begin
-					CompetitionsController.teams params
+					controller.show params
 				rescue RequestError => e
 					e.return_value
 				end
 			end
 
-			base.get "/competitions/:id/matches" do
+			base.get "/#{name}" do
 				begin
-					CompetitionsController.matches params
+					controller.index params
 				rescue RequestError => e
 					e.return_value
 				end
 			end
+		end
 
-			base.get "/competitions/:id/records" do
-				begin
-					CompetitionsController.records params
-				rescue RequestError => e
-					e.return_value
-				end
-			end
+		def self.attribute_routes(base, name, controller)
+			model = controller.model
 
-			resource_routes base, "matches", MatchesController
+			model_attribute_methods = model.class_variable_get(:@@attributes)
 
-			base.get "/matches/:id/records" do
-				begin
-					MatchesController.records params
-				rescue RequestError => e
-					e.return_value
-				end
-			end
+			model_attribute_methods.each do |model_attribute_method|
+				base.get "/#{name}/:id/#{model_attribute_method[:attribute]}" do
+					begin
+						@model = controller.find_model(params)
 
-			base.get "/matches/:id/competition" do
-				begin
-					MatchesController.competition params
-				rescue RequestError => e
-					e.return_value
-				end
-			end
+						params.delete("id")
 
-			resource_routes base, "records", RecordsController
+						result = @model.method(model_attribute_method[:method]).call
 
-			base.get "/records/:id/competition" do
-				begin
-					RecordsController.competition params
-				rescue RequestError => e
-					e.return_value
+						if result.is_a? Mongoid::Criteria
+							params.delete("splat")
+							params.delete("captures")
+
+							result.psv_filter(params).to_json
+						else
+							result.to_json
+						end
+					rescue RequestError => e
+						e.return_value
+					end
 				end
 			end
+		end
 
+		def self.included(base)
+			resource_routes base, "teams", TeamsController
+			resource_routes base, "competitions", CompetitionsController
+			resource_routes base, "matches", MatchesController
+			resource_routes base, "records", RecordsController
 			resource_routes base, "robots", RobotsController
+			resource_routes base, "participations", ParticipationsController
 
-			base.get "/robots/:id/competition" do
-				begin
-					RobotsController.competition params
-				rescue RequestError => e
-					e.return_value
-				end
-			end
+			attribute_routes base, "teams", TeamsController
+			attribute_routes base, "competitions", CompetitionsController
+			attribute_routes base, "matches", MatchesController
+			attribute_routes base, "records", RecordsController
+			attribute_routes base, "robots", RobotsController
+			attribute_routes base, "participations", ParticipationsController
 
-			base.get "/robots/:id/team" do
-				begin
-					RobotsController.team params
-				rescue RequestError => e
-					e.return_value
-				end
+			base.before do
+				params.delete("_")
 			end
 
-			resource_routes base, "participations", ParticipationsController
-
-			base.get "/participations/:id/competition" do
+			base.get "/dump" do
 				begin
-					ParticipationsController.competition params
+					DumpController.full params
 				rescue RequestError => e
 					e.return_value
 				end
 			end
 
-			base.get "/participations/:id/team" do
-				begin
-					ParticipationsController.team params
-				rescue RequestError => e
-					e.return_value
-				end
-			end
+			if ENV["PRINT_ROUTES"]
+				base.routes.each do |verb, routes|
+					puts "#{verb}:"
 
-			base.get "/dump" do
-				begin
-					DumpController.full params
-				rescue RequestError => e
-					e.return_value
+					routes.each do |route|
+						puts "  #{route[0]}"
+					end
 				end
 			end
 		end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frecon
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Sam Craig
@@ -106,6 +106,7 @@ files:
 - lib/frecon/models/robot.rb
 - lib/frecon/models/team.rb
 - lib/frecon/mongoid.yml
+- lib/frecon/mongoid/criteria.rb
 - lib/frecon/position.rb
 - lib/frecon/request_error.rb
 - lib/frecon/routes.rb