easy-jsonapi 1.0.0

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+require 'yard'
+
+task default: %i[test build document]
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.verbose = false
+end
+
+task :build do
+  system('gem build easy-jsonapi.gemspec')
+end
+
+YARD::Rake::YardocTask.new(:document) do |t|
+  t.files = ['lib/**/*.rb'] # optional
+  t.options = ['--title', "YARD #{YARD::VERSION} Documentation", '--markup=markdown'] # optional
+  t.stats_options = ['--list-undoc'] # optional
+end

data/UsingTheRequestObject.md

@@ -0,0 +1,74 @@
+<!--
+# @markup markdown
+# @title AccessingPartsOfTheRequest
+-->
+
+# Accessing Different Parts of The Request
+
+```ruby
+j_req = JSONAPI::Parser.parse(env)
+```
+
+## Quick Access Methods
+
+```ruby
+j_req.path # Gives path info
+j_req.http_method # GET, POST, PUT, etc
+j_req.host # localhost
+j_req.port # 8080
+j_req.query_string # query string
+```
+
+## Accessing the Query Params
+
+```ruby
+j_req.params # returns enumerable JSONAPI::Request::QueryParamCollection
+
+q_param = JSONAPI::Request::QueryParamCollection::QueryParam.new 'new_name' 'value'
+j_req.params.add(q_param) # add a query param to the collection
+j_req.params.get('new_name') # get param
+j_req.params.new_name # dynamically get param
+j_req.params.remove('new_name') # remove header
+j_req.params.to_h # { new_name: ['value'] }
+
+# given ?include=author,comments&filter[author]=name&sort=alpha
+j_req.params.includes # includes
+j_req.paras.filters # resource filters
+j_req.params.sorts # resource ordering
+j_req.params.page # page / offset
+j_req.params.fields # sparse fieldsets
+j_req.params.to_s # include=author,comments&filter[name]=test&new_name=new_val
+```
+
+## Accessing the Headers
+
+```ruby
+j_req.headers # returns enumerable JSONAPI::HeaderCollection
+
+h = JSONAPI::HeaderCollection::Header.new 'Content-Type', 'text/html'
+j_req.headers.add(h)
+j_req.headers.get('content-type') # retrieves header
+j_req.headers.content_type # dynamically retrieves header
+j_req.headers.remove('content-type') # remove header
+j_req.headers.to_h # { CONTENT_TYPE: 'text/html' }
+j_req.headers.to_s # (JSON compliant) { "CONTENT_TYPE": "text/html" }
+```
+
+## Accessing the Request Body
+
+```ruby
+j_req.body # returns JSONAPI::Document
+
+j_req.body.data # The JSONAPI data member
+j_req.body.meta # The JSONAPI meta member
+j_req.body.links # The JSONAPI links member
+j_req.body.included # The JSONAPI included member
+j_req.body.errors # The JSONAPI errors member
+j_req.body.jsonapi # The JSONAPI jsonapi member
+
+j_req.body.to_s # serialized JSONAPI
+j_req.body.to_h # ruby hash representation of JSONAPI 
+
+# NOTE: j_req.body.data returns a resoure or an array of resources depending on the request
+j_req.body.data # JSONAPI::Document::Resource or [JSONAPI::Document::Resource]
+```

data/UsingUserConfigurations.md

@@ -0,0 +1,95 @@
+<!--
+# @markup markdown
+# @title UserConfigurations
+-->
+
+# Configuring the Middleware
+
+## Quick Start
+
+To add custom checks to the middleware, modify a Config object and pass it to the Config Manager.
+
+The Config Manager is accessible through a block passed to the middleware upon initialization.
+
+```ruby
+use JSONAPI::Middleware do |config_manager|
+  # ...
+end
+```
+
+To add restrictions to ALL requests use default global config included with the Config Manager:
+
+```ruby
+use JSONAPI::Middleware do |config_manager|
+  config_manager.global.allow_client_ids = true
+end
+```
+
+To set up a restrictions for a specific resource type, create and configure a new Config object and add it to the Config Manager:
+
+```ruby
+use JSONAPI::Middleware do |config_manager|
+  config = JSONAPI::ConfigManager::Config.new
+  config.allow_client_ids = true
+  config_manager[:person] = config
+end
+```
+
+## Available Config Options
+
+### Document Checking Customization
+
+To specify required members in a document, create a hash in the structure of the expected JSON document, and list required members as nil. Members that are not required do not have to be listed.
+
+```ruby
+config.required_document_members = 
+  {
+    data: {
+      attributes: {
+        this_is_required: nil
+      }
+    },
+    meta: nil
+  }
+```
+
+You can go even further by adding a proc instead of nil to provide a custom way of determining whether a value (and request) is valid.
+
+```ruby
+config.required_document_members = 
+ {
+   data: {
+     attributes: {
+       this_is_required: proc { |value| ['im_allowed', 'me_too', 'also_me'].include?(value) }
+     }
+   },
+   meta: proc { |value_hash| value_hash.keys?(:count) }
+ }
+```
+
+To allow for client generated ids, set the method to true.
+
+```ruby
+  config.allow_client_ids = true
+```
+
+### Header Checking Customization
+
+Specify a list of required headers:
+
+```ruby
+  config.required_headers = %w[content-type xxx-authentication]
+```
+
+### Query Param Customization
+
+Specify a list of required query params:
+
+```ruby
+config.required_query_params =
+  {
+    fields: { people: nil },
+    include: nil,
+    custom_param: nil
+  } 
+```

data/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'easy-jsonapi'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/htmldiff

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' 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("diff-lcs", "htmldiff")

data/bin/kramdown

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'kramdown' 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("kramdown", "kramdown")

data/bin/ldiff

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' 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("diff-lcs", "ldiff")

data/bin/license_finder

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'license_finder' 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("license_finder", "license_finder")