artirix_data_models 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 713d558fd789e3af896c2621897a347ec1493f34
-  data.tar.gz: 95f5c0b37d134fb771f28442000849a9b605011c
+  metadata.gz: f52a06bf80abd71040a8661490da1421091e39b7
+  data.tar.gz: 37fc26419d9f609a85a4911d80914e10d17193d8
 SHA512:
-  metadata.gz: 549184151747d15673c69d9798adce02d61f8afe80d850c34f33d4f14755105a0b51ce7f03bfd771c8ea3b9ea14ea4c4dd8f9022f42b18051711d90f1d02331a
-  data.tar.gz: eb5c9f12149a61af0db1218ca221da1a8816be668194e429511b4210abd4e1446967476f95534010870b477a6e176f8b1d7608502fc601ebea7d30b40c238e03
+  metadata.gz: 8f73b885df6a65abca53fd08529c044d08b0bdfcd11158bc36ef447dda3e9b2c70acc72a3a2cff9d39b9c16701b7fdca98b15597882535c1e98f1a232a49a23a
+  data.tar.gz: a6bbe32acdb54513ae625e60ef36b6c60276a7e46724be2af0f3e08dd20f61fedea33a09f58f2539c6449919b6f0426b951b990f8330cd405dbd6c51df7161d5

data/README.md

@@ -250,6 +250,27 @@ end
 
 ## Changes
 
+### 0.10.0
+
+- Gateways:
+-- added `gateway_factory` besides `gateway` as a creation argument for a DAO and BasicModelDAO. Now, when using a gateway in BasicModelDAO, it will use the given gateway if present, or it will call `gateway_factory.call` and use it. It won't save the result of the gateway factory, so the factory will be called every time a gateway is used.
+-- `BasicModelDAO` methods can receive a `gateway` option to be used instead of the normal gateway for the particular request. Used in `_get`, `_post`, `_put` and `_delete` methods. If no override is passed, then it will use the preloaded gateway (using either `gateway` or `gateway_factory` creation arguments, see above).
+-- `DAO` creation accepts an option `ignore_default_gateway` (`false` by default). If it is false, and no `gateway` or `gateway_factory` is passed, the gateway used will be `DAORegistry.gateway` (same as before). This allows to create DAOs without any gateway configured, making it necessary to instantiate it and pass it to `BasicModelDAO` on each request. 
+
+- Response Adaptors
+-- `DAO`'s `get_full` method now can pass to `BasicModelDAO` a `response_adaptor` option. `BasicModelDAO` will use `BasicModelDAO`'s `response_adaptor_for_reload` if no response adaptor is passed.
+-- `DAO`'s `find` and `get` methods now can pass to `BasicModelDAO` a `response_adaptor` option. `BasicModelDAO` will use `BasicModelDAO`'s `response_adaptor_for_single` if no response adaptor is passed.
+-- `DAO`'s `find` and `get_some` methods now can pass to `BasicModelDAO` a `response_adaptor` option. `BasicModelDAO` will use `BasicModelDAO`'s `response_adaptor_for_some` if no response adaptor is passed.
+
+- `DAO`s now delegate `model_adaptor_factory` to `BasicModelDAO`
+- created `IllegalActionError` error class inside of `ArtirixDataModels` module
+
+- `ArtirixDataModels::Model` with another module `WithoutDefaultAttributes`, same as `CompleteModel` but without default attributes.
+
+- `ArtirixDataModels::DataGateway::Error` subclass now for status `409`: `Conflict`
+
+- in `ArtirixDataModels::DataGateway`, methods `treat_response` and `exception_for_status` are now static. They can still be used in an instance level (it delegates to class methods)
+
 ### 0.9.0
 
 - Fake Responses now can be a callable object (if it responds to `call` it will invoke it)

data/lib/artirix_data_models/dao.rb

@@ -17,6 +17,7 @@ module ArtirixDataModels
       :forced_fake_disabled?,
       :empty_collection,
       :empty_collection_for,
+      :model_adaptor_factory
     ]
 
     included do
@@ -25,13 +26,21 @@ module ArtirixDataModels
     end
 
 
-    def initialize(gateway: nil, model_name: nil, model_class: nil, paths_factory: nil, fake_mode_factory: nil)
-      model_class       = model_class || default_model_class
-      gateway           = gateway || ArtirixDataModels::DAORegistry.gateway
-      model_name        = model_name || default_model_name
-      paths_factory     = paths_factory || default_path_factory
-      fake_mode_factory = fake_mode_factory || default_fake_mode_factory
-      @basic_model_dao  = ArtirixDataModels::DAORegistry.basic_class.new model_name, model_class, paths_factory, gateway, fake_mode_factory
+    def initialize(gateway: nil, gateway_factory: nil, ignore_default_gateway: false, model_name: nil, model_class: nil, paths_factory: nil, fake_mode_factory: nil)
+      if gateway.blank? && gateway_factory.blank? && !ignore_default_gateway
+        gateway = ArtirixDataModels::DAORegistry.gateway
+      end
+
+      model_name        ||= default_model_name
+      model_class       ||= default_model_class
+      paths_factory     ||= default_path_factory
+      fake_mode_factory ||= default_fake_mode_factory
+      @basic_model_dao  = ArtirixDataModels::DAORegistry.basic_class.new model_name:        model_name,
+                                                                         model_class:       model_class,
+                                                                         fake_mode_factory: fake_mode_factory,
+                                                                         paths_factory:     paths_factory,
+                                                                         gateway:           gateway,
+                                                                         gateway_factory:   gateway_factory
     end
 
     def default_model_name
@@ -75,7 +84,7 @@ module ArtirixDataModels
 
     def get_full(model_pk, model_to_reload: nil, cache_adaptor: nil, **extra_options)
       model_to_reload ||= new_model_with_pk(model_pk)
-      cache_adaptor  ||= cache_model_adaptor_for_get_full(model_pk, model_to_reload: model_to_reload, **extra_options)
+      cache_adaptor   ||= cache_model_adaptor_for_get_full(model_pk, model_to_reload: model_to_reload, **extra_options)
       basic_model_dao.get_full(model_pk, model_to_reload: model_to_reload, cache_adaptor: cache_adaptor, **extra_options)
     end
 

data/lib/artirix_data_models/daos/basic_model_dao.rb

@@ -1,14 +1,21 @@
 class ArtirixDataModels::BasicModelDAO
-  attr_reader :model_name, :model_class, :paths_factory, :gateway, :fake_mode_factory
+  attr_reader :model_name, :model_class, :paths_factory, :fake_mode_factory, :gateway_factory, :loaded_gateway
 
-  def initialize(model_name, model_class, paths_factory, gateway, fake_mode_factory)
+  def initialize(model_name:, model_class:, paths_factory:, gateway:, fake_mode_factory:, gateway_factory:)
     @model_name        = model_name
     @model_class       = model_class
     @paths_factory     = paths_factory
-    @gateway           = gateway
+    @loaded_gateway    = gateway
+    @gateway_factory   = gateway_factory
     @fake_mode_factory = fake_mode_factory
   end
 
+  def preloaded_gateway
+    loaded_gateway.presence || gateway_factory.call
+  end
+
+  alias_method :gateway, :preloaded_gateway
+
   def partial_mode_fields
     if fake?
       fake_mode_factory.partial_mode_fields
@@ -17,11 +24,11 @@ class ArtirixDataModels::BasicModelDAO
     end
   end
 
-  def get_full(model_pk, model_to_reload:, cache_adaptor: nil, **extra_options)
-    path    = paths_factory.get_full model_pk
-    adaptor = response_adaptor_for_reload(model_to_reload)
+  def get_full(model_pk, model_to_reload:, response_adaptor: nil, cache_adaptor: nil, **extra_options)
+    path             = paths_factory.get_full model_pk
+    response_adaptor ||= response_adaptor_for_reload(model_to_reload)
 
-    _get path, response_adaptor: adaptor, fake_response: fake_get_full_response(model_pk, model_to_reload), cache_adaptor: cache_adaptor, **extra_options
+    _get path, response_adaptor: response_adaptor, fake_response: fake_get_full_response(model_pk, model_to_reload), cache_adaptor: cache_adaptor, **extra_options
 
     model_to_reload.mark_full_mode
     model_to_reload
@@ -33,18 +40,18 @@ class ArtirixDataModels::BasicModelDAO
     nil
   end
 
-  def find(model_pk, cache_adaptor: nil, **extra_options)
-    path    = paths_factory.get model_pk
-    adaptor = response_adaptor_for_single
+  def find(model_pk, cache_adaptor: nil, response_adaptor: nil, **extra_options)
+    path             = paths_factory.get model_pk
+    response_adaptor ||= response_adaptor_for_single
 
-    _get(path, response_adaptor: adaptor, fake_response: fake_get_response(model_pk), cache_adaptor: cache_adaptor, **extra_options)
+    _get(path, response_adaptor: response_adaptor, fake_response: fake_get_response(model_pk), cache_adaptor: cache_adaptor, **extra_options)
   end
 
-  def get_some(model_pks, cache_adaptor: nil, **extra_options)
-    path    = paths_factory.get_some(model_pks)
-    adaptor = response_adaptor_for_some
+  def get_some(model_pks, cache_adaptor: nil, response_adaptor: nil, **extra_options)
+    path             = paths_factory.get_some(model_pks)
+    response_adaptor ||= response_adaptor_for_some
 
-    _get(path, response_adaptor: adaptor, fake_response: fake_get_some_response(model_pks), cache_adaptor: cache_adaptor, **extra_options)
+    _get(path, response_adaptor: response_adaptor, fake_response: fake_get_some_response(model_pks), cache_adaptor: cache_adaptor, **extra_options)
   rescue ArtirixDataModels::DataGateway::NotFound
     []
   end
@@ -116,20 +123,28 @@ class ArtirixDataModels::BasicModelDAO
     ArtirixDataModels::GatewayResponseAdaptors::ModelAdaptor
   end
 
-  def _get(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil)
-    gateway.get path, response_adaptor: response_adaptor, body: body, fake: fake?, fake_response: fake_response, cache_adaptor: cache_adaptor
+  def _get(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, gateway: nil)
+    g = gateway.presence || preloaded_gateway
+    raise_no_gateway unless g.present?
+    g.get path, response_adaptor: response_adaptor, body: body, fake: fake?, fake_response: fake_response, cache_adaptor: cache_adaptor
   end
 
-  def _post(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil)
-    gateway.post path, response_adaptor: response_adaptor, body: body, fake: fake?, fake_response: fake_response, cache_adaptor: cache_adaptor
+  def _post(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, gateway: nil)
+    g = gateway.presence || preloaded_gateway
+    raise_no_gateway unless g.present?
+    g.post path, response_adaptor: response_adaptor, body: body, fake: fake?, fake_response: fake_response, cache_adaptor: cache_adaptor
   end
 
-  def _put(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil)
-    gateway.put path, response_adaptor: response_adaptor, body: body, fake: fake?, fake_response: fake_response, cache_adaptor: cache_adaptor
+  def _put(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, gateway: nil)
+    g = gateway.presence || preloaded_gateway
+    raise_no_gateway unless g.present?
+    g.put path, response_adaptor: response_adaptor, body: body, fake: fake?, fake_response: fake_response, cache_adaptor: cache_adaptor
   end
 
-  def _delete(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil)
-    gateway.delete path, response_adaptor: response_adaptor, body: body, fake: fake?, fake_response: fake_response, cache_adaptor: cache_adaptor
+  def _delete(path, response_adaptor: nil, body: nil, fake_response: nil, cache_adaptor: nil, gateway: nil)
+    g = gateway.presence || preloaded_gateway
+    raise_no_gateway unless g.present?
+    g.delete path, response_adaptor: response_adaptor, body: body, fake: fake?, fake_response: fake_response, cache_adaptor: cache_adaptor
   end
 
   def fake?
@@ -137,4 +152,19 @@ class ArtirixDataModels::BasicModelDAO
     return false if forced_fake_disabled?
     fake_mode_factory.enabled?
   end
+
+  def raise_no_gateway
+    msg = 'no gateway passed to request, no gateway configured on creation'
+    if gateway_factory.present?
+      msg = "#{msg}, and no gateway returned by the factory"
+    else
+      msg = "#{msg}, and no gateway factory configured on creation"
+    end
+
+    raise NoGatewayConfiguredError, msg
+  end
+
+  class NoGatewayConfiguredError < StandardError
+  end
+
 end

data/lib/artirix_data_models/gateways/data_gateway.rb

@@ -77,13 +77,6 @@ class ArtirixDataModels::DataGateway
     raise ConnectionError.new(path: path, method: method), "method: #{method}, path: #{path}, error: #{e}"
   end
 
-  def treat_response(response, method, path)
-    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)
     case body
     when String
@@ -110,7 +103,26 @@ class ArtirixDataModels::DataGateway
     raise ParseError.new(path: path, method: method, response_body: result), e.message
   end
 
+  #######################
+  # EXCEPTION TREATMENT #
+  #######################
+
+  def treat_response(response, method, path)
+    self.class.treat_response(response, method, path)
+  end
+
   def exception_for_status(response_status)
+    self.class.exception_for_status(response_status)
+  end
+
+  def self.treat_response(response, method, path)
+    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 self.exception_for_status(response_status)
     case response_status.to_i
     when 404
       NotFound
@@ -118,6 +130,8 @@ class ArtirixDataModels::DataGateway
       NotAcceptable
     when 422
       UnprocessableEntity
+    when 409
+      Conflict
     when 401
       Unauthorized
     when 403
@@ -223,6 +237,10 @@ class ArtirixDataModels::DataGateway
   class UnprocessableEntity < Error
   end
 
+  # 409
+  class Conflict < Error
+  end
+
   ##############################
   # subclasses of GatewayError #
   ##############################

data/lib/artirix_data_models/model.rb

@@ -25,6 +25,19 @@ module ArtirixDataModels
       end
     end
 
+    module WithoutDefaultAttributes
+      extend ActiveSupport::Concern
+
+      included do
+        include ActiveModelCompliant
+        include Attributes
+        include PrimaryKey
+        include WithDAO
+        include CacheKey
+        include PartialMode
+      end
+    end
+
     module CompleteModel
       extend ActiveSupport::Concern
 

data/lib/artirix_data_models/version.rb

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

data/lib/artirix_data_models.rb

@@ -128,4 +128,7 @@ module ArtirixDataModels
     @disabled_cache ||= DisabledCache.new
   end
 
+  class IllegalActionError < StandardError
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artirix_data_models
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Eduardo Turiño
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-29 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -304,7 +304,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Data Models (read only model) and Data Layer connection lib