samwise 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cedf0ddf4f864708ca96abba38a421d72d3b977
-  data.tar.gz: 4344f18276fb3ffad195a0ec646a81a4bb380ceb
+  metadata.gz: a2ca088ec51febc2528f8c85bd8def3f12916bcf
+  data.tar.gz: 30d7eefed09aa261d36f52fd9c1c78ac41cf050b
 SHA512:
-  metadata.gz: ac6ef030f7aa3cdc9923893a0ebc2f030c0558d889771b0d91a27353f47a382b1db0b61b16f9696bab82292a72cede315503ca8f13e085ca87d74982bfb1d6a6
-  data.tar.gz: 1318c3ffc619e53dd9f4f7181c2324ce9d233f05dce845bfcf325780b1018a7860425c998a0b3e4811c9881bc4aafbc7c1b6ed5ca8f7c81543214fea7ed36103
+  metadata.gz: 97eecd5982d49f78a088753e3ca05f8f043f96b45d3789e635c9b40d2260265fb27c140b36daf97efed3294f4841339a9035405889648fe99b96ff7465e75311
+  data.tar.gz: 17e4d853e602d24e94eea6176072a3c15b603a42290d7cc8897fa66c2da0717783c75208f0ec1cd66718aa792ef8f87a385cc213e9f0acb6cb52055d7739874d

data/README.md

@@ -36,36 +36,122 @@ client.duns_is_in_sam?(duns: '080037478')
 #=> true
 ```
 
+### Verify Vendor is not on the excluded parties list
+
+```ruby
+client.excluded?(duns: '080037478')
+#=> false
+```
+
+### Verify Vendor is a small business
+
+```ruby
+client.small_business?(duns: '080037478', naicsCode: 541511)
+#=> false
+```
+
 ### Get DUNS info
 
 ```ruby
-client.get_duns_info(duns: '080037478')
-#=>
+duns_info = client.get_duns_info(duns: '080037478')
+
 {
-    "sam_data" => {
-        "registration" => {
-            "govtBusinessPoc" => {
-                "lastName" => "SUDOL", "address" => {
-                    "Line1" => "4301 N HENDERSON RD APT 408", "Zip" => "22203", "Country" => "USA", "City" => "Arlington", "stateorProvince" => "VA"
-                }, "email" => "BRENDANSUDOL@GMAIL.COM", "usPhone" => "5404218332", "firstName" => "BRENDAN"
-            }, "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=%2BFCe4Gq91w3LPzmIapO9KekwldCbu7D2ee%2FlxnUkqFvrQwe3OD%2FJSpI%2FuXW0rrpz&pitId=clfEJcL40D6baXhmKE8hVFZPHUDQegjQvNgn4YGfaL%2Fzh6O%2B%2FUJYaSJJ0dKFPFhm&requestId=Xzq5jdsGDkiXPF4"
-            }, "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", "businessStartDate" => "2015-10-28", "statusMessage" => "Active", "lastUpdateDate" => "2015-11-02 17:36:23.0", "submissionDate" => "2015-10-28 10:53:02.0", "samAddress" => {
-                "Zip4" => "2511", "Line1" => "4301 N Henderson Rd Apt 408", "Zip" => "22203", "Country" => "USA", "City" => "Arlington", "stateorProvince" => "VA"
-            }, "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" => {
-                    "Line1" => "4301 N HENDERSON RD APT 408", "Zip" => "22203", "Country" => "USA", "City" => "Arlington", "stateorProvince" => "VA"
-                }, "email" => "BRENDANSUDOL@GMAIL.COM", "usPhone" => "5404218332", "firstName" => "BRENDAN"
-            }, "mailingAddress" => {
-                "Zip4" => "2511", "Line1" => "4301 N Henderson Rd Apt 408", "Zip" => "22203", "Country" => "USA", "City" => "Arlington", "stateorProvince" => "VA"
-            }, "purposeOfRegistration" => "ALL_AWARDS"
+  "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"
     }
+  }
 }
+#=>
 ```
 
 ### Validate the format of a DUNS number
@@ -101,8 +187,9 @@ Samwise::Util.format_duns(duns: '08-011-5718')
 #=> "0801157180000"
 ```
 
-`duns` can be an 8, 9, or 13 digit number (hyphens are removed):
+`duns` can be a 7, 8, 9, or 13 digit number (hyphens are removed):
 
+- If it is 7 digits, `00` is prepended, and `0000` is added to the end.
 - If it is 8 digits, `0` is prepended, and `0000` is added to the end.
 - If it is 9 digits, `0000` is added to the end.
 - If it is 13 digits, the number is unchanged.
@@ -144,6 +231,38 @@ gem 'samwise', github: '18f/samwise'
 $ gem install samwise
 ```
 
+## Command Line Interface
+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.
+
+#### Input Format
+The CLI expects a .json with the following schema:
+
+```json
+{"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:
+```bash
+cat "input_file.json" | samwise verify > output.json
+samwise verify -i "input_file.json" > output.json
+```
+
+#### Output
+The CLI will output a JSON to `STDOUT` with an addition key to be determined by the method run (see below for reference).
+
+#### Available Commands
+| 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`  |
+
 ## Public Domain
 
 This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):

data/bin/samwise

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'samwise'
+
+Samwise::Cli.start

data/lib/samwise.rb

@@ -3,3 +3,4 @@ require 'samwise/error'
 require 'samwise/util'
 require 'samwise/protocol'
 require 'samwise/client'
+require 'samwise/cli'

data/lib/samwise/cli.rb

@@ -0,0 +1,60 @@
+require "thor"
+require 'json'
+
+# require 'samwise'
+
+module Samwise
+  class Cli < Thor
+    method_option :infile, :aliases => "-i", :desc => "Nonpiped version input"
+    # method_option :dunsnum, :aliases => "-d", :desc => "DUNS number"
+    desc "verify", "Verify DUNS numbers are in SAM.gov"
+    def verify
+      wrap_sam("verified"){|c, u, j| u[j] = c.duns_is_in_sam?(duns: u['duns'])}
+    end
+    method_option :infile, :aliases => "-i", :desc => "Nonpiped version input"
+    desc "excluded", "Verify Vendor is not on the excluded parties list"
+    def excluded
+      wrap_sam("excluded"){|c, u, j| u[j] = c.excluded?(duns: u['duns'])}
+    end
+
+    method_option :infile, :aliases => "-i", :desc => "Nonpiped version input"
+    desc "get_info", "Get DUNS info"
+    def get_info
+      wrap_sam("user_info"){|c, u, j| u[j] = c.get_duns_info(duns: u['duns'])}
+    end
+
+    method_option :infile, :aliases => "-i", :desc => "Nonpiped version input"
+    desc "check_format", "Validate the format of a DUNS number"
+    def check_format
+      wrap_sam("valid_format"){|c, u, j| u[j] = Samwise::Util.duns_is_properly_formatted?(duns: u['duns'])}
+    end
+
+    method_option :infile, :aliases => "-i", :desc => "Nonpiped version input"
+    desc "format", "Format a DUNS number"
+    def format
+        wrap_sam("formatted_duns") {|c, u, j| u[j] = Samwise::Util.format_duns(duns: u['duns'])}
+    end
+
+    #Helpers
+    desc "private method wrap_sam JSonkeytoadd &block", "Opens the client and cli files for all of the calls"
+    def wrap_sam(jsonOutKey, &block)
+      infile = ($stdin.tty?) ? File.read(options[:infile]) : $stdin.read       #read in a json of users to be samwised
+      duns_hash = JSON.parse(infile)
+      #check what method called wrap_sam. Do not init samwise client for utils
+      thor_method = caller_locations(1,1)[0].label
+      client = Samwise::Client.new unless (thor_method == "check_format") || (jsonOutKey =="format")
+
+
+     duns_hash['users'].each do |user|
+      #abort process do improperly formated duns
+       abort("please use a .json with a duns key") unless user.has_key?("duns")
+       block.call(client, user, jsonOutKey)
+     end
+     puts duns_hash.to_json
+
+    end
+
+    private :wrap_sam
+
+  end
+end

data/lib/samwise/client.rb

@@ -1,4 +1,3 @@
-require 'faraday'
 require 'json'
 require 'httpclient'
 
@@ -7,9 +6,6 @@ module Samwise
     def initialize(api_key: nil, sam_status_key: Samwise::Protocol::SAM_STATUS_KEY)
       @api_key        = api_key        || ENV['DATA_DOT_GOV_API_KEY']
       @sam_status_key = sam_status_key || ENV['SAM_STATUS_KEY']
-      @conn = Faraday.new do |faraday|
-        faraday.adapter :httpclient
-      end
       @client = HTTPClient.new
     end
 
@@ -18,7 +14,8 @@ module Samwise
       JSON.parse(response.body)
     end
 
-    def duns_is_in_sam?(duns: nil)
+    def duns_is_in_sam?(duns: nil, delay: 1)
+      sleep(delay)
       response = lookup_duns(duns: duns)
       response.status == 200
     end
@@ -28,6 +25,37 @@ module Samwise
       JSON.parse(response.body)
     end
 
+    def excluded?(duns: nil)
+      response = lookup_duns(duns: duns)
+      JSON.parse(response.body)["hasKnownExclusion"] == false
+    end
+
+    def small_business?(duns: nil, naicsCode: nil)
+      response = lookup_duns(duns: duns)
+      data = JSON.parse(response.body)["sam_data"]["registration"]
+
+      if data["certifications"] == nil
+        return false
+      end
+      data = data["certifications"]["farResponses"]
+      small_biz_array = data.find{|far|far["id"]=="FAR 52.219-1"}["answers"].find{"naics"}["naics"]
+
+      # Allows for exact matches of a NAICS Code *or* NAICS code that starts with the argument.
+      # E.g., 541511 matches, but 54151 also matches
+      if small_biz_array.class == Array
+        naics = small_biz_array.find{|naics|naics["naicsCode"].to_s.start_with?(naicsCode.to_s)}
+      else
+        naics = small_biz_array
+      end
+
+      # Check for the NAICS Code and, if found, check whether it's a small
+      if naics == nil
+        false
+      else
+        naics["isSmallBusiness"] == "Y"
+      end
+    end
+
     private
 
     def lookup_duns(duns: nil)

data/lib/samwise/protocol.rb

@@ -1,7 +1,7 @@
 module Samwise
   module Protocol
     SAM_API_BASE_URL    = 'https://api.data.gov'
-    SAM_API_API_VERSION = 'v1'
+    SAM_API_API_VERSION = 'v4'
     SAM_STATUS_URL      = 'https://www.sam.gov/samdata/registrations/trackProgress'
     SAM_STATUS_KEY      = '1452031543862'
 

data/lib/samwise/util.rb

@@ -8,6 +8,7 @@ module Samwise
 
       return true if duns_contains_forbidden_characters?(duns: duns)
 
+      return true if duns_is_seven_digits?(duns: duns)
       return true if duns_is_eight_digits?(duns: duns)
       return true if duns_is_nine_digits?(duns: duns)
       return true if duns_is_thirteen_digits?(duns: duns)
@@ -24,6 +25,8 @@ module Samwise
         duns = "#{duns}0000"
       elsif duns_is_eight_digits?(duns: duns)
         duns = "0#{duns}0000"
+      elsif duns_is_seven_digits?(duns: duns)
+        duns = "00#{duns}0000"
       end
 
       duns
@@ -45,6 +48,10 @@ module Samwise
       return true
     end
 
+    def self.duns_is_seven_digits?(duns: nil)
+      duns.length == 7
+    end
+
     def self.duns_is_eight_digits?(duns: nil)
       duns.length == 8
     end

data/lib/samwise/version.rb

@@ -1,3 +1,3 @@
 module Samwise
-  VERSION = '0.2.6'
+  VERSION = '0.2.7'
 end

data/samwise.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'vcr'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'thor'
 
   gem.add_runtime_dependency 'httpclient'
-  gem.add_runtime_dependency 'faraday'
 end

data/spec/cli_mocks/bad.json

@@ -0,0 +1 @@
+{"users":[{"uid":"1000"},{"uid":"100"}]}

data/spec/cli_mocks/test.json

@@ -0,0 +1 @@
+{"users":[{"uid":"1000","duns":"080037478"},{"uid":"100","duns":"080031478"}]}

data/spec/cli_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+require 'samwise'
+require 'json'
+require 'factory'
+require 'stringio'
+
+describe Samwise::Cli, vcr: { cassette_name: "Samwise::Cli", record: :new_episodes } do
+  let(:goodfile) {'spec/cli_mocks/test.json'}
+  let(:piped_file){$stdin = StringIO.new(File.read(goodfile))}
+  let(:badfile) {'spec/cli_mocks/bad.json'}
+  let(:user_array) {Factory.create_users(["1000", "100"], ["080037478", "080031478"])}
+  let(:abort_msg) {'please use a .json with a duns key'}
+
+	def output(method, file)
+    capture(:stdout){Samwise::Cli.new.invoke(method, [], {:infile => file})}
+  end
+
+  after(:example) do
+    $stdin = STDIN
+  end
+
+  describe ".verify" do
+    let(:method) {:verify}
+    let(:verified_user) {Factory.build_users_json(user_array, [{"verified" => true}, {"verified" => false}])+"\n"}
+    it "verifies the duns for each user with streamed infile" do
+        piped_file
+        expect(output(method, goodfile)).to eq(verified_user)
+    end
+    it "verifies the duns for each user when given an -i flagged test.json with duns key" do
+      expect(output(method, goodfile)).to eq(verified_user)
+    end
+
+    it "requests to recieve a good json when recieves json without duns key" do
+      begin
+        err = capture_stderr(output(method, badfile))
+      rescue Exception => e
+        expect(e.to_s).to eq(abort_msg)
+      end
+    end
+  end
+
+  describe ".excluded" do
+	  let(:method) {:excluded}
+	  let(:excluded_user){Factory.build_users_json(user_array, [{"excluded" => false}, {"excluded" => false}])+"\n"}
+	  it "checks if users are excluded for each user in a streamed infile" do
+	    piped_file
+	    expect(output(method, goodfile)).to eq(excluded_user)
+	  end
+
+	  it "checks if users are excluded when given an -i flagged test.json with duns key" do
+	      expect(output(method, goodfile)).to eq(excluded_user)
+	  end
+
+	  it "requests to recieve a good json when recieves json without duns key" do
+	    begin
+	      output(method, badfile)
+	    rescue Exception => e
+	      expect(e.to_s).to eq(abort_msg)
+	    end
+	  end
+  end
+
+  describe ".get_info" do
+	  let(:method){:get_info}
+	  let(:expected_info) {"sam_data"}
+	  it "gets the users' information for each user in a streamed infile" do
+      piped_file
+      expect(output(method, goodfile)).to include(expected_info)
+	  end
+
+	  it "gets the users' information and adds to the json when given an -i flagged test.json with duns key" do
+	    expect(output(method, goodfile)).to include(expected_info)
+	  end
+
+	  it "requests to recieve a good json when recieves json without duns key" do
+	    begin
+	      output(method, badfile)
+	    rescue Exception => e
+	      expect(e.to_s).to eq(abort_msg)
+	    end
+	  end
+  end
+
+  describe ".check_format" do
+	  let(:method) {:check_format}
+	  let(:valid_duns){Factory.build_users_json(user_array, [{"valid_format" => true}, {"valid_format" => true}])+"\n"}
+	  it "verifies that the each duns number is formatted for each user in a streamed infile" do
+      piped_file
+      expect(output(method, goodfile)).to eq(valid_duns)
+	  end
+
+	  it "verifies that the each duns number is formatted for -i flagged test.json with duns key" do
+	      expect(output(method, goodfile)).to eq(valid_duns)
+	  end
+
+	  it "requests to recieve a good json when recieves json without duns key" do
+      begin
+        output(method, badfile)
+      rescue Exception => e
+        expect(e.to_s).to eq(abort_msg)
+      end
+	  end
+  end
+
+  describe ".format" do
+    let(:method) {:format}
+    let(:format_duns){Factory.build_users_json(user_array, [{"formatted_duns" => "0800374780000"}, {"formatted_duns" => "0800314780000"}])+"\n"}
+    it "formats duns numbers when streamed in json with users array and duns key" do
+      piped_file
+      expect(output(method, goodfile)).to eq(format_duns)
+    end
+
+    it "formats duns numbers when given an -i flagged test.json with duns key " do
+      expect(output(method, goodfile)).to eq(format_duns)
+    end
+
+    it "requests to recieve a good json when recieves json without duns key" do
+      begin
+        output(method, badfile)
+      rescue Exception => e
+        expect(e.to_s).to eq(abort_msg)
+      end
+    end
+  end
+end