irs_pub78 0.1

data/.gitignore

@@ -0,0 +1,6 @@
+.idea
+.DS_Store
+data
+Gemfile.lock
+irs*.gem
+coverage

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in gem_template.gemspec
+gemspec
+

data/LICENSE

@@ -0,0 +1,3 @@
+This project is subject to the Apache License 2.0, dated 2004.
+
+The full license is referenced here: http://www.apache.org/licenses/LICENSE-2.0.html

data/README.rdoc

@@ -0,0 +1,62 @@
+= Overview
+
+== About this IRS.gem
+
+This IRS .gem is designed to allow improve the accessibility of public nonprofit information
+provided by the IRS via Publication 78 online.
+
+== NOTICE
+
+This .gem is not provided or maintained by the IRS.
+
+== Usage
+
+irb
+load 'irs.rb'
+i = IRS.new
+i.download
+i.unzip
+i.parse_txt_to_json => /data/irs.json
+
+== Notes
+
+IRS Pub 78
+The source is a .zip file.
+There are 800,000+ records in the file.
+
+this .gem does not support more than 500 nonprofits, which most large cities have.
+support may be added in the future, if a Use Case requires it
+
+== Compatibility
+
+This wrapper is developed against Ruby 1.9.2, using RSpec and SimpleCov for testing.
+
+= License
+
+Copyright (c) 2011 Ryan Wold
+
+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.
+
+You will notify the author and give permission to have your software
+listed on this and other websites of the author as using 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.
+
+= Credits
+
+Ryan Wold

data/irs.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "irs_pub78"
+  s.version     = 0.1
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ryan Wold"]
+  s.email       = "rwold@morequality.org"
+  s.summary     = "Wrapper for the IRS.gov's Publication 78"
+  s.homepage    = "http://github.com/morequality/IRS_Pub78"
+  s.description = "Wrapper for the IRS.gov's Publication 78"
+
+  s.rubyforge_project = "irs_pub78"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('rspec', '~> 2.6')
+  s.add_development_dependency('simplecov', '~> 0.4.0')
+  s.add_development_dependency('nokogiri', '~> 1.5.0')
+  s.add_development_dependency('json', '~> 1.5.0')
+  s.add_development_dependency('rubyzip', '~> 0.9.4')
+
+  s.add_dependency('nokogiri', '~> 1.5.0')
+  s.add_dependency('json', '~> 1.5.0')
+  s.add_dependency('rubyzip', '~> 0.9.4')
+
+end

data/lib/irs.rb

@@ -0,0 +1,4 @@
+require 'irs/client'
+
+module Irs
+end

data/lib/irs/client.rb

@@ -0,0 +1,83 @@
+module Irs
+  class Client
+
+    require 'open-uri'
+    require 'zip/zip'
+    require 'json'
+    require 'nokogiri'
+
+    $debug = false # set to true to debug
+
+    def find(city = "", state_id = "")
+      raise ArgumentError unless !city.empty? && !state_id.empty?
+      @url   = "http://www.irs.gov/app/pub-78/search.do?resultsPerPage=500&nameSearchTypeStarts=false&names=&nameSearchTypeAll=false&city=#{URI.escape(city.downcase)}&state=#{state_id.upcase}&country=USA&deductibility=all&sortColumn=name&indexOfFirstRow=0&isDescending=false&dispatchMethod=search"
+      stream = open(@url).read
+      nodes  = Nokogiri::HTML(stream)
+      process_nodes(nodes)
+    end
+
+    # accepts nodes from Nokogiri
+    def process_nodes(nodes = nil)
+      rows       = nodes.css(".epi-dataTable tr")
+      nonprofits = []
+      rows.each do |r|
+        attrs = {}
+        attrs["name"] = r.css("td")[0].text.strip rescue 'error'
+        attrs["city"] = r.css("td")[1].text.strip rescue 'error'
+        attrs["state_id"] = r.css("td")[2].text.strip rescue 'error'
+        attrs["code"] = r.css("td")[3].text.strip rescue 'error'
+        nonprofits << attrs
+      end
+
+      nonprofits
+    end
+
+# ----------------------------------------------------------------------------------------------------------
+
+# grab .zip file from IRS.gov
+# and save it locally
+    def download
+      unless File.exist? "data/eopub78.zip"
+        @url   = "http://www.irs.gov/pub/irs-utl/eopub78.zip"
+        stream = open(@url).read
+
+        directory_name = Dir::pwd + "/" + "data"
+        unless FileTest::directory?(directory_name)
+          Dir::mkdir(directory_name)
+        end
+
+        File.open("data/eopub78.zip", "wb") { |f| f << stream }
+      else
+        puts "The file has already been downloaded.  Delete and try again if you really want the latest."
+      end
+    end
+
+# unzip the .zip file to /data/irs.txt
+    def unzip
+      Zip::ZipFile.open("data/eopub78.zip").extract("eopub780611.txt", "data/irs.txt")
+    end
+
+# Open the .txt file
+# Read it and loop through it and write the data to a hash
+    def parse_txt_to_json
+      entities = []
+      i        = 0 # count
+      lines    = File.open("data/irs.txt", "r").readlines
+      lines[i..-1].each do |line| # ignore the first header line
+        i = i + 1
+        entities << {
+            :name     => (line[0..105].strip rescue ""),
+            :city     => (line[106..136].strip rescue ""),
+            :state_id => (line[137..138].strip rescue ""),
+            :code     => (line[141..141].strip rescue "")
+        }
+        puts i if $debug
+      end
+
+      File.open("data/irs.json", "w") { |f| f << entities.to_json }
+    end
+
+
+  end
+
+end

data/spec/helper.rb

@@ -0,0 +1,18 @@
+# enable SimpleCov
+require 'simplecov'
+SimpleCov.start
+
+require 'rubygems'
+require 'bundler/setup'
+require 'irs'
+
+RSpec.configure do |config|
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

data/spec/irs_spec.rb

@@ -0,0 +1,31 @@
+require 'helper'
+
+# fixtures      = YAML.load(ERB.new(File.new(File.dirname(__FILE__) + '/fixtures/fixtures.yml').read).result)
+
+# public methods
+client = Irs::Client.new
+
+# The projects method
+describe Irs, "::Client.new" do
+  it "should download" do
+    #file = client.download
+    file.should be_kind_of(File)
+    # a file should exist
+    # it should be over 10mb, arbitrarily
+  end
+
+  it "should unzip" do
+  end
+
+  it "should parse the unzipped txt file to json" do
+  end
+
+end
+
+describe Irs, "::Other Methods" do
+  before do
+  end
+
+  it "should do something" do
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: irs_pub78
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Wold
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-28 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70137131188020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70137131188020
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70137131187380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *70137131187380
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70137131167680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *70137131167680
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70137131167080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *70137131167080
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: &70137131166620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :development
+  prerelease: false
+  version_requirements: *70137131166620
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70137131166060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70137131166060
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70137131165540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70137131165540
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: &70137131164980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70137131164980
+description: Wrapper for the IRS.gov's Publication 78
+email: rwold@morequality.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Changelog
+- Gemfile
+- LICENSE
+- README.rdoc
+- irs.gemspec
+- lib/irs.rb
+- lib/irs/client.rb
+- spec/fixtures/fixtures.yml
+- spec/helper.rb
+- spec/irs_spec.rb
+has_rdoc: true
+homepage: http://github.com/morequality/IRS_Pub78
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: irs_pub78
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Wrapper for the IRS.gov's Publication 78
+test_files:
+- spec/fixtures/fixtures.yml
+- spec/helper.rb
+- spec/irs_spec.rb