sba 0.0.1

data/.gitignore

@@ -0,0 +1,41 @@
+!.gitignore
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.redcar
+.yardoc
+/.emacs.desktop
+/.emacs.desktop.lock
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc/
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,10 @@
+Copyright (c) 2011, Code for America
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* Neither the name of Code for America nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/LICENSE.mkd

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Code for America Laboratories
+
+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.mkd

@@ -0,0 +1,72 @@
+SBA API
+=======
+A Ruby wrapper for the SBA APIs at http://www.sba.gov/api.
+
+Does your project or organization use this gem?
+------------------------------------------
+Add it to the [apps](http://github.com/codeforamerica/sba/wiki/apps) wiki!
+
+Installation
+------------
+    $ [sudo] gem install sba
+
+Documentation
+-------------
+[http://rdoc.info/gems/sba_ruby](http://rdoc.info/gems/sba_ruby)
+
+Continuous Integration
+----------------------
+[![Build Status](http://travis-ci.org/codeforamerica/sba_ruby.png)](http://travis-ci.org/codeforamerica/sba_ruby)
+
+Usage Examples
+--------------
+    require 'sba'
+	
+	@client = SBA::Client::New
+	a = @client.all_primary_urls_in_state("ca")
+	a[0]["name"] # =>  "Adelanto"
+	
+    
+Contributing
+------------
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by resolving [issues](http://github.com/cfalabs/sba/issues)
+* by reviewing patches
+
+Submitting an Issue
+-------------------
+We use the [GitHub issue tracker](http://github.com/codeforamerica/sba/issues) to track bugs and
+features. Before submitting a bug report or feature request, check to make sure it hasn't already
+been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
+bug report, please include a [Gist](http://gist.github.com/) that includes a stack trace and any
+details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
+operating system. Ideally, a bug report should include a pull request with failing specs.
+
+Submitting a Pull Request
+-------------------------
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+5. Run <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
+6. Add specs for your feature or bug fix.
+7. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go back to step 6.
+8. Commit and push your changes.
+9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+Copyright
+---------
+Copyright (c) 2010 Code for America Laboratories
+See [LICENSE](https://github.com/cfalabs/sba/blob/master/LICENSE.mkd) for details.
+
+[![Code for America Tracker](http://stats.codeforamerica.org/codeforamerica/sba_ruby.png)](http://stats.codeforamerica.org/projects/sba_ruby)

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec
+
+require 'yard'
+namespace :doc do
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.md', 'lib/**/*.rb']
+    task.options = ['--markup', 'markdown']
+  end
+end

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/lib/faraday/multipart.rb

@@ -0,0 +1,29 @@
+require 'faraday'
+
+# @api private
+module Faraday
+  class Request::Multipart < Faraday::Middleware
+    def call(env)
+      if env[:body].is_a?(Hash)
+        env[:body].each do |key, value|
+          if value.is_a?(File)
+            env[:body][key] = Faraday::UploadIO.new(value, mime_type(value), value.path)
+          end
+        end
+      end
+
+      @app.call(env)
+    end
+
+    private
+
+    def mime_type(file)
+      case file.path
+        when /\.jpe?g/i then 'image/jpeg'
+        when /\.gif$/i then 'image/gif'
+        when /\.png$/i then 'image/png'
+        else 'application/octet-stream'
+      end
+    end
+  end
+end

data/lib/faraday/raise_error.rb

@@ -0,0 +1,31 @@
+require 'faraday'
+
+# @api private
+module Faraday
+  class Response::RaiseError < Response::Middleware
+    def on_complete(response)
+      case response[:status].to_i
+      when 400
+        raise SBA::BadRequest, error_message(response)
+      when 401
+        raise SBA::Unauthorized, error_message(response)
+      when 403
+        raise SBA::Forbidden, error_message(response)
+      when 404
+        raise SBA::NotFound, error_message(response)
+      when 406
+        raise SBA::NotAcceptable, error_message(response)
+      when 500
+        raise SBA::InternalServerError, error_message(response)
+      when 502
+        raise SBA::BadGateway, error_message(response)
+      when 503
+        raise SBA::ServiceUnavailable, error_message(response)
+      end
+    end
+
+    def error_message(response)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:response_headers]['status']}#{(': ' + response[:body]['error']) if response[:body] && response[:body]['error']}"
+    end
+  end
+end

data/lib/faraday/response/raise_error.rb

@@ -0,0 +1,32 @@
+require 'faraday'
+
+# @api private
+module Faraday
+  class Response::RaiseError < Response::Middleware
+    def on_complete(response)
+      case response[:status].to_i
+      when 400
+        raise SBA::BadRequest, error_message(response)
+      when 401
+        raise SBA::Unauthorized, error_message(response)
+      when 403
+        raise SBA::Forbidden, error_message(response)
+      when 404
+        raise SBA::NotFound, error_message(response)
+      when 406
+        raise SBA::NotAcceptable, error_message(response)
+      when 500
+        raise SBA::InternalServerError, error_message(response)
+      when 502
+        raise SBA::BadGateway, error_message(response)
+      when 503
+        raise SBA::ServiceUnavailable, error_message(response)
+      end
+    end
+
+    def error_message(response)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:response_headers]['status']}#{(': ' + response[:body]['error']) if response[:body] && response[:body]['error']}"
+    end
+  end
+end
+

data/lib/sba.rb

@@ -0,0 +1,51 @@
+require ::File.expand_path('../sba/version', __FILE__)
+require ::File.expand_path('../sba/configuration.rb', __FILE__)
+require ::File.expand_path('../sba/client', __FILE__)
+
+module SBA
+  extend Configuration
+
+  # Alias for SBA::Client.new
+  #
+  # @return [SBA::Client]
+  def self.client(options={})
+    SBA::Client.new(options)
+  end
+
+  # Delegate to SBA::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+  
+  def self.respond_to?(method, include_private=false)
+    client.respond_to?(method, include_private) || super(method, include_private)
+  end
+
+  # Custom error class for rescuing from all SBA errors
+  class Error < StandardError; end
+
+  # Raised when SBA returns a 400 HTTP status code
+  class BadRequest < Error; end
+
+  # Raised when SBA returns a 401 HTTP status code
+  class Unauthorized < Error; end
+
+  # Raised when SBA returns a 403 HTTP status code
+  class Forbidden < Error; end
+
+  # Raised when SBA returns a 404 HTTP status code
+  class NotFound < Error; end
+
+  # Raised when SBA returns a 406 HTTP status code
+  class NotAcceptable < Error; end
+
+  # Raised when SBA returns a 500 HTTP status code
+  class InternalServerError < Error; end
+
+  # Raised when SBA returns a 502 HTTP status code
+  class BadGateway < Error; end
+
+  # Raised when SBA returns a 503 HTTP status code
+  class ServiceUnavailable < Error; end
+end

data/lib/sba/client.rb

@@ -0,0 +1,44 @@
+require ::File.expand_path('../client/connection', __FILE__)
+require ::File.expand_path('../client/request', __FILE__)
+require ::File.expand_path('../client/data.rb', __FILE__)
+require ::File.expand_path('../client/loans.rb', __FILE__)
+require ::File.expand_path('../client/licenses.rb', __FILE__)
+require ::File.expand_path('../client/sites.rb', __FILE__)
+require ::File.expand_path('../client/urls.rb', __FILE__)
+
+module SBA
+  class Client
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    def initialize(options={})
+      options = SBA.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include SBA::Client::Connection
+    include SBA::Client::Request
+    include SBA::Client::Data
+    include SBA::Client::Urls
+    include SBA::Client::Loans
+    include SBA::Client::Licenses
+    include SBA::Client::Sites  
+    
+    private
+    #some JSON replies we get back are in an ugly format. simplify them
+    def simplify_response(response)
+      #the returned 'key' is pretty useless. the key=>value thing here is basically an array
+      #within that, we're given an array of key=>value pairs. we want this to be one big hash.
+      Hash[*response.group_by {|key,val| key.match(/(.*)_item/)[1]}.map do |section,items|
+        [section,
+        items.inject([]) do |array,(key,value)|
+          i = key.match(/\d+$/)[0].to_i
+          array[i] = value.inject({}) {|all,current| all.merge! current}
+          array
+        end]
+      end.flatten(1)]
+    end
+              
+  end
+end

data/lib/sba/client/connection.rb

@@ -0,0 +1,37 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../../faraday/*.rb', __FILE__)].each{|file| require file}
+
+module SBA
+  class Client
+    # @private
+    module Connection
+      private
+
+      def connection(raw=false)
+        options = {
+          #:headers => {'Accept' => "*/#{format}", 'User-Agent' => user_agent},
+          :headers => {'Accept' => 'application/json'},
+          :proxy => proxy,
+          :ssl => {:verify => false},
+          :url => 'http://api.sba.gov/' + endpoint.to_s
+        }
+
+        Faraday::Connection.new(options) do |connection|
+          connection.use Faraday::Request::Multipart
+          unless raw
+            connection.use Faraday::Response::Mashify
+            case format.to_s.downcase
+            when 'json'
+              connection.use Faraday::Response::ParseJson
+            when 'xml'
+              connection.use Faraday::Response::ParseXml
+            end
+          end
+          connection.use Faraday::Response::RaiseError
+          connection.adapter(adapter)
+        end
+      end
+    end
+  end
+end
+

data/lib/sba/client/data.rb

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+require 'json'
+
+module SBA
+  class Client
+    module Data
+    include SBA::Client::Connection
+    
+      # Returns Data for all Cities and Counties in a State
+      #
+      # @param state [String]  Input the two leter postal code for state abbreviation.
+      # @param options [Hash] A customizable set of options.
+      # @return {Array}
+      # @see http://www.sba.gov/content/us-city-and-county-web-data-api-city-county-data-all-data-methods
+      # @example
+      #   SBA.data_city_county("ca")
+      def data_city_county(state,options={})
+        response = get("geodata/city_county_data_for_state_of/#{state}.json", options)
+      end
+      
+      # Returns Data for all Cities in a State
+      #
+      # @param state [String]  Input the two leter postal code for state abbreviation.
+      # @param options [Hash] A customizable set of options.
+      # @return {Array}
+      # @see http://www.sba.gov/content/us-city-and-county-web-data-api-city-county-data-all-data-methods
+      # @example
+      #   SBA.data_city("ca")
+      def data_city(state, options={})
+        response = get("geodata/city_data_for_state_of/#{state}.json", options)
+      end
+
+      # Returns Data for all Counties in a State
+      #
+      # @param state [String]  Input the two leter postal code for state abbreviation.
+      # @param options [Hash] A customizable set of options.
+      # @return {Array}
+      # @see http://www.sba.gov/content/us-city-and-county-web-data-api-city-county-data-all-data-methods
+      # @example
+      #   SBA.data_county("ca")      
+      def data_county(state, options={})
+        response = get("geodata/county_data_for_state_of/#{state}.json", options)
+      end
+      
+      # Returns Data for a specific City
+      #
+      # @param city [String]  Input the name of the city 
+      # @param state [String]  Input the two leter postal code for state abbreviation.
+      # @param options [Hash] A customizable set of options.
+      # @return {Array}
+      # @see http://www.sba.gov/content/us-city-and-county-web-data-api-city-county-data-all-data-methods
+      # @example
+      #   SBA.data_specific_city("ca")
+      def data_specific_city(city, state, options={})
+        response = get("geodata/all_data_for_city_of/#{city}/#{state}.json", options)
+      end
+
+      # Returns Data for a specific County
+      #
+      # @param county [String]  Input the name of the County
+      # @param state [String]  Input the two leter postal code for state abbreviation.
+      # @param options [Hash] A customizable set of options.
+      # @return {Array}
+      # @see http://www.sba.gov/content/us-city-and-county-web-data-api-city-county-data-all-data-methods
+      # @example
+      #   SBA.data_specific_county("orange county", "ca")
+      def data_specific_county(county, state, options={})
+        response = get("geodata/all_data_for_county_of/#{county}/#{state}.json", options)
+      end
+      
+    end
+  end
+end