soda-ruby 0.2.15 → 0.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e08ae803c8dea78e00b08a07bc2be1cc4b87cd95
-  data.tar.gz: a9e5a9781c7fcfd40f599698128ed84063bee1d1
+  metadata.gz: 13d50e52df53fba1c46a89fab16acfc9658de473
+  data.tar.gz: 6c5fdfd23f1a7eef3b7dbd1f4043d027d12b1040
 SHA512:
-  metadata.gz: 70975c06355fbcb43a20571dc20d2c0e75ff3f197b59977bd6adaf804f8069e75dd465b311addd7691017074e41aec6474d0f07b6ad19f227bbd286719cc7498
-  data.tar.gz: ea997e8681e790a13e0b59f34e196d62367240a7c15929389e07f2536343f719d7098dcb3a535f85555b37b1e403038f729a4c1ba230f28bae0a8ec3f9bbceec
+  metadata.gz: 48d11e20e4996977d0a5026e0427e34187839cc3f844b7af033cdaeff28798cb28b957fbb298b07d967e15ecd2ef3d243a93baa60bbec3e3304a6f474ef5676a
+  data.tar.gz: 543f337c1b53104a21f4455e8bc20a0ad7c15f2be323c76eb378e887d72ef4aa5fdeafcb488699a42cda3f5c072665a8a612856e39e19e9c76df0b5436b6e428

data/lib/soda/client.rb

@@ -12,6 +12,7 @@ require 'cgi'
 require 'hashie'
 require 'sys/uname'
 require 'soda/version'
+require 'soda/exceptions'
 include Sys
 
 module SODA
@@ -34,6 +35,7 @@ module SODA
     # * +:username+ - Your Socrata username (optional, only necessary for modifying data)
     # * +:password+ - Your Socrata password (optional, only necessary for modifying data)
     # * +:app_token+ - Your Socrata application token (register at http://dev.socrata.com/register)
+    # * +:access_token+ - Your Socrata OAuth token (optional, https://dev.socrata.com/docs/authentication.html)
     # * +:ignore_ssl+ - Ignore ssl errors (defaults to false)
     #
     # Returns a SODA::Client instance.
@@ -183,7 +185,15 @@ module SODA
 
     def check_response_fail(response)
       return if %w(200 202).include? response.code
-      fail "Error in request: #{response.body}"
+
+      # Adapted from RestClient's exception handling
+      begin
+        klass = SODA::Exceptions::EXCEPTIONS_MAP.fetch(response.code.to_i)
+
+        raise klass.new(response, response.code)
+      rescue KeyError
+        raise RequestFailed.new(response, response.code)
+      end
     end
 
     def connection(method = 'Get', resource = nil, body = nil, params = {})
@@ -236,9 +246,12 @@ module SODA
     end
 
     def authenticate(request)
-      return unless @config[:username]
       # Authenticate if we're supposed to
-      request.basic_auth @config[:username], @config[:password]
+      if @config[:username]
+        request.basic_auth @config[:username], @config[:password]
+      elsif @config[:access_token]
+        request.add_field('Authorization', "OAuth #{@config[:access_token]}")
+      end
     end
 
     def add_default_headers_to_request(request)

data/lib/soda/exceptions.rb

@@ -0,0 +1,207 @@
+# Adapted (lifted) from RestClient: https://github.com/rest-client/rest-client/blob/master/lib/restclient/exceptions.rb
+module SODA
+
+  STATUSES = {100 => 'Continue',
+              101 => 'Switching Protocols',
+              102 => 'Processing', #WebDAV
+
+              200 => 'OK',
+              201 => 'Created',
+              202 => 'Accepted',
+              203 => 'Non-Authoritative Information', # http/1.1
+              204 => 'No Content',
+              205 => 'Reset Content',
+              206 => 'Partial Content',
+              207 => 'Multi-Status', #WebDAV
+
+              300 => 'Multiple Choices',
+              301 => 'Moved Permanently',
+              302 => 'Found',
+              303 => 'See Other', # http/1.1
+              304 => 'Not Modified',
+              305 => 'Use Proxy', # http/1.1
+              306 => 'Switch Proxy', # no longer used
+              307 => 'Temporary Redirect', # http/1.1
+
+              400 => 'Bad Request',
+              401 => 'Unauthorized',
+              402 => 'Payment Required',
+              403 => 'Forbidden',
+              404 => 'Not Found',
+              405 => 'Method Not Allowed',
+              406 => 'Not Acceptable',
+              407 => 'Proxy Authentication Required',
+              408 => 'Request Timeout',
+              409 => 'Conflict',
+              410 => 'Gone',
+              411 => 'Length Required',
+              412 => 'Precondition Failed',
+              413 => 'Request Entity Too Large',
+              414 => 'Request-URI Too Long',
+              415 => 'Unsupported Media Type',
+              416 => 'Requested Range Not Satisfiable',
+              417 => 'Expectation Failed',
+              418 => 'I\'m A Teapot', #RFC2324
+              421 => 'Too Many Connections From This IP',
+              422 => 'Unprocessable Entity', #WebDAV
+              423 => 'Locked', #WebDAV
+              424 => 'Failed Dependency', #WebDAV
+              425 => 'Unordered Collection', #WebDAV
+              426 => 'Upgrade Required',
+              428 => 'Precondition Required', #RFC6585
+              429 => 'Too Many Requests', #RFC6585
+              431 => 'Request Header Fields Too Large', #RFC6585
+              449 => 'Retry With', #Microsoft
+              450 => 'Blocked By Windows Parental Controls', #Microsoft
+
+              500 => 'Internal Server Error',
+              501 => 'Not Implemented',
+              502 => 'Bad Gateway',
+              503 => 'Service Unavailable',
+              504 => 'Gateway Timeout',
+              505 => 'HTTP Version Not Supported',
+              506 => 'Variant Also Negotiates',
+              507 => 'Insufficient Storage', #WebDAV
+              509 => 'Bandwidth Limit Exceeded', #Apache
+              510 => 'Not Extended',
+              511 => 'Network Authentication Required', # RFC6585
+  }
+
+  # This is the base exception class. Rescue it if you want to
+  # catch any exception that your request might raise
+  # You can get the status code by e.http_code, or see anything about the
+  # response via e.response.
+  # For example, the entire result body (which is
+  # probably an HTML error page) is e.response.
+  class Exception < RuntimeError
+    attr_accessor :response
+    attr_accessor :original_exception
+    attr_accessor :data
+    attr_writer :message
+
+    def initialize response = nil, initial_response_code = nil
+      @response = response
+      @message = nil
+      @initial_response_code = initial_response_code
+    end
+
+    def http_code
+      # return integer for compatibility
+      if @response
+        @response.code.to_i
+      else
+        @initial_response_code
+      end
+    end
+
+    def http_headers
+      @response.headers if @response
+    end
+
+    def http_body
+      @response.body if @response
+    end
+
+    def to_s
+      message
+    end
+
+    def message
+      @message || default_message
+    end
+
+    def default_message
+      self.class.name
+    end
+  end
+
+  # Compatibility
+  class ExceptionWithResponse < Exception
+  end
+
+  # The request failed with an error code not managed by the code
+  class RequestFailed < ExceptionWithResponse
+
+    def default_message
+      "HTTP status code #{http_code}"
+    end
+
+    def to_s
+      message
+    end
+  end
+
+  # Exception classes. TODO: move all exceptions into this module.
+  #
+  # We will a create an exception for each status code, see
+  # http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
+  #
+  module Exceptions
+    # Map http status codes to the corresponding exception class
+    EXCEPTIONS_MAP = {}
+  end
+
+  # Create HTTP status exception classes
+  STATUSES.each_pair do |code, message|
+    klass = Class.new(RequestFailed) do
+      send(:define_method, :default_message) {"#{http_code ? "#{http_code} " : ''}#{message}"}
+    end
+    klass_constant = const_set(message.delete(' \-\''), klass)
+    Exceptions::EXCEPTIONS_MAP[code] = klass_constant
+  end
+
+  # Backwards compatibility. "Not Found" is the actual text in the RFCs.
+  ResourceNotFound = NotFound
+
+  module Exceptions
+    # We have to split the Exceptions module like we do here because the
+    # EXCEPTIONS_MAP is under Exceptions, but we depend on
+    # SODA::RequestTimeout below.
+
+    # Base class for request timeouts.
+    #
+    # NB: Previous releases of rest-client would raise RequestTimeout both for
+    # HTTP 408 responses and for actual connection timeouts.
+    class Timeout < SODA::RequestTimeout
+      def initialize(message=nil, original_exception=nil)
+        super(nil, nil)
+        self.message = message if message
+        self.original_exception = original_exception if original_exception
+      end
+    end
+
+    # Timeout when connecting to a server. Typically wraps Net::OpenTimeout (in
+    # ruby 2.0 or greater).
+    class OpenTimeout < Timeout
+      def default_message
+        'Timed out connecting to server'
+      end
+    end
+
+    # Timeout when reading from a server. Typically wraps Net::ReadTimeout (in
+    # ruby 2.0 or greater).
+    class ReadTimeout < Timeout
+      def default_message
+        'Timed out reading data from server'
+      end
+    end
+  end
+
+
+  # The server broke the connection prior to the request completing.  Usually
+  # this means it crashed, or sometimes that your network connection was
+  # severed before it could complete.
+  class ServerBrokeConnection < Exception
+    def initialize(message = 'Server broke connection')
+      super nil, nil
+      self.message = message
+    end
+  end
+
+  class SSLCertificateNotVerified < Exception
+    def initialize(message)
+      super nil, nil
+      self.message = message
+    end
+  end
+end

data/lib/soda/version.rb

@@ -1,3 +1,3 @@
 module SODA
-  VERSION = '0.2.15'
+  VERSION = '0.2.16'
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: soda-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.15
+  version: 0.2.16
 platform: ruby
 authors:
 - Chris Metcalf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-20 00:00:00.000000000 Z
+date: 2015-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.4.2
 - !ruby/object:Gem::Dependency
   name: multipart-post
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: sys-uname
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +176,7 @@ files:
 - lib/omniauth-socrata.rb
 - lib/soda.rb
 - lib/soda/client.rb
+- lib/soda/exceptions.rb
 - lib/soda/smartupdate.rb
 - lib/soda/version.rb
 homepage: http://github.com/socrata/soda-ruby