samwise 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8af5c83add66f563dd036246aae10b326d2dda50
-  data.tar.gz: 8ff5bfb1a9ca8a6c56ea2cd027d0fe51123de03d
+  metadata.gz: 51829ef71b62ddf9e69b989b2c82a79a58cd3b44
+  data.tar.gz: 55b99795f3f3557c936afbad12aa0f6b8c45f196
 SHA512:
-  metadata.gz: 17c7b87e130dfeb8125d957090314176aa2e6517ed0afb102b1386bee70d1e64558eb428c5aa922c569289a646c3471bd0e2f950fbedd77a51e686421450b878
-  data.tar.gz: 4a85c96cfcc7cb0a67fc6cababdb26eda6f31913d91e8e372309ecda68537e1ac7565d2da79e528d9639f0c48ad4e50858f898a29e161d90b978f15a756e7f1a
+  metadata.gz: ded464ceac3d0780727bcebb709f5ede19fa79dd7c4aa399b50a233e51f4bed3ed0127026b785bfa7ed9148d8191f10e67de593789483de96beb1b472f4d62ef
+  data.tar.gz: 97951c2cd954eef771e5435111fc0717429b57dbbbb22d9ca9ba5b411d9f2d5e5282be961ece1e370e2a6d32d2811dc037b8485d96f533f3342ab237e59302ed

data/README.md

@@ -29,10 +29,10 @@ client = Samwise::Client.new(api_key: 'my key ...')
 client = Samwise::Client.new
 ```
 
-### Verify DUNS number
+### Verify DUNS number is in SAM.gov
 
 ```ruby
-client.duns_is_valid?(duns: '080037478')
+client.duns_is_in_sam?(duns: '080037478')
 #=> true
 ```
 
@@ -68,7 +68,40 @@ client.get_duns_info(duns: '080037478')
 }
 ```
 
-`duns` can be an 8, 9, or 13 digit number:
+### Validate the format of a DUNS number
+
+This does not need an API key and makes no network calls.
+
+```ruby
+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')
+#=> false
+```
+
+### Format a DUNS number
+
+This removes any hyphens and appends `0`s where appropriate (does not need an API key and makes no network calls):
+
+```ruby
+Samwise::Util.format_duns(duns: '08-011-5718')
+#=> "0801157180000"
+```
+
+`duns` can be an 8, 9, or 13 digit number (hyphens are removed):
 
 - 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.

data/lib/samwise/client.rb

@@ -3,7 +3,7 @@ require 'json'
 
 module Samwise
   class Client
-    def initialize(api_key: api_key)
+    def initialize(api_key: nil)
       @api_key = api_key || ENV['DATA_DOT_GOV_API_KEY']
     end
 
@@ -12,14 +12,14 @@ module Samwise
       JSON.parse(response.body)
     end
 
-    def duns_is_valid?(duns: nil)
+    def duns_is_in_sam?(duns: nil)
       response = lookup_duns(duns: duns)
       response.status == 200
     end
 
     private
 
-    def lookup_duns(duns: duns)
+    def lookup_duns(duns: nil)
       duns = Samwise::Util.format_duns(duns: duns)
       response = Faraday.get(Samwise::Protocol.duns_url(duns: duns, api_key: @api_key))
     end

data/lib/samwise/error.rb

@@ -0,0 +1,9 @@
+module Samwise
+  module Error
+    class InvalidFormat < StandardError
+      def initialize(message: 'The format of the provided DUNS number is invalid')
+        super(message)
+      end
+    end
+  end
+end

data/lib/samwise/util.rb

@@ -2,14 +2,58 @@ require 'pry'
 
 module Samwise
   module Util
-    def self.format_duns(duns: duns)
-      if duns.length == 9
+    def self.duns_is_properly_formatted?(duns: nil)
+      duns.gsub!('-', '')
+
+      return true if duns_contains_forbidden_characters?(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)
+
+      return false
+    end
+
+    def self.format_duns(duns: nil)
+      raise Samwise::Error::InvalidFormat unless duns_is_properly_formatted?(duns: duns)
+
+      duns.gsub!('-', '')
+
+      if duns_is_nine_digits?(duns: duns)
         duns = "#{duns}0000"
-      elsif duns.length == 8
+      elsif duns_is_eight_digits?(duns: duns)
         duns = "0#{duns}0000"
       end
 
       duns
     end
+
+    def self.duns_contains_forbidden_characters?(duns: nil)
+      duns.split('').each do |character|
+        return false if self.string_is_numeric?(string: character)
+      end
+
+      false
+    end
+
+    def self.string_is_numeric?(string: nil)
+      string.split('').each do |character|
+        return false unless character.to_i.to_s == character
+      end
+
+      return true
+    end
+
+    def self.duns_is_eight_digits?(duns: nil)
+      duns.length == 8
+    end
+
+    def self.duns_is_nine_digits?(duns: nil)
+      duns.length == 9
+    end
+
+    def self.duns_is_thirteen_digits?(duns: nil)
+      duns.length == 13
+    end
   end
 end

data/lib/samwise/version.rb

@@ -1,4 +1,3 @@
 module Samwise
-  # samwise version
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/samwise.rb

@@ -1,4 +1,5 @@
 require 'samwise/version'
+require 'samwise/error'
 require 'samwise/util'
 require 'samwise/protocol'
 require 'samwise/client'

data/spec/client_spec.rb

@@ -8,31 +8,31 @@ describe Samwise::Client, vcr: { cassette_name: "Samwise::Client", record: :new_
   let(:thirteen_duns)     { '0223841150000' }
   let(:non_existent_duns) { '0000001000000' }
 
-  context '#duns_is_valid?' do
-    it "should verify that a 9 digit DUNS number exists" do
+  context '#duns_is_in_sam?' do
+    it "should verify that a 9 digit DUNS number exists in sam.gov" do
       client = Samwise::Client.new(api_key: api_key)
-      response = client.duns_is_valid?(duns: nine_duns)
+      response = client.duns_is_in_sam?(duns: nine_duns)
 
       expect(response).to be(true)
     end
 
-    it "should verify that an 8 digit DUNS number exists" do
+    it "should verify that an 8 digit DUNS number exists in sam.gov" do
       client = Samwise::Client.new(api_key: api_key)
-      response = client.duns_is_valid?(duns: eight_duns)
+      response = client.duns_is_in_sam?(duns: eight_duns)
 
       expect(response).to be(true)
     end
 
-    it "should verify that a 13 digit DUNS number exists" do
+    it "should verify that a 13 digit DUNS number exists in sam.gov" do
       client = Samwise::Client.new(api_key: api_key)
-      response = client.duns_is_valid?(duns: thirteen_duns)
+      response = client.duns_is_in_sam?(duns: thirteen_duns)
 
       expect(response).to be(true)
     end
 
-    it "should return false given a non-existent DUNS number" do
+    it "should return false given a DUNS number that is not in sam.gov" do
       client = Samwise::Client.new(api_key: api_key)
-      response = client.duns_is_valid?(duns: non_existent_duns)
+      response = client.duns_is_in_sam?(duns: non_existent_duns)
 
       expect(response).to be(false)
     end
@@ -60,7 +60,7 @@ describe Samwise::Client, vcr: { cassette_name: "Samwise::Client", record: :new_
       expect(response).to be_a(Hash)
     end
 
-    it "should return an error given a non-existent DUNS number" do
+    it "should return an error given a DUNS number that is not in sam.gov" do
       client = Samwise::Client.new(api_key: api_key)
       response = client.get_duns_info(duns: non_existent_duns)
 

data/spec/util_spec.rb

@@ -2,18 +2,82 @@ require 'spec_helper'
 require 'samwise'
 
 describe Samwise::Util do
-  let(:eight_duns) { '88371771' }
-  let(:nine_duns)  { '883717717' }
+  let(:eight_duns)    { '88371771' }
+  let(:nine_duns)     { '883717717' }
+  let(:thirteen_duns) { '0223841150000' }
+  let(:hyphen_duns)   { '08-011-5718' }
+  let(:letters_duns)  { 'abc12345678'}
+  let(:bad_dunses) do
+    [
+      '1234567890',
+      '12345678901',
+      '123456789011',
+      '1',
+      '',
+      '--',
+      '12345678901234567890'
+    ]
+  end
+
+  context '#duns_is_properly_formatted?' do
+    it 'should return true when the DUNS is 13 digits (not counting hyphens)' do
+      is_formatted = Samwise::Util.duns_is_properly_formatted?(duns: thirteen_duns)
+
+      expect(is_formatted).to be(true)
+    end
+
+    it 'should return true when the DUNS is 9 digits (not counting hyphens)' do
+      is_formatted = Samwise::Util.duns_is_properly_formatted?(duns: nine_duns)
+
+      expect(is_formatted).to be(true)
+    end
+
+    it 'should return true when the DUNS is 8 digits (not counting hyphens)' do
+      is_formatted = Samwise::Util.duns_is_properly_formatted?(duns: eight_duns)
+
+      expect(is_formatted).to be(true)
+    end
 
-  it "should format an 8 digit DUNS into a 13 digit DUNS" do
-    formatted_duns = Samwise::Util.format_duns(duns: eight_duns)
+    it 'should return false when the DUNS is not 8, 9, or 13 digits (not counting hyphens)' do
+      bad_dunses.each do |bad_duns|
+        is_formatted = Samwise::Util.duns_is_properly_formatted?(duns: bad_duns)
 
-    expect(formatted_duns.length).to eq(13)
+        expect(is_formatted).to be(false)
+      end
+    end
+
+    it 'should return false when the DUNS contains letters' do
+      is_formatted = Samwise::Util.duns_is_properly_formatted?(duns: letters_duns)
+
+      expect(is_formatted).to be(false)
+    end
   end
 
-  it "should format a 9 digit DUNS into a 13 digit DUNS" do
-    formatted_duns = Samwise::Util.format_duns(duns: nine_duns)
+  context '#format_duns' do
+    it 'should format an 8 digit DUNS into a 13 digit DUNS' do
+      formatted_duns = Samwise::Util.format_duns(duns: eight_duns)
+
+      expect(formatted_duns.length).to eq(13)
+    end
+
+    it 'should format a 9 digit DUNS into a 13 digit DUNS' do
+      formatted_duns = Samwise::Util.format_duns(duns: nine_duns)
+
+      expect(formatted_duns.length).to eq(13)
+    end
+
+    it 'should remove hyphens from a DUNS number' do
+      formatted_duns = Samwise::Util.format_duns(duns: hyphen_duns)
+
+      expect(formatted_duns).to eq('0801157180000')
+    end
 
-    expect(formatted_duns.length).to eq(13)
+    it 'should raise a Samwise::Error::InvalidFormat error if the DUNS is invalid' do
+      bad_dunses.each do |bad_duns|
+        expect do
+          Samwise::Util.format_duns(duns: bad_duns)
+        end.to raise_error(Samwise::Error::InvalidFormat)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: samwise
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Alan deLevie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-04 00:00:00.000000000 Z
+date: 2016-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
@@ -155,6 +155,7 @@ files:
 - Rakefile
 - lib/samwise.rb
 - lib/samwise/client.rb
+- lib/samwise/error.rb
 - lib/samwise/protocol.rb
 - lib/samwise/util.rb
 - lib/samwise/version.rb