Ruby access to the SAM.gov API.
To get started, you'll need an API key from https://api.data.gov.
Set the api.data.gov API key as the environment variable 'DATA_DOT_GOV_API_KEY' or pass the key as an argument:
require 'samwise'
client = Samwise::Client.new(api_key: 'my key ...')
# if you set the 'DATA_DOT_GOV_API_KEY' env var, just use:
client = Samwise::Client.newclient.get_vendor_summary(duns: '080037478')
#=>
{
in_sam: true,
small_business: true
}Note: the definition of small_business is IT-centric.
See Verify Vendor is a small business for the list of NAICS codes uses to check if some a vendor is a small business.
client.duns_is_in_sam?(duns: '080037478')
#=> trueclient.excluded?(duns: '080037478')
#=> falseclient.small_business?(duns: '080037478')
#=> falseThis method checks against the following NAICS codes:
- 511210
- 541511
- 541512
- 541519
- 334614
What is a NAICS code?
The North American Industry Classification System (NAICS) is used by businesses and governments to classify and measure economic activity in the United States, Canada, and Mexico. NAICS is 6-digit code system that is currently the standard used by federal statistical agencies in classifying business establishments.
(source: http://siccode.com/en/pages/what-is-a-naics-code)
The whitelisted NAICS codes classify companies that offer IT or related services.
duns_info = client.get_duns_info(duns: '080037478')
{
"sam_data"=>{
"registration"=>{
"govtBusinessPoc"=>{
"lastName"=>"SUDOL",
"address"=>{
"zip"=>"22203",
"countryCode"=>"USA",
"line1"=>"4301 N HENDERSON RD APT 408",
"stateorProvince"=>"VA",
"city"=>"Arlington"
},
"email"=>"BRENDANSUDOL@GMAIL.COM",
"usPhone"=>"5404218332",
"firstName"=>"BRENDAN"
},
"qualifications"=>{
},
"dunsPlus4"=>"0000",
"activationDate"=>"2015-10-30 11:42:30.0",
"fiscalYearEndCloseDate"=>"12\/31",
"businessTypes"=>[
"VW",
"2X",
"27"
],
"registrationDate"=>"2015-10-28 00:00:00.0",
"certificationsURL"=>{
"pdfUrl":
"https:\/\/www.sam.gov\/SAMPortal\/filedownload?reportType=1&orgId=kZhDothaHaS8Y%2BBby2ety%2B1PIcKkDuGxkhITFtBfiwpmpGqNLrKsCz9OrI6CaxsI&pitId=Pg1XpWC8vQH7LKi9e8r5BK5D6ORH953kPtjfCGikUDnIY8Fsp71cFeSgzD8W9Uqd&requestId=OBq2t61SZrN75k9"
},
"hasDelinquentFederalDebt"=>false,
"duns"=>"080037478",
"cage"=>"7H1Y7",
"hasKnownExclusion"=>false,
"publicDisplay"=>true,
"expirationDate"=>"2016-10-27 10:53:02.0",
"status"=>"ACTIVE",
"corporateStructureCode"=>"2J",
"stateOfIncorporation"=>"VA",
"corporateStructureName"=>"Sole Proprietorship",
"legalBusinessName"=>"Sudol, Brendan",
"congressionalDistrict"=>"VA 08",
"bondingInformation"=>{
},
"businessStartDate"=>"2015-10-28",
"statusMessage"=>"Active",
"lastUpdateDate"=>"2015-11-02 17:36:23.0",
"samAddress"=>{
"zipPlus4"=>"2511",
"zip"=>"22203",
"countryCode"=>"USA",
"line1"=>"4301 N Henderson Rd Apt 408",
"stateorProvince"=>"VA",
"city"=>"Arlington"
},
"submissionDate"=>"2015-10-28 10:53:02.0",
"naics"=>[
{
"isPrimary"=>false,
"naicsCode"=>"518210",
"naicsName"=>"DATA PROCESSING, HOSTING, AND RELATED SERVICES"
},
{
"isPrimary"=>true,
"naicsCode"=>"541511",
"naicsName"=>"CUSTOM COMPUTER PROGRAMMING SERVICES"
}
],
"creditCardUsage"=>true,
"countryOfIncorporation"=>"USA",
"electronicBusinessPoc"=>{
"lastName"=>"SUDOL",
"address"=>{
"zip"=>"22203",
"countryCode"=>"USA",
"line1"=>"4301 N HENDERSON RD APT 408",
"stateorProvince"=>"VA",
"city"=>"Arlington"
},
"email"=>"BRENDANSUDOL@GMAIL.COM",
"usPhone"=>"5404218332",
"firstName"=>"BRENDAN"
},
"mailingAddress"=>{
"zipPlus4"=>"2511",
"zip"=>"22203",
"countryCode"=>"USA",
"line1"=>"4301 N Henderson Rd Apt 408",
"stateorProvince"=>"VA",
"city"=>"Arlington"
},
"purposeOfRegistration"=>"ALL_AWARDS"
}
}
}
#=>This does not need an API key and makes no network calls.
Samwise::Util.duns_is_properly_formatted?(duns: '88371771')
#=> true
Samwise::Util.duns_is_properly_formatted?(duns: '883717717')
#=> true
Samwise::Util.duns_is_properly_formatted?(duns: '0223841150000')
#=> true
Samwise::Util.duns_is_properly_formatted?(duns: '08-011-5718')
#=> true
Samwise::Util.duns_is_properly_formatted?(duns: 'abc1234567')
#=> false
Samwise::Util.duns_is_properly_formatted?(duns: '1234567891234567890')
#=> falseThis removes any hyphens and appends 0s where appropriate (does not need an API key and makes no network calls):
Samwise::Util.format_duns(duns: '08-011-5718')
#=> "0801157180000"duns can be a 7, 8, 9, or 13 digit number (hyphens are removed):
- If it is 7 digits,
00is prepended, and0000is added to the end. - If it is 8 digits,
0is prepended, and0000is added to the end. - If it is 9 digits,
0000is added to the end. - If it is 13 digits, the number is unchanged.
There is a web form where anyone can enter a DUNS number to get its status within SAM.gov: https://www.sam.gov/sam/helpPage/SAM_Reg_Status_Help_Page.html.
This form uses an undocumented/unpublished JSON endpoint. This gem provides Ruby access to that endpoint.
This does not require an api.data.gov API key, but it will make a network call to the above URL.
The SAM.gov status web form hard codes what appears to be an API key. That key is used by default in this gem. However, you may supply your own (also tell us where you got it!).
client = Samwise::Client.new(sam_status_key: 'optional')
client.get_sam_status(duns: '08-011-5718')
#=> {
"Message" => "Request for registration information forbidden",
"Code" => 403,
"Error" => ""
}
client.get_sam_status(duns: )In your Gemfile:
gem 'samwise', github: '18f/samwise'$ gem install samwise
The samwise gem can be run via command line via a piped in file or with a file input flag.
To make the gem executable run gem install samwise which calls makes the contents of the bin directory executable in the gemspec.
The CLI expects a .json with the following schema:
{"users":[{"other_keys": "other_values", "duns":"duns_number"}]}If the JSON does not include a "duns" key, the CLI will abort.
The JSON can be piped in or fed in from a file via a -i flag. For example:
cat "input_file.json" | samwise verify > output.json
samwise verify -i "input_file.json" > output.jsonThe CLI will output a JSON to STDOUT with an addition key to be determined by the method run (see below for reference).
| CLI Comand | Samwise Function | JSON OutKey |
|---|---|---|
samwise verify |
Samwise::Client.duns_is_in_sam? |
verified |
samwise excluded |
Samwise::Client.excluded? |
excluded |
samwise get_info |
Samwise::Client.get_duns_info |
sam_data |
samwise check_format |
Samwise::Util.duns_is_properly_formatted? |
valid_format |
samwise format |
Samwise::Util.format_duns |
formatted_duns |
This project is in the worldwide public domain. As stated in CONTRIBUTING:
This project is in the public domain within the United States, and copyright and related rights in the work worldwide 62D0 are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.