class FederalAccountViewSet(AbstractAccountViewSet):
"""
This route takes award filters and returns spending by Federal Account.
"""
endpoint_doc = "usaspending_api/api_contracts/contracts/v2/search/spending_by_category/federal_account.md"
category = Category(name="federal_account", agg_key="federal_accounts")
class CountryViewSet(AbstractLocationViewSet):
"""
This route takes award filters and returns spending by Country.
"""
endpoint_doc = "usaspending_api/api_contracts/contracts/v2/search/spending_by_category/country.md"
location_type = LocationType.COUNTRY
category = Category(name="country", agg_key="pop_country_agg_key")
class StateTerritoryViewSet(AbstractLocationViewSet):
"""
This route takes award filters and returns spending by State Territory.
"""
endpoint_doc = "usaspending_api/api_contracts/contracts/v2/search/spending_by_category/state_territory.md"
location_type = LocationType.STATE_TERRITORY
category = Category(name="state_territory", agg_key="pop_state_agg_key")
class DistrictViewSet(AbstractLocationViewSet):
"""
This route takes award filters and returns spending by Congressional District.
"""
endpoint_doc = "usaspending_api/api_contracts/contracts/v2/search/spending_by_category/district.md"
location_type = LocationType.CONGRESSIONAL_DISTRICT
category = Category(name="district", agg_key="pop_congressional_agg_key")
class FundingSubagencyViewSet(AbstractAgencyViewSet):
"""
This route takes award filters and returns spending by funding subagencies.
"""
endpoint_doc = "usaspending_api/api_contracts/contracts/v2/search/spending_by_category/funding_subagency.md"
agency_type = AgencyType.FUNDING_SUBTIER
category = Category(name="funding_subagency", agg_key="funding_subtier_agency_agg_key")
class AwardingAgencyViewSet(AbstractAgencyViewSet):
"""
This route takes award filters and returns spending by awarding agencies.
"""
endpoint_doc = "usaspending_api/api_contracts/contracts/v2/search/spending_by_category/awarding_agency.md"
agency_type = AgencyType.AWARDING_TOPTIER
category = Category(name="awarding_agency", agg_key="awarding_toptier_agency_agg_key")
class PSCViewSet(AbstractIndustryCodeViewSet):
"""
This route takes award filters and returns spending by PSC.
"""
endpoint_doc = "usaspending_api/api_contracts/contracts/v2/search/spending_by_category/psc.md"
industry_code_type = IndustryCodeType.PSC
category = Category(name="psc", agg_key="psc_agg_key")
class NAICSViewSet(AbstractIndustryCodeViewSet):
"""
This route takes award filters and returns spending by NAICS.
"""
endpoint_doc = "usaspending_api/api_contracts/contracts/v2/search/spending_by_category/naics.md"
industry_code_type = IndustryCodeType.NAICS
category = Category(name="naics", agg_key="naics_agg_key")
class CfdaViewSet(AbstractIndustryCodeViewSet):
"""
This route takes award filters and returns spending by CFDA.
"""
endpoint_doc = "usaspending_api/api_contracts/contracts/v2/search/spending_by_category/cfda.md"
industry_code_type = IndustryCodeType.CFDA
category = Category(name="cfda", agg_key=industry_code_type.value)
class RecipientDunsViewSet(AbstractSpendingByCategoryViewSet):
"""
This route takes award filters and returns spending by Recipient DUNS.
"""
endpoint_doc = "usaspending_api/api_contracts/contracts/v2/search/spending_by_category/recipient_duns.md"
category = Category(name="recipient_duns", agg_key="recipient_agg_key")
@staticmethod
def _get_recipient_id(row: list) -> str:
"""
In the recipient_profile table there is a 1 to 1 relationship between hashes and DUNS
(recipient_unique_id) and the hashes+duns match exactly between recipient_profile and
recipient_lookup where there are matches. Grab the level from recipient_profile by
hash if we have one or by DUNS if we have one of those.
"""
if "recipient_hash" in row:
profile_filter = {"recipient_hash": row["recipient_hash"]}
elif "recipient_unique_id" in row:
profile_filter = {
"recipient_unique_id": row["recipient_unique_id"]
}
else:
raise RuntimeError(
"Attempted to lookup recipient profile using a queryset that contains neither "
"'recipient_hash' nor 'recipient_unique_id'")
profile = (RecipientProfile.objects.filter(**profile_filter).exclude(
recipient_name__in=SPECIAL_CASES).annotate(sort_order=Case(
When(recipient_level="C", then=Value(0)),
When(recipient_level="R", then=Value(1)),
default=Value(2),
output_field=IntegerField(),
)).values("recipient_hash",
"recipient_level").order_by("sort_order").first())
return (combine_recipient_hash_and_level(profile["recipient_hash"],
profile["recipient_level"])
if profile else None)
def build_elasticsearch_result(self, response: dict) -> List[dict]:
results = []
location_info_buckets = response.get("group_by_agg_key",
{}).get("buckets", [])
for bucket in location_info_buckets:
recipient_info = json.loads(bucket.get("key"))
results.append({
"amount":
int(bucket.get("sum_field", {"value": 0})["value"]) /
Decimal("100"),
"recipient_id":
recipient_info["hash_with_level"] or None,
"name":
recipient_info["name"] or None,
"code":
recipient_info["unique_id"] or "DUNS Number not provided",
})
return results
def query_django_for_subawards(self,
base_queryset: QuerySet) -> List[dict]:
django_filters = {}
django_values = ["recipient_name", "recipient_unique_id"]
annotations = {
"name": F("recipient_name"),
"code": F("recipient_unique_id")
}
queryset = self.common_db_query(base_queryset, django_filters,
django_values).annotate(**annotations)
lower_limit = self.pagination.lower_limit
upper_limit = self.pagination.upper_limit
query_results = list(queryset[lower_limit:upper_limit])
for row in query_results:
row["recipient_id"] = self._get_recipient_id(row)
for key in django_values:
del row[key]
return query_results
