station 0.0.0 → 0.0.100

data/lib/nexmo_developer/Guardfile

@@ -0,0 +1,109 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## NOTE: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard 'livereload' do
+  extensions = {
+    css: :css,
+    scss: :css,
+    sass: :css,
+    js: :js,
+    coffee: :js,
+    html: :html,
+    png: :png,
+    gif: :gif,
+    jpg: :jpg,
+    jpeg: :jpeg,
+    # less: :less, # uncomment if you want LESS stylesheets done in browser
+  }
+
+  rails_view_exts = %w[erb haml slim]
+
+  # file types LiveReload may optimize refresh for
+  compiled_exts = extensions.values.uniq
+  watch(%r{public/.+\.(#{compiled_exts * '|'})})
+
+  extensions.each do |ext, type|
+    watch(%r{
+          (?:app|vendor)
+          (?:/assets/\w+/(?<path>[^.]+) # path+base without extension
+           (?<ext>\.#{ext})) # matching extension (must be first encountered)
+          (?:\.\w+|$) # other extensions
+          }x) do |m|
+      path = m[1]
+      "/assets/#{path}.#{type}"
+    end
+  end
+
+  # file needing a full reload of the page anyway
+  watch(%r{app/views/.+\.(#{rails_view_exts * '|'})$})
+  watch(%r{app/helpers/.+\.rb})
+  watch(%r{config/locales/.+\.yml})
+end
+
+# NOTE: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w[erb haml slim])
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}"),
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
+  end
+end

data/lib/nexmo_developer/Procfile

@@ -0,0 +1,2 @@
+release: bundle exec rake db:migrate && bundle exec rake cache:clear
+web: rails s

data/lib/nexmo_developer/Rakefile

@@ -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/lib/nexmo_developer/Runbook.md

@@ -0,0 +1,69 @@
+# System Overview
+
+Nexmo Developer is a simple Rails application with a mounted Sinatra app that handles the rendering of the [API References](https://developer.nexmo.com/api).
+
+# Deployment
+
+NDP is hosted in Heroku and is automatically deployed every time a branch is merged into master via a Github integration.
+In case you want to force a deploy, you can always deploy NDP from [Heroku's dashboard](https://dashboard.heroku.com/apps/nexmo-developer).
+
+## Required Resources
+
+* Heroku Redis: Used for caching view fragments and resources, its configuration can be found in [production.rb](https://github.com/Nexmo/nexmo-developer/blob/adab0ed5ef9ca61a5be14481cbb6c0a50af0ab11/config/environments/production.rb#L59-L65).
+* Heroku Scheduler: Runs a scheduled job everyday at 5pm that refreshes Algolia's indexes.
+* Heroku Postgres: SQL Database service.
+* Algolia: In Production, the search form is enabled and it is powered by [Algolia](https://www.algolia.com/).
+
+# How to diagnose problems with NDP
+
+## Logs
+
+We use [Logz.io](https://logz.io/) as a logging solution with a 3Gb daily volume and 3 days retention plan, as an alternative you can always check Heroku's logs which expire after one week. 
+
+## Error Monitoring and Reporting
+
+We use [Bugsnag](https://www.bugsnag.com/) for monitoring errors both on the Backend and Frontend splitted into different Projects.
+Bare in mind that most of the errors are logged under `Markdown#show` so it might take a while to find a specific error.
+
+## Health checks
+
+We use [Pingdom](https://www.pingdom.com/) to monitor [NDP's](https://developer.nexmo.com) health, and email notifications are sent when the site is Down/Up.
+
+## Caching
+
+We currently cache the sidenav and the information we fetch from Greenhouse in order to render the careers page. The cache is cleared as part of the deploy process, so when facing a caching issue, just trigger a new deploy or run the following rake task in Heroku `rake cache:clear`.
+
+## Troubleshooting Production issues
+
+In case NDP is Down:
+
+* Check if [Heroku](https://status.heroku.com/) is having an outage. Unfortunately, if that is the case then there isn't much you can do about it (at least for now).
+* Otherwise, check the [logs](#logs) or [Bugsnag](#error-monitoring-and-reporting) to see if any issues show up and try to reproduce it locally.
+If the issue is related to the latest deploy, just revert the offending commits and the deploy again while you work on a fix. Once a fix is ready, open a Pull Request, make sure that it works in the corresponding Review App and finally after all the checks pass merge it into master.
+
+# Available configuration options
+
+## Configuration management
+
+When running NDP locally, `dotenv` loads the corresponding environment variables from `.env` to ENV. However, when the app is deployed to Heroku the evnvironment variables are set in Heroku's dashboard.
+
+## Enabling Search locally
+
+To enable the Search form locally, the `ALGOLIA_SEARCH_KEY` environment variable needs to be set, the rest of the configuration is defined in `config/algolia.yml`
+
+# Common issues when running NDP locally
+
+NDP can be run locally either directly or using Docker, for more information about how to run it see the [Readme](https://github.com/Nexmo/nexmo-developer/blob/master/README.md#running-locally). When using docker, re-building the image should fix the following issues
+
+* `Could not find definition '<insert_file_here>' in '<path>'`: set the right `OAS_PATH`  in `.env`, check `.env.example` for the default value.
+
+* `Error connecting to Redis on localhost:6379`: you are seeing this error becase the `REDIS_URL` env variable is set and the app couldn't connect to it. Make sure redis is up and running and re-start the app server.
+
+* Migration errors: run `bundle exec rake db:migrate`
+
+* While running `bundle install`:
+  * `ruby version '<version>' is not installed`:  try running `rbenv install <version> && gem install bundler` followed by `bundle install`
+
+* Webpacker errors:
+    * `The engine "node" is incompatible with this module. Expected version...` We use [nvm](https://github.com/nvm-sh/nvm) as node's version manage, check that the right version of node is installed (specified in `.nvmrc`) and run `nvm use <version>`.
+    * Make sure that all the packages are install by running `yarn install`

data/lib/nexmo_developer/app/admin/active_admin_feedback_author.rb

@@ -0,0 +1,23 @@
+ActiveAdmin.register Feedback::Author, as: 'Author' do
+  menu parent: 'Feedback'
+  # See permitted parameters documentation:
+  # https://github.com/activeadmin/activeadmin/blob/master/docs/2-resource-customization.md#setting-up-strong-parameters
+  #
+  # permit_params :list, :of, :attributes, :on, :model
+  #
+  # or
+  #
+  # permit_params do
+  #   permitted = [:permitted, :attributes]
+  #   permitted << :other if params[:action] == 'create' && current_user.admin?
+  #   permitted
+  # end
+
+  index do
+    column :id do |author|
+      author.id.first(8)
+    end
+    column :email
+    actions
+  end
+end

data/lib/nexmo_developer/app/admin/active_admin_redirect.rb

@@ -0,0 +1,22 @@
+ActiveAdmin.register Redirect do
+  permit_params :url, :uses
+
+  index do
+    selectable_column
+    id_column
+    column :url
+    column :uses
+    actions
+  end
+
+  filter :url
+  filter :uses
+
+  form do |f|
+    f.inputs do
+      f.input :url
+      f.input :uses
+    end
+    f.actions
+  end
+end

data/lib/nexmo_developer/app/admin/active_admin_session.rb

@@ -0,0 +1,34 @@
+ActiveAdmin.register Session do
+  # See permitted parameters documentation:
+  # https://github.com/activeadmin/activeadmin/blob/master/docs/2-resource-customization.md#setting-up-strong-parameters
+  #
+  permit_params :title, :description, :author, :video_url, :published
+  #
+  # or
+  #
+  # permit_params do
+  #   permitted = [:permitted, :attributes]
+  #   permitted << :other if params[:action] == 'create' && current_user.admin?
+  #   permitted
+  # end
+
+  index do
+    column :title
+    column :description
+    column :author
+    column :video_url
+    column :published
+    actions
+  end
+
+  form do |_f|
+    inputs 'Details' do
+      input :title
+      input :description
+      input :video_url
+      input :author
+      input :published
+    end
+    actions
+  end
+end

data/lib/nexmo_developer/app/admin/admin_building_block_event.rb

@@ -0,0 +1,31 @@
+ActiveAdmin.register ::Usage::CodeSnippetEvent do
+  permit_params :snippet, :language, :section, :action
+
+  index do
+    selectable_column
+    id_column
+    column :snippet
+    column :language
+    column :section
+    column :action
+    column :ip
+    actions
+  end
+
+  filter :snippet
+  filter :language
+  filter :section
+  filter :action
+  filter :ip
+
+  form do |f|
+    f.inputs do
+      f.input :snippet
+      f.input :language
+      f.input :section
+      f.input :action
+      f.input :ip
+    end
+    f.actions
+  end
+end

data/lib/nexmo_developer/app/admin/admin_event.rb

@@ -0,0 +1,40 @@
+ActiveAdmin.register ::Event do
+  # See permitted parameters documentation:
+  # https://github.com/activeadmin/activeadmin/blob/master/docs/2-resource-customization.md#setting-up-strong-parameters
+  #
+  permit_params :title, :description, :starts_at, :ends_at, :url, :city, :country, :remote
+  #
+  # or
+  #
+  # permit_params do
+  #   permitted = [:permitted, :attributes]
+  #   permitted << :other if params[:action] == 'create' && current_user.admin?
+  #   permitted
+  # end
+
+  index do
+    column :title
+    column :description
+    column :starts_at
+    column :ends_at
+    column :url
+    column :city
+    column :country
+    column :remote
+    actions
+  end
+
+  form do |_f|
+    inputs 'Details' do
+      input :title
+      input :description
+      input :url
+      input :remote, as: :boolean
+      input :city
+      input :country, include_blank: true, selected: ''
+      input :starts_at, as: :datepicker
+      input :ends_at, as: :datepicker
+    end
+    actions
+  end
+end

data/lib/nexmo_developer/app/admin/admin_feedback_feedback.rb

@@ -0,0 +1,54 @@
+ActiveAdmin.register ::Feedback::Feedback, as: 'Feedback' do
+  menu parent: 'Feedback', priority: 1
+
+  permit_params :resolved
+
+  index do
+    column :id do |feedback|
+      feedback.id.first(8)
+    end
+    column :sentiment
+    column :resource
+    column :owner
+    column :ip
+    column :comment
+    column :code_language
+    column :code_language_selected_whilst_on_page
+    column :code_language_set_by_url
+    column :created_at
+    column :resolved
+    actions
+  end
+
+  form do |_f|
+    inputs 'Details' do
+      input :resolved
+    end
+    actions
+  end
+
+  show do
+    attributes_table do
+      row :sentiment
+      row :resource
+      row :owner
+      row :owner_type
+      row :ip
+      row :comment
+      row :created_at
+      row :updated_at
+      row :code_language
+      row :code_language_selected_whilst_on_page
+      row :code_language_set_by_url
+      row :resolved
+      row :path
+      row :steps do
+        if feedback.config
+          render 'steps', { feedback: feedback }
+        end
+      end
+    end
+
+    active_admin_comments
+  end
+end

data/lib/nexmo_developer/app/admin/admin_feedback_resource.rb

@@ -0,0 +1,42 @@
+ActiveAdmin.register ::Feedback::Resource, as: 'Resource' do
+  menu parent: 'Feedback'
+  # See permitted parameters documentation:
+  # https://github.com/activeadmin/activeadmin/blob/master/docs/2-resource-customization.md#setting-up-strong-parameters
+  #
+  # permit_params :list, :of, :attributes, :on, :model
+  #
+  # or
+  #
+  # permit_params do
+  #   permitted = [:permitted, :attributes]
+  #   permitted << :other if params[:action] == 'create' && current_user.admin?
+  #   permitted
+  # end
+
+  index do
+    column :id do |resource|
+      resource.id.first(8)
+    end
+    column :uri
+    column :feedbacks do |resource|
+      link_to(resource.feedbacks.size, admin_feedbacks_path(q: { resource_id_eq: resource.id }))
+    end
+    column :feedbacks_positive do |resource|
+      link_to(resource.feedbacks.positive.size, admin_feedbacks_path({
+        q: {
+          resource_id_eq: resource.id,
+          sentiment_equals: 'positive',
+        },
+      }))
+    end
+    column :feedbacks_negative do |resource|
+      link_to(resource.feedbacks.negative.size, admin_feedbacks_path({
+        q: {
+          resource_id_eq: resource.id,
+          sentiment_equals: 'negative',
+        },
+      }))
+    end
+    actions
+  end
+end