wcc-contentful-app 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a9ebca490bb9172d4e1b1a7449ed272b04e0f3f
+  data.tar.gz: 885ac69efd2ac212753c30c9e5022b295731f167
+SHA512:
+  metadata.gz: 72f34bf7714650ce629162c6fc6dbbd45d2cc831cfdac4645f9fe72cc4a84480a6553a0f17931dffac8ab78ef46ce303c242580bc52b636e36ecf2cc01fbb93d
+  data.tar.gz: d03b0292853d51fcbc3b03253bf9534b4928caf1b5a52f65826092199fb24ae47a45d73476a0e24ee4df103586855b2ed7077655d26874b49e833742f58e3ef6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--order rand

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in wcc-contentful.gemspec
+gemspec
+
+gem 'wcc-contentful', path: File.expand_path('../wcc-contentful', __dir__)

data/lib/generators/wcc/USAGE

@@ -0,0 +1,24 @@
+Description:
+    Generates the necessary migrations and initializers to add WCC Menus
+    to your contentful space.
+
+Example:
+    rails generate wcc:model MODEL
+
+    This will install:
+      https://www.github.com/watermarkchurch/migration-cli
+
+    This will create:
+      db/migrate/[date]_generated_add_[MODEL].ts -
+        this migration is run by the migration CLI to create MODEL in your
+        contentful space
+      bin/release -
+        Adds a release command to your rails app which runs migrations.
+      bin/contentful -
+        This bash script is a wrapper around various Contentful CLI tools, and
+        is invoked by bin/release to run migrations
+      Procfile -
+        Adds a release command to be invoked by Heroku which runs the script
+        in bin/release
+      config/initializers/wcc_contentful.rb -
+        This file will initialize the wcc_contentful gem with default options

data/lib/generators/wcc/model_generator.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Wcc
+  class ModelGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    argument :model, type: :string
+
+    VALID_MODELS = %w[menu page].freeze
+
+    def initialize(*)
+      super
+
+      return if VALID_MODELS.include?(singular)
+
+      raise ArgumentError, "Model must be #{VALID_MODELS.to_sentence}"
+    end
+
+    def ensure_migration_tools_installed
+      in_root do
+        run 'npm init -y' unless File.exist?('package.json')
+        package = JSON.parse(File.read('package.json'))
+        deps = package['dependencies']
+
+        unless deps.try(:[], 'contentful-migration-cli').present?
+          run 'npm install --save watermarkchurch/migration-cli ts-node typescript contentful-export'
+        end
+      end
+    end
+
+    def ensure_wrapper_script_in_bin_dir
+      unless inside('bin') { File.exist?('contentful') }
+        copy_file 'contentful_shell_wrapper', 'bin/contentful'
+      end
+
+      if inside('bin') { File.exist?('release') }
+        release = inside('bin') { File.read('release') }
+        unless release.include?('contentful migrate')
+          insert_into_file('bin/release', after: 'bundle exec rake db:migrate') do
+            <<~HEREDOC
+              DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+              $DIR/contentful migrate -y
+            HEREDOC
+          end
+        end
+      else
+        copy_file 'release', 'bin/release'
+      end
+
+      if in_root { File.exist?('Procfile') }
+        procfile = in_root { File.read('Procfile') }
+        unless procfile.include?('release:')
+          insert_into_file('Procfile') do
+            'release: bin/release'
+          end
+        end
+      else
+        copy_file 'Procfile'
+      end
+    end
+
+    def ensure_initializer_exists
+      return if inside('config/initializers') { File.exist?('wcc_contentful.rb') }
+
+      copy_file 'wcc_contentful.rb', 'config/initializers/wcc_contentful.rb'
+    end
+
+    def create_model_migration
+      copy_file "#{singular}/generated_add_#{plural}.ts",
+        "db/migrate/#{timestamp}01_generated_add_#{plural}.ts"
+    end
+
+    def drop_model_overrides_in_app_models
+      directory "#{singular}/models", 'app/models'
+    end
+
+    private
+
+    def singular
+      model.downcase.singularize
+    end
+
+    def plural
+      model.downcase.pluralize
+    end
+
+    def timestamp
+      Time.now.strftime('%Y%m%d%H%M')
+    end
+  end
+end

data/lib/generators/wcc/templates/Procfile

@@ -0,0 +1,3 @@
+web: bundle exec puma -C config/puma.rb
+worker: bundle exec sidekiq
+release: bin/release

data/lib/generators/wcc/templates/contentful_shell_wrapper

@@ -0,0 +1,385 @@
+#!/bin/bash
+
+COLOR_NC='\033[0m' # No Color
+COLOR_GRAY='\033[1;30m'
+COLOR_RED='\033[0;31m'
+COLOR_LCYAN='\033[1;36m'
+COLOR_YELLOW='\033[1;33m'
+COLOR_LGREEN='\033[1;32m'
+
+logv() {
+  [[ -z "$VERBOSE" ]] && return 0;
+
+  local msg=$(echo "$@" | sed "s/$CONTENTFUL_MANAGEMENT_TOKEN/\*\*\*\*\*/" )
+  >&2 echo -e "${COLOR_GRAY}$msg${COLOR_NC}" || true
+}
+
+logerr() {
+  >&2 echo -e "${COLOR_RED}$@${COLOR_NC}"
+}
+
+curlv() {
+  logv "curl" $@
+  curl "$@"
+}
+
+execv() {
+  logv "$@"
+  "$@"
+}
+
+## *** Argument Parsing & validation ***
+
+usage() {
+  echo "$0 <command> [opts]
+  Commands:
+    migrate [dir|file]
+      runs pending migration files in the given directory
+        * [dir|file] optional - Default: db/migrate
+
+    setup [file]
+      initializes a space with bare-minimum schema and seeds
+        * [file] optional - default: db/contentful-schema.json
+
+    backup [file]
+      downloads a backup of the current space to the given file
+        * [file] optional - default: timestamped file in current directory
+
+    clean [no-init]
+      Deletes all data in a given space and optionally sets it up again
+      using 'bin/contentful setup'. 
+        * [no-init] optional - Skips the 'setup' step at the end.
+
+    restore [file]
+      restores a given backup file into the current space
+        * [file] optional - default: the most recent backup file in the current directory
+
+    new_env
+      deletes the current working environment if it exists and makes a new clone of 'master'.
+        * -e [to environment ID] optional - the current working environment.  Default: \$USER
+
+    generate [name]
+      Creates a sample migration in the db/migrate directory
+        * [name] optional - default: 'contentful_migration'
+
+  Flags:" && \
+    grep " .)\ #" $0
+  echo "
+  Examples:" && \
+    grep -i "#\ example:" $0 | awk '{$1=""; $2=""; print "  "$0}'
+}
+
+parse_args() {
+  OPTIND=1
+  local s=$(echo "$1" | tr '[:upper:]' '[:lower:]')
+  case "$s" in
+    migrate|setup|backup|export|restore|new_env|import|generate|clean|help|h|\?)
+      export subcommand=$s
+      OPTIND=2
+      ;;
+  esac
+
+  # Parse flags
+  while getopts ":hyvse:a:" arg; do
+    case $arg in
+      y) # Yes - skip prompts
+        export YES="-y"
+        ;;
+      s) # Contentful Space ID - overrides env var CONTENTFUL_SPACE_ID
+        export CONTENTFUL_SPACE_ID=$OPTARG
+        ;;
+      a) # Contentful Mgmt Token - overrides env var CONTENTFUL_MANAGEMENT_TOKEN
+        export CONTENTFUL_MANAGEMENT_TOKEN=$OPTARG
+        ;;
+      e) # Contentful environment ID - overrides env var CONTENTFUL_ENVIRONMENT
+        export CONTENTFUL_ENVIRONMENT=$OPTARG
+        ;;
+      v) # Verbose mode - extra output
+        export VERBOSE=true
+        ;;
+      h) # Display help.
+        usage
+        exit 0
+        ;;
+      *)
+        logerr "Unknown option: '$OPTARG'"
+        usage
+        exit -1
+        ;;
+    esac
+  done
+
+  export OPTIND
+}
+
+parse_args $@ && shift $(($OPTIND - 1))
+  # If they put args before the command like 'bin/contentful -s 1xab migrate -y', try parsing again
+[[ -z "$subcommand" ]] && parse_args $@ && shift $(($OPTIND - 1))
+
+require_environment() {
+  [[ -z "$CONTENTFUL_SPACE_ID" ]] && logerr "Please set CONTENTFUL_SPACE_ID environment variable or use '-s' flag." && exit -1;
+  [[ -z "$CONTENTFUL_MANAGEMENT_TOKEN" ]] && logerr "Please set CONTENTFUL_MANAGEMENT_TOKEN environment variable or use '-a' flag." && exit -1;
+  if [[ ! -f node_modules/.bin/contentful-migration ]]; then
+    command -v npm >/dev/null 2>&1 || (logerr "I require 'npm' but it's not installed.  Please install nodejs."; exit -1)
+    execv npm install
+    [[ -f node_modules/.bin/contentful-migration ]] || (logerr "Failed installing node modules - please ensure contentful CLI is installed"; exit -1)
+  fi
+}
+
+## *** Utility functions ***
+
+confirm() {
+  [[ -z "$2" ]] && [[ ! -z "$YES" ]] && logv "$1 (y/n): confirmed by -y flag" && return 0;
+
+  while true; do
+    if [[ -z "$2" ]]; then
+      read -p $'\033[1;36m'"$1"' (y/n): '$'\033[0m' yn
+    else
+      # double confirm - extra dangerous.
+      read -p $'\033[0;31m'"$1"' (y/n): '$'\033[0m' yn
+    fi
+    case $yn in
+        [Yy]* ) return 0;;
+        [Nn]* ) return 1;;
+        * ) echo "Please answer yes or no.";;
+    esac
+  done
+}
+
+get_space_name() {
+  curlv -s https://api.contentful.com/spaces/$1?access_token=$CONTENTFUL_MANAGEMENT_TOKEN | jq -r .name | tr '[:upper:]' '[:lower:]'
+}
+
+# Man I wish I understood sed... https://stackoverflow.com/a/29060802
+# $1 File
+# $2 Find
+# $3 Replace / Append
+replace_append() {
+  if grep -q "^$2" "$1"
+  then
+      sed -i.bak "s/^$2.*$/$3/" "$1"
+  else
+      echo "\n$3" >> "$1"
+  fi
+}
+
+set -e
+
+# *** Commands ***
+
+# Example: bin/contentful migrate -y -s 1xab -a $MY_TOKEN db/migrate/20180101120000_add_content_type_dog.ts
+# equivalent to: bin/rake db:migrate
+migrate() {
+  ARG="$1"
+  [[ -z "$ARG" ]] && ARG="db/migrate"
+  [[ -d "$ARG" ]] && ARG="batch $ARG"
+
+  require_environment
+
+  [[ ! -z "$CONTENTFUL_ENVIRONMENT" ]] && ENV="--environment-id $CONTENTFUL_ENVIRONMENT"
+
+  execv node_modules/.bin/ts-node node_modules/.bin/contentful-migration \
+    -s $CONTENTFUL_SPACE_ID $ENV -a $CONTENTFUL_MANAGEMENT_TOKEN \
+    $YES -p $ARG
+
+  mkdir -p db
+  execv node_modules/.bin/contentful-export --export-dir db --content-file contentful-schema.json \
+    --space-id $CONTENTFUL_SPACE_ID $ENV --management-token $CONTENTFUL_MANAGEMENT_TOKEN \
+    --query-entries 'content_type=migrationHistory' \
+    --query-assets 'sys.id=false'
+
+  if [[ $(git diff-index --name-only HEAD | grep 'db/contentful-schema.json') == "" ]]; then
+    echo -e "${COLOR_LGREEN}✓ Schema in contentful space is equivalent to stored schema${COLOR_NC}"
+  else
+    echo -e "${COLOR_YELLOW}⚠️  Schema changed after running migrations${COLOR_NC}"
+  fi
+}
+
+# Example: bin/contentful backup -s 1xab -a $MY_TOKEN 2018_01_01.1xab.dump.json
+# equivalent to: bin/rake db:dump[2018_01_01.dump]
+backup() {
+  FILE="$1"
+  [[ ! -z "$FILE" ]] && FILE="--content-file $FILE" && shift
+
+  require_environment
+
+  [[ ! -z "$CONTENTFUL_ENVIRONMENT" ]] && ENV="--environment-id $CONTENTFUL_ENVIRONMENT"
+
+  execv node_modules/.bin/contentful-export $FILE \
+    --space-id $CONTENTFUL_SPACE_ID $ENV --management-token $CONTENTFUL_MANAGEMENT_TOKEN \
+    $@
+}
+
+# Example: bin/contentful restore -y -s 1xab -a $MY_TOKEN 2018_01_01.1xab.dump.json
+# equivalent to: bin/rake db:restore[2018_01_01.dump]
+restore() {
+  FILE="$1"
+  if [[ -z "$FILE" ]]; then
+    FILE=$(ls contentful-export-$CONTENTFUL_SPACE_ID-* | sort -r | head -n 1)
+    [[ -z "$FILE" ]] && logerr "No file given on command line" && exit -1
+  fi
+
+  name=$(get_space_name $CONTENTFUL_SPACE_ID)
+  if [[ ! -z "$CONTENTFUL_ENVIRONMENT" ]]; then
+    ENV="--environment-id $CONTENTFUL_ENVIRONMENT"
+    name="$name/$CONTENTFUL_ENVIRONMENT"
+  fi
+  confirm "Import $FILE into $name?" || exit -1
+
+  require_environment
+
+  execv node_modules/.bin/contentful-import \
+    --space-id $CONTENTFUL_SPACE_ID $ENV --management-token $CONTENTFUL_MANAGEMENT_TOKEN \
+    --content-file $FILE
+}
+
+# Example: bin/contentful setup -y -s 1xab -a $MY_TOKEN db/my-schema.json
+# equivalent to: bin/rake db:setup
+setup() {
+  FILE="$1"
+  [[ -z "$FILE" ]] && FILE=db/contentful-schema.json
+
+  name=$(get_space_name $CONTENTFUL_SPACE_ID)
+  if [[ ! -z "$CONTENTFUL_ENVIRONMENT" ]]; then
+    ENV="--environment-id $CONTENTFUL_ENVIRONMENT"
+    name="$name/$CONTENTFUL_ENVIRONMENT"
+  fi
+
+  confirm "Initialize space $name from seed file $FILE?" || exit -1
+
+  require_environment
+
+  execv node_modules/.bin/contentful-import \
+    --space-id $CONTENTFUL_SPACE_ID $ENV --management-token $CONTENTFUL_MANAGEMENT_TOKEN \
+    --content-file $FILE
+
+  migrate
+}
+
+# Example: bin/contentful clean -s 1xab -a $MY_TOKEN
+clean() {
+  command -v jq >/dev/null 2>&1 || (logerr "I require 'jq' but it's not installed.  Please run 'brew install jq'"; exit -1)
+
+  require_environment
+
+  [[ -z "$CONTENTFUL_ENVIRONMENT" ]] && CONTENTFUL_ENVIRONMENT="$USER"
+  [[ "$CONTENTFUL_ENVIRONMENT" == "master" ]] && logerr "cannot delete the master environment" && exit -1
+
+  name=$(get_space_name $CONTENTFUL_SPACE_ID)
+  code=$(curlv -s -o /dev/null -w "%{http_code}" https://api.contentful.com/spaces/$CONTENTFUL_SPACE_ID/environments/$CONTENTFUL_ENVIRONMENT\?access_token\=$CONTENTFUL_MANAGEMENT_TOKEN)
+  [[ $code == "404" ]] && logerr "$CONTENTFUL_ENVIRONMENT does not exist in $name" && return 0;
+  
+  confirm "This will delete the '$CONTENTFUL_ENVIRONMENT' environment from $name.  Are you sure?" || exit -1
+    
+  local bkup_file="contentful-export-$CONTENTFUL_SPACE_ID-${CONTENTFUL_ENVIRONMENT}-`date +"%Y-%m-%dT%H-%M-%S"`.json"
+  backup $bkup_file
+  
+  curlv --fail -XDELETE https://api.contentful.com/spaces/$CONTENTFUL_SPACE_ID/environments/$CONTENTFUL_ENVIRONMENT\?access_token\=$CONTENTFUL_MANAGEMENT_TOKEN
+}
+
+# Example: bin/contentful new_env -e gordon_dev
+new_env() {
+  command -v jq >/dev/null 2>&1 || (logerr "I require 'jq' but it's not installed.  Please run 'brew install jq'"; exit -1)
+
+  require_environment
+  name=$(get_space_name $CONTENTFUL_SPACE_ID)
+  [[ -z "$CONTENTFUL_ENVIRONMENT" ]] && CONTENTFUL_ENVIRONMENT="$USER"
+  [[ "$CONTENTFUL_ENVIRONMENT" == "master" ]] && logerr "cannot delete the master environment" && exit -1
+
+  echo -e "${COLOR_LCYAN}This will delete '$CONTENTFUL_ENVIRONMENT' and recreate it from master.${COLOR_NC}"
+  confirm "Continue?" || exit -1
+  export YES='-y' # don't keep bugging the user
+
+  clean
+
+  # make the environment
+  resp=$(curlv -s --fail -XPUT https://api.contentful.com/spaces/$CONTENTFUL_SPACE_ID/environments/$CONTENTFUL_ENVIRONMENT \
+    -H "Authorization: Bearer ${CONTENTFUL_MANAGEMENT_TOKEN}" \
+    -H "Content-Type: application/vnd.contentful.management.v1+json" \
+    -d "{ \"name\": \"${CONTENTFUL_ENVIRONMENT}\" }")
+  
+  while [ ! $(echo "$resp" | jq -r .sys.status.sys.id) == "ready" ]
+  do
+    logv "waiting for environment $CONTENTFUL_ENVIRONMENT to be ready..."
+    sleep 1
+    resp=$(curlv -s https://api.contentful.com/spaces/$CONTENTFUL_SPACE_ID/environments/$CONTENTFUL_ENVIRONMENT \
+      -H "Authorization: Bearer ${CONTENTFUL_MANAGEMENT_TOKEN}")
+  done
+  
+  logv "get the API keys and update the one matching ours to point to the new environment"
+  keys=$(curlv -s --fail https://api.contentful.com/spaces/$CONTENTFUL_SPACE_ID/api_keys\?access_token\=$CONTENTFUL_MANAGEMENT_TOKEN)
+  my_key=$(echo "$keys" | jq -r ".items[] | select(.accessToken == \"$CONTENTFUL_ACCESS_TOKEN\")")
+  my_key_id=$(echo "$my_key" | jq -r ".sys.id")
+  my_key_version=$(echo "$my_key" | jq -r ".sys.version")
+  new_env_links=$(echo "$my_key" | jq ".environments + [{ \"sys\": { \"id\": \"$CONTENTFUL_ENVIRONMENT\", \"type\": \"Link\", \"linkType\": \"Environment\" } }] | { \"environments\": . }")
+  
+  curlv -s -o /dev/null --fail -XPUT https://api.contentful.com/spaces/$CONTENTFUL_SPACE_ID/api_keys/$my_key_id \
+    -H "Authorization: Bearer ${CONTENTFUL_MANAGEMENT_TOKEN}" \
+    -H "Content-Type: application/vnd.contentful.management.v1+json" \
+    -H "X-Contentful-Version: ${my_key_version}" \
+    -d "${new_env_links}"
+
+  execv replace_append .env.local "CONTENTFUL_ENVIRONMENT\=" "CONTENTFUL_ENVIRONMENT=$CONTENTFUL_ENVIRONMENT"
+  execv replace_append .env.test.local "CONTENTFUL_ENVIRONMENT\=" "CONTENTFUL_ENVIRONMENT=$CONTENTFUL_ENVIRONMENT"
+
+  echo "Environment ${CONTENTFUL_ENVIRONMENT} successfully created!"
+}
+
+# Example: bin/contentful generate add content type dog
+# equivalent to: bin/rails generate migration add_content_type_dog
+generate() {
+  migration="
+import Migration from 'contentful-migration-cli'
+
+export = function (migration: Migration) {
+  const dog = migration.createContentType('dog', {
+    name: 'Dog'
+  })
+
+  const name = dog.createField('name')
+  name.name('Name')
+    .type('Symbol')
+    .required(true)
+}
+"
+
+  timestamp=$(date +%Y%m%d%H%M%S)
+  filename="$@"
+  [[ -z "$filename" ]] && filename="contentful_migration"
+  filename=${filename// /\_}
+  filename="db/migrate/${timestamp}_${filename}.ts"
+  echo "$migration" > $filename
+  echo "generated file $filename"
+}
+
+case $subcommand in 
+  migrate)
+    migrate $@
+    ;;
+  backup|export)
+    backup $@
+    ;;
+  restore|import)
+    restore $@
+    ;;
+  setup)
+    setup $@
+    ;;
+  generate)
+    generate $@
+    ;;
+  clean)
+    clean $@
+    ;;
+  new_env)
+    new_env $@
+    ;;
+  help|h|\?)
+    usage
+    ;;
+  *)
+    logerr "Unknown command: '$1'"
+    usage
+    exit -1
+    ;;
+esac