cortex 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02be4dc6153e80f279a2fd206836a381fefc3795f041f374cba3432b4a2635e2
-  data.tar.gz: 9030f02d775228201076a839717fbc448865298cb10439ea7fdd4ad1cc0e793f
+  metadata.gz: 4426b62937bf51d4a6573548dd8d609416a79ff5b30a248ebd2c0ce886b47f59
+  data.tar.gz: 42032a40d2798d5cffbf20cefad8deaed73eafafd56cb16bb16f5b7cb0cb48b4
 SHA512:
-  metadata.gz: 74e62c6f98e35e21d3b401664d8cbee5ed0cccbf8e3d5f10099703324dd947250b412181f7972f4086b4b5b907b6ecf5dfdfd1ef211fa0c9e4957ee55db9f8a9
-  data.tar.gz: 07f749ee18a1b26dcac66f7aa34a8b4b8bc261a7a380614e7b3b0ce9d151d3efa127ceeb7e1725f3996bb6e791a8f82a512d205f90e8e43e743c8e23f8880862
+  metadata.gz: 2055aadd5e0c975dc53b3f2f300a2329cfd967c6b3255f1a24e2d69d02bfb84c073b701c73d7897ea82e1fa9c458269c3f2e82c28e68201cc5c8f8076632dbc5
+  data.tar.gz: c4f75eca590607f743f4b0abb994fa9d8a332be1dea0a2307411543d65cfb70fe9b6e594c01e312761a99da4525305c0b70482c25cb9edfbc0a155b10ec61603

data/.circleci/config.yml

@@ -0,0 +1,103 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    environment:
+      APP_SECRET: eff4949db97d2f67e375b25784984a4c36bb3d7103a4a32562204cba199b01919903635efb901b78f04c5bb55ef5079fca664b35a03b5c59eb6c2721972251c5
+      DEVISE_SECRET: 2af89dd48125b17425532c09c78c051923b0574ac3a1175bbf18c40c8c147c2ba54736323d436b11003a8cc6ef18165a46d7128cfc672f14ca611615e13ba7f4
+      GRAPHQL_URL: /graphql
+      REDIS_NAMESPACE: cortex_test
+      CACHE_URL: redis://localhost:6379/0/cache
+      SESSION_STORE_URL: redis://localhost:6379/0/cache
+      ELASTICSEARCH_ADDRESS: localhost:9200
+      DATABASE_NAME: cortex_starter_test
+      DATABASE_USERNAME: root
+      DATABASE_HOST: localhost
+      DATABASE_PORT: 5432
+
+    docker:
+    # specify the version you desire here
+    - image: circleci/ruby:2.5.1-node-browsers
+
+    # Specify service dependencies here if necessary
+    # CircleCI maintains a library of pre-built images
+    # documented at https://circleci.com/docs/2.0/circleci-images/
+    - image: circleci/postgres:10.4-alpine
+    - image: redis:4.0-alpine
+    - image: docker.elastic.co/elasticsearch/elasticsearch:5.6.10
+      environment:
+        xpack.security.enabled: false
+
+    working_directory: ~/repo
+
+    steps:
+    - checkout
+
+    # Download and cache dependencies
+    - restore_cache:
+        name: Restore Yarn Package Cache
+        keys:
+        - yarn-packages-{{ checksum "yarn.lock" }}
+    - run:
+        name: Install Dependencies
+        command: yarn install
+    - save_cache:
+        name: Save Yarn Package Cache
+        key: yarn-packages-{{ checksum "yarn.lock" }}
+        paths:
+        - ~/.cache/yarn
+
+    - restore_cache:
+        keys:
+        - v1-dependencies-{{ checksum "Gemfile.lock" }}
+        # fallback to using the latest cache if no exact match is found
+        - v1-dependencies-
+    - run:
+        name: install dependencies
+        command: |
+          bundle install --jobs=4 --retry=3 --path vendor/bundle
+    - save_cache:
+        paths:
+        - ./vendor/bundle
+        key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+    - run:
+        name: install dockerize
+        command: wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz && sudo tar -C /usr/local/bin -xzvf dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz && rm dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz
+        environment:
+          DOCKERIZE_VERSION: v0.3.0
+    - run:
+        name: Wait for Postgres
+        command: dockerize -wait tcp://localhost:5432 -timeout 2m
+    - run:
+        name: Wait for Redis
+        command: dockerize -wait tcp://localhost:6379 -timeout 2m
+    - run:
+        name: Wait for ElasticSearch
+        command: dockerize -wait tcp://localhost:9200 -timeout 2m
+
+    # Database setup
+    - run: spec/dummy/bin/setup
+
+    # run tests!
+    - run:
+        name: run tests
+        command: |
+          mkdir /tmp/test-results
+          TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+          spec/dummy/bin/rspec --format progress \
+                          --format RspecJunitFormatter \
+                          --out /tmp/test-results/rspec.xml \
+                          --format progress \
+                          $TEST_FILES
+
+    # collect reports
+    - store_test_results:
+        path: /tmp/test-results
+    - store_artifacts:
+        path: /tmp/test-results
+        destination: test-results

data/CONTRIBUTING.md

@@ -46,13 +46,14 @@ further improvements or alternatives, or the community at large may have input.
 Some things that will increase the chances that your pull request will be accepted:
 
 * Write [good tests][tests]
-* Write [good commit messages][commit]
+* Write [good][good-commit], [semantic][semantic-commit] commit messages
 * Be consistent
 * If applicable, suggest additional options or alternatives, follow-up issues or potential future improvements
 
-[issue]: https://github.com/cbdr/cortex/issues
+[issue]: https://github.com/cortex-cms/cortex/issues
 [tests]: http://betterspecs.org
-[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
-[setup]: https://github.com/cbdr/cortex#setup
-[pr]: https://github.com/cbdr/cortex/compare
-[test-suite]: https://github.com/cbdr/cortex#running-test-suite
+[good-commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[semantic-commit]: https://seesparkbox.com/foundry/semantic_commit_messages
+[setup]: https://docs.cortexcms.org/basics/setup/manual-setup
+[pr]: https://github.com/cortex-cms/cortex/compare
+[test-suite]: https://docs.cortexcms.org/basics/setup/core-and-plugin-development#running-test-suite

data/Gemfile

@@ -78,6 +78,7 @@ group :test do
   gem 'json_spec', '~> 1.1'
   gem 'rspec-sidekiq', '~> 3.0'
   gem 'shoulda-matchers', '~> 3.1'
+  gem "rspec_junit_formatter"
 
   # Coverage
   gem 'simplecov'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cortex (0.1.0)
+    cortex (0.1.3)
       addressable (~> 2.5.2)
       awesome_nested_set (~> 3.1.4)
       breadcrumbs_on_rails (~> 3.0.1)
@@ -485,6 +485,8 @@ GEM
       rspec-core (~> 3.0, >= 3.0.0)
       sidekiq (>= 2.4.0)
     rspec-support (3.7.1)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
     ruby-graphviz (1.2.3)
     ruby-prof (0.17.0)
     ruby_dep (1.5.0)
@@ -588,6 +590,7 @@ DEPENDENCIES
   redis-rails (~> 5.0)
   rspec-rails
   rspec-sidekiq (~> 3.0)
+  rspec_junit_formatter
   sass-rails (~> 5.0)
   shoulda-matchers (~> 3.1)
   sidekiq (~> 5.1.3)

data/README.md

@@ -1,226 +1,15 @@
-# Cortex CMS [![Build Status](https://semaphoreci.com/api/v1/projects/ec90715a-da8f-4960-bb64-f371850f9c98/813409/shields_badge.svg)](https://semaphoreci.com/content-enablement/cortex) [![Code Climate](https://codeclimate.com/repos/53f62c2869568018180036c9/badges/78e3c3c865b118bbd72b/gpa.svg)](https://codeclimate.com/repos/53f62c2869568018180036c9/feed) [![Test Coverage](https://codeclimate.com/repos/53f62c2869568018180036c9/badges/78e3c3c865b118bbd72b/coverage.svg)](https://codeclimate.com/repos/53f62c2869568018180036c9/coverage) [![Documentation Status](https://www.gitbook.com/button/status/book/cortex-cms/cortex-cms)](https://docs.cortexcms.org/)
+# Cortex CMS Engine [![CircleCI](https://circleci.com/gh/cortex-cms/cortex.svg?style=svg)](https://circleci.com/gh/cortex-cms/cortex) [![Code Climate](https://codeclimate.com/repos/53f62c2869568018180036c9/badges/78e3c3c865b118bbd72b/gpa.svg)](https://codeclimate.com/repos/53f62c2869568018180036c9/feed) [![Test Coverage](https://codeclimate.com/repos/53f62c2869568018180036c9/badges/78e3c3c865b118bbd72b/coverage.svg)](https://codeclimate.com/repos/53f62c2869568018180036c9/coverage)
 <img align="right" height="150"
      src="https://hiring-assets.careerbuilder.com/branding/cortex-logo.svg"
      alt="Cortex CMS Logo">
 
-Cortex CMS is a [multitenant](https://en.wikipedia.org/wiki/Multitenancy) identity, content distribution/management and reporting platform built by the [Content Enablement][cb-ce-github] team at [CareerBuilder](https://github.com/careerbuilder). Its purpose is to provide central infrastructure for next-generation applications; exposing a single point of management while enabling quicker build-out of new software.
+Cortex CMS is a [multitenant](https://en.wikipedia.org/wiki/Multitenancy) identity, [custom content](https://docs.cortexcms.org/glossary#custom-content-cms) distribution/management and reporting platform built by the [Content Enablement][cb-ce-github] team at [CareerBuilder](https://github.com/careerbuilder). Its purpose is to provide central infrastructure for next-generation applications; exposing a single point of management while enabling quicker build-out of new software.
 
-Cortex follows a decentralized, API-only architecture - it is *not* built like Wordpress or Drupal, which are considered monolithic, all-in-one solutions.
+Cortex adheres to a headless, API-only architecture - it avoids a monolithic, all-in-one architecture associated with CMSs like WordPress or Drupal.
 
-## Table of Contents
+## Documentation
 
-- [Setup](#setup)
-  - [Environment](#environment)
-  - [Dependencies](#dependencies)
-    - [System](#system)
-      - [OS X](#os-x)
-      - [Linux](#linux)
-    - [Application](#application)
-  - [Database](#database)
-  - [Server](#server)
-  - [Deployment](#deployment)
-- [Running Test Suite](#running-test-suite)
-- [API](#api)
-  - [Documentation](#documentation)
-- [Consuming Cortex](#consuming-cortex)
-  - [Authorization](#authorization)
-  - [Content](#content)
-  - [Localizations](#localizations)
-  - [Exceptions](#exceptions)
-- [Applications Using Cortex](#applications-using-cortex)
-- [Troubleshooting](#troubleshooting)
-- [Contributing](#contributing)
-- [License](#license)
-- [Copyright](#copyright)
-
-## Setup
-
-### Environment
-
-Copy and rename the example `.env.example` file as `.env` and modify it to match your environment.
-
-For a rudimentary setup, these variables should be configured:
-
-* Execute `$ bundle exec rails secret` twice to generate both an `APP_SECRET` and `DEVISE_SECRET`
-* If the superuser isn't used for the app databases, the `DATABASE_USERNAME` and `DATABASE_PASSWORD` should be set accordingly.
-
-### Dependencies
-
-#### System
-
-##### OS X
-
-* Install the Xcode Command Line tools:
-
-```sh
-$ xcode-select --install
-```
-
-* Install all Cortex system-wide dependencies (and the `readline` Ruby/`byebug` build dependency) using [Homebrew](http://brew.sh/) from the `Brewfile` via `$ brew install $(cat Brewfile|grep -v "#")`
-* Install Ruby via [rbenv](https://github.com/sstephenson/rbenv) or [rvm](https://rvm.io/).
-* Enable system agents:
-
-```sh
-$ ln -sfv /usr/local/opt/postgresql/*.plist ~/Library/LaunchAgents
-$ ln -sfv /usr/local/opt/elasticsearch/*.plist ~/Library/LaunchAgents
-$ ln -sfv /usr/local/opt/redis/*.plist ~/Library/LaunchAgents
-```
-
-and start them with `brew services`:
-
-```sh
-$ brew services start postgresql
-$ brew services start elasticsearch
-$ brew services start redis
-```
-
-or `launchctl`:
-
-```sh
-$ launchctl load ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist
-$ launchctl load ~/Library/LaunchAgents/homebrew.mxcl.elasticsearch.plist
-$ launchctl load ~/Library/LaunchAgents/homebrew.mxcl.redis.plist
-```
-
-##### Linux
-
-* Install all Cortex system-wide dependencies (and the `readline` Ruby/`byebug` build dependency) using your distribution's package manager (`pacman`, `apt-get`, `yum`, etc). For example, with Ubuntu's `apt-get`:
-
-```sh
-$ apt-get install libreadline6-dev postgresql postgresql-contrib redis-server openjdk-8-jre imagemagick jpegoptim ghostscript
-```
-
-Ubuntu and Redhat/Fedora do not have an official `elasticsearch` package - you must use Elasticsearch's repositories for [APT](https://www.elastic.co/guide/en/elasticsearch/reference/current/deb.html) or [RPM](https://www.elastic.co/guide/en/elasticsearch/reference/current/rpm.html) or follow these [manual instructions](https://www.elastic.co/guide/en/elasticsearch/reference/current/_installation.html). The same goes for `phantomjs`. Build from [source](http://phantomjs.org/download.html) or use a [PPA](https://launchpad.net/ubuntu/+ppas?name_filter=phantomjs). Other Linux distributions likely have these as prebuilt packages in their official or user repositories.
-
-* Install Ruby via [rbenv](https://github.com/sstephenson/rbenv) or [rvm](https://rvm.io/).
-* Enable system agents using your distribution's service manager frontend, which is likely `systemd`'s frontend, `systemctl`:
-
-```sh
-$ systemctl enable postgresql
-$ systemctl enable elasticsearch
-$ systemctl enable redis
-```
-
-and start them with `systemctl`:
-
-```sh
-$ systemctl start postgresql
-$ systemctl start elasticsearch
-$ systemctl start redis
-```
-
-#### Application
-
-* Install Bundler and its dependencies:
-
-```sh
-$ gem install bundler && bundle install
-```
-
-* Install `node`, then run Yarn to install frontend dependencies:
-
-```sh
-$ yarn install
-```
-
-### Database
-
-* Create databases:
-
-```sh
-$ bin/rails db:create
-```
-
-* Initialize the schema:
-
-```sh
-$ bin/rails db:schema:load
-```
-
-* Seed database with a top-level tenant, the superuser and Custom Content data, then rebuild the ElasticSearch index:
-
-```sh
-$ bundle exec rake db:seed
-$ bundle exec rake cortex:core:db:reseed
-$ bundle exec rake cortex:rebuild_indexes
-```
-
-### Server
-
-Start Cortex, Sidekiq and live rebuild/reload via Foreman:
-
-```sh
-$ gem install foreman
-$ foreman start -f Procfile.dev-server
-```
-
-The admin interface should now be accessible locally on port `3000`. To access Cortex as superadmin, login as `admin@cortexcms.org` with password `welcome1`.
-
-### Deployment
-
-Deploying the `development` environment as a non-local server will require an additional environmental variable be set:
-
-```shell
-DEPLOYED=true
-```
-
-This will configure various things to behave normally in a deployed scenario.
-
-## Running Test Suite
-
-Initialize the test database:
-
-```sh
-$ RAILS_ENV=test bundle exec rake db:schema:load db:seed cortex:core:db:reseed
-$ RAILS_ENV=test bundle exec rake cortex:rebuild_indexes
-```
-
-To run Ruby and JS specs, utilize:
-
-```sh
-$ RAILS_ENV=test bundle exec rake spec
-$ RAILS_ENV=test bundle exec rake spec:javascript
-```
-
-## API
-
-### Documentation
-
-Cortex's live API documentation is available via Swagger. This contains specific endpoints, parameters, and response models.
-
-SwaggerUI is provided at [http://docs.api.cbcortex.com/](http://docs.api.cbcortex.com).
-
-Swagger Endpoints are available at [http://api.cbcortex.com/api/v1/swagger_doc.json](http://api.cbcortex.com/api/v1/swagger_doc.json).
-
-## Consuming Cortex
-
-### Authorization
-
-Cortex's API utilizes [OAuth2](https://tools.ietf.org/html/rfc6749) for Authentication and Authorization. Client Credentials and Authorization Code [grant types](http://alexbilbie.com/2013/02/a-guide-to-oauth-2-grants/) are supported. Want to get up and running quickly with OAuth? Use Cortex's [Ruby client](https://github.com/cortex-cms/cortex-client-ruby) or [OmniAuth strategy](https://github.com/cb-talent-development/omniauth-cortex) for Client Credentials and Authorization Code grants, respectively.
-
-Before an application can consume any data, OAuth credentials must be created for the consuming application in the 'Applications' section of the Cortex admin interface.
-
-### Content
-
-Content can be consumed from a feed or via the resource's endpoint directly. Use the [cortex-client](https://github.com/cbdr/cortex-client) gem to easily consume any content resource and use it in your application.
-
-### Localizations
-
-Localizations can be consumed via the client or via [i18n-backend-cortex](https://github.com/cortex-cms/i18n-backend-cortex), which allows easy localization for Rails applications.
-
-### Exceptions
-
-If a consuming or companion application would like to produce Cortex-equivalent exceptions, use the [cortex-exceptions](https://github.com/cb-talent-development/cortex-exceptions) gem.
-
-## Applications Using Cortex
-
-* [Advice and Resources](https://github.com/cbdr/consumer-main/) - Simple Jobseeker Resources platform built atop the Consumer Web site utilizing Legacy Cortex Posts and Rails. Content will eventually be dynamically dispersed across site (result pages, description pages, etc) [Live Site](https://www.careerbuilder.com/advice)
-* [Employer](https://github.com/cbdr/employer) - Redesigned Employer Marketing platform utilizing Legacy Cortex Webpages/Snippets and Rails. [Live Site](https://hiring.careerbuilder.com/)
-* [CB1 Lander Shell](https://github.com/cbdr/cb1-lander-shell) - Platform for hosting lander pages and experiments, utilizing Legacy Cortex Posts and Sinatra. [Live Site](http://corporate.careerbuilder.com/)
-* [CareerBuilder.com](https://github.com/cbdr/consumer-main) - The main Consumer Web site for CB.com uses Legacy Cortex Posts for the [Privacy](https://www.careerbuilder.com/privacy) and [Terms of Service](https://www.careerbuilder.com/terms) pages.
-
-## Troubleshooting
-* For OS X / homebrew users: Run `which node` to ensure node is properly linked. The path shown should match homebrew's default installation path (run `which brew` to reveal this). If its not, then run `brew link node` and follow the instructions.
+Cortex CMS features a comprehensive [documentation portal](https://docs.cortexcms.org). To get started, refer to the [manual setup guide](https://docs.cortexcms.org/basics/setup/manual-setup).
 
 ## Contributing
 
@@ -234,6 +23,6 @@ Cortex utilizes the Apache 2.0 License. See [LICENSE](LICENSE.md) for details.
 
 ## Copyright
 
-Copyright (c) 2018 CareerBuilder, LLC.
+Copyright (c) CareerBuilder, LLC.
 
 [cb-ce-github]: https://github.com/cb-talent-development "Content Enablement on GitHub"

data/app/controllers/cortex/content_items_controller.rb

@@ -28,47 +28,57 @@ module Cortex
       @content_item = content_type.content_items.find_by_tenant(current_user.active_tenant).find_by_id(params[:id])
       @wizard = wizard_decorator(@content_item.content_type)
 
-      title = @content_item.field_items.find { |field_item| field_item.field.name == 'Title' }.data['text'] # TODO: refactor this hardcoded Field reference
+      title = @content_item.field_items.find {|field_item| field_item.field.name == 'Title'}.data['text'] # TODO: refactor this hardcoded Field reference
       add_breadcrumb content_type.name.pluralize, :content_type_content_items_path
       add_breadcrumb title
       add_breadcrumb 'Edit'
     end
 
     def update
-      begin
-        update_content_item
-      rescue ActiveRecord::RecordInvalid => e
-        flash[:warning] = validation_message(e.message)
-        @content_item = content_item_reload(content_type.content_items.find_by_id(params[:id]))
-        @wizard = wizard_decorator(@content_item.content_type)
+      update_content_item
+        .with_step_args(
+          execute_content_item_state_change: [state: params[:content_item][:state]]
+        )
+        .call(id: params[:id], content_type: content_type,
+              content_item_params: content_item_params, current_user: current_user) do |m|
+        m.success do |content_item|
+          flash[:success] = "#{content_type.name} successfully updated"
+          redirect_to content_type_content_items_path
+        end
 
-        title = @content_item.field_items.find { |field_item| field_item.field.name == 'Title' }.data['text'] # TODO: refactor this hardcoded Field reference
-        add_breadcrumb content_type.name.pluralize, :content_type_content_items_path
-        add_breadcrumb title
-        add_breadcrumb 'Edit'
+        m.failure :persist_content_item do |errors|
+          flash[:warning] = clean_error_messages(errors.full_messages)
+          render_update_content_item_error
+        end
 
-        render :edit
-      else
-        flash[:success] = "Hooray! #{content_type.name} Updated!"
-        redirect_to content_type_content_items_path
+        m.failure do |error|
+          flash[:warning] = ['Unknown System Error']
+          render_update_content_item_error
+        end
       end
     end
 
     def create
-      begin
-        create_content_item
-      rescue ActiveRecord::RecordInvalid => e
-        flash[:warning] = validation_message(e.message)
-        @content_item = content_item_reload(content_type.content_items.new)
-        @wizard = wizard_decorator(@content_item.content_type)
+      create_content_item
+        .with_step_args(
+          execute_content_item_state_change: [state: params[:content_item][:state]]
+        )
+        .call(id: params[:id], content_type: content_type,
+              content_item_params: content_item_params, current_user: current_user) do |m|
+        m.success do |content_item|
+          flash[:success] = "#{content_type.name} successfully created"
+          redirect_to content_type_content_items_path
+        end
 
-        add_breadcrumb content_type.name.pluralize, :content_type_content_items_path
-        add_breadcrumb 'New'
+        m.failure :persist_content_item do |errors|
+          flash[:warning] = clean_error_messages(errors.full_messages)
+          render_create_content_item_error
+        end
 
-        render :new
-      else
-        flash[:success] = "Hooray! #{content_type.name} Created!"
-        redirect_to content_type_content_items_path
+        m.failure do |error|
+          flash[:warning] = ['Unknown System Error']
+          render_update_content_item_error
+        end
       end
     end
   end