device_tracker 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d723cc5a90dabf8893383431a55eadc23c59414
+  data.tar.gz: 7e9d8ed84ab3d673f621b1ff3af1fd21df0eed34
+SHA512:
+  metadata.gz: 5eff08a5da86eb468b2f88698ee2abdb20c27f2577fd0223211a292121440888272bed0ec12c03af5bb4019b052695c55b846c9e4ba8ae10a41fb7145347eced
+  data.tar.gz: 68c74502043868dd62ccdcb41cd216d44c6e3918107fb4565f55c6f6c05516ab47c61acc0398f7a2a4a10ac24e77101be6c718dbddf787a9555e988ccaf2f7f1

data/.gitignore

@@ -0,0 +1,17 @@
+.idea/*
+*.sqlite3
+*.sqlite
+src/bin
+backup.sql
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+capybara-*
+development.json
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format NyanCatMusicFormatter

data/.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  Exclude:
+    - lib/db/schema.rb
+    - lib/device_tracker/db/**/*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in device_tracker.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :debug do
+  sh 'bundle exec exe/device_tracker'
+end

data/Readme.md

@@ -0,0 +1,32 @@
+[![Gem Version](https://badge.fury.io/rb/device-tracker.svg)](https://badge.fury.io/rb/device-tracker)
+# Device Tracker
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'device_tracker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install device_tracker
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bbc/device-tracker.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'device_tracker'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/device_tracker.gemspec

@@ -0,0 +1,63 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'device_tracker/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'device_tracker'
+  spec.version = DeviceTracker::VERSION
+  spec.authors = ['James Ruston', 'John Crossley']
+  spec.email = ['james.ruston@bbc.com', 'john.crossley@bbc.co.uk']
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.summary = 'A web app for managing mobile devices'
+  spec.description = <<-EOF
+    Keep track of your devices.
+    Features: - User registration/login/validation
+              - User levels (normal/admin)
+              - Checkout devices
+              - Return devices
+              - Assign devices to someone (Admin only)
+              - Validate a user (Admin only)
+              - Search devices
+              - Keep track of number of times devices used
+              - Manage OS versions
+              - Send reminders when devices have been out for period of time
+              - Password reset
+  EOF
+  spec.homepage = 'https://github.com/bbc/device-tracker'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'shotgun', '~> 0.9'
+  spec.add_development_dependency 'byebug', '~> 8.1'
+  spec.add_development_dependency 'nyan-cat-formatter'
+  spec.add_development_dependency 'capybara'
+  spec.add_development_dependency 'poltergeist'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'factory_girl'
+
+  spec.add_dependency 'sinatra', '~> 1.4'
+  spec.add_dependency 'activerecord', '~> 4.0'
+  spec.add_dependency 'sinatra-activerecord', '~> 2.0'
+  spec.add_dependency 'bcrypt', '~> 3.1.7'
+  spec.add_dependency 'json', '~> 1.7'
+  spec.add_dependency 'sinatra-contrib', '~> 1.4'
+  spec.add_dependency 'sinatra-partial', '~> 0.4'
+  spec.add_dependency 'sinatra-flash', '~> 0.3'
+  spec.add_dependency 'thin', '~> 1.6'
+  spec.add_dependency 'rake', '~> 10.4'
+  spec.add_dependency 'sqlite3', '~> 1.3'
+  spec.add_dependency 'pony', '~> 1.11'
+  spec.add_dependency 'mysql2', '~> 0.3.20'
+  spec.add_dependency 'json-schema', '~> 2.5'
+  spec.add_dependency 'faker'
+end

data/exe/device_tracker

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+
+require 'device_tracker/device_tracker'
+require 'optparse'
+require 'json-schema'
+require 'json'
+
+config_path = './development.json'
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: device_tracker [configuration]'
+
+  opts.on('-c', '--config [PATH]', String, 'Path to the config file.') do |path|
+    puts path
+    config_path = path
+  end
+
+  begin
+    opts.parse! ARGV
+  rescue OptionParser::InvalidOption
+    puts 'Invalid options supplied, use `device_tracker -h` help.'
+  end
+end
+
+puts config_path
+
+unless File.exist?(config_path)
+  puts "File not found at #{File.expand_path(config_path)}"
+  exit 1
+end
+
+json = File.read(config_path)
+
+errors = JSON::Validator.fully_validate(
+  File.expand_path('../../lib/device_tracker/config-schema.json', __FILE__),
+  json
+)
+
+unless errors.empty?
+  puts errors
+  exit 1
+end
+
+config = JSON.parse(json)
+
+set :database, config['database']
+
+config['email'].symbolize_keys!
+pony_options = {}
+
+# HACK: This needs cleaning at some point
+config['email'].each do |key, value|
+  if key == :via
+    pony_options[key] = value.to_sym if key == :via
+  else
+    if key == :via_options
+      pony_options[key] = value.symbolize_keys!
+      pony_options[:via_options].each do |i_key, i_val|
+        if i_key == :authentication
+          pony_options[:via_options][i_key] = i_val.to_sym
+        else
+          pony_options[:via_options][i_key] = i_val
+        end
+      end
+    else
+      pony_options[key] = value
+    end
+  end
+end
+
+require_relative '../lib/device_tracker/dependencies'
+
+Pony.options = pony_options
+
+DeviceTracker::ApplicationController.set :session_secret,
+                                         config['session_secret']
+DeviceTracker::ApplicationController.set :google_maps_api_key,
+                                         config['google_maps_api_key']
+port = config['port'] || '3000'
+host = config['host'] || '127.0.0.1'
+
+ActiveRecord::Migrator.migrate(
+  File.expand_path('../../lib/device_tracker/db/migrate', __FILE__)
+)
+
+
+require_relative '../lib/device_tracker/db/seeds'
+
+DeviceTracker::Seed.seed(config['admin'])
+
+DeviceTracker.start(host, port)

data/lib/device_tracker/app.rb

@@ -0,0 +1,22 @@
+require_relative 'dependencies'
+require 'rack'
+
+module DeviceTracker
+  # :nodoc:
+  class App
+    def initialize
+      @app = Rack::Builder.new do
+        map('/heartbeats')    { run HeartbeatController }
+        map('/transactions')  { run TransactionsController }
+        map('/users')         { run UsersController }
+        map('/devices')       { run DevicesController }
+        map('/os')            { run OSController }
+        map('/')              { run ApplicationController }
+      end
+    end
+
+    def call(env)
+      @app.call(env)
+    end
+  end
+end

data/lib/device_tracker/config-schema.json

@@ -0,0 +1,111 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "http://jsonschema.net",
+  "type": "object",
+  "properties": {
+    "database": {
+      "id": "http://jsonschema.net/database",
+      "type": "object",
+      "properties": {
+        "adapter": {
+          "id": "http://jsonschema.net/database/adapter",
+          "type": "string"
+        }
+      },
+      "required": [
+        "adapter"
+      ]
+    },
+    "email": {
+      "id": "http://jsonschema.net/email",
+      "type": "object",
+      "properties": {
+        "from": {
+          "id": "http://jsonschema.net/email/from",
+          "type": "string"
+        },
+        "via": {
+          "id": "http://jsonschema.net/email/via",
+          "type": "string"
+        },
+        "via_options": {
+          "id": "http://jsonschema.net/email/via_options",
+          "type": "object",
+          "properties": {
+            "address": {
+              "id": "http://jsonschema.net/email/via_options/address",
+              "type": "string"
+            },
+            "port": {
+              "id": "http://jsonschema.net/email/via_options/port",
+              "type": "string"
+            },
+            "enable_starttls_auto": {
+              "id": "http://jsonschema.net/email/via_options/enable_starttls_auto",
+              "type": "boolean"
+            },
+            "user_name": {
+              "id": "http://jsonschema.net/email/via_options/user_name",
+              "type": "string"
+            },
+            "password": {
+              "id": "http://jsonschema.net/email/via_options/password",
+              "type": "string"
+            },
+            "authentication": {
+              "id": "http://jsonschema.net/email/via_options/authentication",
+              "type": "string"
+            },
+            "domain": {
+              "id": "http://jsonschema.net/email/via_options/domain",
+              "type": "string"
+            }
+          }
+        }
+      }
+    },
+    "session_secret": {
+      "id": "http://jsonschema.net/session_secret",
+      "type": "string"
+    },
+    "google_maps_api_key": {
+      "id": "http://jsonschema.net/google_maps_api_key",
+      "type": "string"
+    },
+    "host": {
+      "id": "http://jsonschema.net/host",
+      "type": "string"
+    },
+    "port": {
+      "id": "http://jsonschema.net/port",
+      "type": "string"
+    },
+    "admin": {
+      "id": "http://jsonschema.net/admin",
+      "type": "object",
+      "properties": {
+        "name": {
+          "id": "http://jsonschema.net/admin/name",
+          "type": "string"
+        },
+        "email": {
+          "id": "http://jsonschema.net/admin/email",
+          "type": "string"
+        },
+        "password": {
+          "id": "http://jsonschema.net/admin/password",
+          "type": "string"
+        }
+      }
+    }
+  },
+  "required": [
+    "database",
+    "email",
+    "session_secret",
+    "google_maps_api_key",
+    "host",
+    "port",
+    "admin"
+  ]
+}

data/lib/device_tracker/config.ru

@@ -0,0 +1,9 @@
+require './dependencies'
+
+# map the controllers to routes
+map('/heartbeats') { run HeartbeatController }
+map('/transactions') { run TransactionsController }
+map('/users') { run UsersController }
+map('/devices') { run DevicesController }
+map('/os') { run OSController }
+map('/') { run ApplicationController }

data/lib/device_tracker/controllers/application_controller.rb

@@ -0,0 +1,226 @@
+module DeviceTracker
+  # :nodoc:
+  class ApplicationController < Sinatra::Base
+    helpers ApplicationHelper
+    helpers UserHelper
+
+    register Sinatra::ActiveRecordExtension
+    register Sinatra::Partial
+    register Sinatra::Flash
+
+    enable :sessions
+    enable :partial_underscores
+
+    set :views, File.expand_path('../../views', __FILE__)
+    set :public_dir, File.expand_path('../../public', __FILE__)
+    set :partial_template_engine, :erb
+
+    set :email_path, File.expand_path('../../views/emails/', __FILE__)
+
+    use Rack::MethodOverride
+
+    configure :development do
+      require 'byebug'
+    end
+
+    configure :test do
+      set database: {
+        adapter: 'sqlite3',
+        database: File.expand_path('../../db/test.sqlite', __FILE__)
+      }
+    end
+
+    configure :production, :development do
+      enable :logging
+    end
+
+    not_found do
+      @administrators = User.where(is_verified: true, is_admin: true)
+      erb :"404"
+    end
+
+    get '/version' do
+      halt 200,
+           error: false,
+           version: DeviceTracker::VERSION
+    end
+
+    get '/' do
+      @devices = Device.where(available: false)
+                 .order(checked_out_since: :desc).limit(10)
+
+      erb :index, devices: @devices
+    end
+
+    get '/forgot-password' do
+      if !params[:user_id].nil? && !params[:password_reset].nil?
+
+        # Check to see if the user_id matches the password_reset
+
+        @user = User.where(id: params[:user_id],
+                           reset_code: params[:password_reset]).first
+
+        if @user.nil?
+          create_flash 'warning',
+                       ['Hmm, that\'s not right. Did you click a valid link?']
+          redirect '/'
+        end
+
+        # Reset that back
+        @user.reset_code = nil
+
+        @new_password = generate_activation_code 12
+
+        @user.password = @new_password
+
+        @user.save
+
+        body = ERB.new(
+          File.read(settings.email_path + '/new_password.erb')
+        ).result(binding)
+
+        send_email(
+          to: @user.email,
+          from: 'no-reply@device-tracker',
+          subject: 'New password | Device Tracker',
+          body: body
+        )
+
+        create_flash 'success',
+                     ["Your new password has been emailed to #{@user.email}"]
+        redirect '/login'
+
+      else
+        erb :forgot_password
+      end
+    end
+
+    put '/:device_id/found' do |device_id|
+      if Device.exists?(device_id)
+
+        user = logged_in_user
+
+        device = Device.find(device_id)
+        device.missing = false
+        device.save
+
+        report_transaction(
+          "#{user[:email]} reported #{device.full_name} as found",
+          Transaction.found, device
+        )
+
+        create_flash 'success',
+                     ['The device has been returned successfully!']
+        redirect back
+      else
+        fail Siatra::NotFound
+      end
+    end
+
+    put '/:device_id/missing' do |device_id|
+      if Device.exists?(device_id)
+
+        user = logged_in_user
+
+        device = Device.find(device_id)
+        device.missing = true
+        device.save
+
+        report_transaction(
+          "#{user[:email]} reported #{device.full_name} missing",
+          Transaction.missing,
+          device
+        )
+
+        create_flash 'success', ['The device has been reported missing!']
+        redirect back
+      else
+        fail Sinatra::NotFound
+      end
+    end
+
+    post '/forgot-password' do
+      # user = User.find(params[:email])
+      if User.exists?(email: params[:email])
+
+        # Generate a random string
+        random_string = generate_activation_code 24
+
+        @user = User.find_by_email(params[:email])
+        @user.reset_code = random_string
+        @user.save
+
+        @reset_url = request.url +
+                     "?user_id=#{@user.id}&password_reset=" + random_string
+
+        body = ERB.new(
+          File.read(settings.email_path + '/password_reset.erb')
+        ).result(binding)
+
+        # Email that user with the link
+        # /password-reset?user_id=1&reset_code=MWAZ9JT9WKRP7RPTF3RHEG9J
+        send_email(
+          to: @user.email,
+          from: 'no-reply@device-tracker',
+          subject: 'Password Reset | Device Tracker',
+          body: body
+        )
+
+        # Validate the link
+        # Send the user a new password
+
+        create_flash 'success',
+                     ["A password reset link has been sent to #{@user.email}"]
+        redirect back
+
+      else
+        create_flash 'warning',
+                     ["Sorry, but the email #{params[:email]} doesn't exist."]
+        redirect back
+      end
+    end
+
+    get '/logout' do
+      session[:user] = nil
+      redirect to('/')
+    end
+
+    get '/login' do
+      erb :login
+    end
+
+    post '/login' do
+      # Parse the form
+      email = params[:user][:email]
+      password = params[:user][:password]
+
+      if email.empty? || password.empty?
+        create_flash 'warning', ['Please supply a username and or password']
+        redirect back
+      end
+
+      flash[:email] = email
+
+      user = User.find_by_email(email)
+
+      if user.nil? || !user.authenticate(password)
+        flash_and_go_back 'warning',
+                          ['Invalid username and or password entered.']
+      end
+
+      unless user.is_verified
+        flash_and_go_back 'warning', ['Your account is waiting verification.']
+      end
+
+      session[:user] = {
+        id: user.id,
+        name: user.name,
+        email: user.email,
+        is_admin: user.is_admin,
+        is_verified: user.is_verified
+      }
+
+      redirect to("devices/users/#{session[:user][:id]}")
+    end
+  end
+end