open311 0.2.3 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91e2d7979b5e169e433be4e1cc56b25a2394c1e4
+  data.tar.gz: ec14c1ef94d7094e7ba1dc0a2f419a9a0b34857e
+SHA512:
+  metadata.gz: 12650fcbf7c2e86417735ae72a635127bd7194e60cbd644bb0b6936cd9ccfe78e6139202a3b101e8ffb6520425c30eb1468240980b8588afd3dcd094fe9eceb9
+  data.tar.gz: 39008e419f2d23b02fe20602da6eaf89f64caddd6a0e01b45124a209c7de63293e51a63b57f6ea1a7f0d1c2c39a56a33399896e1b70fea37933b3511c03dce95

data/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+## Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help improve
+this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+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 fixing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/codeforamerica/open311/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+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.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake`. If your specs fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+   by your tests, return to step 3.
+8. Add documentation for your feature or bug fix.
+9. Run `bundle exec rake verify_measurements`. If your changes are not 100%
+   documented, go back to step 8.
+10. Commit and push your changes.
+11. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/README.md

@@ -1,19 +1,19 @@
-# Open311
+# Open311 [![Build Status](https://secure.travis-ci.org/codeforamerica/open311.png)][travis]
 A Ruby wrapper for the Open311 API v2.
 
-## <a name="apps">Does your project or organization use this gem?</a>
+[travis]: http://travis-ci.org/codeforamerica/open311
+
+## Does your project or organization use this gem?
 Add it to the [apps](https://github.com/codeforamerica/open311/wiki/apps) wiki!
 
-## <a name="installation">Installation</a>
+## Installation
     gem install open311
 
-## <a name="documentation">Documentation</a>
+## Documentation
 [http://rdoc.info/gems/open311](http://rdoc.info/gems/open311)
 
-## <a name="ci">Continuous Integration</a>
-[![Build Status](https://secure.travis-ci.org/codeforamerica/open311.png)](http://travis-ci.org/codeforamerica/open311)
 
-## <a name="examples">Usage Examples</a>
+## Usage Examples
     require 'open311'
 
     # Certain methods require an API key
@@ -52,48 +52,14 @@ Add it to the [apps](https://github.com/codeforamerica/open311/wiki/apps) wiki!
     # Get multiple service requests by ids, comma separated
     Open311.service_requests({"service_request_id" => "101000119824,101000119823"})
 
-## <a name="contributing">Contributing</a>
-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](https://github.com/codeforamerica/open311/issues)
-* by reviewing patches
-
-## <a name="issues">Submitting an Issue</a>
-We use the [GitHub issue tracker](https://github.com/codeforamerica/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](https://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.
-
-## <a name="pulls">Submitting a Pull Request</a>
-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.)
-
-## <a name="rubies">Supported Rubies</a>
+## Supported Rubies
 This library aims to support and is [tested
 against](http://travis-ci.org/codeforamerica/open311) the following Ruby
 implementations:
 
-* Ruby 1.8.7
-* Ruby 1.9.2
 * Ruby 1.9.3
+* Ruby 2.0.0
+* Ruby 2.1
 * [JRuby](http://www.jruby.org/)
 * [Rubinius](http://rubini.us/)
 
@@ -111,7 +77,7 @@ implementation, you will be personally responsible for providing patches in a
 timely fashion. If critical issues for a particular implementation exist at the
 time of a major release, support for that Ruby version may be dropped.
 
-## <a name="copyright">Copyright</a>
+## Copyright
 Copyright (c) 2010 Code for America.
 See [LICENSE](https://github.com/codeforamerica/open311/blob/master/LICENSE.md) for details.
 

data/lib/open311.rb

@@ -8,7 +8,7 @@ module Open311
     # Alias for Open311::Client.new
     #
     # @return [Open311::Client]
-    def new(options={})
+    def new(options = {})
       Open311::Client.new(options)
     end
 
@@ -18,7 +18,7 @@ module Open311
       new.send(method, *args, &block)
     end
 
-    def respond_to?(method, include_private=false)
+    def respond_to?(method, include_private = false)
       new.respond_to?(method, include_private) || super(method, include_private)
     end
   end

data/lib/open311/client.rb

@@ -4,9 +4,9 @@ require 'open311/client/service'
 
 module Open311
   class Client
-    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
 
-    def initialize(options={})
+    def initialize(options = {})
       options = Open311.options.merge(options)
       Configuration::VALID_OPTIONS_KEYS.each do |key|
         send("#{key}=", options[key])

data/lib/open311/client/connection.rb

@@ -1,32 +1,30 @@
 require 'faraday_middleware'
-require 'faraday/response/raise_error'
+require 'open311/response/raise_error'
 
 module Open311
   class Client
     # @private
     module Connection
-      private
+    private
 
-      def connection(raw=false)
-        options = {
+      def options
+        {
           # :headers => {'Accept' => "*/#{format}", 'User-Agent' => user_agent},
-          :proxy => proxy,
-          :ssl => {:verify => false},
-          :url => endpoint
+          proxy: proxy,
+          ssl: {verify: false},
+          url: endpoint,
         }
+      end
 
+      def connection
         Faraday.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
+          connection.use Faraday::Response::Mashify
+          case format.to_s.downcase
+          when 'json' then connection.use Faraday::Response::ParseJson
+          when 'xml' then connection.use Faraday::Response::ParseXml
           end
-          connection.use Faraday::Response::RaiseError
+          connection.use Open311::Response::RaiseError
           connection.adapter(adapter)
         end
       end

data/lib/open311/client/request.rb

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

data/lib/open311/client/service.rb

@@ -10,8 +10,8 @@ module Open311
       # @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)
+      def service_list(options = {})
+        merge_options!(options)
         response = get('services', options)
         unpack_if_xml(response) do
           response['services']['service']
@@ -26,8 +26,8 @@ module Open311
       # @see http://wiki.open311.org/GeoReport_v2#GET_Service_Definition
       # @example define attributes associated with a service code, i.e. 033
       #   Open311.service_definition
-      def service_definition(id, options={})
-        options.merge!(:jurisdiction_id => jurisdiction)
+      def service_definition(id, options = {})
+        merge_options!(options)
         response = get("services/#{id}", options)
         unpack_if_xml(response) do
           response['service_definition']
@@ -40,11 +40,13 @@ module Open311
       # @return [Array]
       # @see http://wiki.open311.org/GeoReport_v2#GET_Service_Requests
       #   Open311.service_requests
-      def service_requests(options={})
-        options.merge!(:jurisdiction_id => jurisdiction)
-        response = get("requests", options)
+      def service_requests(options = {})
+        merge_options!(options)
+        response = get('requests', options)
         unpack_if_xml(response) do
-          response.service_requests.request.map do |request|
+          return [] unless response.service_requests.respond_to? :request
+
+          response.service_requests.request.map do |_request|
             response['service_requests']['request']
           end
         end
@@ -56,9 +58,9 @@ module Open311
       # @return Hash
       # @see http://wiki.open311.org/GeoReport_v2#POST_Service_Request
       #   Open311.post_service_request
-      def post_service_request(options={})
-        options.merge!(:jurisdiction_id => jurisdiction, :api_key => api_key)
-        response = post("requests", options)
+      def post_service_request(options = {})
+        merge_options!(options, api_key: api_key)
+        response = post('requests', options)
         unpack_if_xml(response) do
           response['service_requests']['request']
         end
@@ -71,8 +73,8 @@ module Open311
       # @return Hash
       # @see http://wiki.open311.org/GeoReport_v2#GET_Service_Requests
       #   Open311.get_service_request
-      def get_service_request(id, options={})
-        options.merge!(:jurisdiction_id => jurisdiction)
+      def get_service_request(id, options = {})
+        merge_options!(options)
         response = get("requests/#{id}", options)
         unpack_if_xml(response) do
           response['service_requests']['request']
@@ -87,14 +89,19 @@ module Open311
       # @see http://wiki.open311.org/GeoReport_v2#GET_request_id_from_a_token
       #   Open311.request_id
       def request_id_from_token(token_id, options = {})
-        options.merge!(:jurisdiction_id => jurisdiction)
+        merge_options!(options)
         response = get("tokens/#{token_id}", options)
         unpack_if_xml(response) do
           response['service_requests']['request']
         end
       end
 
-      private 
+    private
+
+      def merge_options!(options, additional_options = {})
+        options.merge!(jurisdiction_id: jurisdiction) if jurisdiction
+        options.merge!(additional_options)
+      end
 
       def unpack_if_xml(response)
         if format.to_s.downcase == 'xml'

data/lib/open311/configuration.rb

@@ -22,9 +22,9 @@ module Open311
     DEFAULT_FORMAT       = :xml
     DEFAULT_JURISDICTION = nil
     DEFAULT_PROXY        = nil
-    DEFAULT_USER_AGENT   = "Open311 Ruby Gem #{Open311::VERSION}".freeze
+    DEFAULT_USER_AGENT   = "Open311 Ruby Gem #{Open311::Version}".freeze
 
-    attr_accessor *VALID_OPTIONS_KEYS
+    attr_accessor(*VALID_OPTIONS_KEYS)
 
     def self.extended(base)
       base.reset
@@ -35,7 +35,7 @@ module Open311
     end
 
     def options
-      VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+      VALID_OPTIONS_KEYS.inject({}) { |a, e| a.merge!(e => send(e)) }
     end
 
     def reset

data/lib/open311/response/raise_error.rb

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

data/lib/open311/version.rb

@@ -1,3 +1,15 @@
 module Open311
-  VERSION = "0.2.3"
+  class Version
+    MAJOR = 0
+    MINOR = 3
+    PATCH = 0
+    PRE = nil
+
+    class << self
+      # @return [String]
+      def to_s
+        [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+      end
+    end
+  end
 end

data/open311.gemspec

@@ -1,32 +1,27 @@
-# encoding: utf-8
-require File.expand_path('../lib/open311/version', __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'open311/version'
 
-Gem::Specification.new do |gem|
-  gem.add_dependency 'faraday', '~> 0.7'
-  gem.add_dependency 'faraday_middleware', '~> 0.7'
-  gem.add_dependency 'hashie', '~> 1.2'
-  gem.add_dependency 'multi_json', '~> 1.0'
-  gem.add_dependency 'multi_xml', '~> 0.4'
-  gem.add_development_dependency 'ox'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rdiscount'
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'webmock'
-  gem.add_development_dependency 'yard'
-  gem.authors = ["Dan Melton", "Erik Michaels-Ober"]
-  gem.description = %q{A Ruby wrapper for the Open311 API v2.}
-  gem.email = ['dan@codeforamerica.org', 'erik@codeforamerica.org']
-  gem.files = `git ls-files`.split("\n")
-  gem.homepage = 'https://github.com/codeforamerica/open311'
-  gem.name = 'open311'
-  gem.post_install_message =<<eos
+Gem::Specification.new do |spec|
+  spec.add_dependency 'faraday', '~> 0.7'
+  spec.add_dependency 'faraday_middleware', '~> 0.7'
+  spec.add_dependency 'hashie', '~> 3.3'
+  spec.add_dependency 'multi_json', '~> 1.0'
+  spec.add_dependency 'multi_xml', '~> 0.4'
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.authors = ['Dan Melton', 'Erik Michaels-Ober']
+  spec.description = 'A Ruby wrapper for the Open311 API v2.'
+  spec.email = ['dan@codeforamerica.org', 'erik@codeforamerica.org']
+  spec.files = %w(.yardopts CONTRIBUTING.md LICENSE.md README.md open311.gemspec) + Dir['lib/**/*.rb']
+  spec.homepage = 'https://github.com/codeforamerica/open311'
+  spec.name = 'open311'
+  spec.post_install_message = <<eos
 Using this gem in your project or organization? Add it to the apps wiki!
 https://github.com/codeforamerica/open311/wiki/apps
 eos
-  gem.require_paths = ['lib']
-  gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
-  gem.summary = gem.description
-  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.version = Open311::VERSION
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
+  spec.summary = spec.description
+  spec.version = Open311::Version
 end