fbo 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dc6df6fe914dd5ff1d22d0052a58bf00a610716
-  data.tar.gz: f905cd423dd324f74ca8448f623bae4eca91e3c8
+  metadata.gz: b0c4e53ddeb9ea9df943ef8af9ca33a4e1f99bbc
+  data.tar.gz: bc42c21126580a453a02996fa1799375d7057339
 SHA512:
-  metadata.gz: ff1bbd4ec5444106621f0aacb197d295546846b8fce7b014134b70b3b9c10118398ad6df0f7d39cf1f1581fd5beb35c9898643e530a13ae28e1be9a5b048dcd3
-  data.tar.gz: 74cb133584ce2138cbac061b56445b7849bb3a1fd0bc0c3c1698f36f132b0bd9b47d4cc50b2ceace754eb42152903854e4954a37968d6a273876ffcda08831e0
+  metadata.gz: 02ea8f7e4d11ba748b01abbe212952c958cb8e20f95b690dfd4b1da657e7bbdb6f744728395b8c2a3c523b8208d5f2560ff57811e3cc92dd2f27b2654d6dada7
+  data.tar.gz: 02ec6b226bbf7c58391fb0073c28bedb6635ad96dc73676f4c353511e585d6554cf27f3226a05c7e6cf6ac7f7c748c8e70703a4728e4e03d4b9fe3c30600e468

data/.gitignore

@@ -1,6 +1,7 @@
 # Emacs temporary files
 *~
 \#*\#
+.\#*
 
 # Bundler artifacts
 .bundle

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    FBO (0.0.1)
+    fbo (0.0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -21,7 +21,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  FBO!
   bundler (~> 1.3)
+  fbo!
   rake
   rspec

data/README.md

@@ -3,6 +3,29 @@
 Fetch a dated dump file from [FedBizOpps](https://www.fbo.gov) and parse its
 contents into structures suitable for use by other programs.
 
+The gem in its current state handles most of the notice types described in the
+[FBO documentation](https://www.fbo.gov/?&static=interface) for the data format.
+* Presolicitation (PRESOL)
+* Combined Synopsis/Solicitation (COMBINE)
+* Amendment to a Previous Combined Solicitation (AMDCSS)
+* Modification to a Previous Base (MOD)
+* Award (AWARD)
+* Justification and Approval (JA)
+* Intent to Bundle Requirements (ITB)
+* Fair Opportunity / Limited Sources Justification (FAIROPP)
+* Sources Sought (SRCSGT)
+* Foreign Government Standard (FSTD)
+* Special Notice (SNOTE)
+* Sale of Surplus Property (SSALE)
+* Document Archival (ARCHIVE)
+* Document Unarchival (UNARCHIVE)
+
+Two notice types have not yet been implemented as no record of their ever having
+been used could be found in any of the FBO dump files dating back as far as 2001.
+These are:
+* Document Upload (EPSUPLOAD)
+* Document Deleting (DELETE)
+
 
 ## Installation
 

data/lib/fbo.rb

@@ -4,21 +4,38 @@ require_relative "fbo/file"
 require_relative "fbo/remote_file"
 require_relative "fbo/notice"
 require_relative "fbo/notices/amendment"
+require_relative "fbo/notices/archive"
 require_relative "fbo/notices/award"
 require_relative "fbo/notices/combined_solicitation"
+require_relative "fbo/notices/fair_opportunity"
+require_relative "fbo/notices/foreign_standard"
+require_relative "fbo/notices/intent_to_bundle"
+require_relative "fbo/notices/justification_approval"
 require_relative "fbo/notices/modification"
 require_relative "fbo/notices/presolicitation"
+require_relative "fbo/notices/sale_of_surplus"
 require_relative "fbo/notices/sources_sought"
+require_relative "fbo/notices/special_notice"
+require_relative "fbo/notices/unarchive"
 require_relative "fbo/notices/unknown"
 require_relative "fbo/parser"
+require_relative "fbo/parser/handler_selector"
 require_relative "fbo/parser/notice_handler"
 require_relative "fbo/parser/parser_helper"
 require_relative "fbo/parser/amendment_handler"
+require_relative "fbo/parser/archive_handler"
 require_relative "fbo/parser/award_handler"
 require_relative "fbo/parser/combined_solicitation_handler"
+require_relative "fbo/parser/fair_opportunity_handler"
+require_relative "fbo/parser/foreign_standard_handler"
+require_relative "fbo/parser/intent_to_bundle_handler"
+require_relative "fbo/parser/justification_approval_handler"
 require_relative "fbo/parser/modification_handler"
 require_relative "fbo/parser/presolicitation_handler"
+require_relative "fbo/parser/sale_of_surplus_handler"
 require_relative "fbo/parser/sources_sought_handler"
+require_relative "fbo/parser/special_notice_handler"
+require_relative "fbo/parser/unarchive_handler"
 require_relative "fbo/parser/unknown_handler"
 
 module FBO

data/lib/fbo/notices/archive.rb

@@ -0,0 +1,8 @@
+module FBO
+  module Notices
+    class Archive < Struct.new(:date, :year, :agency, :office, :location,
+                               :solicitation_number, :notice_type, :archive_date)
+      include FBO::Notice
+    end
+  end
+end

data/lib/fbo/notices/fair_opportunity.rb

@@ -0,0 +1,15 @@
+module FBO
+  module Notices
+    class FairOpportunity < Struct.new(:date, :year, :zip, :class_code, :naics_code,
+                                       :agency, :office, :location, :office_address,
+                                       :subject, :solicitation_number, :notice_type,
+                                       :justification_authority, :award_number,
+                                       :delivery_order_number, :modification_number,
+                                       :award_date, :archive_date, :description,
+                                       :contact_info, :link_url, :link_description,
+                                       :email_address, :email_description, :file_list,
+                                       :correction)
+      include FBO::Notice
+    end
+  end
+end

data/lib/fbo/notices/foreign_standard.rb

@@ -0,0 +1,13 @@
+module FBO
+  module Notices
+    class ForeignStandard < Struct.new(:date, :year, :zip, :class_code, :naics_code,
+                                       :agency, :office, :location, :office_address,
+                                       :subject, :solicitation_number, :archive_date,
+                                       :response_date, :contact_info, :description,
+                                       :link_url, :link_description, :email_address,
+                                       :email_description, :setaside, :pop_address,
+                                       :pop_zip, :pop_country)
+      include FBO::Notice
+    end
+  end
+end

data/lib/fbo/notices/intent_to_bundle.rb

@@ -0,0 +1,13 @@
+module FBO
+  module Notices
+    class IntentToBundle < Struct.new(:date, :year, :zip, :class_code, :naics_code,
+                                      :agency, :office, :location, :office_address,
+                                      :subject, :solicitation_number, :notice_type,
+                                      :archive_date, :description, :contact_info,
+                                      :award_number, :delivery_order_number,
+                                      :link_url, :link_description, :email_address,
+                                      :email_description, :correction)
+      include FBO::Notice
+    end
+  end
+end

data/lib/fbo/notices/justification_approval.rb

@@ -0,0 +1,18 @@
+module FBO
+  module Notices
+    class JustificationApproval < Struct.new(:date, :year, :zip, :class_code,
+                                             :naics_code, :agency, :office,
+                                             :location, :office_address, :subject,
+                                             :solicitation_number, :notice_type,
+                                             :description, :contact_info,
+                                             :statutory_authority, :award_number,
+                                             :modification_number, :award_date,
+                                             :archive_date, :link_url,
+                                             :link_description, :email_address,
+                                             :email_description, :file_list,
+                                             :correction)
+      include FBO::Notice
+    end
+  end
+end
+

data/lib/fbo/notices/sale_of_surplus.rb

@@ -0,0 +1,13 @@
+module FBO
+  module Notices
+    class SaleOfSurplus < Struct.new(:date, :year, :zip, :class_code, :naics_code,
+                                     :agency, :office, :location, :office_address,
+                                     :subject, :solicitation_number, :response_date,
+                                     :archive_date, :description, :contact_info,
+                                     :link_url, :link_description, :email_address,
+                                     :email_description, :setaside, :pop_country,
+                                     :pop_zip, :pop_address)
+      include FBO::Notice
+    end
+  end
+end

data/lib/fbo/notices/special_notice.rb

@@ -0,0 +1,13 @@
+module FBO
+  module Notices
+    class SpecialNotice < Struct.new(:date, :year, :zip, :class_code, :naics_code,
+                                     :agency, :office, :location, :office_address,
+                                     :subject, :solicitation_number, :response_date,
+                                     :archive_date, :description, :contact_info,
+                                     :link_url, :link_description, :email_address,
+                                     :email_description, :setaside, :pop_country,
+                                     :pop_zip, :pop_address)
+      include FBO::Notice
+    end
+  end
+end

data/lib/fbo/notices/unarchive.rb

@@ -0,0 +1,9 @@
+module FBO
+  module Notices
+    class Unarchive < Struct.new(:date, :year, :agency, :office, :location,
+                                 :solicitation_number, :notice_type, :archive_date,
+                                 :award_number)
+      include FBO::Notice
+    end
+  end
+end

data/lib/fbo/parser.rb

@@ -46,21 +46,8 @@ module FBO
     def parse_notices(text_notices)
       @notices = []
       text_notices.each do |text|
-        if FBO::Parser::PresolicitationHandler.is_presolicitation?(text)
-          @notices << FBO::Parser::PresolicitationHandler.parse(text)
-        elsif FBO::Parser::CombinedSolicitationHandler.is_combined_solicitation?(text)
-          @notices << FBO::Parser::CombinedSolicitationHandler.parse(text)
-        elsif FBO::Parser::SourcesSoughtHandler.is_sources_sought?(text)
-          @notices << FBO::Parser::SourcesSoughtHandler.parse(text)
-        elsif FBO::Parser::AmendmentHandler.is_amendment?(text)
-          @notices << FBO::Parser::AmendmentHandler.parse(text)
-        elsif FBO::Parser::ModificationHandler.is_modification?(text)
-          @notices << FBO::Parser::ModificationHandler.parse(text)
-        elsif FBO::Parser::AwardHandler.is_award?(text)
-          @notices << FBO::Parser::AwardHandler.parse(text)
-        else
-          @notices << FBO::Parser::UnknownHandler.parse(text)
-        end
+        handler = FBO::Parser::HandlerSelector.select(text)
+        @notices << handler.parse(text)
       end
     end
 

data/lib/fbo/parser/archive_handler.rb

@@ -0,0 +1,41 @@
+module FBO::Parser::ArchiveHandler
+  TAGS = %w( ARCHIVE DATE YEAR CBAC PASSWORD AGENCY OFFICE LOCATION NTYPE ) +
+    %w( SOLNBR ARCHDATE \/ARCHIVE )
+
+  ANY_ARCHIVE_TAG     = TAGS.join("|")
+  ARCHIVE_PATTERN     = /^<ARCHIVE>/
+
+
+  def is_archive?(text)
+    text =~ ARCHIVE_PATTERN
+  end
+
+  def parse(text)
+    params = {
+      date: date(text),
+      year: year(text),
+      agency: agency(text),
+      office: office(text),
+      location: location(text),
+      solicitation_number: solicitation_number(text),
+      notice_type: notice_type(text),
+      archive_date: archive_date(text)
+    }
+    FBO::Notices::Archive.new(params)
+  end
+
+
+  protected
+
+  # Returns a concatenated list of all tags for the notice
+  #
+  # @return [String]
+  def any_notice_tag
+    ANY_ARCHIVE_TAG
+  end
+
+
+  extend FBO::Parser::NoticeHandler
+  extend FBO::Parser::ParserHelper
+  extend self
+end

data/lib/fbo/parser/fair_opportunity_handler.rb

@@ -0,0 +1,61 @@
+module FBO::Parser::FairOpportunityHandler
+  TAGS = %w( FAIROPP DATE YEAR CBAC PASSWORD ZIP CLASSCOD NAICS OFFADD AGENCY ) +
+    %w( OFFICE LOCATION SUBJECT SOLNBR NTYPE FOJA AWDNBR DONBR MODNBR AWDDATE ) +
+    %w( ARCHDATE DESC CONTACT LINK URL EMAIL ADDRESS FILELIST FILE MIMETYPE ) +
+    %w( /FILE /FILELIST CORRECTION /FAIROPP )
+
+  ANY_FAIROPP_TAG           = TAGS.join("|")
+  FAIR_OPPORTUNITY_PATTERN  = /^<FAIROPP>/
+
+
+  def is_fair_opportunity?(text)
+    text =~ FAIR_OPPORTUNITY_PATTERN
+  end
+
+  def parse(text)
+    params = {
+      date: date(text),
+      year: year(text),
+      zip:  zip(text),
+      class_code: classification_code(text),
+      naics_code: naics_code(text),
+      agency: agency(text),
+      office: office(text),
+      location: location(text),
+      office_address: office_address(text),
+      subject: subject(text),
+      solicitation_number: solicitation_number(text),
+      notice_type: notice_type(text),
+      justification_authority: justification_authority(text),
+      award_number: award_number(text),
+      delivery_order_number: delivery_order_number(text),
+      modification_number: modification_number(text),
+      award_date: award_date(text),
+      archive_date: archive_date(text),
+      description: description(text),
+      contact_info: contact(text),
+      link_url: link_url(text),
+      link_description: link_description(text),
+      email_address: email_address(text),
+      email_description: email_description(text),
+      file_list: file_list(text),
+      correction: correction?(text)
+    }
+    FBO::Notices::FairOpportunity.new(params)
+  end
+
+
+  protected
+
+  # Returns a concatenated list of all tags for the notice
+  #
+  # @return [String]
+  def any_notice_tag
+    ANY_FAIROPP_TAG
+  end
+
+
+  extend FBO::Parser::NoticeHandler
+  extend FBO::Parser::ParserHelper
+  extend self
+end

data/lib/fbo/parser/foreign_standard_handler.rb

@@ -0,0 +1,57 @@
+module FBO::Parser::ForeignStandardHandler
+  TAGS = %w( FSTD DATE YEAR CBAC PASSWORD ZIP CLASSCOD NAICS OFFADD AGENCY ) +
+    %w( OFFICE LOCATION SUBJECT SOLNBR RESPDATE ARCHDATE CONTACT DESC LINK ) +
+    %w( URL EMAIL ADDRESS SETASIDE POPCOUNTRY POPADDRESS POPZIP \/FSTD )
+
+  ANY_FSTD_TAG              = TAGS.join("|")
+  FOREIGN_STANDARD_PATTERN  = /^<FSTD>/
+
+
+  def is_foreign_standard?(text)
+    text =~ FOREIGN_STANDARD_PATTERN
+  end
+
+  def parse(text)
+    params = {
+      date: date(text),
+      year: year(text),
+      zip:  zip(text),
+      class_code: classification_code(text),
+      naics_code: naics_code(text),
+      agency: agency(text),
+      office: office(text),
+      location: location(text),
+      office_address: office_address(text),
+      subject: subject(text),
+      solicitation_number: solicitation_number(text),
+      response_date: response_date(text),
+      archive_date: archive_date(text),
+      contact_info: contact(text),
+      description: description(text),
+      link_url: link_url(text),
+      link_description: link_description(text),
+      email_address: email_address(text),
+      email_description: email_description(text),
+      setaside: set_aside(text),
+      pop_address: pop_address(text),
+      pop_zip: pop_zip_code(text),
+      pop_country: pop_country(text)
+    }
+    FBO::Notices::ForeignStandard.new(params)
+  end
+
+
+  protected
+
+  # Returns a concatenated list of all tags for the notice
+  #
+  # @return [String]
+  def any_notice_tag
+    ANY_FSTD_TAG
+  end
+
+
+  extend FBO::Parser::NoticeHandler
+  extend FBO::Parser::ParserHelper
+  extend self
+end

data/lib/fbo/parser/handler_selector.rb

@@ -0,0 +1,37 @@
+class FBO::Parser::HandlerSelector
+
+  def self.select(text)
+    if FBO::Parser::PresolicitationHandler.is_presolicitation?(text)
+      FBO::Parser::PresolicitationHandler
+    elsif FBO::Parser::CombinedSolicitationHandler.is_combined_solicitation?(text)
+      FBO::Parser::CombinedSolicitationHandler
+    elsif FBO::Parser::SourcesSoughtHandler.is_sources_sought?(text)
+      FBO::Parser::SourcesSoughtHandler
+    elsif FBO::Parser::AmendmentHandler.is_amendment?(text)
+      FBO::Parser::AmendmentHandler
+    elsif FBO::Parser::ModificationHandler.is_modification?(text)
+      FBO::Parser::ModificationHandler
+    elsif FBO::Parser::AwardHandler.is_award?(text)
+      FBO::Parser::AwardHandler
+    elsif FBO::Parser::FairOpportunityHandler.is_fair_opportunity?(text)
+      FBO::Parser::FairOpportunityHandler
+    elsif FBO::Parser::ForeignStandardHandler.is_foreign_standard?(text)
+      FBO::Parser::ForeignStandardHandler
+    elsif FBO::Parser::ArchiveHandler.is_archive?(text)
+      FBO::Parser::ArchiveHandler
+    elsif FBO::Parser::IntentToBundleHandler.is_intent_to_bundle?(text)
+      FBO::Parser::IntentToBundleHandler
+    elsif FBO::Parser::JustificationApprovalHandler.is_justification_approval?(text)
+      FBO::Parser::JustificationApprovalHandler
+    elsif FBO::Parser::SaleOfSurplusHandler.is_sale_of_surplus?(text)
+      FBO::Parser::SaleOfSurplusHandler
+    elsif FBO::Parser::SpecialNoticeHandler.is_special_notice?(text)
+      FBO::Parser::SpecialNoticeHandler
+    elsif FBO::Parser::UnarchiveHandler.is_unarchive?(text)
+      FBO::Parser::UnarchiveHandler
+    else
+      FBO::Parser::UnknownHandler
+    end
+  end
+
+end