Sha256: 61524c3108f31d47a8ade19380fd38cdeeb9d569b1e7b57c71737d27864df6d1

Contents?: true

Size: 1.18 KB

Versions: 140

Compression:

Stored size: 1.18 KB

Contents

module Graphiti
  module Util
    # Utility class for dealing with Include Directives
    class IncludeParams
      class << self
        # Let's say the user requested these sideloads:
        #
        #   GET /posts?include=comments.author
        #
        # But our resource had this code:
        #
        #   sideload_allowlist({ index: [:comments] })
        #
        # We should drop the 'author' sideload from the request.
        #
        # Hashes become 'include directive hashes' within the library. ie
        #
        #   [:tags, { comments: :author }]
        #
        # Becomes
        #
        #   { tags: {}, comments: { author: {} } }
        #
        # @param [Hash] requested_includes the nested hash the user requested
        # @param [Hash] allowed_includes the nested hash configured via DSL
        # @return [Hash] the scrubbed hash
        def scrub(requested_includes, allowed_includes)
          {}.tap do |valid|
            requested_includes.each_pair do |key, sub_hash|
              if allowed_includes[key]
                valid[key] = scrub(sub_hash, allowed_includes[key])
              end
            end
          end
        end
      end
    end
  end
end

Version data entries

140 entries across 140 versions & 1 rubygems

Version Path
graphiti-1.2.31 lib/graphiti/util/include_params.rb
graphiti-1.2.30 lib/graphiti/util/include_params.rb
graphiti-1.2.29 lib/graphiti/util/include_params.rb
graphiti-1.2.28 lib/graphiti/util/include_params.rb
graphiti-1.2.27 lib/graphiti/util/include_params.rb
graphiti-1.2.26 lib/graphiti/util/include_params.rb
graphiti-1.2.25 lib/graphiti/util/include_params.rb
graphiti-1.2.21 lib/graphiti/util/include_params.rb
graphiti-1.2.20 lib/graphiti/util/include_params.rb
graphiti-1.2.19 lib/graphiti/util/include_params.rb
graphiti-1.2.18 lib/graphiti/util/include_params.rb
graphiti-1.2.17 lib/graphiti/util/include_params.rb
graphiti-1.2.16 lib/graphiti/util/include_params.rb
graphiti-1.2.15 lib/graphiti/util/include_params.rb
graphiti-1.2.14 lib/graphiti/util/include_params.rb
graphiti-1.2.13 lib/graphiti/util/include_params.rb
graphiti-1.2.12 lib/graphiti/util/include_params.rb
graphiti-1.2.11 lib/graphiti/util/include_params.rb
graphiti-1.2.10 lib/graphiti/util/include_params.rb
graphiti-1.2.9 lib/graphiti/util/include_params.rb