irs_pub78 0.1 → 0.2

data/LICENSE

@@ -1,3 +1,3 @@
-This project is subject to the Apache License 2.0, dated 2004.
+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
+The full license is referenced here: http://www.apache.org/licenses/LICENSE-2.0.txt.

data/README.rdoc

@@ -1,22 +1,27 @@
-= Overview
-
-== About this IRS.gem
+== About this .gem, IRS_Pub78
 
 This IRS .gem is designed to allow improve the accessibility of public nonprofit information
-provided by the IRS via Publication 78 online.
+provided by the IRS via Publication 78 online.  This .gem is not provided or maintained by the IRS.  The information
+available is publicly available.
 
-== NOTICE
+== Usage
 
-This .gem is not provided or maintained by the IRS.
+From the terminal:
 
-== Usage
+gem install irs_pub78                        # install the .gem
 
-irb
-load 'irs.rb'
-i = IRS.new
-i.download
-i.unzip
-i.parse_txt_to_json => /data/irs.json
+irb                                          # start IRB
+require 'irs_pub78'                          # require the IRS_Pub78 gem
+i = IrsPub78::Client.new                     # create a new instance of the IRS::Client
+i.download                                   # tell the instance to download the file.  downloads to /data/irs.zip
+i.unzip                                      # tell the instance to unzip the downloaded file to a txt file
+i.parse_txt_to_json => /data/irs.json        # tell the instance to parse the txt file to .json
+
+i.find("Vacaville", "CA")                    # tell the instance to find the nonprofits* on the IRS Pub 78 online
+                                             # in a specific City and State. returns an easy-to-use array of hashes,
+                                             # each which has the attributes (Name, City, State, Code)
+                                             #
+                                             # * currently only supports the first 500 nonprofits in a city
 
 == Notes
 
@@ -24,39 +29,25 @@ 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.
+== Known Issues
+
+This .gem does not support more than 500 nonprofits on a given, which most large cities have.
 support may be added in the future, if a Use Case requires it
 
-== Compatibility
+== Development Environment
 
-This wrapper is developed against Ruby 1.9.2, using RSpec and SimpleCov for testing.
+This wrapper is developed against Ruby 1.9.2.
 
 = License
 
-Copyright (c) 2011 Ryan Wold
+Apache 2.0.
+See LICENSE or http://www.apache.org/licenses/LICENSE-2.0.txt
 
-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.
+= Credits
 
-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.
+an open-source project by MoreQuality, a 501(c)(3) nonprofit based in Solano County, California.
 
-= Credits
+== Support this work
 
-Ryan Wold
+Please consider making a donation (http://morequality.org/donate) to support
+MoreQuality's technology and civic education initiatives.

data/{irs.gemspec → irs_pub78.gemspec}

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "irs_pub78"
-  s.version     = 0.1
+  s.version     = 0.2
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Ryan Wold"]
   s.email       = "rwold@morequality.org"

data/lib/{irs → irs_pub78}/client.rb

@@ -1,4 +1,4 @@
-module Irs
+module IrsPub78
   class Client
 
     require 'open-uri'
@@ -52,17 +52,25 @@ module Irs
       end
     end
 
-# unzip the .zip file to /data/irs.txt
-    def unzip
-      Zip::ZipFile.open("data/eopub78.zip").extract("eopub780611.txt", "data/irs.txt")
+    # file = the file you want to unzip
+    # target = the relative directory you want to unzip to
+    def unzip(file, target = "unzipped")
+      Zip::ZipFile.open(file) { |zip|
+        zip.each { |file|
+          path = File.join(target, file.name)
+          FileUtils.mkdir_p(File.dirname(path))
+          zip.extract(file, path) unless File.exist?(path)
+        }
+      }
     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
+      entities        = []
+      i               = 0 # count
+      file_to_process = Dir.glob("data/eopub78/*.txt")[0]
+      lines           = File.open(file_to_process, "r").readlines
       lines[i..-1].each do |line| # ignore the first header line
         i = i + 1
         entities << {

data/lib/irs_pub78.rb

@@ -0,0 +1,4 @@
+require 'irs_pub78/client'
+
+module IrsPub78
+end

data/spec/irs_spec.rb

@@ -3,10 +3,10 @@ require 'helper'
 # fixtures      = YAML.load(ERB.new(File.new(File.dirname(__FILE__) + '/fixtures/fixtures.yml').read).result)
 
 # public methods
-client = Irs::Client.new
+client = IrsPub78::Client.new
 
 # The projects method
-describe Irs, "::Client.new" do
+describe IrsPub78, "::Client.new" do
   it "should download" do
     #file = client.download
     file.should be_kind_of(File)
@@ -22,7 +22,7 @@ describe Irs, "::Client.new" do
 
 end
 
-describe Irs, "::Other Methods" do
+describe IrsPub78, "::Other Methods" do
   before do
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: irs_pub78
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-28 00:00:00.000000000 -07:00
+date: 2011-10-17 00:00:00.000000000 -07:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70137131188020 !ruby/object:Gem::Requirement
+  requirement: &70354740358820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70137131188020
+  version_requirements: *70354740358820
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70137131187380 !ruby/object:Gem::Requirement
+  requirement: &70354740358320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 0.4.0
   type: :development
   prerelease: false
-  version_requirements: *70137131187380
+  version_requirements: *70354740358320
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70137131167680 !ruby/object:Gem::Requirement
+  requirement: &70354740357860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.5.0
   type: :development
   prerelease: false
-  version_requirements: *70137131167680
+  version_requirements: *70354740357860
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70137131167080 !ruby/object:Gem::Requirement
+  requirement: &70354740357400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 1.5.0
   type: :development
   prerelease: false
-  version_requirements: *70137131167080
+  version_requirements: *70354740357400
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &70137131166620 !ruby/object:Gem::Requirement
+  requirement: &70354740384320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: 0.9.4
   type: :development
   prerelease: false
-  version_requirements: *70137131166620
+  version_requirements: *70354740384320
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70137131166060 !ruby/object:Gem::Requirement
+  requirement: &70354740383860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70137131166060
+  version_requirements: *70354740383860
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70137131165540 !ruby/object:Gem::Requirement
+  requirement: &70354740383400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +88,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70137131165540
+  version_requirements: *70354740383400
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &70137131164980 !ruby/object:Gem::Requirement
+  requirement: &70354740382940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -99,7 +99,7 @@ dependencies:
         version: 0.9.4
   type: :runtime
   prerelease: false
-  version_requirements: *70137131164980
+  version_requirements: *70354740382940
 description: Wrapper for the IRS.gov's Publication 78
 email: rwold@morequality.org
 executables: []
@@ -111,9 +111,9 @@ files:
 - Gemfile
 - LICENSE
 - README.rdoc
-- irs.gemspec
-- lib/irs.rb
-- lib/irs/client.rb
+- irs_pub78.gemspec
+- lib/irs_pub78.rb
+- lib/irs_pub78/client.rb
 - spec/fixtures/fixtures.yml
 - spec/helper.rb
 - spec/irs_spec.rb

data/lib/irs.rb

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