ycloudyusa / yusaopeny_gated_content
Y USA Open Y Virtual Y Content
Installs: 15 599
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 1
Forks: 28
Open Issues: 5
Type:drupal-module
Requires
- ext-json: *
- ext-zlib: *
- cboden/ratchet: ^0.4.4
- drupal/csv_serialization: ^2.0 || ^3.0
- drupal/date_recur: ^2.0 || ^3.0
- drupal/date_recur_modular: ^2.0 || ^3.0
- drupal/jsonapi_image_styles: ^2.0.0 || ^3.0
- drupal/recurring_events: ^2.0@RC || ^2.0
- drupal/simple_recaptcha: ^1.0
- drupal/state_machine: ^1.4
- drupal/views_data_export: ^1.0
- ycloudyusa/yusaopeny: *
- ymcatwincities/daxko_sso: *
- dev-master
- dev-main
- 1.9.2
- 1.9.1
- 1.9.0
- 1.8.22
- 1.8.21
- 1.8.20
- 1.8.19
- 1.8.18
- 1.8.17
- 1.8.16
- 1.8.15
- 1.8.14
- 1.8.13
- 1.8.12
- 1.8.11
- 1.8.10
- 1.8.9
- 1.8.8
- 1.8.7
- 1.8.6
- 1.8.5
- 1.8.4
- 1.8.3
- 1.8.2
- 1.8.1
- 1.8.0
- 1.7.3
- 1.7.2
- 1.7.1
- 1.7.0
- 1.6.14
- 1.6.13
- 1.6.12
- 1.6.11
- 1.6.10
- 1.6.9
- 1.6.8
- 1.6.7
- 1.6.6
- 1.6.5
- 1.6.4
- 1.6.3
- 1.6.2
- 1.6.1
- 1.6
- 1.5.2
- 1.5.1
- 1.5
- 1.4.1
- 1.4
- 1.3
- 1.2.4
- 1.2.3
- 1.2.2
- 1.2.1
- 1.2
- 1.1.3
- 1.1.2
- 1.1.1
- 1.1
- 1.0.1
- 1.0
- 0.16
- 0.15
- 0.14
- 0.13
- 0.12
- 0.11
- 0.10
- 0.9
- 0.7
- 0.6
- 0.5
- 0.4
- 0.3
- 0.2
- 0.1
- dev-gc-custom-auth-fix
- dev-recurring_events
- dev-snyk-upgrade-1f9718cdd5795d74f0cdfeca6fe80d88
- dev-snyk-upgrade-7c95da50b241ad181a9fb5a076b21ed6
- dev-snyk-upgrade-7ed20d2be7f671c2f4bff0c765dce541
- dev-snyk-upgrade-4cf03370d84367180f67f998bc72a602
- dev-snyk-upgrade-3345da0982ec2e5941e0386b0440aeae
- dev-snyk-upgrade-a139608cdffb5f93ea9bc559fb81b15f
- dev-anpolimus-patch-1
- dev-filesystem
- dev-snyk-upgrade-147a85a8de550abc19f3708680b8ade5
- dev-docs
- dev-prefer_stable
- dev-jsonapi_image_styles
- dev-csv_serialization
- dev-rename
- dev-oficial_repo
This package is auto-updated.
Last update: 2024-11-14 13:06:39 UTC
README
Virtual Y is a package for Open Y and consists of features, needed to organize gated content for Y clients.
Active development is currently happening at YUSA fork. Pull requests should be submitted there. They will be pulled into this repo as they are reviewed and released.
Server requirements
In order to work Virtual Y requires HTTP server to allow
- GET
- POST
- DELETE http methods.
Submodules
- Authentication system - plugin system for different authentication types.
- Demo - set of migrations that installs Demo content at the initial step of your Virtual Y
- Storage - set of entities, needed for Virtual Y
- Log Features for tracking activities of your Virtual Y users.
- Shared content - module that give's you ability to download content from shared network.
- Shared content server - module for shared.openy.org server.
Installation
See also the video version of these instructions. This assumes you've already built an Open Y site and have it running.
- Add this module to your codebase.
- via composer:
composer require ycloudyusa/yusaopeny_gated_content
- without composer: this is not recommended.
- via composer:
- Enable the modules
- Through the UI:
- Visit Extend in your toolbar.
- Check "Virtual Y Base", "Open Y Virtual YMCA Storage", and "Open Y Virtual YMCA Auth Example".
- Install and say "yes" to add all required dependencies.
- Via drush:
drush en openy_gated_content openy_gc_auth_example -y
- Through the UI:
- Add at least one term in these vocabularies via Structure > Taxonomies
- Virtual Y Category
- Virtual Y Equipment
- Virtual Y Level
- Create a Landing Page and add the Virtual Y Content paragraph to the Content Area section.
- From the toolbar go to Virtual Y > Videos > Add Video and add a piece of video content.
- Visit the landing page you created, click to log in, and observe your new Virtual Y.
Upgrade path
Known issues
If you facing with
[error] Configuration <em class="placeholder">user.role.anonymous</em> depends on configuration (<em class="placeholder">rest.resource.openy_gc_auth_custom, rest.resource.openy_gc_auth_custom_confirm</em>) that will not exist after import.
It’s looks like that previous updates were failed. If you don't use Custom auth provider - disable that module, and it should help. If you use it - try manually delete that config and try again
drush cdel rest.resource.openy_gc_auth_custom_confirm
Another one
Drupal\Component\Plugin\Exception\PluginNotFoundException while adding Views handlers for field Parts of day on index Default: The "" plugin does not exist. Valid plugin IDs for Drupal\search_api\DataType\DataTypePluginManager are: boolean, date, integer, decimal, string, text in
This error was because one of the service lived in a custom folder. Try to analyse what service is broken and fix it.
Development
In development purposes, you might want a set of modules to be enabled. Use
openy_gc_demo
module for such purposes. Specify modules that you want to be
enabled as dependencies of this module. The CI configuration automatially
enables this modules, and all its dependencies.
Coding standards
PHPCS
Please find the PHPCS configuration in .phpcs.xml
.
In order to use the configuration just run phpcs
within the module directory.
You can add this script to .git/hooks/pre-commit to run phpcs and phpcbf on git commit
PROJECT=`php -r "echo dirname(dirname(dirname(realpath('$0'))));"` cd $PROJECT echo "Running phpcs and phpcbf..." phpcs . if [ $? != 0 ] then phpcbf . exit 1 fi
eslint
Please find the esling configuration in js/gated-content/.eslintrc.js
To run the check execute npm install && npm lint-no-fix
. See
js/gated-content/package.json
for details.
Automatic code fixing is available with npm lint
.
With docksal for openy
The docksal configuration https://github.com/fivejars/docksal-for-openy/tree/openy-gc-builds is used to for building the PR builds.
In order to use it you have to install Docksal.
Follow the instruction below to get the working local environment that provides 4 local websites (1 for each base theme and not yet installed Open Y):
mkdir vymca
cd vymca
git clone --branch openy-gc-builds \
git@github.com:fivejars/docksal-for-openy.git .docksal
git clone git@github.com:fivejars/yusaopeny_gated_content.git
mkdir -p docroot/libraries docroot/sites/default/config/staging
wget -N https://raw.githubusercontent.com/fivejars/yusaopeny-project/8.2.x-gated-content-ci/composer.json
docker volume create --name=composer_cache
fin init
Vimeo private videos
For videos, protected from embed by "Specific domains" you can have an issue with thumbnails download to drupal media. In this case - apply a patch for drupal core:
- patches/OEmbed_vimeo_private_videos.patch - in case of using core media
- patches/video_embed_field_vimeo_private_videos.patch - in case of using video_embed_field module
JSON API patch required for Drupal 8.7
{ "extra": { "patches": { "drupal/core": { "JSONAPI wont install (8.7-specific)": "https://www.drupal.org/files/issues/2019-05-23/jsonapi_2996114.patch" } } } }
Migration notes
If you have error:
TypeError: Argument 6 passed to __construct() must be an instance of EntityTypeManagerInterface
apply patch to composer.json:
{ "extra": { "patches": { "drupal/paragraphs": { "3079627": "https://www.drupal.org/files/issues/2019-09-06/3079627-4.paragraphs.Argument-6-passed-to-construct.patch" } } } }