timber 2.0.24 → 2.1.0.rc1

data/bin/timber

@@ -2,12 +2,21 @@
 
 $LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
 require "timber/cli"
+require "timber/cli/io"
+require "timber/cli/io/messages"
 
 begin
   Timber::CLI.run
 rescue => e
   raise e if $DEBUG
-  STDERR.puts e.message
-  STDERR.puts e.backtrace.join("\n")
+
+  io = Timber::CLI::IO.new(io_out: STDERR)
+  io.puts ""
+  io.puts e.message, :red
+  io.puts ""
+  io.puts Timber::CLI::IO::Messages.separator
+  io.puts "Backtrace:"
+  io.puts ""
+  io.puts e.backtrace[0..25].join("\n")
   exit 1
 end

data/lib/timber.rb

@@ -1,14 +1,8 @@
-# core classes
-require "json" # brings to_json to the core classes
-
 # Base (must come first, order matters)
+require "timber/version"
 require "timber/overrides"
 require "timber/config"
-require "timber/context"
-require "timber/event"
-require "timber/integrator"
 require "timber/util"
-require "timber/version"
 
 # Other (sorted alphabetically)
 require "timber/contexts"
@@ -18,6 +12,7 @@ require "timber/log_devices"
 require "timber/log_entry"
 require "timber/logger"
 require "timber/integrations"
+require "timber/timer"
 
 # Load frameworks
 require "timber/frameworks"

data/lib/timber/cli.rb

@@ -1,14 +1,10 @@
 require "optparse"
 require "yaml"
-require "timber"
-
 
 require "timber/cli/api"
-require "timber/cli/application"
-require "timber/cli/io_helper"
-require "timber/cli/messages"
-
-require "timber/cli/install"
+require "timber/cli/installers"
+require "timber/cli/io"
+require "timber/version"
 
 module Timber
   # @private
@@ -19,27 +15,25 @@ module Timber
       attr_accessor :options
 
       def run(argv = ARGV)
-        @options = {}
         global = global_option_parser
-        commands = command_option_parser
         global.order!(argv)
         command = argv.shift
-        if command
-          if AVAILABLE_COMMANDS.include?(command)
-            commands[command].parse!(argv)
-            case command.to_sym
-            when :install
-              Timber::CLI::Install.run(argv.shift)
-            end
-          else
-            puts "Command '#{command}' does not exist, run timber -h to "\
-              "see the help"
-            exit(1)
-          end
-        else
+
+        case command
+        when nil
           # Print help
           puts global
           exit(0)
+
+        when "install"
+          api_key = argv.shift
+          io = IO.new
+          Installers.run(api_key, io)
+
+        else
+          puts "Command '#{command}' does not exist, run timber -h to "\
+            "see the help"
+          exit(1)
         end
       end
 
@@ -61,12 +55,6 @@ module Timber
           o.separator "Available commands: #{AVAILABLE_COMMANDS.join(", ")}"
         end
       end
-
-      def command_option_parser
-        {
-          "install" => OptionParser.new
-        }
-      end
     end
   end
 end

data/lib/timber/cli/api.rb

@@ -4,41 +4,96 @@ require "net/https"
 require "securerandom"
 require "uri"
 
+require "timber/cli/api/application"
+require "timber/cli/io/messages"
+require "timber/version"
+
 module Timber
   class CLI
+    # The API class provides an interface for all Timber API requests, parsing response
+    # and returning the appropriate objects.
     class API
+
+      # Raise when the API key provided is invalid.
       class APIKeyInvalidError < StandardError
         def message
-          "Uh oh! The API key supplied is invalid. Please ensure that you copied the" \
-            " key properly.\n\n#{Messages.obtain_key_instructions}"
+          "Uh oh! The API key supplied is invalid. Please ensure that you copied the \n" \
+            "key properly.\n\n#{IO::Messages.obtain_key_instructions}"
+        end
+      end
+
+      class LogsNotReceivedError< StandardError
+        def message
+          "Bummer, we couldn't confirm log delivery with the Timber API, something is off. " \
+            "If you email support@timber.io, we'll work with you to figure out what's going on. " \
+            "And as a thank you sticking with us, we'll set you up with a 25% indefinite discount."
         end
       end
 
-      class NoAPIKeyError < StandardError
+      # Raised when Timber is returning 500s
+      class ServerError < StandardError
         def message
-          "Uh oh! You didn't supply an API key.\n\n#{Messages.obtain_key_instructions}"
+          "Crap, it looks like the Timber API is returning 500s :/. In order to properly " \
+            "install Timber and test integration we need the Timber API to work correctly. " \
+            "Chances are we're aware of the issue and if you try again later the API should " \
+            "be working. \n\n" \
+            "Status updates: http://status.timber.io \n" \
+            "Yell at us via email: support@timber.io \n"
         end
       end
 
-      TIMBER_API_URI = URI.parse('https://api.timber.io')
+      # Raised when the API returns a response that a particular method is not expecting.
+      class UnrecognizedAPIResponse < StandardError
+        def initialize(res)
+          @res = res
+        end
+
+        def message
+          "Uh oh, we received a response from the Timber API that was not recognized " \
+            "(#{res.code}). We've been notified of the issue, but please feel free to " \
+            "yell at us via email to make sure we're aware: support@timber.io"
+        end
+      end
+
+      TIMBER_PRODUCTION_API_URL = "https://api.timber.io".freeze
+      TIMBER_STAGING_API_URL = "https://api.timber-staging.io".freeze
+      TIMBER_API_URL = ENV['TIMBER_STAGING'] ? TIMBER_STAGING_API_URL : TIMBER_PRODUCTION_API_URL
+      TIMBER_API_URI = URI.parse(TIMBER_API_URL)
       APPLICATION_PATH = "/installer/application".freeze
       EVENT_PATH = "/installer/events".freeze
       HAS_LOGS_PATH = "/installer/has_logs".freeze
       USER_AGENT = "Timber Ruby/#{Timber::VERSION} (HTTP)".freeze
 
+      attr_reader :api_key
+
       def initialize(api_key)
         @api_key = api_key
         @session_id = SecureRandom.uuid
       end
 
+      # Returns the application for the given API key.
       def application!
-        get!(APPLICATION_PATH)
+        res = get!(APPLICATION_PATH)
+        build_application(res)
+      end
+
+      # Hits the API to clone the app for the provided API key to the specified environment.
+      def clone_application!(environment)
+        return nil
       end
 
-      def event!(name, data = {})
+      # Sends an event to Timber so that we can understand how the installer is performing
+      # an ensure a top notch user experience. We do not raise here because it is not
+      # critical for the install process.
+      def event(name, data = {})
         post!(EVENT_PATH, event: {name: name, data: data})
+        true
+      rescue Exception
+        false
       end
 
+      # After test logs are sent to the Timber API this method waits for them to be
+      # received. This is how we test integration.
       def wait_for_logs(iteration = 0, &block)
         if block_given?
           yield iteration
@@ -46,9 +101,11 @@ module Timber
 
         case iteration
         when 0
-          event!(:waiting_for_logs)
-        when 30
-          event!(:excessively_waiting_for_logs)
+          event(:waiting_for_logs)
+        when 20
+          event(:excessively_waiting_for_logs)
+        when 60
+          raise LogsNotReceivedError.new
         end
 
         sleep 0.5
@@ -58,13 +115,20 @@ module Timber
         case res.code
         when "202"
           wait_for_logs(iteration + 1, &block)
-
         when "204"
           true
+        else
+          raise UnrecognizedAPIResponse.new(res)
         end
       end
 
       private
+        def build_application(res)
+          parsed_body = JSON.parse(res.body)
+          attributes = parsed_body.fetch("data")
+          Application.new(attributes)
+        end
+
         def get!(path)
           req = Net::HTTP::Get.new(path)
           issue!(req)
@@ -85,10 +149,12 @@ module Timber
             http.request(req)
           end
 
-          if res.code == "401"
-            raise NoAPIKeyError.new
-          elsif res.code == "403"
+          code = Integer(res.code)
+
+          if [401, 403].include?(code)
             raise APIKeyInvalidError.new
+          elsif code >= 500
+            raise ServerError.new
           else
             res
           end

data/lib/timber/cli/api/application.rb

@@ -0,0 +1,30 @@
+module Timber
+  class CLI
+    class API
+      class Application
+        DEVELOPMENT = "development".freeze
+        HEROKU = "heroku".freeze
+
+        attr_accessor :api_key, :environment, :framework_type, :heroku_drain_url,
+          :name, :platform_type
+
+        def initialize(attributes)
+          @api_key = attributes.fetch("api_key")
+          @environment = attributes.fetch("environment")
+          @framework_type = attributes.fetch("framework_type")
+          @heroku_drain_url = attributes.fetch("heroku_drain_url")
+          @name = attributes.fetch("name")
+          @platform_type = attributes.fetch("platform_type")
+        end
+
+        def development?
+          environment == DEVELOPMENT
+        end
+
+        def heroku?
+          platform_type == HEROKU
+        end
+      end
+    end
+  end
+end

data/lib/timber/cli/config_file.rb

@@ -0,0 +1,66 @@
+require "timber/cli/file_helper"
+
+module Timber
+  class CLI
+    class ConfigFile
+      attr_reader :path
+
+      def initialize(path)
+        @path = path
+        FileHelper.read_or_create(path, initial_content)
+      end
+
+      def logrageify!
+        append("config.logrageify!")
+      end
+
+      private
+        def get_content
+          FileHelper.read(path)
+        end
+
+        def append(code)
+          current_content = get_content
+          if !current_content.include?(code)
+            if current_content.include?(insert_hook)
+              new_content = current_content.gsub(insert_hook, "#{code}\n\n#{insert_hook}")
+              FileHelper.write(path, new_content)
+            else
+              FileHelper.append(path, new_content)
+            end
+          end
+
+          true
+        end
+
+        def insert_hook
+          @insert_hook ||= "# Add additional configuration here."
+        end
+
+        # We provide this as an instance method so that the string is only defined when needed.
+        # This avoids allocating this string during normal app runtime.
+        def initial_content
+          <<-CONTENT
+# Timber.io Ruby Configuration - Simple Structured Logging
+#
+#  ^  ^  ^   ^      ___I_      ^  ^   ^  ^  ^   ^  ^
+# /|\\/|\\/|\\ /|\\    /\\-_--\\    /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\
+# /|\\/|\\/|\\ /|\\   /  \\_-__\\   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\
+# /|\\/|\\/|\\ /|\\   |[]| [] |   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\
+# -------------------------------------------------------------------
+# Website:       https://timber.io
+# Documentation: https://timber.io/docs
+# Support:       support@timber.io
+# -------------------------------------------------------------------
+
+config = Timber::Config.instance
+
+#{insert_hook}
+# For a full list of configuration options and their explanations see:
+# http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Config
+
+CONTENT
+        end
+    end
+  end
+end

data/lib/timber/cli/file_helper.rb

@@ -0,0 +1,43 @@
+module Timber
+  class CLI
+    module FileHelper
+      def self.append(path, contents)
+        File.open(path, "a") do |f|
+          f.write(contents)
+        end
+      end
+
+      def self.read_or_create(path, contents)
+        if !File.exists?(path)
+          write(path, contents)
+        end
+
+        File.read(path)
+      end
+
+      def self.read(path)
+        File.read(path)
+      end
+
+      def self.write(path, contents)
+        File.open(path, "w") do |f|
+          f.write(contents)
+        end
+      end
+
+      def self.verify(path, io)
+        if !File.exists?(path)
+          io.puts ""
+          io.puts "Uh oh! It looks like we couldn't locate the #{path} file. "
+          io.puts "Please enter the correct path:"
+          io.puts
+
+          new_path = io.gets
+          verify(new_path, io)
+        else
+          path
+        end
+      end
+    end
+  end
+end

data/lib/timber/cli/installer.rb

@@ -0,0 +1,58 @@
+require "timber/cli/io/messages"
+
+module Timber
+  class CLI
+    class Installer
+      attr_reader :io, :api
+
+      def initialize(io, api)
+        @io = io
+        @api = api
+      end
+
+      def run(app)
+        raise NotImplementedError.new
+      end
+
+      private
+        # Determines the API key storage prference (environment variable or inline)
+        def get_api_key_storage_preference
+          io.puts ""
+          io.puts IO::Messages.separator
+          io.puts ""
+          io.puts "For production/staging would you like to store your Timber API key"
+          io.puts "in an environment variable? (TIMBER_API_KEY)"
+          io.puts ""
+          io.puts "y) Yes, store in TIMBER_API_KEY", :blue
+          io.puts "n) No, just paste the API key inline", :blue
+          io.puts ""
+
+          case io.ask_yes_no("Enter your choice:", event_prompt: "Store API key in env?")
+          when :yes
+            io.puts ""
+            io.puts IO::Messages.http_environment_variables(api.api_key)
+            io.puts ""
+
+            io.ask_to_proceed
+
+            :environment
+          when :no
+            :inline
+          end
+        end
+
+        # Based on the API key storage preference, we generate the proper code.
+        def get_api_key_code(storage_type)
+          case storage_type
+          when :environment
+            "ENV['TIMBER_API_KEY']"
+          when :inline
+            "'#{api.api_key}'"
+          else
+            raise ArgumentError.new("API key storage type not recognized! " \
+              "#{storage_type.inspect}")
+          end
+        end
+    end
+  end
+end