just_inform 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9d8c59057f16fd2e11ac1cc01088f690f1e508b
+  data.tar.gz: e7d8c5d339a28f4cc640f02eecd0ca0a5338f30f
+SHA512:
+  metadata.gz: 6a0a174207bb7e1148180622225bcdba1ea821e54a127ef27e64bd3a1122eb00b06705ba2ccfdd4bb9d816815074b1152a68998be5da0e2feb9c4b2b8baaaa70
+  data.tar.gz: 8e812e6e68700d18d64bbd11ccb44ffe800d46a69249d3e8d27cefccbbe965a9e079ada9d2b63d19ca8c773f62b11bd1fa617efe79d2008b3becb8b1e4f1d2e1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gem 'nokogiri', '~> 1.6.0'

data/Gemfile.lock

@@ -0,0 +1,12 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    mini_portile (0.5.1)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nokogiri (~> 1.6.0)

data/LICENSE.md

@@ -0,0 +1,22 @@
+# MIT License
+
+Copyright (c) 2013 [Office of Citizen Services and Innovative Technologies, U.S. General Services Administration (GSA-OCSIT)]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+  [Office of Citizen Services and Innovative Technologies, U.S. General Services Administration (GSA-OCSIT)]: https://github.com/GSA-OCSIT

data/README.md

@@ -0,0 +1,30 @@
+# What Is Just Inform
+
+Just Inform is a simple library to help parse the daily XML feed from [RegInfo.gov].  We needed a tool to help sort government forms based on burden hours, cost, and responses.
+
+## Basic Usage
+
+#### Install the gem
+gem install just_inform
+
+#### Create a new parser instance
+parser = JustInform.new
+
+#### Return an array with the sort value (cost) and InformationCollectionRequest objects
+parser.top(10, :cost)  => 
+[["33,672,000,000", U.S. Individual Income Tax Return], ["8,190,000,004", Rule 10b-10 Confirmation of Securities Transactions (17 C.F.R. 240.10b-10)], ["2,857,465,000", Exchange Act  Form 10-K], ["2,727,479,226", America Invents Act Section 10 Patent Fee Adjustments], ["1,801,830,000", Application for a U.S. Passport], ["1,300,147,200", ASSIST Database], ["1,280,341,567", Form SD], ["910,000,000", Online Application for Nonimmigrant Visa], ["791,160,764", Rules for Patent Maintenance Fees], ["772,798,833", Initial Patent Applications]]
+
+You can also sort by burden hours (:burden) and number of responses (:responses).
+
+## Todo
+
+* Add tests with 100% coverage
+* Add ActiveRecord like finder methods (e.g. Parser.find_by_title('Passport'))
+* Build into a Sinatra/Rails app that creates an API/webpage exhibiting the topX forms in gov by burden hours, cost, and response numbers.  This would be updated daily from the XML feed.
+
+## License
+[MIT License]
+
+  [RegInfo.gov]: http://www.reginfo.gov
+  [MIT License]: https://github.com/GSA-OCSIT/just_inform/blob/master/LICENSE.md
+  [README]: https://github.com/GSA-OCSIT/just_inform/blob/master/README.md

data/just_inform.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'just_inform/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'just_inform'
+  s.version     = JustInform::VERSION
+  s.date        = '2013-08-15'
+  s.authors     = ["Justin Grevich"]
+  s.summary     = "Reginfo.gov XML Forms Report Data Parser"
+  s.description = "A library to help parse the XML report published by Reginfo.gov (http://www.reginfo.gov/public/do/PRAXML)"
+  s.email       = 'justin@grevi.ch'
+  s.files       =  [
+    "Gemfile",
+    "Gemfile.lock",
+    "just_inform.gemspec",
+    "LICENSE.md",
+    "README.md",
+    'data',
+    "lib/just_inform.rb",
+    "lib/just_inform/downloader.rb",
+    "lib/just_inform/information_collection.rb",
+    "lib/just_inform/information_collection_request.rb",
+    "lib/just_inform/parser.rb",
+    "lib/just_inform/version.rb"]
+  s.homepage    = 'https://github.com/GSA-OCSIT/just_inform'
+  s.license     = 'MIT'
+  s.platform    = Gem::Platform::RUBY
+  s.add_dependency('nokogiri', '~> 1.6.0')
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+  s.extra_rdoc_files = %w[README.md LICENSE.md]
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  
+end

data/lib/just_inform.rb

@@ -0,0 +1,32 @@
+module JustInform; end
+
+module Nokogiri
+  module XML
+    class Node
+      
+      def inspect_attributes
+        [:name]
+      end
+      
+    end
+  end
+end
+
+module Nokogiri
+  module XML
+
+    class Document < Nokogiri::XML::Node
+
+      def inspect_attributes
+          [:name, :children]
+      end
+
+    end
+  end
+end
+
+require 'just_inform/downloader'
+require 'just_inform/information_collection'
+require 'just_inform/information_collection_request'
+require 'just_inform/parser'
+require 'just_inform/version'

data/lib/just_inform/downloader.rb

@@ -0,0 +1,28 @@
+module JustInform
+  class Downloader
+    require 'open-uri' unless defined?(OpenURI)
+    
+    def self.get_latest
+      if self.current_file?
+        puts "Using downloaded file"
+        latest = File.open(File.join 'data', self.current_filename)
+      else
+        puts 'Downloading file, this could take a minute...'
+        latest = File.open(File.join('data',self.current_filename), 'wb') {|file| file << open('http://www.reginfo.gov/public/do/PRAXML?type=inventory').read}
+        latest = File.open(File.join 'data', self.current_filename)
+      end
+    end
+    
+    private
+    
+    def self.current_file?
+      true if File.exists?(File.join 'data', self.current_filename)
+    end
+    
+    def self.current_filename
+      filename = Time.now.strftime("%Y.%m.%d-CurrentInventoryReport.xml")
+    end
+    
+  end
+end
+

data/lib/just_inform/information_collection.rb

@@ -0,0 +1,11 @@
+module JustInform
+  class InformationCollection
+    attr_accessor :burden_hours, :cost, :file_name, :form_name, :raw_data, :parent_id, :responses, :title
+    
+    def initialize(data)
+      parent_id = data.at_css('ICRReferenceNumber')
+      @raw_data, @parent_id = data, parent_id
+    end
+    
+  end
+end

data/lib/just_inform/information_collection_request.rb

@@ -0,0 +1,50 @@
+module JustInform
+  class InformationCollectionRequest
+    attr_accessor :raw_data
+    
+    def inspect
+      title
+    end
+    
+    def initialize(data)
+      @raw_data = data
+    end
+    
+    def abstract
+      @raw_data.at_css('Abstract').content
+    end
+    
+    def agency_code
+      @raw_data.at_css('AgencyCode').content
+    end
+    
+    def icr_reference_number
+      @raw_data.at_css('ICRReferenceNumber').content
+    end
+    
+    def omb_control_number
+      @raw_data.at_css('OMBControlNumber').content
+    end
+    
+    def title
+      @raw_data.at_css('Title').content
+    end
+    
+    def total_burden_hours
+      @raw_data.at_css('Burden BurdenHour TotalQuantity').content.to_i
+    end
+    alias_method :burden_hours, :total_burden_hours
+    alias_method :burden, :total_burden_hours
+
+    def total_cost
+      @raw_data.at_css('Burden BurdenCost TotalAmount').content.to_i
+    end
+    alias_method :cost, :total_cost
+
+    def total_responses
+      @raw_data.at_css('Burden BurdenResponse TotalQuantity').content.to_i
+    end
+    alias_method :responses, :total_responses
+    
+  end
+end

data/lib/just_inform/parser.rb

@@ -0,0 +1,66 @@
+module JustInform
+  class Parser
+    require 'nokogiri' unless defined?(Nokogiri)
+    
+    attr_accessor :doc
+    
+    def initialize
+      load
+    end
+    
+    # Show top 10 forms, PRA.top(sort_by_symbol, number_of_results)
+    # parser.top(:burden,2) => [<Nokogiri::XML::Element>, <Nokogiri::XML::Element>]
+    def top(limit=10, attrib_name=:burden_hours)
+      @topx = []
+      @topx_size = limit
+      sort_method = attrib_name.to_sym
+      
+      reports.each_with_index do |report, index|
+        if @topx.last
+          add_report_to_topx(report.send(sort_method), index) if report.send(sort_method) > @topx.last[0]
+        else
+          @topx << [report.send(sort_method), reports[index]]
+        end
+      end
+      
+      @topx.map! {|x| [number_to_delimited(x[0]), x[1]]}
+    end
+    
+    def reports(doc=@doc)
+      reports = []
+      
+      doc.xpath('//InformationCollectionRequest').map {|r| reports << InformationCollectionRequest.new(r) }
+      reports
+    end
+    
+    private
+    
+    # pretify number results
+    def number_to_delimited(number)
+      number.to_s.gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
+    end
+    
+    # add report search value (e.g. value of burden hours, responses, or cost) and index to @topx array
+    def add_report_to_topx(sort_value, index)
+      (0..@topx_size).map do |n|
+        if sort_value > @topx[n][0]
+          @topx.insert(n, [sort_value, reports[index]])
+          break
+        else
+          next
+        end
+      end
+      
+      @topx = @topx[0..(@topx_size-1)]
+    end
+    
+    # load XML data into Nokogiri and set @doc instance variable
+    def load
+      puts 'Loading >50 MB of XML data and parsing with Nokogiri, this could take awhile (e.g. 2-3m)'
+      data = Downloader.get_latest
+      @doc = Nokogiri::XML(data)
+    end
+    
+
+  end
+end

data/lib/just_inform/version.rb

@@ -0,0 +1,3 @@
+module JustInform
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: just_inform
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Justin Grevich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A library to help parse the XML report published by Reginfo.gov (http://www.reginfo.gov/public/do/PRAXML)
+email: justin@grevi.ch
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+files:
+- Gemfile
+- Gemfile.lock
+- just_inform.gemspec
+- LICENSE.md
+- README.md
+- lib/just_inform.rb
+- lib/just_inform/downloader.rb
+- lib/just_inform/information_collection.rb
+- lib/just_inform/information_collection_request.rb
+- lib/just_inform/parser.rb
+- lib/just_inform/version.rb
+homepage: https://github.com/GSA-OCSIT/just_inform
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Reginfo.gov XML Forms Report Data Parser
+test_files: []