station 0.0.0 → 0.0.100

data/docs/_config.yml

@@ -0,0 +1,5 @@
+plugins:
+  - jekyll-relative-links
+
+relative_links:
+  enabled: true

data/docs/index.md

@@ -0,0 +1,46 @@
+---
+title: "Home"
+permalink: /
+---
+
+# Station
+
+1.  [What Is Station?](#what-is-station)
+2.  [What Is Station For?](#what-is-station-for)
+3.  [What Problems Does Station Solve?](#what-problems-does-station-solve)
+4.  [How Does Station Accomplish Its Goals?](#how-does-station-accomplish-its-goals)
+
+## What Is Station?
+
+Station is a platform tool. In combination with custom configuration files and a path to content files in markdown, Station provides a platform website that can be used for any number of purposes.
+
+Station is built with Ruby on Rails as its infrastructure incorporated with Webpack. For the experienced Rails developer, it will feel familiar. For a person not acquainted with Rails, it will be unnecessary to learn the nuances of the framework to run or contribute content to a Station powered site.
+
+## What Is Station For?
+
+Station is built to provide the following out of the box:
+
+*   A solution for creating text-driven content websites quickly
+*   The ability for non-software developers to contribute content in a streamlined fashion
+*   Highly customizable to meet each site's needs through a set of defined configuration files
+
+## What Problems Does Station Solve?
+
+There are multiple concerns involved in creating a platform site, and all too often, any individual contributor needs to be proficient in many of them to make a contribution in their area of expertise. A technical writer should not need to know Ruby to offer documentation. A graphic designer should not need to know JavaScript to contribute a graphic design for the site. Yet, in many instances, that is the case.
+
+Furthermore, a single business often can have multiple product lines that need multiple documentation or developer portals. It can be difficult to ensure that the style guide and overall look of the business remain consistent over time across different platform sites.
+
+Station comes to solve both of these problems. Through Station people can contribute in their area of expertise without needing to be proficient in other areas. Likewise, through Station distinct product documentation portals under the same business can be built and can retain sustainably the same experience across platforms.
+
+## How Does Station Accomplish Its Goals?
+
+Station accomplishes this by:
+
+*   Providing a CLI that lets administrators boot up a platform with a one-line command
+*   Offering different configuration files for different customizable aspects of the platform
+*   Integrating web assets such as images from the `/public` folder in the content path into the platform
+*   Utilizing custom exception messaging to provide users with advice during troubleshooting platform problems
+*   Disaggregating the code of the platform and its content so content contributors do not need to be concerned at all with the code
+*   With regular releases of new versions following semantic versioning guidelines, providing administrators with the assurance that their platform will be current with dependency upgrades by maintaining a single gem dependency, that of Station itself
+
+Learn more about [Getting Started](Getting-Started.md) and [How To Use](How-To-Use.md) Station.

data/lib/nexmo_developer/.disallowed_words

@@ -0,0 +1,2 @@
+“
+”

data/lib/nexmo_developer/.dockerignore

@@ -0,0 +1 @@
+public/packs

data/lib/nexmo_developer/.eslintrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  "extends": "standard",
+  "rules": {
+    "space-before-function-paren": ["error", "never"]
+  }
+};

data/lib/nexmo_developer/.nvmrc

@@ -0,0 +1 @@
+12.7.0

data/lib/nexmo_developer/.postcssrc.yml

@@ -0,0 +1,4 @@
+plugins:
+  postcss-smart-import: {}
+  autoprefixer: {}
+  postcss-cssnext: {}

data/lib/nexmo_developer/.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+-   repo: git://github.com/pre-commit/pre-commit-hooks
+    sha: v0.9.1
+    hooks:
+    -   id: check-yaml
+    -   id: check-json
+    -   id: check-xml
+    -   id: check-merge-conflict
+    -   id: check-case-conflict

data/lib/nexmo_developer/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--tag ~ndp

data/lib/nexmo_developer/.rubocop.yml

@@ -0,0 +1,276 @@
+require: rubocop-rails
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'bin/*'
+    - 'db/**/*.rb'
+    - 'node_modules/**/*'
+    - 'vendor/**/*'
+    - '.vendor/**/*'
+    - '.git/**/*'
+    - '_open_api/**/*'
+
+# Temporarily disabled until we can refactor
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+# Always enabled
+Rails:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/BlockComments:
+  Enabled: false
+
+Layout/ParameterAlignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Rails/FilePath:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Rails/OutputSafety:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/RedundantInterpolation:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/TernaryParentheses:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Lint/NonDeterministicRequireOrder:
+  Enabled: false
+
+Layout/AccessModifierIndentation:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Rails/HelperInstanceVariable:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: false
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Naming/FileName:
+  Exclude:
+    - 'public/assets/**/*'
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: false
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/DuplicateRescueException:
+  Enabled: true
+
+Lint/EmptyConditionalBody:
+  Enabled: true
+
+Lint/FloatComparison:
+  Enabled: true
+
+Lint/MissingSuper:
+  Enabled: true
+
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+
+Lint/SelfAssignment:
+  Enabled: true
+
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+
+Lint/UnreachableLoop:
+  Enabled: true
+
+Style/ExplicitBlockArgument:
+  Enabled: true
+
+Style/GlobalStdStream:
+  Enabled: true
+
+Style/OptionalBooleanParameter:
+  Enabled: true
+
+Style/SingleArgumentDig:
+  Enabled: true
+
+Style/StringConcatenation:
+  Enabled: true
+
+Rails/ActiveRecordCallbacksOrder:
+  Enabled: true
+
+Rails/FindById:
+  Enabled: true
+
+Rails/Inquiry:
+  Enabled: true
+
+Rails/MailerName:
+  Enabled: true
+
+Rails/NegateInclude:
+  Enabled: true
+
+Rails/Pluck:
+  Enabled: true
+
+Rails/PluckId:
+  Enabled: true
+
+Rails/PluckInWhere:
+  Enabled: true
+
+Rails/RenderInline:
+  Enabled: true
+
+Rails/RenderPlainText:
+  Enabled: true
+
+Rails/ShortI18n:
+  Enabled: true
+
+Rails/WhereExists:
+  Enabled: true
+
+Rails/MatchRoute:
+  Enabled: true
+
+Rails/AfterCommitOverride:
+  Enabled: true
+
+Rails/SquishedSQLHeredocs:
+  Enabled: true
+
+Rails/WhereNot:
+  Enabled: true
+
+Lint/DuplicateBranch:
+  Enabled: false

data/lib/nexmo_developer/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/lib/nexmo_developer/Dockerfile

@@ -0,0 +1,28 @@
+# Base image:
+FROM ruby:2.7.2
+
+# Install dependencies
+RUN apt-get update -qq && apt-get install -y build-essential libpq-dev lsof
+
+# Install modern NodeJS
+run curl -sL https://deb.nodesource.com/setup_12.x | bash -
+run curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
+run echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list
+run apt-get update && apt-get install -y nodejs yarn
+
+# Set an environment variable where the Rails app is installed to inside of Docker image:
+RUN mkdir -p /app/.git/hooks
+
+WORKDIR /app
+
+# Install Node Dependencies
+ADD package.json yarn.lock /app/
+RUN yarn install
+
+# Update Bundler to Version 2 as ruby:2.5.5 defaults to an older version
+RUN gem update --system && gem install bundler
+
+# Install Ruby Dependencies
+ADD Gemfile /app/Gemfile
+ADD Gemfile.lock /app/Gemfile.lock
+RUN bundle install

data/lib/nexmo_developer/Gemfile

@@ -0,0 +1,192 @@
+source 'https://rubygems.org'
+ruby '2.7.2'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 6.0.3'
+gem 'webpacker'
+
+# Use postgresql as the database for Active Record
+gem 'pg', '~> 1.2'
+# Use Puma as the app server
+gem 'puma', '~> 5.0'
+# Use SCSS for stylesheets
+gem 'sassc-rails', '~> 2.1'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 4.1.20'
+# Use CoffeeScript for .coffee assets and views
+gem 'coffee-rails', '~> 5.0'
+# See https://github.com/rails/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+# Add clipboard for copying content
+gem 'clipboard-rails'
+
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.10.1'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 3.0'
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+# Add Geocoder to get latitude and longitude for geographic places
+gem 'geocoder'
+
+# Add gmap4rails to integrate the Google Maps API
+gem 'gmaps4rails'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+# Nokogiri (鋸) is an HTML, XML, SAX, and Reader parser. Among Nokogiri's many features is the ability to search documents via XPath or CSS3 selectors.
+gem 'nokogiri', '~> 1.10.9'
+
+# Autoload dotenv in Rails.
+gem 'dotenv-rails', groups: %i[development test]
+
+# Ruby/ProgressBar is a text progress bar library for Ruby.
+gem 'ruby-progressbar', require: false
+
+# Ruby notifier for bugsnag.com
+gem 'bugsnag'
+
+# Extends String class or add a ColorizedString with methods to set text color, background color and text effects.
+gem 'colorize'
+
+# A simple Ruby client for the algolia.com REST API
+gem 'algoliasearch'
+
+# A simple HTTP and REST client for Ruby, inspired by the Sinatra microframework style of specifying actions: get, put, post, delete.
+gem 'rest-client'
+
+# Helpers for the reCAPTCHA API
+gem 'recaptcha', require: 'recaptcha/rails'
+
+# Implements the iCalendar specification (RFC-5545) in Ruby.
+gem 'icalendar', require: false
+
+# Generate JSON strings from Ruby objects with flexible formatting options.
+gem 'neatjson'
+
+# Faker, a port of Data::Faker from Perl, is used to easily generate fake data: names, addresses, phone numbers, etc.
+gem 'faker', '2.14.0', require: false
+
+# factory_girl_rails provides integration between factory_girl and rails 3 or newer (currently just automatic factory definition loading)
+gem 'factory_bot_rails', '6.1.0', require: false
+
+# A slim ruby wrapper for posting to slack webhooks
+gem 'slack-notifier', '2.3.2'
+
+# The administration framework for Ruby on Rails.
+gem 'activeadmin', '~> 2.8'
+
+# Flexible authentication solution for Rails with Warden
+gem 'devise', '>= 4.6.0'
+
+# Simple wrapper for the GitHub API
+gem 'octokit', require: false
+
+# Cross-language UserAgent classifier library, ruby implementation
+gem 'woothee'
+
+# Create beautiful JavaScript charts with one line of Ruby
+gem 'chartkick', '3.4.2'
+
+# The simplest way to group temporal data
+gem 'groupdate', '5.2.1'
+
+# A configurable and documented Rails view helper for adding gravatars into your Rails application.
+gem 'gravatar_image_tag', '1.2.0'
+
+# Boot large ruby/rails apps faster
+gem 'bootsnap', require: false
+
+# Convenient diffing in ruby
+gem 'diffy', require: false
+
+# Automatic Ruby code style checking tool. Aims to enforce the community-driven Ruby Style Guide.
+gem 'rubocop', '~> 1.3.1', require: false
+gem 'rubocop-rails', '~> 2.8', require: false
+
+# Volta needs a CSS autoprefixer
+gem 'autoprefixer-rails'
+
+# Titleize modifies the existing Titleize Rails functionality to better suit our needs
+gem 'titleize'
+
+# Used in our reporting rake tasks
+gem 'terminal-table'
+
+# Single line logging for production
+gem 'lograge'
+
+# Country picker for ActiveAdmin
+gem 'countries'
+gem 'country_select', '~> 4.0'
+
+gem 'nexmo-oas-renderer', '~> 2.4.1', require: false
+
+gem 'nexmo_markdown_renderer', '~> 0.5'
+
+gem 'smartling'
+
+gem 'newrelic_rpm'
+
+# A/B Testing
+gem 'split', '~> 3.4.1', require: 'split/dashboard'
+
+gem 'greenhouse_io'
+
+# For truncating HTML strings
+gem 'truncato'
+
+gem 'redis'
+
+gem 'barnes'
+
+gem 'actionpack-page_caching', github: 'rails/actionpack-page_caching'
+
+group :development, :test do
+  gem 'awesome_print'
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platform: :mri
+  gem 'pry', require: false
+  gem 'rawler', git: 'https://github.com/oscardelben/rawler.git', require: false
+  gem 'rspec-collection_matchers'
+  gem 'rspec-rails', '~> 4.0'
+  gem 'rspec-snapshot', '~> 0.1.2'
+  gem 'simplecov', require: false
+  gem 'webmock'
+end
+
+group :development do
+  # Access an IRB console on exception pages or by using <%= console %> anywhere in the code.
+  gem 'listen', '~> 3.3'
+  gem 'web-console', '>= 3.3.0'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'guard-livereload', '~> 2.5', require: false
+  gem 'guard-rspec'
+  # gem 'spring'
+  # gem 'spring-watcher-listen', '~> 2.0.0'
+  # Much nicer error experience, including repl
+  gem 'better_errors'
+  gem 'binding_of_caller'
+end
+
+group :test do
+  gem 'apparition'
+  gem 'capybara'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]
+
+# The following are dependencies of dependencies, but we require them here to
+# force minimum versions due to security issues
+gem 'ffi', '>= 1.9.24'
+gem 'rack', '>= 2.0.6'