easy-jsonapi 1.0.0

data/bin/tilt

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tilt' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tilt", "tilt")

data/bin/yard

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yard")

data/bin/yardoc

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yardoc")

data/bin/yri

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yri")

data/easy-jsonapi.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'easy-jsonapi'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Joshua DeMoss, Joe Viscomi']
+  spec.email         = ['demoss.joshua@gmail.com']
+
+  spec.summary       = 'Middleware, Parser, and Validator for JSONAPI requests and serialized resopnses'
+  spec.description   = 'Middleware to screen non-JSONAPI-compliant requests, a parser to provide Object Oriented access to requests, and a validator for validating JSONAPI Serialized responses.'
+  spec.homepage      = 'https://rubygems.org/gems/easy-jsonapi'
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.metadata["source_code_uri"] = "https://github.com/Curatess/easy-jsonapi"
+  spec.metadata["changelog_uri"] = "https://github.com/Curatess/easy-jsonapi/CHANGELOG.mg"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Dev Dependencies
+  spec.add_development_dependency 'license_finder', '~> 6.10'
+  spec.add_development_dependency 'rack', '~> 2.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.5'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rubocop', '~> 1.11'
+  spec.add_development_dependency 'solargraph', '~> 0.39'
+
+  # Dependencies
+  spec.add_dependency 'oj', '~> 3.10'
+
+  spec.license = 'MIT'
+end

data/lib/easy/jsonapi.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'easy/jsonapi/middleware'
+require 'easy/jsonapi/parser'
+require 'easy/jsonapi/response'
+
+# This module is the top level namespace for the curatess jsonapi middleware gem
+#
+# @author Joshua DeMoss
+# @see https://app.lucidchart.com/invitations/accept/e24c2cfe-78f1-4192-8e88-6dbc4454a5ea UML Class Diagram
+module JSONAPI
+end

data/lib/easy/jsonapi/collection.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module JSONAPI
+  # Models a collection of items
+  class Collection
+    include Enumerable
+
+    # Assume collection is empty not innitialized with an array of objects.
+    # @param arr_of_obj [Object] The objects to be stored
+    # for block { |item| item[:name] } 
+    # @yield [item] Determines what should be used as keys when storing objects in collection's internal hash
+    def initialize(arr_of_obj = [], item_type: Object, &block)
+      @item_type = item_type
+      @collection = {}
+
+      return unless (arr_of_obj != []) && block_given?
+
+      arr_of_obj.each do |obj|
+        add(obj, &block)
+      end
+    end
+
+    # Collection.new([
+    #   { key: 'include', value: 'authors,comments,likes' },
+    #   { key: 'lebron', value: 'james' },
+    #   { key: 'charles', value: 'barkley' },
+    #   { key: 'michael', value: 'jordan,jackson' },
+    #   { key: 'kobe', value: 'bryant' }
+    # ]
+
+    # Checks to see if the collection is empty
+    # @return [TrueClass | FalseClass]
+    def empty?
+      @collection == {}
+    end
+
+    # Does the collection's internal hash include this key?
+    # @param key [String | Symbol]  The key to search for in the hash
+    def include?(key)
+      @collection.include?(key.to_sym)
+    end
+
+    # Add an item to the collection, giving a block to indicate how the
+    #   collection should create a hash key for the item.
+    # @param item [Object]
+    def add(item, &block)
+      raise 'a block must be passed to #add indicating what should be used as a key' unless block_given?
+      raise "Cannot add an item that is not #{@item_type}" unless item.is_a? @item_type
+      insert(block.call(item), item)
+    end
+
+    # Adds an item to Collection's internal hash
+    def insert(key, item)
+      if include?(key)
+        raise 'The hash key given already has an Item associated with it. ' \
+              'Remove existing item first.'
+      end
+      set(key, item)
+    end
+
+    # Overwrites the item associated w a given key, or adds an association if no item is already associated.
+    def set(key, item)
+      raise "Cannot add an item that is not #{@item_type}" unless item.is_a? @item_type
+      @collection[key.to_sym] = item
+    end
+
+    # Yield the block given on all the items in the collection
+    def each
+      return @collection.each { |_, item| yield(item) } if block_given?
+      to_enum(:each)
+    end
+
+    # Remove an item from the collection
+    # @param (see #include)
+    # @return [Item | nil] the deleted item object if it exists
+    def remove(key)
+      return nil if @collection[key.to_sym].nil?
+      @collection.delete(key.to_sym)
+    end
+
+    # @param (see #remove)
+    # @return [Item | nil] The appropriate Item object if it exists
+    def get(key)
+      @collection[key.to_sym]
+    end
+
+    # Alias to #get
+    # @param (see #get)
+    # @param (see #get)
+    def [](key)
+      get(key)
+    end
+
+    # Alias to #set
+    # @param (see #set)
+    # @param (see #set)
+    def []=(key, item)
+      set(key, item)
+    end
+
+    # Allows the developer to treat the Collection class as a hash, retrieving all keys mapped to Items.
+    # @return [Array<Symbol>] An array of all the item keys stored in the Collection object.
+    def keys
+      @collection.keys
+    end
+
+    # @return [Integer] The number of items in the collection
+    def size
+      @collection.size
+    end
+
+    # Used to print out the Collection object with better formatting
+    # return [String] The collection object contents represented as a formatted string
+    def to_s
+      to_return = '{ '
+      is_first = true
+      @collection.each do |k, item|
+        if is_first
+          to_return += "\"#{k}\": #{item}"
+          is_first = false
+        else
+          to_return += ", \"#{k}\": #{item}"
+        end
+      end
+      to_return += ' }'
+    end
+
+    private
+
+    # Gets the Collection object whose hash key matches the method_name called
+    # @param method_name [Symbol] The name of the method called
+    # @param args If any arguments were passed to the method called
+    # @param block If a block was passed to the method called
+    def method_missing(method_name, *args, &block)
+      super unless @collection.include?(method_name)
+      get(method_name)
+    end
+
+    # Whether or not method missing should be called.
+    def respond_to_missing?(method_name, *)
+      @collection.include?(method_name) || super
+    end
+  end
+end

data/lib/easy/jsonapi/config_manager.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require 'easy/jsonapi/config_manager/config'
+
+module JSONAPI
+
+  # Manages user configuration options
+  class ConfigManager
+
+    include Enumerable
+
+    # Config Manager always has an internal global config
+    def initialize
+      @class_type = JSONAPI::ConfigManager::Config
+      @config_manager = { global: JSONAPI::ConfigManager::Config.new }
+    end
+
+    # Yield the block given on all the config in the config_manager
+    def each(&block)
+      return @config_manager.each(&block) if block_given?
+      to_enum(:each)
+    end
+
+    # Are any user configurations set?
+    def default?
+      (@config_manager.size == 1 && @config_manager[:global].default?) || all_configs_default?
+    end
+
+    # Does the config_manager's internal hash include this res_name?
+    # @param res_name [String | Symbol]  The res_name to search for in the hash
+    def include?(res_name)
+      @config_manager.include?(res_name.to_sym)
+    end
+
+    # Add an config to the config_manager
+    # @param config [Object]
+    def add(res_name, config)
+      raise "Cannot add a config that is not #{@class_type}" unless config.is_a? @class_type
+      insert(res_name, config)
+    end
+
+    # Adds an config to config_manager's internal hash
+    def insert(res_name, config)
+      if include?(res_name.to_sym)
+        raise "The resource type: #{res_name}, already has an config associated with it. " \
+              'Remove existing config first.'
+      end
+      set(res_name, config)
+    end
+
+    # Overwrites the config associated w a given res_name, or adds an association if no config is already associated.
+    def set(res_name, config)
+      raise "Cannot add a config that is not #{@class_type}" unless config.is_a? @class_type
+      @config_manager[res_name.to_sym] = config
+    end
+
+    # Alias to #set
+    # @param (see #set)
+    # @param (see #set)
+    def []=(res_name, config)
+      set(res_name, config)
+    end
+
+    # @param (see #remove)
+    # @return [JSONAPI::ConfigManager::Config | nil] The appropriate Item object if it exists
+    def get(res_name)
+      @config_manager[res_name.to_sym]
+    end
+
+    # Alias to #get
+    # @param (see #get)
+    # @param (see #get)
+    def [](res_name)
+      get(res_name)
+    end
+
+    # Remove an config from the config_manager
+    # @param (see #include)
+    # @return [JSONAPI::ConfigManager::Config | nil] the deleted config object if it exists
+    def remove(res_name)
+      if res_name.to_s == 'global'
+        raise "Cannot remove global config"
+      end
+      @config_manager.delete(res_name.to_sym)
+    end
+
+    # @return [Integer] The number of config in the config_manager
+    def size
+      configs.size
+    end
+
+    # @return [Array<Symbol>] The names of the resource types the configs belong to
+    def configs
+      c_arr = []
+      @config_manager.each_key do |res_type|
+        c = self[res_type]
+        unless c.default?
+          c_arr << res_type
+        end
+      end
+      c_arr
+    end
+
+    # Used to print out the config_manager object with better formatting
+    # return [String] The config_manager object contents represented as a formatted string
+    def to_s
+      to_return = '{ '
+      is_first = true
+      each do |k, config|
+        if is_first
+          to_return += "#{k}: #{config}"
+          is_first = false
+        else
+          to_return += ", #{k}: #{config}"
+        end
+      end
+      to_return += ' }'
+    end
+
+    private
+
+    # Gets the config_manager object whose hash res_name matches the method_name called
+    # @param method_name [Symbol] The name of the method called
+    # @param args If any arguments were passed to the method called
+    # @param block If a block was passed to the method called
+    def method_missing(method_name, *args, &block)
+      super unless @config_manager.include?(method_name)
+      get(method_name)
+    end
+
+    # Whether or not method missing should be called.
+    def respond_to_missing?(method_name, *)
+      @config_manager.include?(method_name) || super
+    end
+
+    # All of the included configs are set to default?
+    # @return [TrueClass | FalseClass]
+    def all_configs_default?
+      res = true
+      @config_manager.each_value { |c| res &= c.default? }
+      res
+    end
+  end
+end