reso_transport 1.5.7 → 1.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49293478c0827ccb4bdca1bb6c9974900f8c0c16853b247487120a0ed3bb79df
-  data.tar.gz: c9d8c93979377ed18d22a179bae44175961b44e8641eb091930f99542d1e610f
+  metadata.gz: 91e46c54493b29b1afd7cf10e4193209a6f91692494f5d5f9b35c48e176f0e50
+  data.tar.gz: 5778db15cafacd613b1262c88434c4f484e508da600d62d7ef960ea3a4e6e1c5
 SHA512:
-  metadata.gz: 4464fe0a9aa0006f25c5eab29dab8422401ac2ebf435b712e65d5727e43606bb0df4fdf895e5a1d6a1e3e44d4937d19c42389577d28568351832ccae64d55ebb
-  data.tar.gz: 729d643455ddd8e7a827ddc6aea2a8512f93bc65a3e469993da5d2cd5085ecdc5eed4befee4f376cd9986f51a81d363fdeb042a1f8f51e2e51d7230f265c2d7a
+  metadata.gz: 140b63e766d92ec632abf864803dd7a6beffde76069b5f9cec4b7f37f0c659b437a15b3b47bbde9692cf84070276e5d189520fbb45c35c7edc8af7396ed86ff6
+  data.tar.gz: 17525cbd4fb045a43b5c14082fd076f7798ff7d3abede002e36efecb85a526d5ab4b245d77c2cd08dc191942b7cf0b572979339c51bdda518061c209f889155a

data/README.md

@@ -278,6 +278,19 @@ When querying for an enumeration value, you can provide either the system name,
   #=> {"$top"=>1, "$filter"=>"StandardStatus eq 'ActiveUnderContract'"}
 ```
 
+### Troubleshooting
+
+In the event there are connection issues, the following errors are raised:
+
+* `ResoTransport::NoResponse` - The server did not respond to the request
+* `ResoTransport::RequestError` - The server responded with a status code outside the 200 range
+* `ResoTransport::ResponseError` - The server responded with errors in the body
+* `ResoTransport::AccessDenied` - Check your authentication details
+* `ResoTransport::LocalizationRequired` - Provide one of the required localizations through the `localization` method
+* `ResoTransport::EncodeError` - No match was found for one or more of the properties
+
+The Faraday Request hash is attached to the error for `NoResponse`, `RequestError`, `ResponseError`, and `AccessDenied`.  A Faraday Response is attached on `RequestError`, `ResponseError`, and `AccessDenied`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/reso_transport.rb

@@ -21,13 +21,11 @@ require 'reso_transport/entity_type'
 require 'reso_transport/enum'
 require 'reso_transport/property'
 require 'reso_transport/query'
+require 'reso_transport/errors'
 
 Faraday::Utils.default_space_encoding = '%20'
 
 module ResoTransport
-  class Error < StandardError; end
-
-  class AccessDenied < StandardError; end
   ODATA_TIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'.freeze
 
   class << self

data/lib/reso_transport/authentication/fetch_token_auth.rb

@@ -19,6 +19,7 @@ module ResoTransport
         @endpoint      = options.fetch(:endpoint)
         @username      = options.fetch(:username, nil)
         @password      = options.fetch(:password, nil)
+        @request       = nil
       end
 
       def connection
@@ -31,13 +32,10 @@ module ResoTransport
       end
 
       def authenticate
-        response = connection.post nil, auth_params
+        response = connection.post(nil, auth_params { |req| @request = req })
         json = JSON.parse response.body
 
-        unless response.success?
-          message = "#{response.reason_phrase}: #{json['error'] || response.body}"
-          raise ResoTransport::AccessDenied, response: response, message: message
-        end
+        raise AccessDenied.new(request, response, 'token') unless response.success?
 
         Access.new({
           access_token: json.fetch('access_token'),
@@ -46,6 +44,12 @@ module ResoTransport
         })
       end
 
+      def request
+        return @request.to_h if @request.respond_to? :to_h
+
+        {}
+      end
+
       private
 
       def auth_params

data/lib/reso_transport/authentication/middleware.rb

@@ -18,10 +18,11 @@ module ResoTransport
           authorize_request(request_env)
 
           @app.call(request_env).on_complete do |response_env|
-            raise_if_unauthorized(response_env)
+            raise_if_unauthorized(request_env, response_env)
           end
         rescue ResoTransport::AccessDenied
-          raise if retries == 0
+          raise if retries.zero?
+
           @auth.reset
           retries -= 1
           retry
@@ -38,8 +39,8 @@ module ResoTransport
         )
       end
 
-      def raise_if_unauthorized(response_env)
-        raise ResoTransport::AccessDenied if response_env[:status] == 401
+      def raise_if_unauthorized(request_env, response_env)
+        raise ResoTransport::AccessDenied.new(request_env.to_h, response_env) if response_env[:status] == 401
       end
     end
   end

data/lib/reso_transport/base_metadata.rb

@@ -46,16 +46,19 @@ module ResoTransport
     end
 
     def raw
-      if response.success?
-        response.body
-      else
-        puts response.body
-        raise "Error getting #{classname}!"
-      end
+      return response.body if response.success?
+
+      raise RequestError.new(request, response, classname)
     end
 
     def response
       raise 'Must implement response method'
     end
+
+    def request
+      return @request.to_h if @request.respond_to? :to_h
+
+      {}
+    end
   end
 end

data/lib/reso_transport/datasystem.rb

@@ -16,7 +16,10 @@ module ResoTransport
     def response
       @response ||= client.connection.get('DataSystem') do |req|
         req.headers['Accept'] = 'application/json'
+        @request = req
       end
+    rescue Faraday::ConnectionFailed
+      raise NoResponse.new(request, nil, 'DataSystem')
     end
   end
 end

data/lib/reso_transport/errors.rb

@@ -0,0 +1,69 @@
+module ResoTransport
+  class ResourceError < StandardError
+    attr_reader :resource
+
+    def initialize(resource)
+      @resource = resource
+      super message
+    end
+
+    def resource_name
+      return resource.name if resource.respond_to?(:name)
+
+      resource || 'unknown'
+    end
+
+    def message
+      "Request error for #{resource_name}"
+    end
+  end
+
+  class EncodeError < ResourceError
+    def initialize(resource, property)
+      @property = property
+      super resource
+    end
+
+    def message
+      "Property #{@property} not found for #{resource_name}"
+    end
+  end
+
+  class LocalizationRequired < ResourceError
+    def message
+      "Localization required for #{resource_name}"
+    end
+  end
+
+  class RequestError < ResourceError
+    attr_reader :request, :response
+
+    def initialize(request, response, resource = nil)
+      @response = response.respond_to?(:to_hash) ? response.to_hash : response
+      @request = request
+      super resource
+    end
+
+    def message
+      "Received #{response[:status]} for #{resource_name}"
+    end
+  end
+
+  class NoResponse < RequestError
+    def message
+      "No response for #{resource_name}"
+    end
+  end
+
+  class ResponseError < RequestError
+    def message
+      "Request succeeded for #{resource_name} with response errors"
+    end
+  end
+
+  class AccessDenied < RequestError
+    def message
+      "Access denied: #{response.reason_phrase}"
+    end
+  end
+end

data/lib/reso_transport/metadata.rb

@@ -23,7 +23,10 @@ module ResoTransport
     def response
       @response ||= client.connection.get('$metadata') do |req|
         req.headers['Accept'] = MIME_TYPES[client.vendor.fetch(:metadata_format, :xml).to_sym]
+        @request = req
       end
+    rescue Faraday::ConnectionFailed
+      raise NoResponse.new(request, nil, '$metadata')
     end
   end
 end

data/lib/reso_transport/query.rb

@@ -58,41 +58,31 @@ module ResoTransport
     end
 
     def count
-      p compile_params
       limit(1).include_count
-      resp = resource.get(compile_params)
-      parsed_body = JSON.parse(resp.body)
-      parsed_body.fetch('@odata.count', 0)
+      parsed = handle_response response
+      parsed.fetch('@odata.count', 0)
     end
 
     def results
-      resp = execute
+      parsed = handle_response response
 
-      if resp[:success]
-        resp[:results]
-      else
-        puts resp[:meta]
-        raise 'Request Failed'
-      end
+      results = Array(parsed.delete('value'))
+      resource.parse(results)
     end
 
-    def execute
-      resp = resource.get(compile_params)
-      if resp.success?
-        parsed_body = JSON.parse(resp.body)
-        results = Array(parsed_body.delete('value'))
-
-        {
-          success: resp.success? && !parsed_body.key?('error'),
-          meta: parsed_body,
-          results: resource.parse(results)
-        }
-      else
-        {
-          success: false,
-          meta: resp.body
-        }
-      end
+    def response
+      resource.get(compile_params)
+    rescue Faraday::ConnectionFailed
+      raise NoResponse.new(resource.request, nil, resource)
+    end
+
+    def handle_response(response)
+      raise RequestError.new(resource.request, response, resource) unless response.success?
+
+      parsed = JSON.parse(response.body)
+      raise ResponseError.new(resource.request, response, resource) if parsed.key?('error')
+
+      parsed
     end
 
     def new_query_context(context)
@@ -149,7 +139,7 @@ module ResoTransport
 
     def encode_value(key, val)
       field = resource.property(key.to_s)
-      raise "Couldn't find property #{key} for #{resource.name}" if field.nil?
+      raise EncodeError.new(resource, key) if field.nil?
 
       field.encode(val)
     end

data/lib/reso_transport/resource.rb

@@ -39,13 +39,14 @@ module ResoTransport
     def get(params)
       client.connection.get(url, params) do |req|
         req.headers['Accept'] = 'application/json'
+        @request = req
       end
     end
 
     def url
       return local['ResourcePath'].gsub(%r{^/}, '') if local
 
-      raise 'Localization required' if localizations.any? && local.nil?
+      raise LocalizationRequired, self if localizations.any? && local.nil?
 
       return "#{name}/replication" if client.use_replication_endpoint
 
@@ -64,5 +65,11 @@ module ResoTransport
     def inspect
       to_s
     end
+
+    def request
+      return @request.to_h if @request.respond_to? :to_h
+
+      {}
+    end
   end
 end

data/lib/reso_transport/version.rb

@@ -1,3 +1,3 @@
 module ResoTransport
-  VERSION = '1.5.7'.freeze
+  VERSION = '1.5.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reso_transport
 version: !ruby/object:Gem::Version
-  version: 1.5.7
+  version: 1.5.8
 platform: ruby
 authors:
 - Jon Druse
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-18 00:00:00.000000000 Z
+date: 2021-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -144,6 +144,7 @@ files:
 - lib/reso_transport/entity_set.rb
 - lib/reso_transport/entity_type.rb
 - lib/reso_transport/enum.rb
+- lib/reso_transport/errors.rb
 - lib/reso_transport/metadata.rb
 - lib/reso_transport/metadata_cache.rb
 - lib/reso_transport/metadata_parser.rb