businessdotgov 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Chip Castle
+
+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.

data/README.rdoc

@@ -0,0 +1,36 @@
+= businessdotgov
+
+Ruby library for the following Business.gov Search API
+http://www.business.gov/about/features/api/loans-grants/state-industry.html
+
+Examples:
+
+  industries = BusinessDotGov::LoansGrants::INDUSTRIES
+  @industry = industries[rand(industries.length)]      
+  @state_abbreviation = 'FL'
+
+  # format is :json by default
+  results = BusinessDotGov::LoansGrants.new.search({:industry => @industry, :state_abbreviation => @state_abbreviation})
+  puts "Found #{results.size} results for #{@industry} within #{@state_abbreviation}"
+  # :json format
+  puts "First result title #{results.first['title']}"
+
+  # specify if :xml format is desired
+  results = BusinessDotGov::LoansGrants.new.search({:industry => @industry, :state_abbreviation => @state_abbreviation, :format => :xml})
+  # :xml format
+  puts "First result title #{results['grant_loans'][0]['title']}"
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Chip Castle. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "businessdotgov"
+    gem.summary = %Q{Ruby gem for the Business.gov Search API}
+    gem.description = %Q{Ruby gem for the Business.gov Search API}
+    gem.email = "chip@chipcastle.com"
+    gem.homepage = "http://github.com/chip/businessdotgov"
+    gem.authors = ["Chip Castle"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency "weary", ">= 0.7.2"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "businessdotgov #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/businessdotgov.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{businessdotgov}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chip Castle"]
+  s.date = %q{2010-10-09}
+  s.description = %q{Ruby gem for the Business.gov Search API}
+  s.email = %q{chip@chipcastle.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "businessdotgov.gemspec",
+     "lib/businessdotgov.rb",
+     "test/helper.rb",
+     "test/test_businessdotgov.rb"
+  ]
+  s.homepage = %q{http://github.com/chip/businessdotgov}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby gem for the Business.gov Search API}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_businessdotgov.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<weary>, [">= 0.7.2"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<weary>, [">= 0.7.2"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<weary>, [">= 0.7.2"])
+  end
+end
+

data/lib/businessdotgov.rb

@@ -0,0 +1,124 @@
+require 'rubygems'
+require 'weary'
+
+module BusinessDotGov
+  class LoansGrants
+    attr_accessor :state_abbreviation, :industry, :data_format
+    
+    API_URL = 'http://api.business.gov/loans_grants/STATE ABBREVIATION/for_profit/INDUSTRY/nil.FORMAT'
+    US_STATES = {      
+      'ALABAMA' => 'AL',
+      'ALASKA' => 'AK',
+      'AMERICAN SAMOA' => 'AS',
+      'ARIZONA' => 'AZ',
+      'ARKANSAS' => 'AR',
+      'CALIFORNIA' => 'CA',
+      'COLORADO' => 'CO',
+      'CONNECTICUT' => 'CT',
+      'DELAWARE' => 'DE',
+      'DISTRICT' => 'OF',
+      'COLUMBIA' => 'DC',
+      'FEDERATED STATES' => 'OF',
+      'MICRONESIA' => 'FM',
+      'FLORIDA' => 'FL',
+      'GEORGIA' => 'GA',
+      'GUAM' => 'GU',
+      'HAWAII' => 'HI',
+      'IDAHO' => 'ID',
+      'ILLINOIS' => 'IL',
+      'INDIANA' => 'IN',
+      'IOWA' => 'IA',
+      'KANSAS' => 'KS',
+      'KENTUCKY' => 'KY',
+      'LOUISIANA' => 'LA',
+      'MAINE' => 'ME',
+      'MARSHALL ISLANDS' => 'MH',
+      'MARYLAND' => 'MD',
+      'MASSACHUSETTS' => 'MA',
+      'MICHIGAN' => 'MI',
+      'MINNESOTA' => 'MN',
+      'MISSISSIPPI' => 'MS',
+      'MISSOURI' => 'MO',
+      'MONTANA' => 'MT',
+      'NEBRASKA' => 'NE',
+      'NEVADA' => 'NV',
+      'NEW HAMPSHIRE' => 'NH',
+      'NEW JERSEY' => 'NJ',
+      'NEW MEXICO' => 'NM',
+      'NEW YORK' => 'NY',
+      'NORTH CAROLINA' => 'NC',
+      'NORTH DAKOTA' => 'ND',
+      'NORTHERN MARIANA ISLANDS' => 'MP',
+      'OHIO' => 'OH',
+      'OKLAHOMA' => 'OK',
+      'OREGON' => 'OR',
+      'PALAU' => 'PW',
+      'PENNSYLVANIA' => 'PA',
+      'PUERTO RICO' => 'PR',
+      'RHODE ISLAND' => 'RI',
+      'SOUTH CAROLINA' => 'SC',
+      'SOUTH DAKOTA' => 'SD',
+      'TENNESSEE' => 'TN',
+      'TEXAS' => 'TX',
+      'UTAH' => 'UT',
+      'VERMONT' => 'VT',
+      'VIRGIN ISLANDS' => 'VI',
+      'VIRGINIA' => 'VA',
+      'WASHINGTON' => 'WA',
+      'WEST VIRGINIA' => 'WV',
+      'WISCONSIN' => 'WI',
+      'WYOMING' => 'WY'
+    }
+    MILITARY_STATES = {
+      'Armed Forces Africa' => 'AE',
+      'Armed Forces Americas (except Canada)' => 'AA',
+      'Armed Forces Canada' => 'AE',
+      'Armed Forces Europe' => 'AE',
+      'Armed Forces Middle East' => 'AE',
+      'Armed Forces Pacific' => 'AP'
+    }
+    STATES = US_STATES # MILITARY_STATES
+    
+    INDUSTRIES = [
+      'Agriculture', 
+      'Child Care', 
+      'Environmental Management',
+      'Health Care',
+      'Manufacturing',
+      'Technology',
+      'Tourism'
+    ]
+    
+    DATA_FORMATS = [:xml, :json]
+    
+    def initialize(format = :json)
+      @format = format
+      @industry, @state_abbreviation = nil
+    end
+    
+    def search(options = {})
+      @industry ||= options[:industry]
+      @state_abbreviation ||= options[:state_abbreviation]
+      @format ||= options[:format]
+      if @industry.nil?
+        raise ArgumentError, "Oops, an industry wasn't provided.  Please provide one of the following industries: #{INDUSTRIES.join(', ')}"
+      end
+      if @state_abbreviation.nil?
+        raise ArgumentError, "Oops, an US state wasn't provided.  Please provide one of the following US states: #{STATES.values.join(', ')}"
+      end
+      api_call = URI.escape(API_URL.sub(/STATE ABBREVIATION/, @state_abbreviation).sub(/INDUSTRY/, @industry).sub(/FORMAT/, @format.to_s))
+      puts "api_call = #{api_call}"
+      response = Weary.get(api_call).perform
+      if response.success?
+        return response.parse
+      else
+        raise "Something went wrong. Request failed with #{response.code}: #{response.message}"
+      end
+    end
+  end
+end
+
+# b = BusinessDotGov::LoansGrants.new
+# b.industry = 'Technology'
+# b.state_abbreviation = 'FL'
+# b.search

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'businessdotgov'
+
+class Test::Unit::TestCase
+end

data/test/test_businessdotgov.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestBusinessdotgov < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: businessdotgov
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chip Castle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-09 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: weary
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 7
+        - 2
+        version: 0.7.2
+  type: :runtime
+  version_requirements: *id002
+description: Ruby gem for the Business.gov Search API
+email: chip@chipcastle.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- businessdotgov.gemspec
+- lib/businessdotgov.rb
+- test/helper.rb
+- test/test_businessdotgov.rb
+has_rdoc: true
+homepage: http://github.com/chip/businessdotgov
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby gem for the Business.gov Search API
+test_files: 
+- test/helper.rb
+- test/test_businessdotgov.rb