sp-duh 2.0.6

data/lib/sp/duh/jsonapi/exceptions.rb

@@ -0,0 +1,56 @@
+module SP
+  module Duh
+    module JSONAPI
+      module Exceptions
+
+        # JSONAPI service and configuration errors
+
+        class ServiceSetupError < SP::Duh::Exceptions::GenericError ; ; end
+        class ServiceProtocolError < SP::Duh::Exceptions::GenericDetailedError ; ; end
+        class InvalidResourceConfigurationError < SP::Duh::Exceptions::GenericDetailedError ; ; end
+        class InvalidResourcePublisherError < SP::Duh::Exceptions::GenericDetailedError ; ; end
+        class DuplicateResourceError < SP::Duh::Exceptions::GenericDetailedError ; ; end
+        class SaveConfigurationError < SP::Duh::Exceptions::GenericError ; ; end
+        class InvalidJSONAPIKeyError < SP::Duh::Exceptions::GenericDetailedError ; ; end
+
+        # JSONAPI model querying errors
+
+        class GenericModelError < SP::Duh::Exceptions::GenericError
+
+          attr_reader :id
+          attr_reader :status
+          attr_reader :result
+
+          def initialize(result, nested = $!)
+            @result = result
+            errors = get_result_errors()
+            @status = (errors.map { |error| error[:status].to_i }.max) || 403
+            message = errors.first[:detail]
+            super(message, nested)
+          end
+
+          def internal_error
+            errors = get_result_errors()
+            if errors.length != 1
+              @result.to_json
+            else
+              errors.first[:meta]['internal-error'] if errors.first[:meta]
+            end
+          end
+
+          def inspect()
+            description = super()
+            description = description + " (#{internal_error})" if internal_error
+            description
+          end
+
+          private
+
+            def get_result_errors() ; (result.is_a?(Hash) ? result : HashWithIndifferentAccess.new(JSON.parse(result)))[:errors] ; end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/sp/duh/jsonapi/model/base.rb

@@ -0,0 +1,25 @@
+require 'sp/duh/jsonapi/model/concerns/model'
+
+module SP
+  module Duh
+    module JSONAPI
+      module Model
+
+        class Base
+          include ::ActiveRecord::Validations
+          include Concerns::Model
+
+          def self.inherited(child)
+            child.resource_name = child.name.demodulize.underscore.pluralize
+            child.autogenerated_id = true
+          end
+
+          def self.i18n_scope
+            :activerecord
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/sp/duh/jsonapi/model/concerns/attributes.rb

@@ -0,0 +1,94 @@
+module SP
+  module Duh
+    module JSONAPI
+      module Model
+        module Concerns
+          module Attributes
+            extend ::ActiveSupport::Concern
+
+            included do
+            end
+
+            module ClassMethods
+
+              def attributes
+                if !@attributes && superclass.respond_to?(:attributes)
+                  @attributes = []
+                  @attributes += superclass.attributes
+                end
+                @attributes = [] if !@attributes
+                @attributes
+              end
+
+              def attr_accessible(name)
+                attributes << name if !attributes.include?(name)
+                attr_accessor name
+              end
+            end
+
+            def initialize(new_attributes = nil)
+              assign_attributes(new_attributes) if new_attributes
+              yield self if block_given?
+            end
+
+            def attributes=(new_attributes)
+              return unless new_attributes.is_a?(Hash)
+              assign_attributes(new_attributes)
+            end
+
+            private
+
+              def assign_attributes(new_attributes)
+                return if new_attributes.blank?
+
+                new_attributes = new_attributes.stringify_keys
+                nested_parameter_attributes = []
+
+                new_attributes.each do |k, v|
+                  if respond_to?("#{k}=")
+                    if v.is_a?(Hash)
+                      nested_parameter_attributes << [ k, v ]
+                    else
+                      send("#{k}=", v)
+                    end
+                  # else
+                  #   raise(ActiveRecord::UnknownAttributeError, "unknown attribute: #{k}")
+                  end
+                end
+
+                # Assign any deferred nested attributes after the base attributes have been set
+                nested_parameter_attributes.each do |k,v|
+                  send("#{k}=", v)
+                end
+              end
+
+              # Returns an <tt>#inspect</tt>-like string for the value of the
+              # attribute +attr_name+. String attributes are truncated upto 50
+              # characters, and Date and Time attributes are returned in the
+              # <tt>:db</tt> format. Other attributes return the value of
+              # <tt>#inspect</tt> without modification.
+              #
+              #   person = Person.create!(:name => "David Heinemeier Hansson " * 3)
+              #
+              #   person.attribute_for_inspect(:name)
+              #   # => '"David Heinemeier Hansson David Heinemeier Hansson D..."'
+              #
+              #   person.attribute_for_inspect(:created_at)
+              #   # => '"2009-01-12 04:48:57"'
+              def attribute_for_inspect(name)
+                value = self.send(name)
+                if value.is_a?(String) && value.length > 50
+                  "#{value[0..50]}...".inspect
+                elsif value.is_a?(Date) || value.is_a?(Time)
+                  %("#{value.to_s(:db)}")
+                else
+                  value.inspect
+                end
+              end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sp/duh/jsonapi/model/concerns/model.rb

@@ -0,0 +1,42 @@
+require 'active_support'
+require 'active_record'
+
+require 'sp/duh/jsonapi/model/concerns/attributes'
+require 'sp/duh/jsonapi/model/concerns/serialization'
+require 'sp/duh/jsonapi/model/concerns/persistence'
+
+module SP
+  module Duh
+    module JSONAPI
+      module Model
+        module Concerns
+          module Model
+            extend ::ActiveSupport::Concern
+
+            include Attributes
+            include Serialization
+            include Persistence
+
+            included do
+            end
+
+            module ClassMethods
+
+              def inspect
+                "#{super}(#{self.attributes.join(', ')})"
+              end
+            end
+
+            # Returns the contents of the record as a nicely formatted string.
+            def inspect
+              # attrs = self.class.attributes
+              inspection = self.class.attributes.collect { |name| "#{name}: #{attribute_for_inspect(name)}" }.compact.join(", ")
+              "#<#{self.class} #{inspection}>"
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sp/duh/jsonapi/model/concerns/persistence.rb

@@ -0,0 +1,221 @@
+module SP
+  module Duh
+    module JSONAPI
+      module Model
+        module Concerns
+          module Persistence
+            extend ::ActiveSupport::Concern
+
+            included do
+
+              # Idem for data adapter configuration...
+              # In a similar way to ActiveRecord::Base.connection, the adapter should be defined at the base level and is inherited by all subclasses
+              class_attribute :adapter, instance_reader: false, instance_writer: false
+
+              self.autogenerated_id = true
+
+              attr_accessible :id
+            end
+
+            module ClassMethods
+
+              # Define resource configuration accessors at the class (and subclass) level (static).
+              # These attribute values are NOT inherited by subclasses, each subclass MUST define their own.
+              # Instances can access these attributes at the class level only.
+              attr_accessor :resource_name
+              attr_accessor :autogenerated_id
+
+              def find!(id, conditions = nil) ; get(id, conditions) ; end
+
+              def find_explicit!(exp_accounting_schema, exp_accounting_prefix, id, conditions = nil)
+                get_explicit(exp_accounting_schema, exp_accounting_prefix, id, conditions)
+              end
+
+              def find(id, conditions = nil)
+                begin
+                  get(id, conditions)
+                rescue Exception => e
+                  return nil
+                end
+              end
+
+              def query!(condition) ; get_all(condition) ; end
+              def query_explicit!(exp_accounting_schema, exp_accounting_prefix, condition) ; get_all_explicit(exp_accounting_schema, exp_accounting_prefix, condition) ; end
+
+              def query(condition)
+                begin
+                  get_all(condition)
+                rescue Exception => e
+                  nil
+                end
+              end
+
+              def first!(condition = "")
+                condition += (condition.blank? ? "" : "&") + "page[size]=1"
+                get_all(condition).first
+              end
+
+              def first(condition = "")
+                begin
+                  condition += (condition.blank? ? "" : "&") + "page[size]=1"
+                  get_all(condition).first
+                rescue Exception => e
+                  nil
+                end
+              end
+
+              def all! ; get_all("") ; end
+
+              def all
+                begin
+                  get_all("")
+                rescue Exception => e
+                  nil
+                end
+              end
+
+              private
+
+                def get_explicit(exp_accounting_schema, exp_accounting_prefix, id, conditions = nil)
+                  result = self.adapter.get_explicit!(exp_accounting_schema, exp_accounting_prefix, "#{self.resource_name}/#{id.to_s}", conditions)
+                  jsonapi_result_to_instance(result[:data], result)
+                end
+
+                def get(id, conditions = nil)
+                  result = self.adapter.get("#{self.resource_name}/#{id.to_s}", conditions)
+                  jsonapi_result_to_instance(result[:data], result)
+                end
+
+                def get_all(condition)
+                  got = []
+                  result = self.adapter.get(self.resource_name, condition)
+                  if result
+                    got = result[:data].map do |item|
+                      data = { data: item }
+                      data.merge(included: result[:included]) if result[:included]
+                      jsonapi_result_to_instance(item, data)
+                    end
+                  end
+                  got
+                end
+
+                def get_all_explicit(exp_accounting_schema, exp_accounting_prefix, condition)
+                  got = []
+                  result = self.adapter.get_explicit!(exp_accounting_schema, exp_accounting_prefix, self.resource_name, condition)
+                  if result
+                    got = result[:data].map do |item|
+                      data = { data: item }
+                      data.merge(included: result[:included]) if result[:included]
+                      jsonapi_result_to_instance(item, data)
+                    end
+                  end
+                  got
+                end
+
+                def jsonapi_result_to_instance(result, data)
+                  if result
+                    instance = self.new(result.merge(result[:attributes]).except(:attributes))
+                    instance.send :_data=, data
+                  end
+                  instance
+                end
+            end
+
+            # Instance methods
+
+            def new_record?
+              if self.class.autogenerated_id || self.id.nil?
+                self.id.nil?
+              else
+                self.class.find(self.id).nil?
+              end
+            end
+
+            def save!
+              if new_record?
+                create!
+              else
+                update!
+              end
+            end
+
+            def save_explicit!(exp_accounting_schema, exp_accounting_prefix)
+              if new_record?
+                create!(exp_accounting_schema, exp_accounting_prefix)
+              else
+                update!(exp_accounting_schema, exp_accounting_prefix)
+              end
+            end
+
+            def destroy!
+              if !new_record?
+                self.class.adapter.delete(path_for_id)
+              end
+            end
+
+            def destroy_explicit!(exp_accounting_schema, exp_accounting_prefix)
+              if !new_record?
+                self.class.adapter.delete_explicit!(exp_accounting_schema, exp_accounting_prefix, path_for_id)
+              end
+            end
+
+            alias :delete! :destroy!
+
+            def create!(exp_accounting_schema = nil, exp_accounting_prefix = nil)
+              if self.class.autogenerated_id
+                params = {
+                  data: {
+                    type: self.class.resource_name,
+                    attributes: get_persistent_json.reject { |k,v| k == :id || v.nil? }
+                  }
+                }
+              else
+                params = {
+                  data: {
+                    type: self.class.resource_name,
+                    attributes: get_persistent_json.reject { |k,v| v.nil? }
+                  }
+                }
+              end
+              result = if !exp_accounting_schema.blank? || !exp_accounting_prefix.blank?
+                self.class.adapter.post_explicit!(exp_accounting_schema, exp_accounting_prefix, self.class.resource_name, params)
+              else
+                self.class.adapter.post(self.class.resource_name, params)
+              end
+              # Set the id to the newly created id
+              self.id = result[:data][:id]
+            end
+
+            def update!(exp_accounting_schema = nil, exp_accounting_prefix = nil)
+              params = {
+                data: {
+                  type: self.class.resource_name,
+                  id: self.id.to_s,
+                  attributes: get_persistent_json.reject { |k,v| k == :id }
+                }
+              }
+              result = if !exp_accounting_schema.blank? || !exp_accounting_prefix.blank?
+                self.class.adapter.patch_explicit!(exp_accounting_schema, exp_accounting_prefix, path_for_id, params)
+              else
+                self.class.adapter.patch(path_for_id, params)
+              end
+            end
+
+            def get_persistent_json
+              as_json.reject { |k| !k.in?(self.class.attributes) }
+            end
+
+            protected
+
+              attr_accessor :_data
+
+            private
+
+              def path_for_id ; "#{self.class.resource_name}/#{self.id.to_s}" ; end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sp/duh/jsonapi/model/concerns/serialization.rb

@@ -0,0 +1,59 @@
+module SP
+  module Duh
+    module JSONAPI
+      module Model
+        module Concerns
+          module Serialization
+            extend ::ActiveSupport::Concern
+
+            included do
+            end
+
+            def as_json(options = {})
+              root = ActiveRecord::Base.include_root_in_json
+              root = options[:root] if options.try(:key?, :root)
+              if root
+                root = self.class.name.underscore.gsub('/','_').to_sym
+                { root => serializable_hash(options) }
+              else
+                serializable_hash(options)
+              end
+            end
+
+            def from_json(json)
+              root = ActiveRecord::Base.include_root_in_json
+              hash = ActiveSupport::JSON.decode(json)
+              hash = hash.values.first if root
+              self.attributes = hash
+              self
+            end
+
+            private
+
+              alias :read_attribute_for_serialization :send
+
+              def serializable_hash(options = {})
+
+                attribute_names = self.class.attributes.sort
+                if only = options[:only]
+                  attribute_names &= Array.wrap(only).map(&:to_s)
+                elsif except = options[:except]
+                  attribute_names -= Array.wrap(except).map(&:to_s)
+                end
+
+                hash = {}
+                attribute_names.each { |n| hash[n] = read_attribute_for_serialization(n) }
+
+                method_names = Array.wrap(options[:methods]).select { |n| respond_to?(n) }
+                method_names.each { |n| hash[n] = send(n) }
+
+                hash
+
+              end
+
+          end
+        end
+      end
+    end
+  end
+end