rescuetime 0.3.3 → 0.4.0

data/lib/rescuetime/client.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'rescuetime/core_extensions/string'
 require 'rescuetime/query_buildable'
 
 require 'rescuetime/requester'
@@ -61,7 +64,8 @@ module Rescuetime
     #
     # @return [Boolean]
     def api_key?
-      present? api_key
+      key = CoreExtensions::String.new api_key.to_s
+      key.present?
     end
 
     # Returns true if the provided api key is valid. Performs a request to the
@@ -87,22 +91,14 @@ module Rescuetime
     def valid_credentials?
       return false unless api_key?
       !activities.all.nil?
-    rescue Rescuetime::InvalidCredentialsError
+    rescue Rescuetime::Errors::InvalidCredentialsError
       false
     end
 
     private
 
-    # Returns true if the project is present and non-blank
+    # Client-specific request parameters
     #
-    # @param  [#emtpy?] obj
-    # @return [Boolean]
-    # @since  v0.3.2
-    def present?(obj)
-      blank = obj.respond_to?(:empty?) ? obj.empty? : obj.nil?
-      !blank
-    end
-
     # @return [Hash]
     def state
       { key: api_key }

data/lib/rescuetime/collection.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'csv'
 
 require 'rescuetime/query_buildable'
+require 'rescuetime/report_formatters'
 
 module Rescuetime
   # Represents a potential rescuetime collection. It holds the query information
@@ -10,7 +13,7 @@ module Rescuetime
     include Enumerable
 
     # Rescuetime Analytics API endpoint
-    HOST = 'https://www.rescuetime.com/anapi/data'
+    HOST = 'https://www.rescuetime.com/anapi/data'.freeze
 
     # Returns a new Rescuetime collection. Default format is array.
     #
@@ -49,16 +52,19 @@ module Rescuetime
     # @see #all
     # @see http://ruby-doc.org/core/Enumerable.html Enumerable
     def each(&block)
-      all.each &block
+      all.each(&block)
     end
 
+    # Sets the report format to a valid type
+    #
     # @param  [#to_s] format  desired report format (one of 'array' or 'csv')
     # @return [Rescuetime::Collection]
     #
-    # @todo: make chainable to the client
+    # TODO: make chainable to the client
     def format(format)
+      # Guard: fail if the passed format isn't on the whitelist
       format = format.to_s
-      fail InvalidFormatError unless %w(array csv).include? format
+      formatters.all.include?(format) || raise(Errors::InvalidFormatError)
 
       @format = format
       self
@@ -69,6 +75,19 @@ module Rescuetime
     # Stores the query parameters to be set to the rescuetime host
     attr_reader :params
 
+    # Returns a new collection of available report formatters (using the
+    # Rescuetime::ReportFormatters class)
+    #
+    # @param  [Class] formatter_collection  defaults to
+    #                                       Rescuetime::ReportFormatters
+    # @return [Rescuetime::ReportFormatter]
+    # @since v0.4.0
+    def formatters(formatter_collection: Rescuetime::ReportFormatters)
+      @formatters ||= formatter_collection.new
+    end
+
+    # Parses a response from the string response body to the desired format.
+    #
     # @param [String] body response body
     # @return [Array, CSV]
     def parse_response(body)
@@ -77,12 +96,10 @@ module Rescuetime
                        header_converters: :symbol,
                        converters: :all)
 
-      case @format.intern
-      when :array then report.to_a.map(&:to_hash)
-      when :csv   then report
-      else
-        fail InvalidFormatError
-      end
+      format           = @format.to_s.downcase
+      report_formatter = formatters.find(format)
+
+      report_formatter.format report
     end
   end
 end

data/lib/rescuetime/configuration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Rescuetime
+  # Represents a set of Rescuetime configuration settings
+  #
+  # @since v0.4.0
+  class Configuration
+    # Contains user-specified formatter paths. Defaults to [] when a new
+    # configuration is created.
+    #
+    # @see Rescuetime.configure
+    attr_accessor :formatter_paths
+
+    # Creates a new Rescuetime configuration, defaulting to no formatter paths
+    #
+    # @return [Rescuetime::Configuration]  a new rescuetime configuration
+    # @see Rescuetime.configure
+    def initialize
+      @formatter_paths = []
+    end
+  end
+end

data/lib/rescuetime/core_extensions.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Rescuetime
+  # Contains extensions to the core classes
+  # @since v0.4.0
+  module CoreExtensions
+  end
+end

data/lib/rescuetime/core_extensions/object.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Rescuetime::CoreExtensions
+  # Contains extensions to the Object class
+  # @since v0.4.0
+  module Object
+  end
+end

data/lib/rescuetime/core_extensions/object/blank.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Rescuetime::CoreExtensions
+  module Object
+    # Includes methods that check the presence or blankness of an object.
+    # @since v0.4.0
+    module Blank
+      # Returns true if the associated object is empty or falsey. Based on
+      # Rails' ActiveSupport method Object#blank?
+      #
+      # @example
+      #   module Rescuetime
+      #     # ...
+      #
+      #     def format(report)
+      #       # Guard: report presence
+      #       report.extend CoreExtensions::Object::Blank
+      #       report.blank? && return false
+      #       # ...
+      #     end
+      #   end
+      #
+      # @return [Boolean]  true if the object is empty or falsey
+      # @see #present?
+      def blank?
+        respond_to?(:empty?) ? !!empty? : !self
+      end
+
+      # Returns true if an object is truthy and is not empty (is not blank).
+      # Based on Rails' ActiveSupport method Object#present?
+      #
+      # @example
+      #   module Rescuetime
+      #     # ...
+      #
+      #     def api_key?
+      #       api_key.extend CoreExtensions::Object::Blank
+      #       api_key.present?
+      #     end
+      #   end
+      #
+      # @return [Boolean]  true if the object is not blank
+      # @see #blank?
+      def present?
+        !blank?
+      end
+    end
+  end
+end

data/lib/rescuetime/core_extensions/string.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rescuetime/core_extensions/object/blank'
+
+module Rescuetime::CoreExtensions
+  # Represents an exteded Rescuetime::String object
+  class String < ::String
+    include Object::Blank
+  end
+end

data/lib/rescuetime/date_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rescuetime
   # Responsible for formatting user-inputted dates into proper Rescuetime format
   # @since v0.3.2
@@ -7,9 +9,9 @@ module Rescuetime
     DATE_FORMATS = {
       'yyyy-mm-dd'                => /\d{4}-\d{2}-\d{2}/,
       'yyyy/mm/dd'                => %r{\d{4}\/\d{2}\/\d{2}},
-      'mm-dd-yyyy or mm/dd/yyyy'  => %r{\d{2}[-\/]\d{2}[-\/]\d{4}/},
+      'mm-dd-yyyy or mm/dd/yyyy'  => %r{\d{2}[-\/]\d{2}[-\/]\d{4}},
       'mm-dd or mm/dd'            => %r{\d{2}[-\/]\d{2}}
-    }
+    }.freeze
 
     class << self
       # Returns a date as a string in the correct Rescuetime API format
@@ -35,13 +37,13 @@ module Rescuetime
       #   #=> '2015-12-25'
       #
       #   parser.parse 'Dec. 25, 2015'
-      #   #=> Rescuetime::InvalidQueryError: Invalid date entered. Please
+      #   #=> Rescuetime::Errors::InvalidQueryError: Invalid date entered. Please
       #   #                                  see docs for allowed formats.
       #
       # @param  [#strftime, String] date  a date to be formatted
       # @return [String]                  a date string in the YYYY-MM-DD format
       #
-      # @raise [Rescuetime::InvalidQueryError] if the date format is invalid
+      # @raise [Rescuetime::Errors::InvalidQueryError] if the date format is invalid
       def parse(date)
         if date.respond_to? :strftime
           date.strftime '%Y-%m-%d'
@@ -58,11 +60,11 @@ module Rescuetime
       # @param  [Hash]   formatted_as  A hash of date formats and patterns
       # @return [String] a string date in YYYY-MM-DD format
       #
-      # @raise [Rescuetime::InvalidQueryError] if the date format is invalid
+      # @raise [Rescuetime::Errors::InvalidQueryError] if the date format is invalid
       def reformat_string(date, formatted_as: DATE_FORMATS)
         case date
         when formatted_as['yyyy-mm-dd']  then date
-        when formatted_as['yyyy/mm/dd']  then date.gsub '/', '-'
+        when formatted_as['yyyy/mm/dd']  then date.tr '/', '-'
         when formatted_as['mm-dd-yyyy or mm/dd/yyyy']
           month, day, year = date.scan(/\d+/)
           "#{year}-#{month}-#{day}"
@@ -75,11 +77,11 @@ module Rescuetime
         end
       end
 
-      # Raises Rescuetime::InvalidQueryError
-      # @raise [Rescuetime::InvalidQueryError]
-      def fail_date_format(exception: Rescuetime::InvalidQueryError)
+      # Raises Rescuetime::Errors::InvalidQueryError
+      # @raise [Rescuetime::Errors::InvalidQueryError]
+      def fail_date_format(exception: Rescuetime::Errors::InvalidQueryError)
         message = 'Invalid date entered. Please see docs for allowed formats.'
-        fail exception, message
+        raise exception, message
       end
     end
   end

data/lib/rescuetime/errors.rb

@@ -1,88 +1,94 @@
+# frozen_string_literal: true
+
 module Rescuetime
-  # Error class for rescuing all RescueTime errors
-  class Error < StandardError; end
+  # Contains all Rescuetime error classes
+  module Errors
+    # Error class for rescuing all RescueTime errors
+    class Error < StandardError; end
 
-  ##
-  # HTTP Errors
-  # ===========
-  # 4xx HTTP status code
-  class ClientError < Error; end
-  # HTTP status code 400
-  class BadRequest < ClientError; end
-  # HTTP status code 401
-  class Unauthorized < ClientError; end
-  # HTTP status code 403
-  class Forbidden < ClientError; end
-  # HTTP status code 404
-  class NotFound < ClientError; end
-  # HTTP status code 406
-  class NotAcceptable < ClientError; end
-  # HTTP status code 422
-  class UnprocessableEntity < ClientError; end
-  # HTTP status code 429
-  class TooManyRequests < ClientError; end
+    ##
+    # HTTP Errors
+    # ===========
+    # 4xx HTTP status code
+    class ClientError < Error; end
+    # HTTP status code 400
+    class BadRequest < ClientError; end
+    # HTTP status code 401
+    class Unauthorized < ClientError; end
+    # HTTP status code 403
+    class Forbidden < ClientError; end
+    # HTTP status code 404
+    class NotFound < ClientError; end
+    # HTTP status code 406
+    class NotAcceptable < ClientError; end
+    # HTTP status code 422
+    class UnprocessableEntity < ClientError; end
+    # HTTP status code 429
+    class TooManyRequests < ClientError; end
 
-  # 5xx HTTP status code
-  class ServerError < Error; end
-  # HTTP status code 500
-  class InternalServerError < ServerError; end
-  # HTTP status code 501
-  class NotImplemented < ServerError; end
-  # HTTP status code 502
-  class BadGateway < ServerError; end
-  # HTTP status code 503
-  class ServiceUnavailable < ServerError; end
-  # HTTP status code 504
-  class GatewayTimeout < ServerError; end
+    # 5xx HTTP status code
+    class ServerError < Error; end
+    # HTTP status code 500
+    class InternalServerError < ServerError; end
+    # HTTP status code 501
+    class NotImplemented < ServerError; end
+    # HTTP status code 502
+    class BadGateway < ServerError; end
+    # HTTP status code 503
+    class ServiceUnavailable < ServerError; end
+    # HTTP status code 504
+    class GatewayTimeout < ServerError; end
 
-  ##
-  # Custom Errors
-  # =============
+    ##
+    # Custom Errors
+    # =============
 
-  # Raised when a method requires credentials but none are provided
-  class MissingCredentialsError < Unauthorized
-    def initialize(msg = 'No API key provided. Please provide a valid key.')
-      super
+    # Raised when a method requires credentials but none are provided
+    class MissingCredentialsError < Unauthorized
+      def initialize(msg = 'No API key provided. Please provide a valid key.')
+        super
+      end
     end
-  end
 
-  # Raised when a method requires credentials but credentials are invalid
-  class InvalidCredentialsError < Unauthorized
-    def initialize(msg = 'API key is invalid. Please provide a valid key.')
-      super
+    # Raised when a method requires credentials but credentials are invalid
+    class InvalidCredentialsError < Unauthorized
+      def initialize(msg = 'API key is invalid. Please provide a valid key.')
+        super
+      end
     end
-  end
 
-  # Raised when a user-submitted query value is invalid
-  class InvalidQueryError < BadRequest
-    def initialize(msg = 'Likely a badly formatted or missing parameter')
-      super
+    # Raised when a user-submitted query value is invalid
+    class InvalidQueryError < BadRequest
+      def initialize(msg = 'Likely a badly formatted or missing parameter')
+        super
+      end
     end
-  end
 
-  # Raised when a user-submitted query value is invalid
-  class InvalidFormatError < Error
-    def initialize(msg = 'Invalid format. Please see docs for allowed formats.')
-      super
+    # Raised when a user-submitted query value is invalid
+    class InvalidFormatError < Error
+      def initialize(msg = 'Invalid format. Please see docs for allowed formats.')
+        super
+      end
     end
-  end
 
-  class Error
-    # Collection of possible return status codes and corresponding Rescuetime
-    # errors
-    CODES = {
-      400 => Rescuetime::BadRequest,
-      401 => Rescuetime::Unauthorized,
-      403 => Rescuetime::Forbidden,
-      404 => Rescuetime::NotFound,
-      406 => Rescuetime::NotAcceptable,
-      422 => Rescuetime::UnprocessableEntity,
-      429 => Rescuetime::TooManyRequests,
-      500 => Rescuetime::InternalServerError,
-      501 => Rescuetime::NotImplemented,
-      502 => Rescuetime::BadGateway,
-      503 => Rescuetime::ServiceUnavailable,
-      504 => Rescuetime::GatewayTimeout
-    }
+    # Error class for rescuing all RescueTime errors
+    class Error
+      # Collection of possible return status codes and corresponding Rescuetime
+      # errors
+      CODES = {
+        400 => Rescuetime::Errors::BadRequest,
+        401 => Rescuetime::Errors::Unauthorized,
+        403 => Rescuetime::Errors::Forbidden,
+        404 => Rescuetime::Errors::NotFound,
+        406 => Rescuetime::Errors::NotAcceptable,
+        422 => Rescuetime::Errors::UnprocessableEntity,
+        429 => Rescuetime::Errors::TooManyRequests,
+        500 => Rescuetime::Errors::InternalServerError,
+        501 => Rescuetime::Errors::NotImplemented,
+        502 => Rescuetime::Errors::BadGateway,
+        503 => Rescuetime::Errors::ServiceUnavailable,
+        504 => Rescuetime::Errors::GatewayTimeout
+      }.freeze
+    end
   end
 end