ubcbooker 0.2.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 053f9ad2f8d23269ce39d0c7e6cf53b51774d810
-  data.tar.gz: 79624f9a62de98c504efc5a53b96ee94da8ab41d
+  metadata.gz: d1e73b63f6a87178f231f0c23da7c8cccc7b2037
+  data.tar.gz: c1d507e4562bf8ce1da4dac8c09c5363a6c7d947
 SHA512:
-  metadata.gz: 8464319a1fbebeb17ae4c7e66ff9335cf2a3125bd5cfe81b8aec9eacafd93b40d8b14813dbec3258bce30601eb3f0d0984b8fe77dfdc202dacb206edd4bdcca6
-  data.tar.gz: 5990bc3fdb45c82be09c794b712e199701a8a13d427281b480c6ba94c2ba889c8cccd6d609dfdd1dba5e8787fdcbea232dbb823bcdfab5c3a1e2f9747c053ec5
+  metadata.gz: 3b840fbd221115e669777f7dd264bcf8ae2db82c492ba2711be026d2cbfc0aa650f1a6d4a9ba9742a216a7945ebd930075b4fb1ad2d563b1cd7ba75cc9018c23
+  data.tar.gz: 1f5a9abbdc2cd2a1ec6747d207207a8f318e142bc37abc3f959a5f4efef67c7ebfb667a342e4620b443e1e1460dc66d4c6441427beab508d82e606b52cce701c

data/README.md

@@ -49,7 +49,7 @@ ex. Book a room in CS from 11am to 1pm on March 5th with the name 'Study Group'
     $> ubcbooker -b cs -n 'Study Group' -d 03/05 -t 11:00-13:00
 ```
 
-Currently this app supports project rooms in cs (Commputer Science). Run `ubcbooker -l` to check the latest supported departments.
+Currently this app supports project rooms in cs (Computer Science). Run `ubcbooker -l` to check the latest supported departments.
 
 Feel free to send a PR that supports your department's rooms.
 
@@ -67,4 +67,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Ubcbooker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jumbosushi/ubcbooker/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Ubcbooker project’s codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jumbosushi/ubcbooker/blob/master/CODE_OF_CONDUCT.md).

data/lib/ubcbooker.rb

@@ -7,6 +7,17 @@ require "obscenity"
 require "io/console" # For handling password
 require "optparse"
 require "yaml"
+require "keyring"
+# Keyring dependencies
+# Keyring gem is currently unable to correcly detect the following downlaod
+# https://github.com/jheiss/keyring/blob/master/ext/mkrf_conf.rb#L26
+# http://en.wikibooks.org/wiki/Ruby_Programming/RubyGems#How_to_install_different_versions_of_gems_depending_on_which_version_of_ruby_the_installee_is_using
+case Gem::Platform.local.os
+  when "linux"
+    require "gir_ffi-gnome_keyring"
+  when "darwin"
+    require "ruby-keychain"
+end
 
 module Ubcbooker
   BOOKING_URL = {

data/lib/ubcbooker/cli.rb

@@ -130,11 +130,13 @@ module Ubcbooker
       ]
 
       @options = get_options
-      @config.ask if !@config.defined?
+      if !@config.defined? || @config.is_windows?
+        @config.ask
+      end
 
       @client = get_scraper(@options[:department],
-                            @config.account["username"],
-                            @config.account["password"])
+                            @config.get_username,
+                            @config.get_password)
       begin
         room_id = @client.book(@options)
         puts "Success! #{room_id} is booked".green

data/lib/ubcbooker/config.rb

@@ -2,13 +2,15 @@ module Ubcbooker
   class Config
     attr_accessor :account
 
+    # We use system keyring for storing cwl credentials
+    # https://askubuntu.com/questions/32164/what-does-a-keyring-do
+    #
+    # since the keyring gem doesn't suppot Windows, we ask for cred each time
+    # if the user is on OSX or Linux, username and password will be stored in keyring
     def initialize
-      @config_path = get_config_path
-      if !File.exist?(@config_path)
-        create_config_file(@config_path)
-      end
-
-      @account = YAML.load_file(@config_path)
+      @keyring = Keyring.new
+      @win_username = ""
+      @win_password = ""
     end
 
     def ask
@@ -17,24 +19,20 @@ module Ubcbooker
       print "Your CWL password: "
       # Hide the password input
       password = STDIN.noecho(&:gets).chomp
-      write(username, password)
+      save_credentials(username, password)
       puts
     end
 
-    def create_config_file(config_path)
-      File.open(config_path, "w") do |f|
-        f.write("---\nusername: sample\npassword: sample")
+    def save_credentials(username, password)
+      if is_windows?
+        @win_username = username
+        @win_pasword = password
+      else
+        @keyring.set_password("ubcbooker", "username", username)
+        @keyring.set_password("ubcbooker", "password", password)
       end
     end
 
-    def write(username, password)
-      @account["username"] = username
-      @account["password"] = password
-      new_yml = YAML.dump(@account)
-      open(@config_path, "w") { |f| f.write(new_yml) }
-      @account = YAML.load_file(@config_path)
-    end
-
     def print_supported_departments
       puts "Supported department options in #{Ubcbooker::VERSION}:"
       BOOKING_URL.keys.each do |d|
@@ -42,18 +40,41 @@ module Ubcbooker
       end
     end
 
-    def get_config_path
-      if ENV['RACK_ENV'] == 'test'
-        File.expand_path("../config.yml", __FILE__)
+    # True if user is on windows platform
+    def is_windows?
+      return Gem.win_platform?
+    end
+
+    # Delete stored user credentials
+    # Used in specs
+    def delete_credentials
+      if is_windows?
+        @win_username = ""
+        @win_password = ""
+      else
+        @keyring.delete_password("ubcbooker", "username")
+        @keyring.delete_password("ubcbooker", "password")
+      end
+    end
+
+    def get_username
+      if is_windows?
+        return @win_username
+      else
+        return @keyring.get_password("ubcbooker", "username")
+      end
+    end
+
+    def get_password
+      if is_windows?
+        return @win_pasword
       else
-        File.expand_path("../../../spec/config.yml", __FILE__)
+        return @keyring.get_password("ubcbooker", "password")
       end
     end
 
     def defined?
-      return File.exist?(@config_path) &&
-             @account["username"] != "sample" &&
-             @account["password"] != "sample"
+      return !!(get_username && get_password)
     end
   end
 end

data/lib/ubcbooker/version.rb

@@ -1,3 +1,3 @@
 module Ubcbooker
-  VERSION = "0.2.3"
+  VERSION = "1.0.0"
 end

data/ubcbooker.gemspec

@@ -24,6 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "typhoeus", "~> 1.1"
   spec.add_dependency "obscenity", "~> 1.0.2"
   spec.add_dependency "tty-spinner", "~> 0.7.0"
+  spec.add_dependency "keyring", "~> 0.4.1"
+  spec.add_dependency "gir_ffi-gnome_keyring", "~> 0.0.3"
+  spec.add_dependency "ruby-keychain", "~> 0.3.2"
 
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ubcbooker
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Atsushi Yamamoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-18 00:00:00.000000000 Z
+date: 2018-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -80,6 +80,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: keyring
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: gir_ffi-gnome_keyring
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: ruby-keychain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -175,7 +217,6 @@ files:
 - lib/ubcbooker/color.rb
 - lib/ubcbooker/config.rb
 - lib/ubcbooker/error.rb
-- lib/ubcbooker/sample.yml
 - lib/ubcbooker/scrapers/base_scraper.rb
 - lib/ubcbooker/scrapers/cs.rb
 - lib/ubcbooker/scrapers/scraper.rb

data/lib/ubcbooker/sample.yml

@@ -1,3 +0,0 @@
----
-username: sample
-password: sample