levee 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c7914e86b72b6401588783ca7bae634b4999da7
-  data.tar.gz: d9716f4148d31fb9a37fb5d9a3891a5aad3809e5
+  metadata.gz: 7c93ba9e7e4b2dd04833b04ae1ece0d87a8fd349
+  data.tar.gz: d17711b6b67052cb693b9c34890d3da4feaa0b26
 SHA512:
-  metadata.gz: 69a2eb7d1d755284a542f40410eb49b76a4528423c653648210a89ee90a56e5f163a7c301d66c78cd1e014ee18c2b0759b1d22458b6f7b9762da863304678d88
-  data.tar.gz: 08ea0de0d98c6f98645cbe5cf67ef6112a6b3afaa7561745c36741adca7ed4456255871004722c938e692ce826b9f8e30978a2febd573111515d219511dfe7e1
+  metadata.gz: 64e427d6f9d8a2d16cd6e9168139a68e49e56e582fbb01309e5ac7ac446989a12f5c29570af79ded87eae6a1d504eb7b184ca94ece50accdcf667c1d461b17c7
+  data.tar.gz: 9d53286d208e26ff64c38d6e330cb11e7500bb13c18c989f1ab45c1b50daf4e229280335a93ff30c348c08209460d744e12dd7fc144a2c534737b9611bebcc5f

data/lib/levee/adapters/json_api.rb

@@ -0,0 +1,36 @@
+module JsonApi
+
+  def included
+    @included
+  end
+
+  def included=(v)
+    @included = v
+  end
+
+  def set_params_using_adapter(params)
+    self.params = params[:data]
+    self.included = params[:included]
+    validate_params 
+    validate_included
+  end
+
+  def validate_params
+    message =  "Params passed to a builder using :json_api adapter must be a hash with the root_node data"
+    raise message unless params.respond_to?(:fetch)
+    return true if params.is_a? Array
+    message = "Params passed to builder must not have a root node"
+    key = params.keys.first
+    raise message if key && key.to_s.camelize == object_class.to_s
+  end
+
+  def validate_included
+    message =  "Params passed to builder must be a hash"
+    raise message unless params.respond_to?(:fetch)
+    return true if params.is_a? Array
+    message = "Params passed to builder must not have a root node"
+    key = params.keys.first
+    raise message if key && key.to_s.camelize == object_class.to_s
+  end
+
+end

data/lib/levee/builder.rb

@@ -10,8 +10,7 @@ module Levee
                   :builder_options
 
     def initialize(params, options={}, &blk)
-      self.params                 = params
-      validate_params
+      set_params_using_adapter(params)
       self.errors                 = []
       self.nested_objects_to_save = []
       self.permitted_attributes   = [:id]
@@ -24,6 +23,7 @@ module Levee
       unless params.is_a? Array
         self.object = object_class.find_by(id: params[:id]) || object_class.new
       end
+      Rails.logger.debug({message: "#{self.class} building object", object: object, parmas: params })
       assign_parameters_in_transaction
     end
 
@@ -54,6 +54,10 @@ module Levee
         begin
           perform_in_transaction
         rescue => e
+          Rails.logger.warn({message: "Error caught in builder", 
+                             error: e,
+                             builder: self,
+                             params: params})
           raise_error = -> { raise e }
           rescue_errors(e) || raise_error.call
         ensure
@@ -61,15 +65,16 @@ module Levee
           raise ActiveRecord::Rollback unless errors.flatten.empty?
         end  
       end
-      Rails.logger.error "Builder Errors:"
-      Rails.logger.error errors.to_yaml
-      self.object = object.reload if errors.empty? && object.try(:persisted?)
+      Rails.logger.warn({message: "Builder Errors",
+                          errors: errors}) 
+      # self.object = object.reload if errors.empty? && object.try(:persisted?)
       errors.empty? ? object : {errors: errors, error_status: errors.first[:status]}
     end
 
     def perform_in_transaction
-      self.errors += validator.validate_params.errors if validator
+      self.errors += validator.validate_params(builder_options).errors if validator
       return false if errors.any?
+      flatten_attributes
       self.object = top_level_array || call_setter_for_each_param_key
       return true unless requires_save && !top_level_array
       before_save_callbacks.each { |callback| send(callback) }
@@ -80,6 +85,7 @@ module Levee
     end
 
     def call_setter_for_each_param_key
+      Rails.logger.info({message: "Attributes being set:", attributes: params})
       params.each do |key, value|
         send_if_key_included_in_attributes(key.to_sym, value)
       end
@@ -90,7 +96,11 @@ module Levee
       if permitted_attributes.include?(key)
         self.send(key, value)
       else
-        errors << {status: 400, message: "Unpermitted parameter key #{key}"}
+        error = {status: 400, message: "Unpermitted parameter key #{key}"}
+        errors << error
+        Rails.logger.warn({message: "Unpermitted parameter key, not listed in #{self.class} attributes",
+                           key: key,
+                           listed_attributes: permitted_attributes})
         raise ActiveRecord::Rollback
       end
     end
@@ -110,6 +120,10 @@ module Levee
       rescue => e
         if params.has_key?(method_name)
           message = "Unable to process value for :#{method_name}, no attribute writer. Be sure to override the automatic setters for all params that do not map straight to a model attribute."
+          Rails.logger.warn({message: message,
+                             missing_writer: method_name,
+                             value: args.first,
+                             error: error})
           self.errors << {status: 422, message: message}
         else
           raise e
@@ -146,7 +160,10 @@ module Levee
 
     def raise_if_validation_error(rescued_error)
       if rescued_error.is_a? ActiveRecord::RecordInvalid
-        self.errors << { status: 422, code: 'validation_error', message: object.errors.full_messages, record: rescued_error.record }
+        error = { status: 422, code: 'validation_error', message: rescued_error.message, full_messages: object.errors.full_messages, record: rescued_error.record, error: rescued_error }
+        Rails.logger.warn error
+        self.errors << error
+        Rails.warn "Transaction rolled back"
         raise ActiveRecord::Rollback
       end  
     end
@@ -154,14 +171,20 @@ module Levee
     def raise_if_argument_error(rescued_error)
       if rescued_error.is_a? ArgumentError
         message = "All methods on the builder that override attribute setters must accept one argument to catch the parameter value"
-        self.errors << { status: 500, code: 'builder_error', message: message }
+        error = { status: 500, code: 'builder_error', message: message, error: rescued_error }
+        Rails.logger.error error
+        self.errors << error
+        Rails.warn "Transaction rolled back"
         raise ArgumentError.new message
       end
     end
 
     def raise_if_unknown_attribute_error(rescued_error)
       if rescued_error.is_a? ActiveRecord::UnknownAttributeError
-        self.errors << { status: 400, code: 'unknown_attribute_error', message: rescued_error.message, record: rescued_error.record }
+        error = { status: 400, code: 'unknown_attribute_error', message: rescued_error.message, record: rescued_error.record, error: rescued_error, trace: rescued_error.backtrace }
+        Rails.logger.warn error
+        self.errors << error
+        Rails.warn "Transaction rolled back"
         raise ActiveRecord::Rollback
       end
     end
@@ -177,11 +200,13 @@ module Levee
     
     def validate_params
       message =  "Params passed to builder must be a hash or top level array"
+      # Rails.logger.error message
       raise message unless params.respond_to?(:fetch)
       return true if params.is_a? Array
       message = "Params passed to builder must not have a root node"
       key = params.keys.first
       raise message if key && key.to_s.camelize == object_class.to_s
+      Rails.logger.debug({message: "Params passed validation", builder: "self.class", params: params})
     end
 
     #used so that id setter is not called by default
@@ -226,5 +251,41 @@ module Levee
     def self._validator
       @validator
     end
+
+    def self.set_adapter(adapter)
+      adapter_module = adapter.to_s.camelize.constantize
+      self.include adapter_module
+      self.extend adapter_module
+    end
+
+    def set_params_using_adapter(params)
+      self.params = params
+      validate_params
+    end
+
+    def flatten_attributes
+     if params.is_a?(Hash)
+       self.params = flatten_hash(params)
+     elsif params.is_a?(Array)
+       self.params = flatten_array
+     end
+    end
+
+    def flatten_array
+      params.map do |p|
+        flatten_hash(p)
+      end
+    end
+
+    def flatten_hash(val)
+      if val.fetch(:attributes, nil)
+        p = val.dup
+        p[:attributes][:id] = val[:id] if val[:id]
+        p[:attributes][:type] = val[:type] if val[:type]
+        p[:attributes]
+      else
+        val
+      end   
+    end
   end
 end

data/lib/levee/validator.rb

@@ -1,13 +1,14 @@
 module Levee
   class Validator
-    attr_accessor :errors, :params
+    attr_accessor :errors, :params, :builder_options
 
     def initialize(params)
       self.errors  = []
       self.params = params
     end
 
-    def validate_params
+    def validate_params(builder_options = {})
+      @builder_options = builder_options
       validations.each { |val| send(val) }
       self
     end

data/lib/levee/version.rb

@@ -1,7 +1,7 @@
 module Levee
   extend self
 
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 
   def gem_description
     %Q(The purpose of the builder object is to create a layer of abstraction between the controller and models in a Rails application. The builder is particularly useful for receiving complex post and put requests with multiple parameters, but is lightweight enough to use for simple writes when some filtering or parameter combination validation might be useful before writing to the database. Since it wraps the entire write action to mulitple models in a single transaction, any failure in the builder will result in the entire request being rolled back.)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: levee
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Mike Martinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2015-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -70,9 +70,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- levee-0.0.2.gem
 - levee.gemspec
 - lib/levee.rb
+- lib/levee/adapters/json_api.rb
 - lib/levee/builder.rb
 - lib/levee/validator.rb
 - lib/levee/version.rb