RubyGems - jsonapi-resources-home - Versions diffs - 1.0.0 - Mend

jsonapi-resources-home 1.0.0

Files changed (64) hide show

checksums.yaml +7 -0
data/LICENSE +6 -0
data/README.md +251 -0
data/Rakefile +15 -0
data/app/controllers/jsonapi/resources/home/v1/resources_controller.rb +13 -0
data/app/models/jsonapi/resources/home/v1/resource.rb +110 -0
data/app/resources/jsonapi/resources/home/v1/resource_resource.rb +30 -0
data/config/routes.rb +7 -0
data/lib/jsonapi/resources/home.rb +21 -0
data/lib/jsonapi/resources/home/engine.rb +9 -0
data/lib/jsonapi/resources/home/inflector.rb +9 -0
data/lib/jsonapi/resources/home/version.rb +7 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/controllers/application_controller.rb +2 -0
data/spec/dummy/app/controllers/v1/accounts_controller.rb +5 -0
data/spec/dummy/app/controllers/v1/application_controller.rb +5 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/jobs/application_job.rb +2 -0
data/spec/dummy/app/mailers/application_mailer.rb +4 -0
data/spec/dummy/app/models/application_record.rb +3 -0
data/spec/dummy/app/resources/application_resource.rb +4 -0
data/spec/dummy/app/resources/v1/account_resource.rb +5 -0
data/spec/dummy/app/resources/v1/application_resource.rb +6 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/app/views/layouts/mailer.html.erb +13 -0
data/spec/dummy/app/views/layouts/mailer.text.erb +1 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/bin/setup +38 -0
data/spec/dummy/bin/update +29 -0
data/spec/dummy/bin/yarn +11 -0
data/spec/dummy/config.ru +5 -0
data/spec/dummy/config/application.rb +18 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/cable.yml +10 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +54 -0
data/spec/dummy/config/environments/production.rb +91 -0
data/spec/dummy/config/environments/test.rb +42 -0
data/spec/dummy/config/initializers/application_controller_renderer.rb +8 -0
data/spec/dummy/config/initializers/assets.rb +14 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/cookies_serializer.rb +5 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +4 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +33 -0
data/spec/dummy/config/puma.rb +56 -0
data/spec/dummy/config/routes.rb +9 -0
data/spec/dummy/config/secrets.yml +32 -0
data/spec/dummy/config/spring.rb +6 -0
data/spec/dummy/log/development.log +5436 -0
data/spec/dummy/public/404.html +67 -0
data/spec/dummy/public/422.html +67 -0
data/spec/dummy/public/500.html +66 -0
data/spec/dummy/public/apple-touch-icon-precomposed.png +0 -0
data/spec/dummy/public/apple-touch-icon.png +0 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/jsonapi/resources/home_test.rb +0 -0
data/spec/test_helper.rb +17 -0
metadata +283 -0

data/lib/jsonapi/resources/home.rb ADDED

@@ -0,0 +1,21 @@
+require "jsonapi-resources"
+require "array-where"
+module JSONAPI
+  module ActsAsResourceController
+    module ClassMethods
+      def home_discoverable(description: nil, location: nil)
+        instance_variable_set(:@jsonapi_resources_home, true)
+        instance_variable_set(:@jsonapi_resources_home_description, description)
+        instance_variable_set(:@jsonapi_resources_home_location, location)
+      end
+    end
+  end
+  module Resources
+    module Home
+      require_relative "home/inflector"
+      require_relative "home/engine"
+    end
+  end
+end

data/lib/jsonapi/resources/home/engine.rb ADDED

@@ -0,0 +1,9 @@
+module JSONAPI
+  module Resources
+    module Home
+      class Engine < Rails::Engine
+        isolate_namespace JSONAPI::Resources::Home
+      end
+    end
+  end
+end

data/lib/jsonapi/resources/home/inflector.rb ADDED

@@ -0,0 +1,9 @@
+module JSONAPI
+  module Resources
+    module Home
+      ActiveSupport::Inflector.inflections do |inflect|
+        inflect.acronym 'JSONAPI'
+      end
+    end
+  end
+end

data/lib/jsonapi/resources/home/version.rb ADDED

@@ -0,0 +1,7 @@
+module JSONAPI
+  module Resources
+    module Home
+      VERSION = "1.0.0"
+    end
+  end
+end

data/spec/dummy/Rakefile ADDED

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+require_relative 'config/application'
+Rails.application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb ADDED

	@@ -0,0 +1,2 @@
1	+ class ApplicationController < ActionController::API
2	+ end

data/spec/dummy/app/controllers/v1/accounts_controller.rb ADDED

@@ -0,0 +1,5 @@
+module V1
+  class AccountsController < V1::ApplicationController
+    home_discoverable description: "The accounts resource"
+  end
+end

data/spec/dummy/app/controllers/v1/application_controller.rb ADDED

@@ -0,0 +1,5 @@
+module V1
+  class ApplicationController < ::ApplicationController
+    include JSONAPI::ActsAsResourceController
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb ADDED

	@@ -0,0 +1,2 @@
1	+ module ApplicationHelper
2	+ end

data/spec/dummy/app/jobs/application_job.rb ADDED

	@@ -0,0 +1,2 @@
1	+ class ApplicationJob < ActiveJob::Base
2	+ end

data/spec/dummy/app/mailers/application_mailer.rb ADDED

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb ADDED

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/resources/application_resource.rb ADDED

@@ -0,0 +1,4 @@
+class ApplicationResource < JSONAPI::Resource
+  abstract
+end

data/spec/dummy/app/resources/v1/account_resource.rb ADDED

@@ -0,0 +1,5 @@
+module V1
+  class AccountResource < ApplicationResource
+  end
+end

data/spec/dummy/app/resources/v1/application_resource.rb ADDED

@@ -0,0 +1,6 @@
+module V1
+  class ApplicationResource < ::ApplicationResource
+    abstract
+  end
+end

data/spec/dummy/app/views/layouts/application.html.erb ADDED

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb ADDED

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb ADDED

	@@ -0,0 +1 @@
1	+ <%= yield %>

data/spec/dummy/bin/bundle ADDED

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails ADDED

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake ADDED

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup ADDED

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update ADDED

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/yarn ADDED

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+VENDOR_PATH = File.expand_path('..', __dir__)
+Dir.chdir(VENDOR_PATH) do
+  begin
+    exec "yarnpkg #{ARGV.join(" ")}"
+  rescue Errno::ENOENT
+    $stderr.puts "Yarn executable was not detected in the system."
+    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
+end

data/spec/dummy/config.ru ADDED

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+require_relative 'config/environment'
+run Rails.application

data/spec/dummy/config/application.rb ADDED

@@ -0,0 +1,18 @@
+require_relative 'boot'
+require 'rails/all'
+Bundler.require(*Rails.groups)
+require "jsonapi/resources/home"
+module Dummy
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 5.1
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+  end
+end

data/spec/dummy/config/boot.rb ADDED

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/cable.yml ADDED

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+test:
+  adapter: async
+production:
+  adapter: redis
+  url: redis://localhost:6379/1
+  channel_prefix: dummy_production

data/spec/dummy/config/database.yml ADDED

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  timeout: 5000
+development:
+  <<: *default
+  database: db/development.sqlite3
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb ADDED

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb ADDED

@@ -0,0 +1,54 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+  # Do not eager load code on boot.
+  config.eager_load = false
+  # Show full error reports.
+  config.consider_all_requests_local = true
+  # Enable/disable caching. By default caching is disabled.
+  if Rails.root.join('tmp/caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => "public, max-age=#{2.days.seconds.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+    config.cache_store = :null_store
+  end
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+  config.action_mailer.perform_caching = false
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end

data/spec/dummy/config/environments/production.rb ADDED

@@ -0,0 +1,91 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+  # Attempt to read encrypted secrets from `config/secrets.yml.enc`.
+  # Requires an encryption key in `ENV["RAILS_MASTER_KEY"]` or
+  # `config/secrets.yml.key`.
+  config.read_encrypted_secrets = true
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+  # Mount Action Cable outside main process or domain
+  # config.action_cable.mount_path = nil
+  # config.action_cable.url = 'wss://example.com/cable'
+  # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+  # Prepend all log lines with the following tags.
+  config.log_tags = [ :request_id ]
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+  # Use a real queuing backend for Active Job (and separate queues per environment)
+  # config.active_job.queue_adapter     = :resque
+  # config.active_job.queue_name_prefix = "dummy_#{Rails.env}"
+  config.action_mailer.perform_caching = false
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+  # Use a different logger for distributed setups.
+  # require 'syslog/logger'
+  # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
+  if ENV["RAILS_LOG_TO_STDOUT"].present?
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger    = ActiveSupport::TaggedLogging.new(logger)
+  end
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end