peoplefinder 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72942bf17c531fa7faf99910438f8af4bbd2ea3e
+  data.tar.gz: e15b4fd50289678e19f21eb36454d11c83ce70f8
+SHA512:
+  metadata.gz: a27110981bc3ed88297d2c0ce48c8e977339409d290a5a8f71423ae66acc7f4fc1ee900421ee7f50e577c0c63ab5fc26ccbf5db95becbc623b5a2b6f725e7f5f
+  data.tar.gz: 1f23d6f2044a72825faf571f35b54ab81cfc422952ead59ced0a2201782344b2fc1ef3b5559de8ee92a184abec4dfcf2cd7faf80e261bc87977d90ace0415e9a

data/LICENCE.txt

@@ -0,0 +1,19 @@
+(C) Crown copyright 2014
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,234 @@
+# MoJ People Finder
+
+This is a rails engine that can be mounted inside a rails 4 application.
+
+A working example can be seen at https://github.com/alphagov/gds-peoplefinder
+
+## Preparing the Gemfile
+
+In Gemfile:
+
+`gem 'peoplefinder'`
+
+The peoplefinder engine requires some forked / tagged versions gems
+so these need to be included also:
+
+`gem 'carrierwave',
+  git: 'https://github.com/carrierwaveuploader/carrierwave.git',
+  tag: 'cc39842e44edcb6187b2d379a606ec48a6b5e4a8'`
+
+`gem 'omniauth-gplus',
+  git: 'https://github.com/ministryofjustice/omniauth-gplus.git'`
+
+
+Install the gems with bundler:
+
+`bundle install`
+
+
+## Mounting the engine
+
+In config/routes.rb:
+
+`mount Peoplefinder::Engine, at: "/"`
+
+## Importing migrations from engine
+
+If the engine has new database migrations, you can import them into this application to apply them to the application database using the following:
+
+`$ bundle exec rake peoplefinder:install:migrations`
+
+This copies the migrations into the application's `db/migrate` directory. You should commit any such imported migration files to this applications repo:
+
+`$ git add db/migrate $ git commit -m 'Imported new migrations from engine'`
+
+You should then run the migrations in the usual way:
+
+` $ bundle exec rake db:migrate`
+
+And commit the `schema.rb`
+
+
+##Configurable elements
+
+These should be defined in the config/application.rb or in the enviroments/__environment__.rb files if the settings need to be
+defined on a per environment basis.
+
+`config.app_title` e.g. 'My New People Finder'
+
+`config.default_url_options` e.g. { host: mail.peoplefinder.example.com }
+
+`config.elastic_search_url` Required for production (see Search section below)
+
+`config.ga_tracking_id` Google Analytics tracking id [optional]. e.g. 'XXXX-XXX'
+
+`config.support_email` e.g. 'peoplefinder-support@example.com'
+
+`config.valid_login_domains` Restrict login to email addresses from the list of valid domains. e.g. %w[ peoplefinder.example.com ]
+
+
+
+## Authentication
+
+Authentication requires two environment variables. You can obtain these by
+visiting the [Google Developers Console](https://console.developers.google.com/)
+and selecting **APIs & auth** from the sidebar, followed by **Credentials**,
+then **Create new Client ID**.
+
+Set `GPLUS_CLIENT_ID` to the value of **Client ID** and `GPLUS_CLIENT_SECRET`
+to **Client secret**.
+
+You will also need to configure **Consent screen** below for logging in to work.
+
+For local development, you can use a `.env` file; see `.env.sample` for an
+example.
+
+The permitted domains are configured in `config/application.rb`.
+
+## Search
+
+To run the engine in production mode, `config.elastic_search_url` must be set in, for example, config/application.rb.
+See 'Configurable elements' above.
+
+
+Heroku provides [Bonsai Elasticsearch](https://devcenter.heroku.com/articles/bonsai)
+as an add-on.
+
+You can install a development version from [Elasticsearch downloads](http://www.elasticsearch.org/download/)
+or with a package manager.
+e.g. `brew install elasticsearch`.
+
+Elasticsearch requires [jdk version 7 or greater](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html).
+
+If you get an IndexMissingException, you will need to index the Person model:
+
+`bundle exec rake environment elasticsearch:import:model CLASS='Person' FORCE=y`
+
+Or you can build the index from the console:
+
+`Person.__elasticsearch__.create_index! index: Person.index_name, force: true`
+`Person.import`
+
+You can also delete the index:
+
+`Person.delete_indexes`
+
+To run specs without Elasticsearch:
+
+`bundle exec rspec . --tag ~elastic`
+
+## Images
+
+We use [MiniMagick](https://github.com/minimagick/minimagick) so either Imagemagick or Graphicsmagick need to be installed for image manipulation and for some of the tests.
+
+If using brew you can use the following command:
+
+`brew install imagemagick`
+
+## Testing
+
+You'll need to install PhantomJS in order to run the headless browser tests.
+
+`brew install phantomjs`
+
+Also, if you'd like test coverage for Javascript you'll need to have Node and Istanbul installed. The easiest way to do this is installing Node via nvm and then use npm to install Istanbul like so:
+
+`npm install -g istanbul`
+
+## Utilities
+
+CI by [Travis](https://travis-ci.org/ministryofjustice/peoplefinder).
+
+Software metrics by [Code Climate](https://codeclimate.com/github/ministryofjustice/peoplefinder)
+
+## Releases
+
+Within the bin directory there is a file called release.sh. The purpose of this script is for management of releases i.e tagged versions compatible with Githubs release conventions.
+
+To create a new release:
+
+`bin/release.sh create`
+
+Listing all releases:
+
+`bin/release.sh list`
+
+Deleting a particular release:
+
+`bin/release.sh remove RELEASE_VERSION`
+
+Perform a git show of a release:
+
+`bin/release.sh show RELEASE_VERSION`
+
+List all releases with verbose output:
+
+`bin/release.sh ll`
+
+Last release:
+
+`bin/release.sh last`
+
+##Deployment
+
+For this example we're making the following assumptions:
+
+- You're using Heroku
+- You've setup staging and production environments as git remotes that we'll henceforth refer to as staging and production
+
+First if you don't already have a release, create a new one from the current branch:
+
+`bin/release.sh create`
+
+The name of the tagged released should be echoed back to the console. And will read back like release/ISO_DATE_TIME.
+Copy and past it as an argument together with '^{}:master' appended to the configured git remote of your choosing. For this example we'll use staging.
+
+`git push -f staging release/2014-08-08T08.59.09Z^{}:master`
+
+You should then see the standard git based deployment process for Heroku kick into action.
+
+It should be noted that depending on your circumstances e.g running migrations etc. You may want to run the following sequence of commands:
+
+`heroku maintenance:on` maintenance mode on
+
+`heroku ps:scale worker=0` scale down any background workers
+
+`git push -f staging release/2014-08-08T08.59.09Z^{}:master` push the code to heroku
+
+`heroku run rake db:migrate` run your migrations
+
+`heroku ps:scale worker=1` turn your workers back on
+
+`heroku maintenance:on` unleash the app to the world
+
+
+##SSL
+
+If you look in the .env.example you'll see a setting called SSL_ON which defaults to false. However the application is fully able to take advantage of
+SSL and by setting SSL_ON to true it will force the application to use SSL only which you'll definitely want for production.
+
+To do this on Heroku run:
+
+`heroku config:set SSL_ON=true`
+
+
+##Reminders
+
+If the Peoplefinder is to be successful, profiles need to be populated and maintained.
+
+###Inadequate profiles
+
+To view a list of people whose profiles are deemed to be 'inadequate' (not having a phone number, location and photo):
+
+`rake peoplefinder:inadequate_profiles`
+
+To send emails prompting people to complete their profiles:
+
+`rake peoplefinder:inadequate_profile_reminders`
+
+
+##Environment Variables
+
+###Support
+
+A support email address is set as SUPPORT_EMAIL.

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+load "jshint/tasks/jshint.rake"
+
+Peoplefinder::Engine.load_tasks
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/application.js

@@ -0,0 +1 @@
+//= require peoplefinder/application.js

data/app/assets/javascripts/peoplefinder/application.js

@@ -0,0 +1,17 @@
+// This is a manifest file that'll be compiled into application.js, which will
+// include all the files listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts,
+// vendor/assets/javascripts, or vendor/assets/javascripts of plugins, if any,
+// can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at
+// the bottom of the compiled file.
+//
+// Read Sprockets README
+// (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/peoplefinder/form_input_mapper.js

@@ -0,0 +1,15 @@
+/* global $ */
+
+function FormInputMapper(element) {
+  this._hiddenInput = $(element).find('input[type="hidden"]');
+  this.active = !!this._hiddenInput.length;
+}
+
+FormInputMapper.prototype.getId = function() {
+  return parseInt(this._hiddenInput.attr('value'), 10);
+};
+
+FormInputMapper.prototype.setId = function(id) {
+  if (!this.active) { return; }
+  this._hiddenInput.attr('value', id);
+};

data/app/assets/javascripts/peoplefinder/image_crop.js

@@ -0,0 +1,18 @@
+/* global $ */
+//= require Jcrop/js/jquery.Jcrop.min
+
+$(window).load(function(){
+  var stashCoords = function(coords) {
+    $('#person_crop_x').val(coords.x);
+    $('#person_crop_y').val(coords.y);
+    $('#person_crop_w').val(coords.w);
+    $('#person_crop_h').val(coords.h);
+  };
+
+  $('#croppable').Jcrop({
+    setSelect: [20, 20, 300, 300],
+    boxWidth:  ($(window).width()*0.80),
+    onSelect: stashCoords,
+    aspectRatio: 1
+  });
+});

data/app/assets/javascripts/peoplefinder/org_browser_controller.js

@@ -0,0 +1,58 @@
+/* global peoplefinderApp, OrgTree, FormInputMapper */
+//= require peoplefinder/peoplefinder_app
+//= require peoplefinder/org_tree
+//= require peoplefinder/form_input_mapper
+
+peoplefinderApp.controller('OrgBrowserCtrl', function($scope, $element, $http) {
+  var initialize = function() {
+    $scope.groups = [];
+    $scope.mapper = new FormInputMapper($element);
+    $scope.selectMode = $scope.mapper.active;
+    if ($scope.selectMode) { $scope.selectedId = $scope.mapper.getId(); }
+    $http.get('/org.json').success(jsonLoaded);
+  };
+
+  var jsonLoaded = function(tree) {
+    var current;
+    if ($scope.selectMode) {
+      current = parseInt($element.data('current-id'), 10);
+    }
+
+    var orgTree = new OrgTree(tree, current);
+    var path = orgTree.pathToNodeId($scope.selectedId);
+
+    path.forEach(function(group) { $scope.moveDown(group); });
+  };
+
+  $scope.moveDown = function(group) {
+    if (group.disabled) { return; }
+    if ($scope.isExpandable(group)) { $scope.groups.push(group); }
+    $scope.select(group);
+  };
+
+  $scope.moveUp = function(group) {
+    if (group.disabled) { return; }
+    while ($scope.current !== group) { $scope.groups.pop(); }
+    $scope.select(group);
+  };
+
+  $scope.isExpandable = function(group) {
+    return !!group.children.length;
+  };
+
+  $scope.isSelected = function(group) {
+    return group.id === $scope.selectedId;
+  };
+
+  $scope.select = function(group) {
+    $scope.selectedId = group.id;
+    $scope.mapper.setId(group.id);
+  };
+
+  Object.defineProperty(
+    $scope, 'current',
+    { get: function() { return $scope.groups[$scope.groups.length - 1]; } }
+  );
+
+  initialize();
+});

data/app/assets/javascripts/peoplefinder/org_tree.js

@@ -0,0 +1,37 @@
+function OrgTree(tree, currentNodeId) {
+  this.tree = this.augmentTree(tree, currentNodeId, false);
+}
+
+OrgTree.prototype.augmentTree = function(node, currentNodeId, disabled) {
+  var self = this;
+
+  if (node.id === currentNodeId) { disabled = true; }
+
+  return {
+    id: node.id,
+    name: node.name,
+    url: node.url,
+    disabled: disabled,
+    children: node.children.map(function(child) {
+      return self.augmentTree(child, currentNodeId, disabled);
+    })
+  };
+};
+
+OrgTree.prototype.pathToNodeId = function(id, node, path) {
+  var self = this;
+
+  node = node || self.tree;
+  path = path || [node];
+
+  if (!id) { return [self.tree]; }
+  if (node.id === id) { return path; }
+
+  for (var i = 0, ii = node.children.length; i < ii; i++) {
+    var child = node.children[i];
+    var res = self.pathToNodeId(id, child, path.concat(child));
+    if (res) { return res; }
+  }
+
+  return null;
+};