artirix_data_models 0.8.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2359922337aa2624392a98ae869724c2a3afa640
-  data.tar.gz: ec9c7dfcc6fe58d603176940e0e0e4f39314fc41
+  metadata.gz: 713d558fd789e3af896c2621897a347ec1493f34
+  data.tar.gz: 95f5c0b37d134fb771f28442000849a9b605011c
 SHA512:
-  metadata.gz: 08cce0d7e14055cc719a79a202266becd424dc9a53689e00c45d788531bd9928f6880a597f28fd9b8c91cf780f33daab2fafefb713c83edfe421b90355046eb9
-  data.tar.gz: b68d7c20dc2741561c482917edd897abd97bb80d8bc77d0e9a9a27790a855ca3625657d38a271fa76a12dfa633ba53d0c17039e5f5f8195a4f24524dcde792e9
+  metadata.gz: 549184151747d15673c69d9798adce02d61f8afe80d850c34f33d4f14755105a0b51ce7f03bfd771c8ea3b9ea14ea4c4dd8f9022f42b18051711d90f1d02331a
+  data.tar.gz: eb5c9f12149a61af0db1218ca221da1a8816be668194e429511b4210abd4e1446967476f95534010870b477a6e176f8b1d7608502fc601ebea7d30b40c238e03

data/README.md

@@ -250,6 +250,23 @@ end
 
 ## Changes
 
+### 0.9.0
+
+- Fake Responses now can be a callable object (if it responds to `call` it will invoke it)
+- refactor in `ArtirixDataModels::DataGateway` to add more info into the exceptions
+- `ArtirixDataModels::DataGateway::Error` and subclasses have now `path`, `method`, `response_status`, `response_body` (when applicable) and also `json_response_body` method which will try to parse `response_body` as if it were json (nil if it is not present or if it is not a valid json)
+- `ArtirixDataModels::DataGateway::Error` subclasses now for specific response status: 
+-- `NotFound`
+-- `NotAcceptable` 
+-- `UnprocessableEntity`
+-- `Unauthorized`
+-- `Forbidden`
+-- `RequestTimeout`
+-- `TooManyRequests`
+-- `ServerError`
+
+note: `ParseError` will not have the `response_status`
+
 ### 0.8.3
 
 - `DataGateway` refactor, plus adding `put` and `delete` support.

data/lib/artirix_data_models/gateways/data_gateway.rb

@@ -24,13 +24,17 @@ class ArtirixDataModels::DataGateway
 
   def call(method, path, json_body: true, response_adaptor: nil, body: nil, fake: false, fake_response: nil, cache_adaptor: nil, **_ignored_options)
     if fake
-      response_body = fake_response
+      result = fake_response.respond_to?(:call) ? fake_response.call : fake_response
     elsif cache_adaptor.present?
-      response_body = cache_adaptor.call { perform(method, path, body, json_body) }
+      result = cache_adaptor.call { perform(method, path, body, json_body) }
     else
-      response_body = perform(method, path, body, json_body)
+      result = perform(method, path, body, json_body)
     end
-    parse_response(response_body, response_adaptor)
+
+    parse_response result:           result,
+                   response_adaptor: response_adaptor,
+                   method:           method,
+                   path:             path
   end
 
   private
@@ -70,17 +74,14 @@ class ArtirixDataModels::DataGateway
       end
     end
   rescue Faraday::ConnectionFailed => e
-    raise ConnectionError, "method: #{method}, path: #{path}, error: #{e}"
+    raise ConnectionError.new(path: path, method: method), "method: #{method}, path: #{path}, error: #{e}"
   end
 
   def treat_response(response, method, path)
-    if response.success?
-      response.body
-    elsif response.status.to_i == 404
-      raise NotFound, path
-    else
-      raise GatewayError, "method: #{method}, path: #{path}, status: #{response.status}, body: #{response.body}"
-    end
+    return response.body if response.success?
+
+    klass = exception_for_status(response.status)
+    raise klass.new(path: path, method: method, response_body: response.body, response_status: response.status)
   end
 
   def body_to_json(body)
@@ -92,7 +93,7 @@ class ArtirixDataModels::DataGateway
     end
   end
 
-  def parse_response(result, response_adaptor)
+  def parse_response(result:, response_adaptor:, path:, method:)
     if result.present?
       parsed_response = Oj.load result, symbol_keys: true
     else
@@ -106,7 +107,30 @@ class ArtirixDataModels::DataGateway
     end
 
   rescue Oj::ParseError => e
-    raise ParseError, "response: #{result}, #{e}"
+    raise ParseError.new(path: path, method: method, response_body: result), e.message
+  end
+
+  def exception_for_status(response_status)
+    case response_status.to_i
+    when 404
+      NotFound
+    when 406
+      NotAcceptable
+    when 422
+      UnprocessableEntity
+    when 401
+      Unauthorized
+    when 403
+      Forbidden
+    when 408
+      RequestTimeout
+    when 429
+      TooManyRequests
+    when 500
+      ServerError
+    else
+      GatewayError
+    end
   end
 
   module DefaultConnectionLoader
@@ -143,9 +167,38 @@ class ArtirixDataModels::DataGateway
   end
 
   class Error < StandardError
-  end
+    attr_reader :path, :method, :response_status, :response_body
 
-  class NotFound < Error
+    def initialize(path: nil, method: nil, response_status: nil, response_body: nil)
+      @path            = path
+      @method          = method
+      @response_status = response_status
+      @response_body   = response_body
+    end
+
+    def json_response_body
+      return nil unless response_body.present?
+
+      Oj.load response_body, symbol_keys: true
+
+    rescue Oj::Error # in case it's not json
+      nil
+    end
+
+    def to_s
+      msg = super
+      msg = nil if msg == self.class.to_s
+
+      parts = {
+        path:            path,
+        method:          method,
+        response_status: response_status,
+        response_body:   response_body,
+        message:         msg,
+      }.select { |_, v| v.present? }.map { |k, v| "#{k}: #{v.inspect}" }
+
+      "#{self.class}: #{parts.join ', '}"
+    end
   end
 
   class ParseError < Error
@@ -154,6 +207,47 @@ class ArtirixDataModels::DataGateway
   class GatewayError < Error
   end
 
+  ###########################################
+  # SPECIAL, not subclasses of GatewayError #
+  ###########################################
+
+  # 404
+  class NotFound < Error
+  end
+
+  # 406
+  class NotAcceptable < Error
+  end
+
+  # 422
+  class UnprocessableEntity < Error
+  end
+
+  ##############################
+  # subclasses of GatewayError #
+  ##############################
+
+  # 401
+  class Unauthorized < GatewayError
+  end
+
+  # 403
+  class Forbidden < GatewayError
+  end
+
+  # 408
+  class RequestTimeout < GatewayError
+  end
+
+  # 429
+  class TooManyRequests < GatewayError
+  end
+
+  # 500
+  class ServerError < GatewayError
+  end
+
+  # generic error
   class ConnectionError < GatewayError
   end
 end

data/lib/artirix_data_models/version.rb

@@ -1,3 +1,3 @@
 module ArtirixDataModels
-  VERSION = '0.8.3'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artirix_data_models
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Eduardo Turiño
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-22 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport