open311 0.0.0

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.DS_Store
+.bundle
+.yardoc
+coverage/*
+doc/*
+log/*
+pkg/*

data/.rspec

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

data/.yardopts

@@ -0,0 +1,7 @@
+--no-private
+--protected
+--tag format:"Supported formats"
+--tag key:"Requires API key"
+--markup markdown
+-
+LICENSE.mkd

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    open311 (0.0.0)
+      faraday (~> 0.5.2)
+      faraday_middleware (~> 0.2.3)
+      hashie (~> 0.4.0)
+      multi_json (~> 0.0.5)
+      multi_xml (~> 0.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.4.0)
+    addressable (2.2.2)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    faraday (0.5.2)
+      addressable (~> 2.2.2)
+      multipart-post (~> 1.0.1)
+      rack (>= 1.1.0, < 2)
+    faraday_middleware (0.2.3)
+      faraday (~> 0.5.2)
+    hashie (0.4.0)
+    libxml-ruby (1.1.4)
+    multi_json (0.0.5)
+    multi_xml (0.2.0)
+    multipart-post (1.0.1)
+    rack (1.2.1)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    webmock (1.5.0)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+    yajl-ruby (0.7.8)
+    yard (0.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest (~> 4.4)
+  bundler (~> 1.0)
+  faraday (~> 0.5.2)
+  faraday_middleware (~> 0.2.3)
+  hashie (~> 0.4.0)
+  libxml-ruby (~> 1.1)
+  multi_json (~> 0.0.5)
+  multi_xml (~> 0.2.0)
+  open311!
+  rake (~> 0.8)
+  rcov (~> 0.9)
+  rspec (~> 2.0.1)
+  webmock (~> 1.5)
+  yajl-ruby (~> 0.7)
+  yard (~> 0.6)

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,71 @@
+Open311
+=======
+A Ruby wrapper for the Open311 API v2.
+
+Does your project or company use this gem?
+------------------------------------------
+Add it to the [apps](http://github.com/cfalabs/open311/wiki/apps) wiki!
+
+Installation
+------------
+    $ [sudo] gem install open311
+
+Documentation
+-------------
+<http://rdoc.info/gems/open311>
+
+Usage Examples
+--------------
+    require 'open311'
+    
+    # Certain methods require an API key
+    Open311.configure do |config|
+      config.api_key      = YOUR_API_KEY
+      config.endpoint     = 'https://open311.sfgov.org/'
+      config.jurisdiction = 'sfgov.org'
+    end
+    
+    # Provide a list of acceptable 311 service request types and their associated service codes
+    Open311.service_list
+
+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/open311/issues)
+* by reviewing patches
+
+Submitting an Issue
+-------------------
+We use the [GitHub issue tracker](http://github.com/cfalabs/open311/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:rcov</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/open311/blob/master/LICENSE.mkd) for details.

data/Rakefile

@@ -0,0 +1,34 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :spec do
+  desc "Run all examples using rcov"
+  RSpec::Core::RakeTask.new(:rcov => :cleanup_rcov_files) do |task|
+    task.rcov = true
+    task.rcov_opts = %[-Ilib -Ispec --exclude "gems/*,features,specs" --text-report --sort coverage]
+  end
+end
+
+task :cleanup_rcov_files do
+  rm_rf 'coverage'
+end
+
+task :default => ["spec:rcov"]
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.mkd', 'lib/**/*.rb']
+    task.options = [
+      '--no-private',
+      '--protected',
+      '--output-dir', 'doc/yard',
+      '--tag', 'format:Supported formats',
+      '--tag', 'key:Requires API key',
+      '--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,40 @@
+require 'faraday'
+
+# @api private
+module Faraday
+  class Response::RaiseError < Response::Middleware
+    def self.register_on_complete(env)
+      env[:response].on_complete do |response|
+        case response[:status].to_i
+        when 400
+          raise Open311::BadRequest, error_message(response)
+        when 401
+          raise Open311::Unauthorized, error_message(response)
+        when 403
+          raise Open311::Forbidden, error_message(response)
+        when 404
+          raise Open311::NotFound, error_message(response)
+        when 406
+          raise Open311::NotAcceptable, error_message(response)
+        when 500
+          raise Open311::InternalServerError, error_message(response)
+        when 502
+          raise Open311::BadGateway, error_message(response)
+        when 503
+          raise Open311::ServiceUnavailable, error_message(response)
+        end
+      end
+    end
+
+    def initialize(app)
+      super
+      @parser = nil
+    end
+
+    private
+
+    def self.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/open311.rb

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

data/lib/open311/client.rb

@@ -0,0 +1,19 @@
+Dir[File.expand_path('../client/*.rb', __FILE__)].each{|file| require file}
+
+module Open311
+  class Client
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    def initialize(options={})
+      options = Open311.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Open311::Client::Connection
+    include Open311::Client::Request
+
+    include Open311::Client::Service
+  end
+end

data/lib/open311/client/connection.rb

@@ -0,0 +1,28 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../../faraday/*.rb', __FILE__)].each{|file| require file}
+
+module Open311
+  class Client
+    # @private
+    module Connection
+      private
+
+      def connection(raw=false)
+        options = {
+          # :headers => {'Accept' => "*/#{format}", 'User-Agent' => user_agent},
+          :proxy => proxy,
+          :ssl => {:verify => false},
+          :url => endpoint
+        }
+
+        Faraday::Connection.new(options) do |builder|
+          builder.use Faraday::Request::Multipart
+          builder.adapter(adapter)
+          builder.use Faraday::Response::RaiseError
+          builder.use Faraday::Response::Parse unless raw
+          builder.use Faraday::Response::Mashify unless raw
+        end
+      end
+    end
+  end
+end

data/lib/open311/client/request.rb

@@ -0,0 +1,40 @@
+module Open311
+  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(formatted_path(path), options)
+            when :post, :put
+              request.path = formatted_path(path)
+              request.body = options
+          end
+        end
+        raw ? response : response.body
+      end
+
+      def formatted_path(path)
+        [path, format].compact.join('.')
+      end
+    end
+  end
+end

data/lib/open311/client/service.rb

@@ -0,0 +1,21 @@
+module Open311
+  class Client
+    module Service
+      # Provide a list of acceptable 311 service request types and their associated service codes
+      #
+      # @todo Overload the method to allow fetching of the authenticated user's screen name from configurati
+      # @format :xml
+      # @key false
+      # @param options [Hash] A customizable set of options.
+      # @return [Array]
+      # @see http://wiki.open311.org/GeoReport_v2#GET_Service_List
+      # @example Provide a list of acceptable 311 service request types and their associated service codes
+      #   Open311.service_list
+      def service_list(options={})
+        options.merge!(:jurisdiction_id => jurisdiction)
+        response = get('dev/v2/services', options)
+        format.to_s.downcase == 'xml' ? response['services']['service'] : response
+      end
+    end
+  end
+end

data/lib/open311/configuration.rb

@@ -0,0 +1,41 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module Open311
+  module Configuration
+    VALID_OPTIONS_KEYS   = [:adapter, :api_key, :endpoint, :format, :jurisdiction, :proxy, :user_agent].freeze
+    VALID_FORMATS        = [:json, :xml].freeze
+
+    DEFAULT_ADAPTER      = Faraday.default_adapter.freeze
+    DEFAULT_API_KEY      = nil.freeze
+    DEFAULT_ENDPOINT     = nil.freeze
+    DEFAULT_FORMAT       = :json.freeze
+    DEFAULT_JURISDICTION = nil.freeze
+    DEFAULT_PROXY        = nil.freeze
+    DEFAULT_USER_AGENT   = "Open311 Ruby Gem #{Open311::VERSION}".freeze
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+    end
+
+    def reset
+      self.adapter      = DEFAULT_ADAPTER
+      self.api_key      = DEFAULT_API_KEY
+      self.endpoint     = DEFAULT_ENDPOINT
+      self.format       = DEFAULT_FORMAT
+      self.jurisdiction = DEFAULT_JURISDICTION
+      self.proxy        = DEFAULT_PROXY
+      self.user_agent   = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/open311/version.rb

@@ -0,0 +1,3 @@
+module Open311
+  VERSION = "0.0.0"
+end

data/open311.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/open311/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.add_development_dependency("bundler", "~> 1.0")
+  s.add_development_dependency("libxml-ruby", "~> 1.1")
+  s.add_development_dependency("rake", "~> 0.8")
+  s.add_development_dependency("rcov", "~> 0.9")
+  s.add_development_dependency("rspec", "~> 2.0.1")
+  s.add_development_dependency("webmock", "~> 1.5")
+  s.add_development_dependency("yajl-ruby", "~> 0.7")
+  s.add_development_dependency("yard", "~> 0.6")
+  s.add_development_dependency("ZenTest", "~> 4.4")
+  s.add_runtime_dependency("hashie", "~> 0.4.0")
+  s.add_runtime_dependency("faraday", "~> 0.5.2")
+  s.add_runtime_dependency("faraday_middleware", "~> 0.2.3")
+  s.add_runtime_dependency("multi_json", "~> 0.0.5")
+  s.add_runtime_dependency("multi_xml", "~> 0.2.0")
+  s.authors = ["Dan Melton", "Erik Michaels-Ober"]
+  s.description = %q{A Ruby wrapper for the Open311 API v2.}
+  s.post_install_message =<<eos
+Using this gem for your project or company? Add it to the apps wiki!
+https://github.com/cfalabs/open311/wiki/apps
+eos
+  s.email = ["dan@codeforamerica.org"]
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = `git ls-files`.split("\n")
+  s.homepage = "http://rubygems.org/gems/open311"
+  s.name = "open311"
+  s.platform = Gem::Platform::RUBY
+  s.require_paths = ["lib"]
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if s.respond_to? :required_rubygems_version=
+  s.summary = s.description
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = Open311::VERSION
+end

data/spec/fixtures/services.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<services xmlns:m="http://org/sfgov/sf311v2/services" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><service><service_code>001</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Litter Receptacles</group><service_name>Cans_Left_Out_24x7</service_name><description>Garbage or recycling cans that have been left out for more than 24 hours after collection. Violators will be cited.
+</description></service><service><service_code>002</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Street Defects</group><service_name>Construction_Plate_Shifted</service_name><description>Metal construction plate covering the street or sidewalk has been moved.
+</description></service><service><service_code>003</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Sidewalk or Curb</group><service_name>Curb_or_Curb_Ramp_Defect</service_name><description>Sidewalk curb or ramp has problems such as cracking, missing pieces, holes, and/or chipped curb.
+</description></service><service><service_code>004</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Litter Receptacles</group><service_name>Damaged_City_Can</service_name><description>Damage to a city garbage receptacle such as missing parts (lid, door, liner) or other physical damage.
+</description></service><service><service_code>005</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Sidewalk or Curb</group><service_name>Damaged_Side_Sewer_Vent_Cover</service_name><description>Damage to a side sewer vent cover with problems such as cracking, bending, rusting, or denting</description></service><service><service_code>006</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Tree Maintenance</group><service_name>Damaged_Tree</service_name><description>Damage to a city maintained tree. To check whether a tree is city maintained: http://bit.ly/6hsDk1</description></service><service><service_code>007</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Graffiti</group><service_name>Graffiti - Public - Bike_rack</service_name><description>Graffiti on a bike rack that does not contain racial slurs, profanity, or gang related language</description></service><service><service_code>008</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Graffiti</group><service_name>Graffiti - Public - News_rack</service_name><description>Graffiti on a news rack that does not contain racial slurs, profanity, or gang related language
+</description></service><service><service_code>009</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Graffiti</group><service_name>Graffiti - Public - Parking_meter</service_name><description>Graffiti on a parking meter that does not contain racial slurs, profanity, or gang related language
+</description></service><service><service_code>010</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Graffiti</group><service_name>Graffiti - Public - Pay_phone</service_name><description>Graffiti on a pay phone that does not contain racial slurs, profanity, or gang related language. 
+</description></service><service><service_code>011</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Graffiti</group><service_name>Graffiti - Private - Not_Offensive</service_name><description>Graffiti on a privately owned building or structure that does not contain racial slurs, profanity, or gang related language 
+</description></service><service><service_code>012</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Graffiti</group><service_name>Graffiti - Private - Offensive</service_name><description>Graffiti on a privately owned building or structure that contains racial slurs, profanity, or gang related language
+</description></service><service><service_code>013</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Graffiti</group><service_name>Graffiti - Public - Other_enter_additional_details_below</service_name><description>Graffiti on public property (building, pole, sidewalk, hydrant, etc) with racial slurs, profanity, or gang related language
+</description></service><service><service_code>015</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Illegal Dumping</group><service_name>Illegal_Dumping</service_name><description>Identify someone that has dumped or is dumping furniture or garbage onto the street or sidewalk. Violators will be cited
+</description></service><service><service_code>016</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Tree Maintenance</group><service_name>Landscaping</service_name><description>Request maintenance on public property (except on park property) such as lawn mowing, bush or strip trimming and removal
+</description></service><service><service_code>017</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Street and Sidewalk Cleaning</group><service_name>Missed_Route_Mechanical_Sweeping</service_name><description>Street cleaning sweeper did not show up as scheduled according to the street cleaning signs
+</description></service><service><service_code>018</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Sidewalk or Curb</group><service_name>Missing_Side_Sewer_Vent_Cover</service_name><description>The 4" side sewer vent cover (http://bit.ly/57BlOv) is missing from the sidewalk 
+</description></service><service><service_code>019</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Overflowing City Receptacle or Dumpster</group><service_name>Overflowing_City_Receptacle_or_Dumpster</service_name><description>City receptacle is overflowing and/or has garbage on and around the container
+</description></service><service><service_code>020</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Tree Maintenance</group><service_name>Overgrown_Tree</service_name><description>Request that a city maintained tree (except on park property) be trimmed.  To check whether a tree is city maintained: http://bit.ly/6hsDk1
+</description></service><service><service_code>021</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Street Defects</group><service_name>Pavement_Defect</service_name><description>Defect on the street such as broken, cracked, and sinking asphalt or concrete
+</description></service><service><service_code>022</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Sewer Issues</group><service_name>Sewage_Back_Up Out_of_catch_basin</service_name><description>Sewage or dirty water coming out of a catchbasin (located at the corner of intersections)
+</description></service><service><service_code>023</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Sewer Issues</group><service_name>Side_Sewer_issues Water_coming_out</service_name><description>Sewage or odor coming out of a 4 inch side sewer (http://bit.ly/57BlOv) located on the sidewalk
+</description></service><service><service_code>024</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Sidewalk Cleaning</group><service_name>Sidewalk_Cleaning</service_name><description>Have garbage or human waste removed from the sidewalk and/or request services such as steam cleaning of sidewalks
+</description></service><service><service_code>025</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Sidewalk Defect</group><service_name>Sidewalk_Defect</service_name><description>Defect on the sidewalk such as broken, cracked, and/or sinking concrete
+</description></service><service><service_code>026</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Street Cleaning</group><service_name>Street_Cleaning</service_name><description>Request to have garbage or human waste removed from the street
+</description></service><service><service_code>027</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Tree Maintenance</group><service_name>Damaging_Property</service_name><description>Tree is damaging property (except for parks) or housing structure. City will address problem if it is a city maintained tree otherwise the property owner is notified to correct the issue
+</description></service><service><service_code>028</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Graffiti</group><service_name>Water_Main_Break</service_name><description>Street is flooding due to water coming from within the asphalt or from a catchbasin
+</description></service><service><service_code>029</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Graffiti</group><service_name>Sign - Defaced</service_name><description>Graffiti on a street sign such as a stop sign, street name, and/or other parking and traffic signs
+</description></service><service><service_code>030</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Sewer Issues</group><service_name>Side_Sewer_issues Odor</service_name><description>Odor coming out of a 4 inch side sewer (http://bit.ly/57BlOv) located on the sidewalk. 
+</description></service><service><service_code>031</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Sewer Issues</group><service_name>Sewage_Back_up Out_of_manhole_cover</service_name><description>Sewage or dirty water coming out of a manhole cover (typically located in the a street or alley)
+</description></service><service><service_code>032</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Sewer Issues</group><service_name>Sewage_Back_up Outofsewervent4inch</service_name><description>Sewage or dirty water coming out of a sewer vent (located on the sidewalk)
+</description></service><service><service_code>375</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Street or Sidewalk</group><service_name>Damaged_Benches_on_Sidewalk</service_name><description>Report a damaged bench on city property.</description></service><service><service_code>376</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Street or Sidewalk</group><service_name>Damaged_Bike_Rack</service_name><description>Report a damaged bike rack on city property.</description></service><service><service_code>377</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Street or Sidewalk</group><service_name>Damaged_Kiosk_or_Public_Toilet</service_name><description>Report a damaged kiosk or public toilet on city property.</description></service><service><service_code>378</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Street or Sidewalk</group><service_name>Damaged_News_Rack</service_name><description>Report a damaged news rack on city property.</description></service><service><service_code>379</service_code><metadata>false</metadata><type>realtime</type><keywords/><group>Street or Sidewalk</group><service_name>Damaged_Parking_Meter</service_name><description>Report a damaged parking meter on city property.</description></service></services>

data/spec/open311_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Open311, ".service_list" do
+  before do
+    Open311.configure do |config|
+      config.endpoint     = 'https://open311.sfgov.org/'
+      config.format       = 'xml'
+      config.jurisdiction = 'sfgov.org'
+    end
+    stub_request(:get, 'https://open311.sfgov.org/dev/v2/services.xml').
+      with(:query => {:jurisdiction_id => 'sfgov.org'}).
+      to_return(:body => fixture('services.xml'), :headers => {'Content-Type' => 'text/xml; charset=utf-8'})
+  end
+
+  it "should request the correct resource" do
+    Open311.service_list
+    a_request(:get, 'https://open311.sfgov.org/dev/v2/services.xml').
+      with(:query => {:jurisdiction_id => 'sfgov.org'}).
+      should have_been_made
+  end
+
+  it "should return the correct results" do
+    services = Open311.service_list
+    services.should be_an Array
+    services.first.service_code.should == '001'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../../lib/open311', __FILE__)
+
+require 'webmock/rspec'
+RSpec.configure do |config|
+  config.include WebMock::API
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

metadata

@@ -0,0 +1,312 @@
+--- !ruby/object:Gem::Specification 
+name: open311
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Dan Melton
+- Erik Michaels-Ober
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: libxml-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 0
+        - 1
+        version: 2.0.1
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: ZenTest
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 4
+        - 4
+        version: "4.4"
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :runtime
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: faraday_middleware
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 2
+        - 3
+        version: 0.2.3
+  type: :runtime
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 0
+        - 0
+        - 5
+        version: 0.0.5
+  type: :runtime
+  version_requirements: *id013
+- !ruby/object:Gem::Dependency 
+  name: multi_xml
+  prerelease: false
+  requirement: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id014
+description: A Ruby wrapper for the Open311 API v2.
+email: 
+- dan@codeforamerica.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .yardopts
+- Gemfile
+- Gemfile.lock
+- LICENSE.mkd
+- README.mkd
+- Rakefile
+- autotest/discover.rb
+- lib/faraday/multipart.rb
+- lib/faraday/raise_error.rb
+- lib/open311.rb
+- lib/open311/client.rb
+- lib/open311/client/connection.rb
+- lib/open311/client/request.rb
+- lib/open311/client/service.rb
+- lib/open311/configuration.rb
+- lib/open311/version.rb
+- open311.gemspec
+- spec/fixtures/services.xml
+- spec/open311_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/open311
+licenses: []
+
+post_install_message: |
+  Using this gem for your project or company? Add it to the apps wiki!
+  https://github.com/cfalabs/open311/wiki/apps
+
+rdoc_options: []
+
+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: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the Open311 API v2.
+test_files: 
+- spec/fixtures/services.xml
+- spec/open311_spec.rb
+- spec/spec_helper.rb