uq-libraries 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93aa6b64252c43c27fc73ca5861fc8206939fb71
+  data.tar.gz: aca350c261701f290810d6ae2fb477a5fe76b8d5
+SHA512:
+  metadata.gz: ef937106b27634536994bfb5cf911acf503d04e8f5efa9d8402231335ce99b702766919d5552231bcf372d88a31d2a375aa4c7f3b6a2a3e36945129aaec3d145
+  data.tar.gz: 846a0837ba8c43d7d0480554d7262ec578701636db0c4fd6b68e4199025330fd0fbf453e6308940b4f303277f0efe137ecf6fc9479297db4b6e412eb27691dc0

data/bin/uq-libraries

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require_relative '../lib/uq_libraries'
+
+UqLibraries::CLI.new.call
+
+get '/' do
+    uq-libraries = UqLibraries::CLI.new
+    return uq-libraries.call
+   end

data/config/environment.rb

@@ -0,0 +1,9 @@
+require 'pry'
+require 'nokogiri'
+require 'open-uri'
+require 'colorize'
+
+require_relative '../lib/uq_libraries/scraper'
+require_relative '../lib/uq_libraries/library'
+require_relative '../lib/uq_libraries/library_details'
+require_relative '../lib/uq_libraries/cli'

data/lib/uq_libraries.rb

@@ -0,0 +1,4 @@
+module UqLibraries
+end
+
+require_relative '../config/environment'

data/lib/uq_libraries/cli.rb

@@ -0,0 +1,85 @@
+class UqLibraries::CLI
+
+    def call
+        loading # Shows loading screen while waiting for libraries to be scraped
+
+        create_libraries # Creates library instances for each library hash
+
+        display_libraries # Iterates through all libraries and lists them with an index
+
+        run_gem # Takes the user input and calls methods depending on input
+    end
+
+    def loading # Shows loading screen while waiting for libraries to be scraped
+        puts "Loading...\n"
+    end
+
+    def display_libraries # Gets libraries from array and puts out their names preceded by their index starting at 1.
+        system "clear" or system "cls"
+        UqLibraries::Library.all.each.with_index(1) do |library, index|
+            puts "#{index}. #{library.name}: #{status(index)}"
+        end
+    end
+
+    def create_libraries # Creates library instances for each library hash
+        UqLibraries::Library.create_from_collection(UqLibraries::Scraper.scrape_main_page)
+    end
+
+    def status(index) # Helper method for #display_libraries. Shows status of library QUIET/NORMAL/BUSY
+        library = UqLibraries::Library.all[index - 1]
+
+        if library.total_available.to_i <= 0.3333333333 * library.total_out_of_available.to_i
+            "BUSY".colorize(:red)
+        elsif library.total_available.to_i > 0.3333333333 * library.total_out_of_available.to_i && library.total_available.to_i <= 0.666666666666 * library.total_out_of_available.to_i
+            "NORMAL".colorize(:yellow)
+        elsif library.total_available.to_i > 0.666666666666 * library.total_out_of_available.to_i
+            "QUIET".colorize(:green)
+        end
+    end
+
+    def run_gem # Takes the user input and calls methods depending on input
+            puts "\nEnter a number (1-9) to show more information about a library."
+            puts "Type `list` to see the library list again or type 'exit' to leave."
+            print "> "
+            input = gets.strip.downcase
+
+            if input.to_i.between?(1, 12)
+                system "clear" or system "cls"
+                puts "#{UqLibraries::Library.all[input.to_i - 1].name}"
+                puts "---------------------------------------------------".colorize(:blue)
+                more_info(input.to_i - 1)
+                puts "---------------------------------------------------".colorize(:blue)
+                run_gem
+            elsif input == "list"
+                system "clear" or system "cls"
+                display_libraries
+                run_gem
+            elsif input == "exit"
+                system "clear" or system "cls"
+                exit
+            else
+                system "clear" or system "cls"
+                puts "\nThat's not a library! Enter the index number of a library (1-9) or type 'list' for a list of libraries.".colorize(:red)
+                run_gem
+            end
+    end
+
+    def more_info(input) # Helper method for #run_gem. Displays more information on the library using the input provided by the user
+        details = UqLibraries::Library.all[input].details
+
+        details.each do |level|
+            if level[:available].to_i > 0.6666666666 * level[:out_of_available].to_i
+                print "QUIET: ".colorize(:green)
+                puts "#{level[:level]} has #{level[:available]} computers available out of #{level[:out_of_available]}".gsub("Entry ", "")
+
+            elsif level[:available].to_i > 0.3333333333 * level[:out_of_available].to_i && level[:available].to_i <= 0.666666666666 * level[:out_of_available].to_i
+                print "NORMAL: ".colorize(:yellow)
+                puts "#{level[:level]} has #{level[:available]} computers available out of #{level[:out_of_available]}".gsub("Entry ", "")
+
+            elsif level[:available].to_i <= 0.3333333333 * level[:out_of_available].to_i
+                print "BUSY: ".colorize(:red)
+                puts "#{level[:level]} has #{level[:available]} computers available out of #{level[:out_of_available]}".gsub("Entry ", "")
+            end
+        end
+    end
+end

data/lib/uq_libraries/library.rb

@@ -0,0 +1,22 @@
+class UqLibraries::Library
+    attr_accessor :name, :library_url, :total_available, :total_out_of_available, :details
+    @@all = []
+
+    def initialize(library_hash)
+        library_hash.each {|attribute, value| self.send("#{attribute}=", value)}
+        add_details
+        @@all << self
+    end
+
+    def self.create_from_collection(libraries_array) # Creates library instance from an array of hashes returned by Scraper#scrape_main_page
+        libraries_array.each {|i| self.new(i)}
+    end
+
+    def self.all # Getter method for @@all array. Returns all Library instances
+        @@all
+    end
+
+    def add_details # Sets library.details equal to an array of hashes containing different details for each level of the library
+        @details = UqLibraries::LibraryDetails.create_from_collection(UqLibraries::Scraper.scrape_details_page(@library_url))
+    end
+end

data/lib/uq_libraries/library_details.rb

@@ -0,0 +1,20 @@
+class UqLibraries::LibraryDetails
+    attr_accessor :level, :available, :out_of_available
+    @@all = []
+
+    def initialize(details_hash)
+        @level = details_hash[:level]
+        @available = details_hash[:available]
+        @out_of_available = details_hash[:out_of_available]
+
+        @@all << self
+    end
+
+    def self.create_from_collection(details_array) # Creates library_details instance from array of hashes returned by Scraper#scrape_details_page
+        details_array.each {|details_hash| self.new(details_hash)}
+    end
+
+    def self.all # Getter method for @@all array. Returns all LibraryDetails instances
+        @@all
+    end
+end

data/lib/uq_libraries/scraper.rb

@@ -0,0 +1,34 @@
+class UqLibraries::Scraper
+
+    @base_url = "https://www.library.uq.edu.au/uqlsm/" # URL without page
+    @main_page = "availablepcsembed.php" # Page to append to URL
+    @main_url = "#{@base_url}#{@main_page}" # Adds page and URL together
+    
+
+    def self.scrape_main_page # Scrapes the main libraries page for primary details
+        libraries = []
+        frontpage = Nokogiri::HTML(open(@main_url))
+
+        frontpage.css(".chart tr").each do |row|
+            name = row.css("a[href]").text
+
+            total_available = row.css(".right").text.split(" ")[0]
+            out_of_available = row.css(".right").text.split(" ")[3]
+
+            library_page = row.css("a[href]")[0]["href"]
+            library_url = "#{@base_url}#{library_page}"
+
+            libraries << {name: name, total_available: total_available, total_out_of_available: out_of_available, library_url: library_url}
+        end
+        libraries
+    end
+
+    def self.scrape_details_page(library_url) # Scrapes library details page for secondary details
+        details_page = Nokogiri::HTML(open(library_url))
+
+        details_page.css("table.chart tr").collect do |level|
+            right = level.css(".right").text.split
+            {level: level.css(".left").text, available: right[0], out_of_available: right[3]}
+        end
+    end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: uq-libraries
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Hough
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Shows users how busy a selected UQ library is.
+email: matt@hough.tv
+executables:
+- uq-libraries
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/uq-libraries
+- config/environment.rb
+- lib/uq_libraries.rb
+- lib/uq_libraries/cli.rb
+- lib/uq_libraries/library.rb
+- lib/uq_libraries/library_details.rb
+- lib/uq_libraries/scraper.rb
+homepage: http://rubygems.org/gems/uq-libraries
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: How busy are UQ libraries?
+test_files: []