easy-jsonapi 1.0.0

data/lib/easy/jsonapi/config_manager/config.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module JSONAPI
+  class ConfigManager
+
+    # User configurations for the gem
+    class Config
+
+      attr_reader :required_document_members, :required_headers, :required_query_params,
+                  :allow_client_ids
+      
+      def initialize
+        @allow_client_ids = false
+        @default = true
+      end
+      
+      # Performancewise, configs are all initialized as a startup cost, to change them you need to
+      #   restart the server. As a result of this, the #default? is used to process a request 
+      #   faster if user-defined configs do not need to be checked when screening http requests.
+      #   Because @default is set to false upon config assignment (see #method missing in Config),
+      #   this allows the a user to potentially make the middleware screening less performant than necessary
+      #   by assigning config values to the default values, or assigning values to something not default,
+      #   and then assigning config values to the default again. If used as intended, however, this should make
+      #   the middleware screening faster.
+      # @return [TrueClass | FalseClass]
+      def default?
+        @default
+      end
+
+      private
+
+      READER_METHODS = %i[required_document_members required_headers required_query_params allow_client_ids].freeze
+
+      # Only used if implementing Item directly.
+      #   dynamically creates accessor methods for instance variables
+      #   created in the initialize
+      def method_missing(method_name, *args, &block)
+        super unless READER_METHODS.include?(method_name.to_s[..-2].to_sym)
+        instance_variable_set("@#{method_name}"[..-2].to_sym, args[0])
+        @default = false 
+      end
+
+      # Needed when using #method_missing
+      def respond_to_missing?(method_name, *args)
+        methods.include?(method_name) || super
+      end
+    end
+  end
+end

data/lib/easy/jsonapi/document.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# classes extending document: (require needed because parser requires document)
+require 'easy/jsonapi/document/resource'
+require 'easy/jsonapi/document/resource_id'
+require 'easy/jsonapi/document/error'
+require 'easy/jsonapi/document/jsonapi'
+require 'easy/jsonapi/document/links'
+require 'easy/jsonapi/document/meta'
+
+require 'easy/jsonapi/utility'
+require 'easy/jsonapi/exceptions/document_exceptions'
+
+module JSONAPI
+
+  # Contains all objects relating to a JSONAPI Document
+  class Document
+
+    attr_reader :data, :meta, :links, :included, :errors, :jsonapi
+
+    # @param document [Hash] A hash of the different possible document members
+    #   with the values being clases associated with those members
+    #   @data is either a JSONAPI::Document::Resource or a Array<JSONAPI::Document::Resource>
+    #                 or a JSONAPI::Document::ResourceId or a Array<JSONAPI::Document::ResourceId>
+    #   @meta is JSONAPI::Document::Meta
+    #   @links is JSONAPI::Document::Links
+    #   @included is an Array<JSONAPI::Document::Resource>
+    #   @errors is an Array<JSONAPI::Document::Error>
+    #   @jsonapi is JSONAPI::Document::Jsonapi
+    # @raise RuntimeError A document must be initialized with a hash of its members.
+    def initialize(document = {})
+      raise 'JSONAPI::Document parameter must be a Hash' unless document.is_a? Hash
+      @data = document[:data]
+      @meta = document[:meta]
+      @links = document[:links] # software generated?
+      @included = document[:included]
+      @errors = document[:errors]
+      @jsonapi = document[:jsonapi] # online documentation
+    end
+
+    # Represent as a string mimicing the JSONAPI format
+    def to_s
+      '{ ' \
+        "#{JSONAPI::Utility.member_to_s('data', @data, first_member: true)}" \
+        "#{JSONAPI::Utility.member_to_s('meta', @meta)}" \
+        "#{JSONAPI::Utility.member_to_s('links', @links)}" \
+        "#{JSONAPI::Utility.member_to_s('included', @included)}" \
+        "#{JSONAPI::Utility.member_to_s('errors', @errors)}" \
+        "#{JSONAPI::Utility.member_to_s('jsonapi', @jsonapi)}" \
+      ' }'
+    end
+
+    # Represent as a hash mimicing the JSONAPI format
+    def to_h
+      to_return = {}
+      JSONAPI::Utility.to_h_member(to_return, @data, :data)
+      JSONAPI::Utility.to_h_member(to_return, @meta, :meta)
+      JSONAPI::Utility.to_h_member(to_return, @links, :links)
+      JSONAPI::Utility.to_h_member(to_return, @included, :included)
+      JSONAPI::Utility.to_h_member(to_return, @errors, :errors)
+      JSONAPI::Utility.to_h_member(to_return, @jsonapi, :jsonapi)
+      to_return
+    end
+
+    # Check if the document is JSONAPI compliant
+    # @raise If the document's to_h does not comply
+    def validate
+      JSONAPI::Exceptions::DocumentExceptions.check_compliance(to_h)
+    end
+  end
+end

data/lib/easy/jsonapi/document/error.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'easy/jsonapi/name_value_pair_collection'
+require 'easy/jsonapi/document/error/error_member' # extension
+require 'easy/jsonapi/utility'
+
+module JSONAPI
+  class Document
+    # An individual errors member in a jsonapi's document top level 'errors' member array
+    class Error < JSONAPI::NameValuePairCollection
+
+      # @param err_members [Array<JSONAPI::Document::Error::ErrorMember>]
+      #   The error members that belong to this specific error.
+      def initialize(err_members = [])
+        super(err_members, item_type: JSONAPI::Document::Error::ErrorMember)
+      end
+
+      # #empyt? provided by super
+      # #include provided by super
+      
+      # Add a error to the collection using it's name
+      # @param error_mem [JSONAPI::Document::Error::ErrorMember]
+      def add(error_mem)
+        super(error_mem, &:name)
+      end
+
+      # Another way to call add
+      # @param (see #add)
+      def <<(error_mem)
+        super(error_mem, &:name)
+      end
+      
+      # #<< provided by super, but calls overriden #add
+      # #each provided from super
+      # #remove provided from super
+      # #get provided by super
+      # #keys provided by super
+      # #size provided by super
+      # #to_s provided by super
+
+      # Represent an Error as a hash
+      def to_h
+        JSONAPI::Utility.to_h_collection(self)
+      end
+
+    end
+  end
+end

data/lib/easy/jsonapi/document/error/error_member.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'easy/jsonapi/name_value_pair'
+require 'easy/jsonapi/document/error'
+
+module JSONAPI
+  class Document
+    class Error < JSONAPI::NameValuePairCollection
+
+      # An individual error member
+      class ErrorMember < JSONAPI::NameValuePair
+      end
+    end
+  end
+end

data/lib/easy/jsonapi/document/jsonapi.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'easy/jsonapi/name_value_pair_collection'
+require 'easy/jsonapi/document/jsonapi/jsonapi_member' # extension
+
+module JSONAPI
+  class Document
+    
+    # The jsonapi top level member of a JSON:API document
+    class Jsonapi < JSONAPI::NameValuePairCollection
+
+      # @param jsonapi_member_arr [Array<JSONAPI::Document::Jsonapi::JsonapiMember] The collection
+      #   of members to intialize this collection with.
+      def initialize(jsonapi_member_arr = [])
+        super(jsonapi_member_arr, item_type: JSONAPI::Document::Jsonapi::JsonapiMember)
+      end
+
+      # Add a jsonapi member to the collection
+      # @param jsonapi_member [JSONAPI::Document::Jsonapi::JsonapiMember] The member to add
+      def add(jsonapi_member)
+        super(jsonapi_member, &:name)
+      end
+
+    end
+  end
+end

data/lib/easy/jsonapi/document/jsonapi/jsonapi_member.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'easy/jsonapi/name_value_pair'
+require 'easy/jsonapi/document/jsonapi'
+
+module JSONAPI
+  class Document
+    class Jsonapi < JSONAPI::NameValuePairCollection
+
+      # An individual member in a JSON:API Meta object
+      class JsonapiMember < JSONAPI::NameValuePair
+      end
+    end
+  end
+end

data/lib/easy/jsonapi/document/links.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'easy/jsonapi/name_value_pair_collection'
+require 'easy/jsonapi/document/links/link' # extension
+require 'easy/jsonapi/utility'
+
+module JSONAPI
+  class Document
+    
+    # The links of a resource
+    class Links < JSONAPI::NameValuePairCollection
+
+      # @param link_arr [Array<JSONAPI::Document::Links::Link] The array
+      #   of links to initialize this collection with.
+      def initialize(link_arr = [])
+        super(link_arr, item_type: JSONAPI::Document::Links::Link)
+      end
+
+      # Add a jsonapi member to the collection
+      # @param link [JSONAPI::Document::Links:Link] The member to add
+      def add(link)
+        super(link, &:name)
+      end
+    end
+  end
+end
+
+# #empyt? provided by super class
+# #include provided by super class
+# #add provided by super
+# #each provided from super class
+# #remove provided from super class
+# #get provided by super class
+# #keys provided by super class
+# #size provided by super class
+# #to_s provided from super class

data/lib/easy/jsonapi/document/links/link.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'easy/jsonapi/name_value_pair'
+require 'easy/jsonapi/document/links'
+
+module JSONAPI
+  class Document
+    class Links < JSONAPI::NameValuePairCollection
+
+      # An individual attribute in a JSON:API Links object
+      class Link < JSONAPI::NameValuePair
+      end
+    end
+  end
+end

data/lib/easy/jsonapi/document/meta.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'easy/jsonapi/name_value_pair_collection'
+require 'easy/jsonapi/document/meta/meta_member' # extension
+
+module JSONAPI
+  class Document
+    
+    # The meta of a resource
+    class Meta < JSONAPI::NameValuePairCollection
+
+      # @param meta_arr [Array<JSONAPI::Document::Meta::MetaMember] The 
+      #   array of meta members to initialize the collection with
+      def initialize(meta_arr = [])
+        meta_arr = [meta_arr] unless meta_arr.is_a? Array
+        super(meta_arr, item_type: JSONAPI::Document::Meta::MetaMember)
+      end
+
+      # Add a jsonapi member to the collection
+      # @param meta_member [JSONAPI::Document::Meta::MetaMember] The member to add
+      def add(meta_member)
+        super(meta_member, &:name)
+      end
+    end
+  end
+end

data/lib/easy/jsonapi/document/meta/meta_member.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'easy/jsonapi/document/meta'
+
+module JSONAPI
+  class Document
+    class Meta < JSONAPI::NameValuePairCollection
+
+      # An individual member in a JSON:API Meta object
+      class MetaMember < JSONAPI::NameValuePair
+      end
+    end
+  end
+end

data/lib/easy/jsonapi/document/resource.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'easy/jsonapi/document/resource/attributes' # extension
+require 'easy/jsonapi/document/resource/relationships' # extension
+require 'easy/jsonapi/utility'
+
+module JSONAPI
+  class Document
+    # A jsonapi resource object
+    class Resource
+
+      attr_accessor :attributes, :relationships, :links, :meta, :type, :id
+      
+      # @param members_hash [Hash] The members to initialize a resource with
+      def initialize(members_hash)
+        unless members_hash.is_a? Hash
+          raise 'A JSONAPI::Document::Resource must be initialized with a Hash'
+        end
+        @type = members_hash[:type].to_s unless members_hash[:type].nil?
+        @id = members_hash[:id].to_s unless members_hash[:id].nil?
+        @attributes = members_hash[:attributes]
+        @relationships = members_hash[:relationships]
+        @links = members_hash[:links]
+        @meta = members_hash[:meta]
+      end
+
+      # String representation of Document that is JSON parsable
+      #   If any document memeber is nil, it does not include it
+      #   in the returned string.
+      # @return [String] The string representation of a JSONAPI Document
+      def to_s
+        '{ ' \
+          "#{JSONAPI::Utility.member_to_s('type', @type, first_member: true)}" \
+          "#{JSONAPI::Utility.member_to_s('id', @id)}" \
+          "#{JSONAPI::Utility.member_to_s('attributes', @attributes)}" \
+          "#{JSONAPI::Utility.member_to_s('relationships', @relationships)}" \
+          "#{JSONAPI::Utility.member_to_s('links', @links)}" \
+          "#{JSONAPI::Utility.member_to_s('meta', @meta)}" \
+        ' }'
+      end
+
+      # Hash representation of a jsonapi resource
+      # @return [Hash] The jsonapi representation of the resource
+      def to_h
+        to_return = {}
+        JSONAPI::Utility.to_h_member(to_return, @type, :type)
+        JSONAPI::Utility.to_h_member(to_return, @id, :id)
+        JSONAPI::Utility.to_h_member(to_return, @attributes, :attributes)
+        JSONAPI::Utility.to_h_member(to_return, @relationships, :relationships)
+        JSONAPI::Utility.to_h_member(to_return, @links, :links)
+        JSONAPI::Utility.to_h_member(to_return, @meta, :meta)
+        to_return
+      end
+    end
+  end
+end

data/lib/easy/jsonapi/document/resource/attributes.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'easy/jsonapi/name_value_pair_collection'
+require 'easy/jsonapi/document/resource/attributes/attribute'
+
+module JSONAPI
+  class Document
+    class Resource
+      # The attributes of a resource
+      class Attributes < JSONAPI::NameValuePairCollection
+  
+        # @param attr_arr [Array<JSONAPI::Document::Resource::Attributes::Attribute] 
+        #   The collection of attributes to initialize the collection with.
+        def initialize(attr_arr = [])
+          super(attr_arr, item_type: JSONAPI::Document::Resource::Attributes::Attribute)
+        end
+
+        # Add a jsonapi member to the collection
+        # @param attribute [JSONAPI::Document::Resource::Attributes::Attribute] The member to add
+        def add(attribute)
+          super(attribute, &:name)
+        end
+
+        # #empyt? provided by super
+        # #include provided by super
+        # #add provided by super
+        # #each provided from super
+        # #remove provided from super
+        # #get provided by super
+        # #keys provided by super
+        # #size provided by super
+
+        # to_s provided from super
+      end
+    end
+  end
+end

data/lib/easy/jsonapi/document/resource/attributes/attribute.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'easy/jsonapi/field'
+require 'easy/jsonapi/document/resource/attributes'
+require 'easy/jsonapi/name_value_pair'
+
+module JSONAPI
+  class Document
+    class Resource
+      class Attributes < JSONAPI::NameValuePairCollection
+
+        # An individual attribute in a JSON:API Attributes object
+        class Attribute < JSONAPI::NameValuePair
+
+          attr_reader :field
+
+          # @param name [String] The name of an attribute
+          # @param value [String] The value of an attribute
+          # @param type [Any] The type of an attribute value
+          def initialize(name, value, type: String)
+            @field = JSONAPI::Field.new(name, type: type)
+            super(name, value)
+          end
+
+        end
+      end
+    end
+  end
+end