device-tracker 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b7aa5c184e0fd1093576b5790a62ada3593fd65
-  data.tar.gz: 64894ad46f5bf3ee7e8e825fc731d464faa099b1
+  metadata.gz: 83f4b95d5d9d1f5c8204a70f048e888414ab3e9a
+  data.tar.gz: caa35c654efdd961f99ae2d290481e7077e26a77
 SHA512:
-  metadata.gz: e2f07af494decec02d8f0930346369f4be55e752d11c819bdabfaf3a2744086ab17e1daedb879e62c1de225f8a5bcc8f862ec93a3a517297b87ad32c660460d3
-  data.tar.gz: 5e79c8eecb4a83d0ea66fd87c969d654b710f1582546827a73b792224d26dba97cd95eb7905ef06fcdb0b1fa98f22cc2f64bedf6c3488af4e7d9b98a8e91b92b
+  metadata.gz: 69021e135d7479c49e8303d5ca15a8d37070044af39486931bad18b59afe9f49c94f18bb94c22cccb571f609e976d4fcdd136a456167efe2acefcc31906a1480
+  data.tar.gz: d34875d902978747356500b5e047505234931c66e84e90013feb196c58ab7ef089f33899180f138fa4d1578c32e1246acc83560fcee78b006c9ea5409e42be77

data/.gitignore

@@ -1,5 +1,6 @@
 .idea/*
 *.sqlite3
+*.sqlite
 src/bin
 backup.sql
 /.bundle/
@@ -11,4 +12,5 @@ backup.sql
 /pkg/
 /spec/reports/
 /tmp/
-
+capybara-*
+development.json

data/.rspec

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

data/Readme.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/device-tracker.svg)](https://badge.fury.io/rb/device-tracker)
 # Device Tracker
 
 ## Installation

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "device/tracker"
+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.

data/device-tracker.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'device/tracker/version'
+require 'device_tracker/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "device-tracker"
-  spec.version       = Device::Tracker::VERSION
+  spec.version       = DeviceTracker::VERSION
   spec.authors       = ["James Ruston", "John Crossley"]
   spec.email         = ["james.ruston@bbc.com", "john.crossley@bbc.co.uk"]
 
@@ -38,6 +38,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "tux", "~> 0.3"
   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"
@@ -53,4 +58,5 @@ Gem::Specification.new do |spec|
   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

@@ -1,13 +1,14 @@
 #!/usr/bin/env ruby
 
-require "device/tracker"
+require "device_tracker/device_tracker"
 require "optparse"
 require "json-schema"
 require "json"
 
 config_path = "./development.json"
+dummy_data = false
 
-opts = OptionParser.new do |opts|
+OptionParser.new do |opts|
   opts.banner = "Usage: device-tracker [configuration]"
 
   opts.separator ""
@@ -16,6 +17,10 @@ opts = OptionParser.new do |opts|
     config_path = path
   end
 
+  opts.on("-d", "--dummy", "run the application in dummy mode, with dummy data") do
+    dummy_data = true
+  end
+
   opts.parse! ARGV
 end
 
@@ -28,7 +33,7 @@ end
 
 json = File.read(config_path)
 
-errors = JSON::Validator.fully_validate(File.expand_path('../../lib/device/tracker/config-schema.json', __FILE__), json)
+errors = JSON::Validator.fully_validate(File.expand_path('../../lib/device_tracker/config-schema.json', __FILE__), json)
 
 unless errors.empty?
   puts errors
@@ -38,7 +43,36 @@ end
 config = JSON.parse(json)
 
 set :database, config["database"]
-Pony.options = config["email"]
+
+config["email"].symbolize_keys!
+pony_options = {}
+
+# TODO - CLEAN ME .. OMG, I KNOW
+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!
+
+      # Iterate via_options
+      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
+
+Pony.options = pony_options
+
 set :google_maps_api_key, config["google_maps_api_key"]
 port = config["port"] || "3000"
 host = config["host"] || "127.0.0.1"
@@ -46,10 +80,15 @@ name = config["admin"]["name"]
 password = config["admin"]["password"]
 email = config["admin"]["email"]
 
-ActiveRecord::Migrator.migrate(File.expand_path('../../lib/device/tracker/db/migrate', __FILE__))
+ActiveRecord::Migrator.migrate(File.expand_path('../../lib/device_tracker/db/migrate', __FILE__))
+
+require_relative '../lib/device_tracker/dependencies'
+require_relative '../lib/device_tracker/db/seeds'
 
-require_relative '../lib/device/tracker/dependencies'
-require_relative '../lib/device/tracker/db/seeds'
+DeviceTracker::Seed.seed(name: name, password: password, email: email)
+
+if dummy_data
+  DeviceTracker::Seed.seed_dummy_data
+end
 
-Device::Tracker::Seed.seed(name: name, password: password, email: email)
-Device::Tracker.start(host, port)
+DeviceTracker.start(host, port)

data/lib/device_tracker/app.rb

@@ -0,0 +1,21 @@
+require_relative 'dependencies'
+require 'rack'
+
+module DeviceTracker
+  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/controllers/application_controller.rb

@@ -0,0 +1,220 @@
+module DeviceTracker
+  class ApplicationController < Sinatra::Base
+    helpers ApplicationHelper
+
+    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 :session_secret, SECRET
+
+    use Rack::MethodOverride
+
+    EMAILS_PATH = File.expand_path('../../views/emails/', __FILE__)
+
+    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: $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? and !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", ["Sorry, but something went wrong. Did you click on the correct 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(EMAILS_PATH + "/new_password.erb")).result(binding)
+
+        begin
+          Pony.mail(
+            :to => @user.email,
+            :from => 'no-reply@device-tracker',
+            :subject => 'New password | Device Tracker',
+            :html_body => body
+          )
+        rescue Net::OpenTimeout => e
+          puts "ERROR: Error sending email"
+        end
+
+        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 = get_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", ["Yay.. The device has been returned successfully!"]
+        redirect back
+      else
+        raise Siatra::NotFound
+      end
+    end
+
+    put "/:device_id/missing" do |device_id|
+      if Device.exists?(device_id)
+
+        user = get_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", ["Oh no, the device has been reported missing!"]
+        redirect back
+      else
+        raise 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
+
+        @password_reset_url =  request.url + "?user_id=#{@user.id}&password_reset=#{random_string}"
+
+        body = ERB.new(File.read(EMAILS_PATH + "/password_reset.erb")).result(binding)
+
+        # Email that user with the link
+        # /password-reset?user_id=1&reset_code=MWAZ9JT9WKRP7RPTF3RHEG9J
+        begin
+          Pony.mail(
+            :to => @user.email,
+            :subject => 'Password Reset | Device Tracker',
+            :html_body => body
+          )
+        rescue Net::OpenTimeout => e
+          puts "ERROR: Error sending email"
+        end
+
+        # Validate the link
+          # Send the user a new password
+
+        create_flash "success", ["We have sent you a password reset link 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? or password.empty?
+        create_flash "warning", ["Please supply a username and or password"]
+        redirect back
+      end
+
+      flash[:email] = email
+
+      user = User.find_by_email(email)
+
+      unless user.is_verified
+        create_flash "warning", ["Your account is waiting verification."]
+        redirect back
+      end
+
+      if user.nil? or !user.authenticate(password)
+        create_flash "warning", ["You entered an invalid username and or password, please try again."]
+        redirect back
+      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

data/lib/device_tracker/controllers/devices_controller.rb

@@ -0,0 +1,313 @@
+require_relative 'application_controller'
+
+module DeviceTracker
+
+  class DevicesController < ApplicationController
+
+    before do
+      protected!
+    end
+
+    get "/new" do
+      perform_admin_check
+
+      @device = Device.new
+
+      @operating_systems = OperatingSystem.select(:name, :id).distinct.order(:name)
+
+      erb :"devices/new"
+    end
+
+    post "/create" do
+      perform_admin_check
+
+      attributes = {
+        unid: params[:device][:unid],
+        manufacturer: params[:device][:manufacturer],
+        device: params[:device][:device],
+        description: params[:device][:description],
+        imei: params[:device][:imei],
+        serial_number: params[:device][:serial_number],
+        operating_system_id: params[:device][:operating_system_id]
+      }
+
+      if params[:device][:sim_card]
+        attributes[:sim_card] = true
+      end
+
+      if params[:device][:debug_device]
+        attributes[:debug_device] = true
+      end
+
+      attributes.each do |key, value|
+        flash[key] = value
+      end
+
+      @device = Device.new(attributes)
+
+      if @device.valid?
+        @device.save
+        create_flash "success", ["Created new device #{@device.full_name}"]
+        redirect "/devices/#{@device.id}"
+      else
+        create_flash "warning", @device.errors.full_messages
+        redirect back
+      end
+    end
+
+    get "/" do
+      @title = "All Devices"
+
+      @devices = Device.all
+      @users   = User.all
+
+      @show_search = true
+
+      if params[:device_name] && ! params[:device_name].empty?
+        @show_search = false
+        @devices = @devices.where("device like ? or manufacturer like ?", "%#{params[:device_name]}%", "%#{params[:device_name]}%")
+      end
+
+      @devices = @devices.sort { |a, b|  a.full_name <=> b.full_name }
+
+      erb :"devices/index"
+    end
+
+    get "/checked-out" do
+      @devices = Device.where(available: false).order(checked_out_since: :desc)
+      @users   = User.all
+
+      if params[:device_name] && ! params[:device_name].empty?
+        @devices = @devices.where("description like ?", "%#{params[:device_name]}%")
+      end
+
+      @title = "Checked out Devices"
+
+      erb :"devices/index"
+    end
+
+    get "/:device_id" do |device_id|
+
+      unless Device.exists?(device_id)
+        raise Sinatra::NotFound
+      end
+
+      @users = User.where(is_verified: true).order(email: :desc)
+
+      @device = Device.find(device_id)
+
+      if @device.missing?
+        @last_checkout_transaction = Transaction
+          .where(transaction_type: 'CHECKOUT', device_id: @device.id)
+          .order(id: :desc).first
+      end
+
+      @transactions = @device.transactions.order(created_at: :desc).take(10)
+
+      @current_user = get_logged_in_user
+
+      erb :"devices/show"
+    end
+
+    put "/:device_id" do |device_id|
+      perform_admin_check
+
+      unless Device.exists?(device_id)
+        raise Sinatra::NotFound
+      end
+
+      params[:device].each do |key, value|
+        flash[key.to_sym] = value
+      end
+
+      @device = Device.find(device_id)
+      @device.update(params[:device])
+
+      if @device.save
+
+        create_flash "success", ["The device has been successfully updated."]
+        redirect "/devices/#{device_id}"
+      else
+        create_flash "warning", @device.errors.full_messages
+        redirect back
+      end
+
+    end
+
+    # devices/users/1
+    get "/users/:user_id" do |user_id|
+
+      user = get_logged_in_user
+
+      if user[:id] != user_id.to_i
+        create_flash "warning", ["You don't have permission to view this page."]
+        redirect back
+      end
+
+      unless User.exists?(user_id)
+        raise Sinatra::NotFound
+      end
+
+      # Get the user
+      @user = User.find(user_id)
+
+      @devices = @user.devices
+
+      erb :"devices/users", devices: @devices
+    end
+
+    put "/:device_id/return" do |device_id|
+
+      unid = device_id.upcase
+
+      if Device.exists?(unid: unid)
+        @device = Device.find_by_unid(unid)
+
+        user = @device.user
+
+        current_user = get_logged_in_user
+        if current_user[:id] == @device.user.id
+          report_transaction("#{user.email} returned #{@device.device}", Transaction.return, @device)
+        else
+          report_transaction("#{current_user[:email]} returned #{@device.device} on behalf of #{@device.user.email}", Transaction.return, @device)
+        end
+
+        @device.user = nil
+        @device.available = true
+        @device.checked_out_since = nil
+
+        @device.save
+
+        create_flash "success", ["The device has been successfully returned, thank you."]
+        redirect back
+      else
+        create_flash "warning", ["Device not found with id #{device_id}."]
+        redirect back
+      end
+    end
+
+    put "/:device_id/checkout" do |device_id|
+
+      unid = device_id.upcase
+
+      if Device.exists?(unid: unid)
+
+        @user = User.find(session[:user][:id])
+
+        device = Device.find_by_unid(unid)
+        device.user = @user
+
+        device.available = false
+        device.checked_out_since = Time.now.utc.iso8601
+
+        if device.save
+          report_transaction("#{@user.email} checked out #{device.device}.", Transaction.checkout, device)
+
+          create_flash "success", ["You have successfully checked out the device."]
+          redirect back
+
+        else
+          create_flash "warning", device.errors.full_messages
+          redirect back
+        end
+
+      end
+
+    end
+
+    # /devices/<%= @device.id %>/assign
+    put "/:device_id/assign" do |device_id|
+      perform_admin_check
+
+      if Device.exists?(device_id)
+
+        user_id = params[:user_id]
+
+        if user_id.nil?
+          create_flash "warning", ["You must select a user to assign the device to"]
+          redirect back
+        end
+
+        @current_user  = User.find(session[:user][:id])
+        if ! User.exists?(user_id)
+          create_flash "danger", ["User not found with id #{user_id}"]
+        end
+
+        @assigned_user = User.find(user_id)
+
+        device = Device.find(device_id)
+        device.user = @assigned_user
+
+        device.available = false
+        device.checked_out_since = Time.now.utc.iso8601
+
+        if device.save
+          report_transaction("#{@current_user.email} checked out #{device.device} on behalf of #{@assigned_user.email}", Transaction.checkout, device)
+        end
+
+        create_flash "success", ["You have successfully assigned out the device to #{@assigned_user.name}."]
+        redirect back
+
+      end
+    end
+
+    post "/:device_id/send_reminder" do |device_id|
+      perform_admin_check
+
+      if Device.exists?(device_id)
+
+        @device = Device.find(device_id)
+        @device_url = request.base_url + '/devices/' + device_id
+
+        body = ERB.new(File.read(EMAILS_PATH + "/reminder.erb")).result(binding)
+
+        begin
+          Pony.mail(
+            :to => [@device.user.email],
+            :from => 'no-reply@device-tracker',
+            :subject => 'Reminder | Device Tracker',
+            :html_body => body
+          )
+        rescue Net::OpenTimeout => e
+          puts "ERROR: Error sending email"
+        end
+
+        # Send email
+        create_flash "success", ["A reminder email has been sent out to #{@device.user.name}."]
+        redirect "/devices/#{device_id}"
+
+      else
+        # Feedback
+        create_flash "warning", ["Sorry but that device doesn't exists.."]
+        redirect "/devices/#{device_id}"
+      end
+
+    end
+
+    get "/:device_id/edit" do |device_id|
+      perform_admin_check
+
+      unless Device.exists?(device_id)
+        raise Sinatra::NotFound
+      end
+
+      @device = Device.find(device_id)
+      @operating_systems = OperatingSystem.select(:name, :id).distinct.order(:name)
+
+      erb :"devices/edit"
+    end
+
+    delete "/:device_id" do |device_id|
+      perform_admin_check
+
+      unless Device.exists?(device_id)
+        raise Sinatra::NotFound
+      end
+
+      @device = Device.find(device_id).destroy
+      create_flash "success", ["Deleted device #{@device.unid}"]
+      redirect "/devices"
+    end
+
+  end
+end