sba 0.0.1

data/lib/sba/client/licenses.rb

@@ -0,0 +1,111 @@
+# -*- coding: utf-8 -*-
+require 'json'
+
+module SBA
+  class Client
+    module Licenses
+    
+      include SBA::Client::Connection
+      
+      # Returns results for a matching license or permit category for each 54 states and territories. 
+      #
+      # @param category [String] One of the following categories: doing business as, entity filing, employer requirements, states licenses, tax registration
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/business-licenses-permits-api-category-method
+      # @example
+      #   SBA.by_category("doing business as")
+      def by_category(category, options={})
+        options.merge!({:format=> "json"})
+        response = get("/license_permit/by_category/#{category}.json")
+        simplify_response(response)
+      end
+      
+      # Returns all business licenses for all business types required to operate in an specific state or territory.
+      #
+      # @param state [String] input the two letter postal code for the state abbreviation.
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/business-licenses-permits-api-state-method
+      # @example
+      #   SBA.by_state("ca")
+      def by_state(state, options={})
+        options.merge!({:format=> "json"})
+        response = get("/license_permit/all_by_state/#{state}.json", options)
+        simplify_response(response)
+      end
+      
+      # Returns business licenses and permits required for a specific type of business for all 54 states and territories
+      #
+      # @param business [String] The business parameter includes standard values that allow you to return license and permit information for a specific type of business or for specific employer requirements
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/business-licenses-permits-api-business-type-method
+      # @example
+      #   SBA.by_business_type("child care services") 
+      def by_business_type(business, options={})
+        response = get("license_permit/by_business_type/#{business}.json", options)
+        simplify_response(response)
+      end
+
+      # Returns business licenses and permits required for a specific type of business in a specific state.
+      #
+      # @param business [String] The business parameter includes standard values that allow you to return license and permit information for a specific type of business or for specific employer requirements
+      # @param state [String] Input the two letter postal code for the state abbreviation.
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/business-licenses-permits-api-business-type-and-state-method
+      # @example
+      #   SBA.business_type_state("child care services", "ca")
+      def business_type_state(business, state, options={})
+        response = get("license_permit/state_only/#{business}/#{state}.json", options)
+        simplify_response(response)
+      end
+      
+      # Returns business licenses and permits required for a specific type of business in a specific state and county.
+      #
+      # @param business [String] The business parameter includes standard values that allow you to return license and permit information for a specific type of business or for specific employer requirements
+      # @param state [String] Input the two letter postal code for the state abbreviation.
+      # @param county [String] Input the name of the county (or its equivalent).  County (or equivalent) name should including the word "county" (or "parish" etc.)  For example, input Orange County, not Orange.
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/business-licenses-permits-api-business-type-state-and-county-method
+      # @example
+      #   SBA.business_type_state_county("child care services", "ca", "los angeles county")
+      def business_type_state_county(business, state, county, options={})
+        response = get("license_permit/state_and_county/#{business}/#{state}/#{county}.json")
+        simplify_response(response)
+      end
+
+      # Returns business licenses and permits required for a specific type of business in a specific state and city
+      #
+      # @param business [String] The business parameter includes standard values that allow you to return license and permit information for a specific type of business or for specific employer requirements
+      # @param state [String] Input the two letter postal code for the state abbreviation.
+      # @param city [String] Input the name of the City. 
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/business-licenses-permits-api-business-type-state-and-city-method
+      # @example
+      #   SBA.business_type_state_city("restaurant", "ny", "albany")
+      def business_type_state_city(business, state, city, options={})
+        response = get("license_permit/state_and_city/#{business}/#{state}/#{city}.json")
+        simplify_response(response)
+      end
+      
+      # Returns business licenses and permits required for a specific type of business in a specific zip code
+      #
+      # @param business [String] The business parameter includes standard values that allow you to return license and permit information for a specific type of business or for specific employer requirements
+      # @param zip [String] Input a valid five digit zip code.
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/business-licenses-permits-api-business-type-state-and-city-method
+      # @example
+      #   SBA.business_type_zip("restaurant","94105")
+      def business_type_zip(business, zip, options={})
+        response = get("license_permit/by_zip/#{business}/#{zip}.json")
+        simplify_response(response)
+      end
+      
+    end
+  end
+end

data/lib/sba/client/loans.rb

@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+require 'json'
+
+module SBA
+  class Client
+    module Loans
+    include SBA::Client::Connection
+    
+      # Returns financing programs available from Federal government agencies and select non-profit organizations nationwide.
+      #
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/loans-grants-search-api-federal-program-method
+      # @example
+      #   SBA.loan_grants_by_federal   
+      def loan_grants_by_federal(options={})
+        response = get("loans_grants/federal.json", options)
+      end
+
+      # Returns all small business financing programs sponsored by state government agencies and select non-profit and commercial organizations.
+      #
+      # @param state [String] input the two leter postal code for the state abbreviation
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/loans-grants-search-api-programs-specific-state-method
+      # @example
+      #   SBA.loan_grants_by_state("ca")     
+      def loan_grants_by_state(state, options={})
+        response = get("loans_grants/state_financing_for/#{state}.json", options)
+      end
+      
+      # Returns all small business financing programs sponsored by federal and state government agencies and selected non-profit and commercial organizations.
+      #
+      # @param state [String] input the two leter postal code for the state abbreviation
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/loans-grants-search-api-federal-and-state-specific-method
+      # @example
+      #   SBA.loan_grants_by_federal_state("ca")
+      def loan_grants_by_federal_state(state, options={})
+        response = get("loans_grants/federal_and_state_financing_for/#{state}.json", options)
+      end
+      
+      # Returns all small business financing programs for a specific industry in all 54 states and territories (when available).
+      #
+      # @param industry [String] input one of the standard industry values: Agriculture,Child Care,Environmental Management,Health Care,Manufacturing,Technology,Tourism
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/loans-grants-search-api-industry-method
+      # @example
+      #   SBA.loan_grants_by_industry("Technology")
+      def loan_grants_by_industry(industry, options={})
+        response = get("loans_grants/nil/for_profit/#{industry}/nil.json", options)
+      end
+      
+      # Returns small business special financing programs for certain business owner groups (e.g., women, veterans, minorities, etc.); or business activities (e.g., export, energy efficiency, disaster assistance, etc.).
+      #
+      # @param industry [String]  input one or more of the standard industry values
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/loans-grants-search-api-specialty-method
+      # @example
+      #   SBA.loan_grants_by_specialty("general_purpose")
+      #   SBA.loan_grants_by_specialty("general_purpose-rural")
+      def loan_grants_by_specialty(specialty, options={})
+        response = get("loans_grants/nil/for_profit/nil/#{specialty}.json", options)
+      end
+      
+      # Returns financing programs for specific industries AND specific business groups (e.g., women, veterans, minorities, etc.); or business activities (e.g., export, energy efficiency, disaster assistance, etc.).
+      #
+      # @param industry [String]  input one or more of the standard industry values
+      # @param specialty [String] input one or more of the stanard industry values
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/loans-grants-search-api-industry-and-specialty-method
+      # @example
+      #   SBA.loan_grants_by_industry_specialty("technology", "contractor")
+      #   SBA.loan_grants_by_industry_specialty("technology, "general_purpose-rural")      
+      def loan_grants_by_industry_specialty(industry, specialty, options={})
+        response = get("loans_grants/nil/for_profit/#{industry}/#{specialty}.json", options)
+      end
+      
+      # Returns all small business financing programs for a specific industry in a specific state.
+      #
+      # @param state [String]  input the two leterl postal code for state abbreviation
+      # @param industry [String]  input one or more of the standard industry values
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/loans-grants-search-api-state-and-industry-method
+      # @example
+      #   SBA.loan_grants_by_state_industry("ca", "technology")   
+      def loan_grants_by_state_industry(state, industry, options={})
+        response = get("loans_grants/#{state}/for_profit/#{industry}/nil.json", options)
+      end
+
+      # Returns state programs for specific business groups or specialized business activities.
+      #
+      # @param state [String]  input the two leterl postal code for state abbreviation
+      # @param specialty [String] input one or more of the stanard industry values
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/loans-grants-search-api-state-and-specialty-method
+      # @example
+      #   SBA.loan_grants_by_state_specialty("ca", "development")
+      def loan_grants_by_state_specialty(state, specialty, options={})
+        response = get("loans_grants/#{state}/for_profit/nil/#{specialty}.json", options)
+      end
+      
+      # Returns state programs by industry and specific business groups or specialized business activities.
+      #
+      # @param state [String]  input the two leterl postal code for state abbreviation
+      # @param industry [String]  input one or more of the standard industry values
+      # @param specialty [String] input one or more of the stanard industry values
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/loans-grants-search-api-state-industry-and-specialty-method
+      # @example
+      #   SBA.loan_grants_by_state_industry_specialty("ca","tecnology","development")
+      def loan_grants_by_state_industry_specialty(state, industry, specialty, options={})
+        response = get("loans_grants/#{state}/for_profit/#{industry}/#{specialty}.json", options)
+      end
+
+    end
+  end
+end

data/lib/sba/client/request.rb

@@ -0,0 +1,37 @@
+module SBA
+  class Client
+    module Request
+      def get(path, options={}, raw=false)
+        request(:get, path, options, raw)
+      end
+
+      def post(path, options={}, raw=false)
+        request(:post, path, options, raw)
+      end
+
+      def put(path, options={}, raw=false)
+        request(:put, path, options, raw)
+      end
+
+      def delete(path, options={}, raw=false)
+        request(:delete, path, options, raw)
+      end
+
+      private
+
+      def request(method, path, options, raw)
+        response = connection(raw).send(method) do |request|
+          case method
+          when :get, :delete
+            request.url(path, options)
+          when :post, :put
+            request.path = path
+            request.body = options unless options.empty?
+          end
+        end
+        raw ? response : response.body
+      end
+
+    end
+  end
+end

data/lib/sba/client/sites.rb

@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+require 'json'
+
+module SBA
+  class Client
+    module Sites
+    include SBA::Client::Connection
+
+      # Returns all recommended sites for all keywords and phrases.
+      #
+      # @format :xml
+      # @return {Hash}
+      # @see http://www.sba.gov/about-sba-services/7630#all
+      # @example Returns recommended sites for keywords and phrases
+      #   SBA.all_sites
+      def all_sites(options={})
+        response = get("rec_sites/all_sites/keywords.json", options)
+        #simplify_response(response)
+      end
+    
+      # Returns all recommended sites for a specific keyword.
+      #
+      # @param keyword [String] A search word or phrase.
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/about-sba-services/7630#keyword
+      # @example
+      #   SBA.sites_by_keyword("contracting")     
+      def sites_by_keyword(keyword, options={})
+        response = get("rec_sites/keywords/#{keyword}.json", options)
+      end
+
+      # Returns all recommended sites for a specific category.
+      #
+      # @param category [String] Name of standard category.
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/about-sba-services/7630#category
+      # @example
+      #   SBA.sites_by_category("managing a business")    
+      def sites_by_category(category, options={})
+        response = get("rec_sites/category/#{category}.json", options)
+      end
+
+      # Returns all recommended sites assigned a specific master term.
+      #
+      # @param term [String] A standard search word or phrase assigned to group of synonyms
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/about-sba-services/7630#master
+      # @example
+      #   SBA.sites_by_master_term("export")
+      def sites_by_master_term(term, options={})
+        response = get("rec_sites/keywords/master_term/#{term}.json", options)
+      end
+
+      # Returns all recommended sites belonging to a specific domain
+      #
+      # @param domain [String] Domain name without the www or .com, .gov, .net
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/about-sba-services/7630#category
+      # @example
+      #   SBA.sites_by_domain("irs")    
+      def sites_by_domain(domain, options={})
+        response = get("rec_sites/keywords/domain/#{domain}.json", options)
+      end
+
+    end
+  end
+end

data/lib/sba/client/urls.rb

@@ -0,0 +1,134 @@
+# -*- coding: utf-8 -*-
+require 'json'
+
+module SBA
+  class Client
+    module Urls
+    include SBA::Client::Connection
+    
+      # Returns primary URLS for All Cities and Counties in a State
+      #
+      # @param state [String] The two letter postal code for the state abbreviation
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/us-city-and-county-web-data-api-city-county-data-primary-methods#all
+      # @example
+      #   SBA.all_primary_urls_in_state("ca")    
+      def all_primary_urls_in_state(state, options={})
+        response = get("geodata/primary_city_county_links_for_state_of/#{state}.json", options)
+      end
+      
+      # Returns primary URLS for All Cities in a State
+      #
+      # @param state [String] The two letter postal code for the state abbreviation
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/us-city-and-county-web-data-api-city-county-data-primary-methods#allcity
+      # @example
+      #   SBA.all_city_primary_urls_in_state("ca")      
+      def all_city_primary_urls_in_state(state, options={})
+        response = get("geodata/primary_city_links_for_state_of/#{state}.json", options)
+      end
+
+      # Returns primary URLS for All Counties in a State
+      #
+      # @param state [String] The two letter postal code for the state abbreviation
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/us-city-and-county-web-data-api-city-county-data-primary-methods#allcounty
+      # @example
+      #   SBA.all_county_primary_urls_in_state("ca")      
+      def all_county_primary_urls_in_state(state, options={})
+        response = get("geodata/primary_county_links_for_state_of/#{state}.json", options)
+      end
+      
+      # Returns the primary URL for a specific city
+      #
+      # @param city [String] Input the name of the city, town or village.
+      # @param state [String] The two letter postal code for the state abbreviation.
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/us-city-and-county-web-data-api-city-county-data-primary-methods#city
+      # @example
+      #   SBA.primary_url_for_city("ca")
+      def primary_url_for_city(city, state, options={})
+        response = get("geodata/primary_links_for_city_of/#{city}/#{state}.json", options)
+      end
+      
+      # Returns the primary URL for a specific County
+      #
+      # @param county [String] Input the name of the county (or its equivalent), including the word county in the name
+      # @param state [String] The two letter postal code for the state abbreviation.
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/us-city-and-county-web-data-api-city-county-data-primary-methods#county
+      # @example
+      #   SBA.all_primary_urls_for_county("king county", "wa")      
+      def all_primary_urls_for_county(county, state, options={})
+        response = get("geodata/primary_links_for_county_of/#{county}/#{state}.json", options)
+      end
+      
+      # Returns All City and County URLS in a State
+      #
+      # @param state [String] The two letter postal code for the state abbreviation.
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/us-city-and-county-web-data-api-city-county-data-all-urls
+      # @example
+      #   SBA.all_urls_city_county("ca")
+      def all_urls_city_county(state, options={})
+        response = get("geodata/city_county_links_for_state_of/#{state}.json", options)
+      end
+      
+      # Returns All City URLS in a State
+      #
+      # @param state [String] The two letter postal code for the state abbreviation.
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/us-city-and-county-web-data-api-city-county-data-all-urls
+      # @example
+      #   SBA.all_urls_city("ca")
+      def all_urls_city(state, options={})
+        response = get("geodata/city_links_for_state_of/#{state}.json", options)
+      end
+
+      # Returns All County URLS in a State
+      #
+      # @param state [String] The two letter postal code for the state abbreviation.
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/us-city-and-county-web-data-api-city-county-data-all-urls
+      # @example
+      #   SBA.all_urls_county("ca")      
+      def all_urls_county(state, options={})
+        response = get("geodata/county_links_for_state_of/#{state}.json", options)
+      end
+
+      # Returns All URLS for a specific city
+      #
+      # @param city [String] Input the name of the city, town or village.
+      # @param state [String] The two letter postal code for the state abbreviation.
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/us-city-and-county-web-data-api-city-county-data-all-urls
+      # @example
+      #   SBA.all_urls_specific_city("dallas","tx")
+      def all_urls_specific_city(city, state, options={})
+        response = get("geodata/all_links_for_city_of/#{city}/#{state}.json", options)
+      end
+
+      # Returns All URLS for a specific county
+      #
+      # @param city [String] Input the name of the county.
+      # @param state [String] The two letter postal code for the state abbreviation.
+      # @param options [Hash] A customizable set of options.
+      # @return {Hash}
+      # @see http://www.sba.gov/content/us-city-and-county-web-data-api-city-county-data-all-urls
+      # @example
+      #   SBA.all_urls_specific_county("orange county", "ca")      
+      def all_urls_specific_county(county, state, options={})
+        response = get("geodata/all_links_for_county_of/#{county}/#{state}.json", options)
+      end
+    end
+  end
+end