torque 0.0.1

data/lib/torque/date_settings.rb

@@ -0,0 +1,166 @@
+require_relative 'file_system'
+
+class Torque
+
+  ##
+  # Determines the date range for a release notes generation
+  class DateSettings
+
+    ##
+    # @param options A hash of the command line options used to run Torque
+    # @param last_run_path The path to the lastRun file
+    # @param fs An instance of the FileSystem class
+    def initialize(options, last_run_path, fs)
+      @options = options
+      @last_run_path = last_run_path
+      @fs = fs
+
+      @current_date = Date.today
+      @beginning_of_time = Date.new(1900, 1, 1)
+      @date_format = "%Y-%m-%d"
+    end
+
+    ##
+    # Generates the accept_from and accept_to dates if they don't already exist
+    #
+    # Returns [accept_from, accept_to]
+    def get_dates
+      generate_dates if !@accept_from || !@accept_to
+      return @accept_from, @accept_to
+    end
+
+    ##
+    # Returns true if the date range was set manually via command line, else false
+    def custom_date_range?
+      generate_dates if !@custom_date_range
+      return @custom_date_range
+    end
+    
+
+    private
+
+    # Generates values for @accept_from and @accept_to
+    # Returns [@accept_from, @accept_to]
+    def generate_dates
+      
+      # If custom date settings exist, takes dates from there
+      if @options[:accept_from] || @options[:accept_to]
+        get_dates_from_custom_range
+        @custom_date_range = true
+
+      # If not:
+      # @accept_to = today
+      # @accept_from is calculated from the dates of previous generations
+      else
+        get_dates_from_default
+        @custom_date_range = false 
+      end
+
+      return @accept_from, @accept_to
+
+    end
+
+    # Handles date values that were set manually in the environment 
+    # Returns [@accept_from, @accept_to]
+    def get_dates_from_custom_range
+      begin
+        @accept_from = Date.parse(@options[:accept_from].nil? ? "1900-01-01" : @options[:accept_from])
+      rescue ArgumentError
+        raise ArgumentError.new("Date #{@options[:accept_from]} could not be parsed")
+      end
+
+      begin
+        @accept_to = (@options[:accept_to].nil? ? @current_date : Date.parse(@options[:accept_to]))
+      rescue ArgumentError
+        raise ArgumentError.new("Date #{@options[:accept_to]} could not be parsed")
+      end
+
+      if @accept_from > @accept_to
+        raise ArgumentError.new("Date ACCEPT_FROM (#{@accept_from}) occurs after ACCEPT_TO (#{@accept_to})")
+      end
+
+      return @accept_from, @accept_to
+    end
+
+    # dates: An array of the dates contained by .lastRun
+    #
+    # Reads from the .last-run file for the project to figure out when notes were last generated
+    # Returns [@accept_from, @accept_to]
+    def get_dates_from_default
+
+      dates = update_last_run_file
+
+      @accept_to = @current_date
+      @accept_from = dates[1] || @beginning_of_time
+
+      return @accept_from, @accept_to
+    end
+
+    # Updates .last-run on the filesystem, returning the dates it contains after the update
+    def update_last_run_file
+
+      # Structure of last-run file:
+      # 
+      # <Most recent generation date>
+      # <Second most recent generation date>
+      
+      # Creates the .last-run if none exists
+      if !@fs.path_exist? @last_run_path
+        @fs.file_create(@last_run_path)
+      end
+
+      # Generates and writes the new file contents
+      new_file_str, dates = update_last_run_file_string(@fs.file_read(@last_run_path))
+      @fs.file_write(@last_run_path, new_file_str)
+
+      # Returns the new dates
+      dates
+
+    end
+
+    # Takes in a string with the contents of the last-run file, outputs a string with its new contents
+    def update_last_run_file_string(file_str)
+
+      # Parses the dates in .last-run
+      date_strings = []
+      file_str.each_line do |date_str|
+        date_strings << date_str
+      end
+      dates = date_strings.map do |date_str|
+        Date.strptime(date_str, @date_format)
+      end
+
+      #Generates new dates
+      new_dates = []
+            
+      if dates.length == 0
+        new_dates = [@current_date]
+      
+      elsif dates.length == 1
+        if dates[0] == @current_date
+          new_dates = [dates[0]]
+        else
+          new_dates = [@current_date, dates[0]]
+        end
+
+      else
+        if dates[0] == @current_date
+          new_dates = [dates[0], dates[1]]
+        else
+          new_dates = [@current_date, dates[0]]
+        end
+      end
+
+      # Generates a new file string
+      new_file_str = ""
+      new_dates.each do
+        |date|
+        new_file_str += "#{date.strftime(@date_format)}\n"
+      end
+
+      # Returns [new_file_str, new_dates]
+      return new_file_str, new_dates
+    end
+
+  end
+end

data/lib/torque/error/invalid_project_error.rb

@@ -0,0 +1,10 @@
+require_relative 'pivotal_api_error'
+
+class Torque
+
+  ##
+  # Error to be thrown if a Pivotal Tracker project ID is invalid
+  class InvalidProjectError < PivotalAPIError
+  end
+
+end

data/lib/torque/error/invalid_token_error.rb

@@ -0,0 +1,10 @@
+require_relative 'pivotal_api_error'
+
+class Torque
+
+  ##
+  # Error to be thrown if a Pivotal Tracker API token is invalid
+  class InvalidTokenError < PivotalAPIError
+  end
+
+end

data/lib/torque/error/missing_output_directory_error.rb

@@ -0,0 +1,7 @@
+class Torque
+
+  ##
+  # Error to throw if the output directory is missing
+  class MissingOutputDirectoryError < StandardError
+  end
+end

data/lib/torque/error/missing_project_error.rb

@@ -0,0 +1,8 @@
+class Torque
+  
+  ##
+  # Error to be thrown if a Pivotal Tracker project ID cannot be found
+  class MissingProjectError < StandardError
+  end
+
+end 

data/lib/torque/error/missing_token_error.rb

@@ -0,0 +1,8 @@
+class Torque
+  
+  ##
+  # Error to be thrown if a Pivotal Tracker API token cannot be found
+  class MissingTokenError < StandardError
+  end
+
+end 

data/lib/torque/error/missing_torque_info_file_error.rb

@@ -0,0 +1,8 @@
+class Torque
+
+  ##
+  # Error to be thrown if no .torqueinfo.yaml file can be found
+  class MissingTorqueInfoFileError < StandardError
+  end
+
+end

data/lib/torque/error/pivotal_api_error.rb

@@ -0,0 +1,8 @@
+class Torque
+
+  ##
+  # Catch-all class for errors when making requests to the Pivotal Tracker API
+  class PivotalAPIError < StandardError
+  end
+
+end

data/lib/torque/file_system.rb

@@ -0,0 +1,70 @@
+require 'fileutils'
+require 'pathname'
+
+class Torque
+
+  ##
+  # Creates a (limited) interface through which Torque can interact with the local file system
+  #
+  # Supports:
+  #
+  # * File creation, reading, line-by-line iteration, and overwriting
+  #
+  # * Directory creation
+  #
+  # * Pathname checking
+  #
+  class FileSystem
+
+    def initialize
+      # Do nothing. The file system's properties are automatically global
+    end
+
+    ##
+    # Creates a file, optionally overwriting an existing file to do so
+    def file_create(filename, over=false)
+      if !path_exist? filename || over
+        File.open(filename, "w")
+      else
+        raise IOError.new "File #{filename} already exists"
+      end
+    end
+
+    ##
+    # Returns an iterator over each line of a file
+    def file_each_line(filename)
+      File.open(filename, "r").each_line
+    end
+
+    ##
+    # Returns the contents of a file
+    def file_read(filename)
+      File.read(filename)
+    end
+
+    ##
+    # Writes a string to file
+    def file_write(filename, string)
+      File.write(filename, string)
+    end
+
+    ##
+    # Creates a directory
+    def mkdir(dirname)
+      FileUtils.mkdir(dirname)
+    end
+
+    ##
+    # Creates a directory, creating intermediate directories as needed
+    def mkdir_p(dirname)
+      FileUtils.mkdir_p(dirname)
+    end
+
+    ##
+    # Returns true if a pathname exists, else false
+    def path_exist?(pathname)
+      Pathname.new(pathname).exist?
+    end
+
+  end
+end

data/lib/torque/mailer.rb

@@ -0,0 +1,62 @@
+require 'mail'
+
+class Torque
+
+  ##
+  # Handles sending the finished release notes document to a list of emails after Torque generates it
+  class Mailer
+
+    ##
+    # @param email An email address
+    # @param password A password that matches the email address given
+    # 
+    # Creates a Mailer that will send emails from the email address/password combo given
+    def initialize(email, password)
+      @email = email
+      @password = password
+
+      options = { :address              => "smtp.gmail.com",
+                  :port                 => 587,
+                  :domain               => 'gmail.com',
+                  :user_name            => @email,
+                  :password             => @password,
+                  :authentication       => 'plain',
+                  :enable_starttls_auto => true }
+
+      Mail.defaults do
+        delivery_method :smtp, options
+      end
+    end
+
+    # ##
+    # # Returns true if the email and password combination is valid, else false
+    # def verify
+    # end
+
+    # @param notes_string The release notes file in string form
+    # @param subject_line The subject line to use in the email
+    # @param address_list A comma-separated list of email addresses to which to send the notes
+    # 
+    # Sends notes_string as an email with subject_line from an arbitrary email address to everyone on address_list
+    def send_notes(notes_string, subject_line, address_list)
+
+      mail = Mail::Message.new
+      
+      mail.charset = "UTF-8"
+      mail.to        address_list
+      mail.from      @email
+      mail.subject   subject_line
+      mail.body      notes_string
+      
+      begin
+        mail.deliver
+      rescue Net::SMTPAuthenticationError
+        # TODO Remove this output. Should fail silently and be replaced by an independent call to :verify 
+        puts "Username and password not accepted by Gmail. Check your username and password or try using a Gmail " \
+          "account"
+      end
+
+    end
+   
+  end
+end

data/lib/torque/pivotal.rb

@@ -0,0 +1,98 @@
+require 'net/http'
+require_relative 'error/invalid_project_error'
+require_relative 'error/invalid_token_error'
+require_relative 'error/pivotal_api_error'
+
+class Torque
+  class Pivotal
+
+    ##
+    # @param token A Pivotal Tracker api token
+    def initialize(token)
+      @token = token
+    end
+
+    ##
+    # Returns true if a connection to www.pivotaltracker.com exists, else false
+    def self.connection?
+      begin
+        TCPSocket.new "www.pivotaltracker.com", 80
+        true
+      rescue SocketError
+        false
+      end
+    end
+
+    ##
+    # Returns true if the token supplied is a valid token, else false
+    def check_token
+      begin
+        get_project_data
+        true
+      rescue InvalidTokenError
+        false
+      end
+    end
+
+    ##
+    # Sends a request through the Pivotal Tracker API
+    #
+    # Returns a string of html data from Pivotal Tracker with data on the stories for the given project
+    def get_project_stories(project)
+
+      # Polls story data from pivotal tracker
+      host="pivotaltracker.com"
+      port=80
+      url="http://www.pivotaltracker.com/services/v3/projects/#{project}/stories"
+      headers={'X-TrackerToken'=>@token}
+
+      response=Net::HTTP.new(host, port).get(url, headers)
+
+      # Handles network errors
+      if response.code == "401"
+        raise InvalidTokenError.new "The Pivotal Tracker API token supplied is not valid for project #{project}"
+
+      elsif response.code == "500"
+        raise InvalidProjectError.new "The Pivotal Tracker project ID supplied, #{project}, is invalid"
+
+      elsif response.code != "200"
+        raise PivotalAPIError.new(
+          "The Pivotal Tracker API responded with an unexpected error code: #{response.code}. Check your " \
+          + "project ID, API token, and/or internet connection"
+        )
+        
+      end
+
+      response.body
+    end
+
+    ##
+    # Sends a request through the Pivotal Tracker API
+    #
+    # Returns a string of html data from Pivotal Tracker with data on each of a user's projects
+    def get_project_data
+
+      host="pivotaltracker.com"
+      port=80
+      url="http://www.pivotaltracker.com/services/v3/projects"
+      headers={'X-TrackerToken'=>@token}
+
+      response=Net::HTTP.new(host, port).get(url, headers)
+
+      # Handles network errors
+      if response.code == "401"
+        raise InvalidTokenError.new "The Pivotal Tracker API token supplied is not valid"
+
+      elsif response.code != "200"
+        raise PivotalAPIError.new(
+          "The Pivotal Tracker API responded with an unexpected error code: #{response.code}. Check your " \
+            "API token, and/or internet connection"
+        )
+      end
+
+      response.body
+    end
+
+
+  end
+end