graphiti-rb 1.0.alpha.1

data/lib/graphiti/util/relationship_payload.rb

@@ -0,0 +1,64 @@
+module Graphiti
+  module Util
+    # Helper methods for traversing the 'relationships' JSONAPI payloads
+    # @api private
+    class RelationshipPayload
+      attr_reader :resource, :payload
+
+      def self.iterate(resource:, relationships: {}, only: [], except: [])
+        instance = new(resource, relationships, only: only, except: except)
+        instance.iterate do |sideload, relationship_data, sub_relationships|
+          yield sideload, relationship_data, sub_relationships
+        end
+      end
+
+      def initialize(resource, payload, only: [], except: [])
+        @resource = resource
+        @payload  = payload
+        @only     = only
+        @except   = except
+      end
+
+      def iterate
+        payload.each_pair do |relationship_name, relationship_payload|
+          if sl = resource.class.sideload(relationship_name.to_sym)
+            if should_yield?(sl.type)
+              if relationship_payload.is_a?(Array)
+                relationship_payload.each do |rp|
+                  yield payload_for(sl, rp)
+                end
+              else
+                yield payload_for(sl, relationship_payload)
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+      def should_yield?(type)
+        (@only.length > 0 && @only.include?(type)) ||
+          (@except.length > 0 && !@except.include?(type))
+      end
+
+      def payload_for(sideload, relationship_payload)
+        if sideload.polymorphic_parent?
+          type     = relationship_payload[:meta][:jsonapi_type]
+          sideload = sideload.child_for_type(type.to_sym)
+        end
+        relationship_payload[:meta][:method] ||= :update
+
+        {
+          sideload: sideload,
+          is_polymorphic: sideload.polymorphic_child?,
+          primary_key: sideload.primary_key,
+          foreign_key: sideload.foreign_key,
+          attributes: relationship_payload[:attributes],
+          meta: relationship_payload[:meta],
+          relationships: relationship_payload[:relationships]
+        }
+      end
+    end
+  end
+end

data/lib/graphiti/util/serializer_attributes.rb

@@ -0,0 +1,97 @@
+module Graphiti
+  module Util
+    class SerializerAttribute
+      def initialize(name, attr, resource, serializer, extra)
+        @name = name
+        @attr = attr
+        @resource = resource
+        @serializer = serializer
+        @extra = extra
+      end
+
+      def apply
+        return unless readable?
+
+        if @name == :id
+          @serializer.id(&@attr[:proc]) if @attr[:proc]
+        elsif @attr[:proc]
+          @serializer.send(_method, @name, serializer_options, &proc)
+        else
+          if @serializer.attribute_blocks[@name].nil?
+            @serializer.send(_method, @name, serializer_options, &proc)
+          else
+            inner = @serializer.attribute_blocks.delete(@name)
+            wrapped = wrap_proc(inner)
+            @serializer.send(_method, @name, serializer_options, &wrapped)
+          end
+        end
+      end
+
+      private
+
+      def _method
+        extra? ? :extra_attribute : :attribute
+      end
+
+      def extra?
+        !!@extra
+      end
+
+      def readable?
+        !!@attr[:readable]
+      end
+
+      def guard
+        _method = @attr[:readable]
+        instance = @resource.new
+        -> { instance.instance_eval(&_method) }
+      end
+
+      def guard?
+        @attr[:readable] != true
+      end
+
+      def serializer_options
+        {}.tap do |opts|
+          opts[:if] = guard if guard?
+        end
+      end
+
+      def default_proc
+        _name = @name
+        _resource = @resource.new
+        ->(_) {
+          _resource.typecast(_name, @object.send(_name), :readable)
+        }
+      end
+
+      def wrap_proc(inner)
+        type_name = @attr[:type]
+        ->(serializer_instance = nil) {
+          type = Graphiti::Types[type_name]
+          type[:read][serializer_instance.instance_eval(&inner)]
+        }
+      end
+
+      def proc
+        @attr[:proc] ? wrap_proc(@attr[:proc]) : default_proc
+      end
+    end
+
+    class SerializerAttributes
+      def initialize(resource, attributes, extra = false)
+        @resource = resource
+        @serializer = resource.serializer
+        @attributes = attributes
+        @extra = extra
+      end
+
+      def apply
+        @attributes.each_pair do |name, attr|
+          SerializerAttribute
+            .new(name, attr, @resource, @serializer, @extra).apply
+        end
+      end
+    end
+  end
+end

data/lib/graphiti/util/sideload.rb

@@ -0,0 +1,33 @@
+module Graphiti
+  module Util
+    # @api private
+    class Sideload
+      # Determine the namespace for the sideload
+      #
+      # In other words, given a query like
+      # /things?include=a.b
+      #
+      # When 'a' is sideloading 'b', b's namespace is 'b'.
+      #
+      # However, consider a recursive tree structure:
+      #
+      # /things?include=children.children
+      #
+      # The first occurrance of "children" will have the namespace
+      # "children", the second will be "children.children" and so forth.
+      #
+      # This is used to match up other criteria in the query:
+      #
+      # ?filter[children.children][a]=b
+      #
+      # @api private
+      def self.namespace(a, b)
+        if a.to_s.split('.')[0] == b.to_s
+          :"#{a}.#{b}"
+        else
+          b
+        end
+      end
+    end
+  end
+end

data/lib/graphiti/util/validation_response.rb

@@ -0,0 +1,78 @@
+# We need to know two things in the response of a persistence call:
+#
+#   * The model we just tried to persist
+#   * Was the persistence successful?
+#
+# This object wraps those bits of data. The call is considered
+# unsuccessful when it adheres to the ActiveModel#errors interface,
+# and #errors is not blank. In other words, it is not successful if
+# there were validation errors.
+#
+# @attr_reader object the object we are saving
+class Graphiti::Util::ValidationResponse
+  attr_reader :object
+
+  # @param object the model instance we tried to save
+  # @param deserialized_params see Base#deserialized_params
+  def initialize(object, deserialized_params)
+    @object = object
+    @deserialized_params = deserialized_params
+  end
+
+  # Check to ensure no validation errors.
+  # @return [Boolean] did the persistence call succeed?
+  def success?
+    all_valid?(object, relationships)
+  end
+
+  # @return [Array] the object and success state
+  def to_a
+    [object, success?]
+  end
+
+  def validate!
+    unless success?
+      raise ::Graphiti::Errors::ValidationError.new(self)
+    end
+    self
+  end
+
+  private
+
+  def relationships
+    if @deserialized_params
+      @deserialized_params.relationships
+    else
+      {}
+    end
+  end
+
+  def valid_object?(object)
+    !object.respond_to?(:errors) ||
+      (object.respond_to?(:errors) && object.errors.blank?)
+  end
+
+  def all_valid?(model, deserialized_params)
+    valid = true
+    return false unless valid_object?(model)
+    deserialized_params.each_pair do |name, payload|
+      if payload.is_a?(Array)
+        related_objects = model.send(name)
+        related_objects.each do |r|
+          valid = valid_object?(r)
+
+          if valid
+            valid = all_valid?(r, deserialized_params[:relationships] || {})
+          end
+        end
+      else
+        related_object = model.send(name)
+        valid = valid_object?(related_object)
+        if valid
+          valid = all_valid?(related_object, deserialized_params[:relationships] || {})
+        end
+      end
+    end
+    valid
+  end
+end

data/lib/graphiti/version.rb

@@ -0,0 +1,3 @@
+module Graphiti
+  VERSION = "1.0.alpha.1"
+end

metadata

@@ -0,0 +1,317 @@
+--- !ruby/object:Gem::Specification
+name: graphiti-rb
+version: !ruby/object:Gem::Version
+  version: 1.0.alpha.1
+platform: ruby
+authors:
+- Lee Richmond
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jsonapi-serializable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: jsonapi_errorable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: jsonapi_spec_helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.alpha.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.alpha.1
+description: 
+email:
+- richmolj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- ".yardopts"
+- Appraisals
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/appraisal
+- bin/console
+- bin/rspec
+- bin/setup
+- gemfiles/rails_4.gemfile
+- gemfiles/rails_5.gemfile
+- graphiti.gemspec
+- lib/generators/jsonapi/resource_generator.rb
+- lib/generators/jsonapi/templates/application_resource.rb.erb
+- lib/generators/jsonapi/templates/controller.rb.erb
+- lib/generators/jsonapi/templates/create_request_spec.rb.erb
+- lib/generators/jsonapi/templates/destroy_request_spec.rb.erb
+- lib/generators/jsonapi/templates/index_request_spec.rb.erb
+- lib/generators/jsonapi/templates/resource.rb.erb
+- lib/generators/jsonapi/templates/resource_reads_spec.rb.erb
+- lib/generators/jsonapi/templates/resource_writes_spec.rb.erb
+- lib/generators/jsonapi/templates/show_request_spec.rb.erb
+- lib/generators/jsonapi/templates/update_request_spec.rb.erb
+- lib/graphiti-rb.rb
+- lib/graphiti.rb
+- lib/graphiti/adapters/abstract.rb
+- lib/graphiti/adapters/active_record.rb
+- lib/graphiti/adapters/active_record/base.rb
+- lib/graphiti/adapters/active_record/belongs_to_sideload.rb
+- lib/graphiti/adapters/active_record/has_many_sideload.rb
+- lib/graphiti/adapters/active_record/has_one_sideload.rb
+- lib/graphiti/adapters/active_record/inferrence.rb
+- lib/graphiti/adapters/active_record/many_to_many_sideload.rb
+- lib/graphiti/adapters/null.rb
+- lib/graphiti/base.rb
+- lib/graphiti/configuration.rb
+- lib/graphiti/context.rb
+- lib/graphiti/deserializer.rb
+- lib/graphiti/errors.rb
+- lib/graphiti/extensions/boolean_attribute.rb
+- lib/graphiti/extensions/extra_attribute.rb
+- lib/graphiti/extensions/temp_id.rb
+- lib/graphiti/filter_operators.rb
+- lib/graphiti/hash_renderer.rb
+- lib/graphiti/jsonapi_serializable_ext.rb
+- lib/graphiti/query.rb
+- lib/graphiti/rails.rb
+- lib/graphiti/railtie.rb
+- lib/graphiti/renderer.rb
+- lib/graphiti/resource.rb
+- lib/graphiti/resource/configuration.rb
+- lib/graphiti/resource/dsl.rb
+- lib/graphiti/resource/interface.rb
+- lib/graphiti/resource/polymorphism.rb
+- lib/graphiti/resource/sideloading.rb
+- lib/graphiti/resource_proxy.rb
+- lib/graphiti/responders.rb
+- lib/graphiti/runner.rb
+- lib/graphiti/scope.rb
+- lib/graphiti/scoping/base.rb
+- lib/graphiti/scoping/default_filter.rb
+- lib/graphiti/scoping/extra_attributes.rb
+- lib/graphiti/scoping/filter.rb
+- lib/graphiti/scoping/filterable.rb
+- lib/graphiti/scoping/paginate.rb
+- lib/graphiti/scoping/sort.rb
+- lib/graphiti/sideload.rb
+- lib/graphiti/sideload/belongs_to.rb
+- lib/graphiti/sideload/has_many.rb
+- lib/graphiti/sideload/has_one.rb
+- lib/graphiti/sideload/many_to_many.rb
+- lib/graphiti/sideload/polymorphic_belongs_to.rb
+- lib/graphiti/stats/dsl.rb
+- lib/graphiti/stats/payload.rb
+- lib/graphiti/types.rb
+- lib/graphiti/util/attribute_check.rb
+- lib/graphiti/util/field_params.rb
+- lib/graphiti/util/hash.rb
+- lib/graphiti/util/hooks.rb
+- lib/graphiti/util/include_params.rb
+- lib/graphiti/util/persistence.rb
+- lib/graphiti/util/relationship_payload.rb
+- lib/graphiti/util/serializer_attributes.rb
+- lib/graphiti/util/sideload.rb
+- lib/graphiti/util/validation_response.rb
+- lib/graphiti/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Easily build jsonapi.org-compatible APIs
+test_files: []