gas 0.1.7 → 0.1.8

data/lib/gas.rb

@@ -1,15 +1,21 @@
-GAS_DIRECTORY = File.expand_path('~/.gas')
-SSH_DIRECTORY = File.expand_path('~/.ssh')
+require 'rbconfig'
+
+GAS_DIRECTORY = "#{ENV['HOME']}/.gas" # File.expand_path('~/.gas')
+SSH_DIRECTORY = "#{ENV['HOME']}/.ssh" # File.expand_path('~/.ssh')
 GITHUB_SERVER = 'api.github.com'
+IS_WINDOWS = (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
 
 
 require 'sshkey' #external
 
 require 'gas/version'
+require 'gas/prompter'
 require 'gas/ssh'
 require 'gas/user'
 require 'gas/config'
 require 'gas/gitconfig'
+require 'gas/settings'
+require 'gas/github_speaker'
 
 
 module Gas
@@ -24,8 +30,6 @@ module Gas
     puts
     puts @config
     puts
-
-    # self.show  # XXX: get rid of
   end
 
   # Shows the current user
@@ -43,11 +47,11 @@ module Gas
   # Sets _nickname_ as current user
   # @param [String] nickname The nickname to use
   def self.use(nickname)
-    self.no_user? nickname
+    return false unless self.no_user?(nickname)
     user = @config[nickname]
-    
+
     @gitconfig.change_user user        # daring change made here!  Heads up Walle
-    
+
     self.show
   end
 
@@ -55,21 +59,21 @@ module Gas
   # @param [String] nickname The nickname of the author
   # @param [String] name The name of the author
   # @param [String] email The email of the author
-  def self.add(nickname, name, email)
+  def self.add(nickname, name, email, github_speaker = nil)
     return false if self.has_user?(nickname)
     user = User.new name, email, nickname
     @config.add user
     @config.save!
-    
+
     using_ssh = Ssh.setup_ssh_keys user
     
-    Ssh.upload_public_key_to_github(user) if using_ssh
-    
+    Ssh.upload_public_key_to_github(user, github_speaker) if using_ssh
+
     puts 'Added new author'
     puts user
   end
-  
-  
+
+
   # Adds an ssh key for the specified user
   def self.ssh(nickname)
     if nickname.nil?
@@ -89,26 +93,26 @@ module Gas
       puts "The ssh feature of gas offers you and the world ease of use, and even marginally enhanced privacy against corporate databases.  Did you know that IBM built one of the first automated database systems?  These ancient database machines (called tabulators) were used to facilitate the holocaust =("
     else
       user = @config[nickname]
-      
-      
+
+
       # Prompt Remake this user's ssh keys?
-      
+
       # check for ssh keys
       if !Ssh.corresponding_rsa_files_exist?(nickname)
         Ssh.setup_ssh_keys user
         Ssh.upload_public_key_to_github user
-      else  
+      else
         Ssh.setup_ssh_keys user
         Ssh.upload_public_key_to_github user
       end
     end
   end
-  
+
 
   # Imports current user from .gitconfig to .gas
   # @param [String] nickname The nickname to give to the new user
   def self.import(nickname)
-    self.has_user? nickname
+    return false if self.has_user?(nickname)
     user = @gitconfig.current_user
 
     if user
@@ -127,18 +131,13 @@ module Gas
   # Deletes an author from the config using nickname
   # @param [String] nickname The nickname of the author
   def self.delete(nickname)
-    
+
     return false unless self.no_user? nickname        # I re-engineered this section so I could use Gas.delete in a test even when that author didn't exist
-                                                      # TODO: The name no_user? is now very confusing.  It should be changed to something like "is_user?" now maybe?
-    
-    Ssh.delete nickname  # XXX: there are 2 calls to this in the method!  
-    
-    
-    # exit
+                                                      # TODO: The name no_user? is now very confusing.  It should be changed to something like "user_exists?" now maybe?
+    Ssh.delete nickname
+
     @config.delete nickname
     @config.save!
-    
-    #Ssh.delete nickname   # TODO: delete this duplicate after...
 
     puts "Deleted author #{nickname}"
     return true

data/lib/gas/config.rb

@@ -10,9 +10,9 @@ module Gas
     # then it creates the ~/.gas FOLDER and saves the old .gas file as ~/git.conf
     #
     def migrate_to_gas_dir!
-      old_config_file = File.expand_path('~/.gas')
-      config_dir = File.expand_path('~/.gas')
-      new_config_file = File.expand_path('~/.gas') + "/gas.authors"
+      old_config_file = GAS_DIRECTORY
+      config_dir = GAS_DIRECTORY
+      new_config_file = GAS_DIRECTORY + "/gas.authors"
 
       if File.file? old_config_file
         file = File.open(old_config_file, "rb")
@@ -35,8 +35,8 @@ module Gas
     # @param [String] config The override config
     def initialize(users = nil, config = nil)
       migrate_to_gas_dir! # Migrates old users to the new configuration file location, how thoughtful of me, I know
-      @config_file = File.expand_path('~/.gas/gas.authors')
-      @gas_dir = File.expand_path('~/.gas')
+      @config_file = "#{GAS_DIRECTORY}/gas.authors"
+      @gas_dir = GAS_DIRECTORY
       @config = ''
 
       if config.nil?

data/lib/gas/github_speaker.rb

@@ -0,0 +1,219 @@
+module Gas
+  # A beautiful class that makes working with the github API an enjoyable experience
+  class GithubSpeaker
+    attr_reader :user, :account_name, :password, :keys, :status
+    attr_accessor :server
+    
+    def keys
+      refresh_keys if @keys.nil?
+      @keys
+    end
+    
+    def initialize(user, account_name=nil, password=nil, server = 'api.github.com')
+      @user = user
+      @server = server
+      @keys = nil
+      
+      # sort out username and password...  Make it's own function?
+      if account_name.nil? and password.nil?
+        # Prompt for username and password
+        credentials = get_username_and_password_diligently
+        @account_name = credentials[:account_name]            # this overwrite happens twice to make testing easier...  Stub on get_username, kekeke
+        @password = credentials[:password]
+      else
+        @account_name = account_name
+        @password = password
+        authenticate
+      end
+      
+    end
+    
+    
+    def post_key!(rsa)
+      refresh_keys if @keys.nil? 
+      
+      puts "Posting key to GitHub.com..."
+  
+      #  find key...
+      if has_key(rsa)
+        puts "Key already installed."
+        return false
+      end      
+      title = "GAS: #{@user.nickname}"
+      result = install_key(rsa)
+      
+      if result != false
+        @keys << result
+        return true
+      end
+    end
+    
+    
+    def refresh_keys
+      raise "Attempted to update keys when unable to authenticate credentials with github" if @status != :authenticated
+      
+      path = '/user/keys'
+      
+      http = Net::HTTP.new(@server,443)
+      req = Net::HTTP::Get.new(path)
+      http.use_ssl = true
+      req.basic_auth @account_name, @password
+      response = http.request(req)
+      
+      @keys = JSON.parse(response.body)
+    end
+    
+    
+    # Cycles through github, looking to see if rsa exists as a public key, then deletes it if it does
+    def remove_key!(rsa)
+      refresh_keys
+      
+      # loop through arrays checking against 'key'
+      @keys.each do |key|
+        if key["key"] == rsa
+          return remove_key_by_id!(key["id"])
+        end
+      end
+      
+      return false   # key not found      
+    end
+    
+    
+    private
+      def authenticate
+        path = '/user'
+        
+        http = Net::HTTP.new(@server,443)
+        http.use_ssl = true
+        
+        req = Net::HTTP::Get.new(path)
+        req.basic_auth @account_name, @password
+        response = http.request(req)
+        
+        result = JSON.parse(response.body)["message"]
+        
+        if result == "Bad credentials"
+          @status = :bad_credentials
+          return false
+        else
+          @status = :authenticated
+          return true
+        end
+      end
+      
+      def get_username_and_password_and_authenticate
+        puts "Type your github.com user name:"
+        print "User: "
+        account_name = STDIN.gets.strip
+        
+        puts "Type your github password:"
+        password = ask("Password: ") { |q| q.echo = false }
+        puts
+        
+        credentials = {:account_name => account_name, :password => password}
+        #p credentials
+        @account_name = account_name
+        @password = password
+          
+        if authenticate
+          return credentials
+        else
+          return false
+        end
+      end
+      
+      # Get's the username and password from the user, then authenticates.  If it fails, it asks them if they'd like to try again.  
+      # Returns false if aborted
+      def get_username_and_password_diligently
+        while true
+          credentials = get_username_and_password_and_authenticate
+          if credentials == false
+            puts "Could not authenticate, try again?"
+            puts "y/n"
+            
+            again = STDIN.gets.strip
+            case again.downcase
+            when "y"
+            when "n"
+              return false
+            end
+          else
+            return credentials
+          end
+        end
+      end
+      
+      def install_key(rsa)
+        require "socket"
+        host_name = Socket.gethostname
+        
+        title = "GAS: #{@user.nickname} \-#{host_name}"
+        
+        path = '/user/keys'
+        
+        http = Net::HTTP.new(@server, 443)   # 443 for ssl
+        http.use_ssl = true
+        
+        req = Net::HTTP::Post.new(path)
+        req.basic_auth @account_name, @password
+        req.body = "{\"title\":\"#{title}\", \"key\":\"#{rsa}\"}"
+        
+        response = http.start {|m_http| m_http.request(req) }
+        the_code = response.code
+        
+        key_json = JSON.parse(response.body)
+        
+        return key_json if the_code == "201"
+                
+        puts "The key you are trying to use already exists in another github user's account.  You need to use another key." if the_code == "already_exists"
+        
+        # currently.. I think it always returns "already_exists" even if successful.  API bug.  
+        puts "Something may have gone wrong.  Either github changed their API, or your key couldn't be installed." if the_code != "already_exists"
+        
+        #return true if my_hash.key?("errors")   # this doesn't work due to it being a buggy API atm  # false  change me to false when they fix their API
+        puts "Server Response: #{response.body}"
+        return false
+      end
+      
+      # Cycles through github, looking to see if rsa exists as a public key, then deletes it if it does
+      def has_key(rsa)
+        refresh_keys if @keys.nil?
+        return false if @keys.empty?
+        
+        # loop through arrays checking against 'key'
+        @keys.each do |key|
+          return true if key["key"] == rsa
+        end
+  
+        return false   # key not found      
+      end
+      
+      def remove_key_by_id!(id)
+        path = "/user/keys/#{id}"
+        
+        http = Net::HTTP.new(@server,443)
+        http.use_ssl = true
+        req = Net::HTTP::Delete.new(path)
+        req.basic_auth @account_name, @password
+        
+        response = http.request(req)
+        
+        if response.body.nil?
+          #@keys = nil  # lame hack! sooo lazy of me.  I should learn how to remove the proper key from the @keys hash...
+          remove_key_from_keys id
+          return true
+        end
+      end
+      
+      
+      def remove_key_from_keys(id_to_delete)
+        @keys.each.with_index do |key, i|
+          @keys.delete_at(i) if key['id'].to_i == id_to_delete.to_i
+        end
+      end
+      
+      
+        
+    
+  end
+end

data/lib/gas/prompter.rb

@@ -0,0 +1,169 @@
+module Gas
+  module Prompter
+    @invalid_input_response_with_default = "Please use 'y' or 'n' or enter for default."
+    # If the user says 'f', the system will
+    #   report that there isn't an id_rsa already in gas.  This causes a new key to overwrite automatically down the road.
+    # This is for checking if a .gas/rsa file already exists for a nickname which is being registered
+    # If the rsa exists, then we're goona need to ask if we should use it, or if we should delete it
+    #
+    # Returns true to indicate that the user would like to use the rsa file already in .gas ()
+    # Returns false when there are no naming conflicts.
+    def self.user_wants_to_use_key_already_in_gas?(uid = '')
+      puts "Gas has detected a key in its archive directory ~/.gas/#{uid}_id_rsa.  Should gas use this key or overwrite this key with a brand new one?"
+      puts "Keep current key? [y/n]"
+
+      while true
+        keep_current_file = clean_gets
+
+        case keep_current_file
+
+        when "y"
+          return true # keep the files already in .gas, skip making key.
+        when "n"
+          return false
+        else
+          puts "please respond 'y' or 'n'"
+        end
+      end
+    end
+    
+    #  Checks if the ~/.ssh directroy contains id_rsa and id_rsa.pub
+    #  if it does, it asks the user if they would like to use that as their ssh key, instead of generating a new key pair.
+    #
+    def self.user_wants_to_use_key_already_in_ssh?
+      puts "Generate a brand new ssh key pair?  (Choose 'n' to use key in ~/.ssh/id_rsa)"
+      puts "Default: 'y'"
+      puts "[Y/n]"
+
+      while true
+        generate_new_rsa = clean_gets.downcase
+        case generate_new_rsa
+          when "y", ""
+            return false
+          when "n"
+            return true # return true if we aren't generating a new key
+          else
+            puts @invalid_input_response_with_default
+        end
+      end
+    end
+    
+    def self.user_wants_gas_to_handle_rsa_keys?
+      puts
+      puts "Do you want gas to handle switching rsa keys for this user?"
+      puts "[Y/n]"
+
+      while true
+        handle_rsa = clean_gets
+
+        case handle_rsa
+        when "y", ""
+          return true
+        when "n"
+          return false
+        else
+          puts "Please use 'y' or 'n'"
+        end
+      end
+    end
+    
+    def self.user_wants_to_remove_the_keys_that_already_exist_for_this_user?(uid)
+      puts
+      puts "Well... there's already a ~/.gas/#{uid}_id_rsa configured and ready to go.  Are you sure you don't want gas to handle rsa switching?  (Clicking no will delete the key from the gas directory)"
+      puts "Just let gas handle ssh key for this user? [y/n]"
+
+      while true
+        keep_file = clean_gets
+
+        case keep_file
+        when "n"
+          return true
+        when "y"
+          puts "Excelent!  Gas will handle rsa keys for this user."
+          return false
+        else
+          puts @invalid_input_response_with_default
+        end
+      end
+    end
+    
+    # This is another prompt function, but it returns a more complicated lexicon
+    #
+    # returns "a", "l", "g", or "n"
+    def self.user_wants_to_delete_all_ssh_data?
+      puts "Would you like to remove all of this user's ssh keys too!?!"  
+      puts "(github account keys can be removed as well!)"
+      puts
+      puts "a:  All, the local copy, and checks github too."
+      puts "l:  Remove local key only."
+      puts "g:  Removes key from github.com only."
+      puts "n:  Don't remove this user's keys."
+      puts "Default: l"
+
+      while true
+        delete_all_keys = clean_gets
+
+        case delete_all_keys.downcase
+        when "a"
+          return "a"
+        when "l", ""
+          return "l"
+        when "g"
+          return "g"
+        when "n"
+          return "n"
+        else
+          puts "please use 'a', 'l', 'g' or 'n' for NONE."
+        end
+      end
+    end
+    
+    def self.user_wants_to_install_key_to_github?
+      puts "Gas can automatically install this ssh key into the github account of your choice.  Would you like gas to do this for you?  (Requires inputting github username and password)"
+      puts "[Y/n]"
+
+      while true
+        upload_key = clean_gets.downcase
+        case upload_key
+        when "y", ""
+          return true
+        when "n"
+          return false
+        else
+          puts @invalid_input_response_with_default
+        end
+      end
+    end
+    
+    def self.user_wants_to_overwrite_existing_rsa_key?
+      puts "~/.ssh/id_rsa already exists.  Overwrite?"
+      puts "[y/n]"
+
+      while true
+        overwrite = clean_gets
+        case overwrite
+          when "y"
+            return true
+          when "n"
+            return false
+          else
+            puts "please respond 'y' or 'n'"
+        end
+      end
+    end
+    
+    # If the user hits ctrl+c with this, it will exit cleanly
+    def self.clean_gets
+      begin
+        getit = STDIN.gets.strip
+      rescue SystemExit, Interrupt           # catch if they hit ctrl+c
+        puts
+        puts "Safely aborting operation..."    # reassure user that ctrl+c is fine to use.  
+        exit
+      end
+      
+      return getit
+    end
+
+  end
+end