timber 2.6.2 → 3.0.0

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

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

data/lib/timber/cli/config_file.rb

@@ -1,71 +0,0 @@
-require "timber/cli/file_helper"
-
-module Timber
-  class CLI
-    class ConfigFile
-      attr_reader :path, :file_helper
-
-      def initialize(path, file_helper)
-        @path = path
-        @file_helper = file_helper
-      end
-
-      def create!
-        file_helper.write(path, content)
-      end
-
-      def exists?
-        File.exists?(path)
-      end
-
-      def logrageify!
-        append!("config.logrageify!")
-      end
-
-      def silence_template_renders!
-        append!("config.integrations.action_view.silence = Rails.env.production?")
-      end
-
-      private
-        def append!(code)
-          if !content.include?(code)
-            content.gsub!(insert_hook, "#{code}\n\n#{insert_hook}")
-          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 content
-          @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 common configuration options see:
-# https://timber.io/docs/languages/ruby/configuration
-#
-# For a full list of configuration options see:
-# http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Config
-
-CONTENT
-        end
-    end
-  end
-end

data/lib/timber/cli/file_helper.rb

@@ -1,53 +0,0 @@
-module Timber
-  class CLI
-    class FileHelper
-      attr_reader :api
-
-      def initialize(api)
-        @api = api
-      end
-
-      def append(path, contents)
-        File.open(path, "a") do |f|
-          f.write(contents)
-        end
-      end
-
-      def exists?(path)
-        File.exists?(path)
-      end
-
-      def read_or_create(path, contents)
-        if !exists?(path)
-          write(path, contents)
-        end
-
-        read(path)
-      end
-
-      def read(path)
-        File.read(path)
-      end
-
-      def write(path, contents)
-        File.open(path, "w") do |f|
-          f.write(contents)
-        end
-      end
-
-      def verify(path, io)
-        if !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

@@ -1,70 +0,0 @@
-require "timber/cli/file_helper"
-require "timber/cli/io/messages"
-
-module Timber
-  class CLI
-    class Installer
-      DEPRIORITIZED_PLATFORMS = ["linux", "other"].freeze
-
-      attr_reader :io, :api, :file_helper
-
-      def initialize(io, api)
-        @io = io
-        @api = api
-        @file_helper = FileHelper.new(api)
-      end
-
-      def run(app)
-        raise NotImplementedError.new
-      end
-
-      private
-        def get_delivery_strategy(app)
-          if DEPRIORITIZED_PLATFORMS.include?(app.platform_type)
-            :http
-          else
-            :stdout
-          end
-        end
-
-        # 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

data/lib/timber/cli/installers.rb

@@ -1,102 +0,0 @@
-# encoding: utf-8
-
-require "timber/cli/api"
-require "timber/cli/installers/root"
-require "timber/cli/io/messages"
-require "timber/cli/os_helper"
-
-module Timber
-  class CLI
-    module Installers
-      def self.run(api_key, io)
-        api = API.new(api_key)
-        api.event(:started)
-
-        begin
-          io.puts IO::Messages.header, :green
-          io.puts IO::Messages.separator, :green
-          io.puts IO::Messages.contact, :green
-          io.puts IO::Messages.separator, :green
-          io.puts ""
-
-          # if OSHelper.has_git?
-          #   if OSHelper.git_master? || !OSHelper.git_clean_working_tree?
-          #     io.puts "Before we begin, this installer will make a few simple code changes."
-          #     io.puts ""
-
-          #     case io.ask_yes_no("Would you like to exit and start over on a clean git branch?")
-          #     when :yes
-          #       command = "git checkout -b install-timber"
-          #       copied = OSHelper.copy_to_clipboard(command)
-
-          #       io.puts ""
-          #       io.puts "Good idea. Here's a simple git command to make things easier:"
-          #       io.puts ""
-          #       io.puts "    #{IO::ANSI.colorize(command, :blue)}"
-
-          #       if copied
-          #         io.puts "    #{IO::Messages.copied_to_clipboard}"
-          #       end
-
-          #       io.puts ""
-          #       io.puts "Once you've switched branches, run the installer command again."
-          #       io.puts ""
-          #       return
-          #     end
-          #   end
-          # end
-
-          if !api_key
-            api.event(:no_api_key)
-
-            app_url = IO::Messages::APP_URL
-
-            io.puts "Hey there! Welcome to Timber. In order to proceed, you'll need an API key."
-            io.puts "You can grab one by registering at #{IO::ANSI.colorize(app_url, :blue)}."
-            io.puts ""
-            io.puts "It takes less than a minute, with one click Google and Github registration."
-            io.puts ""
-
-            if OSHelper.can_open?
-              case io.ask_yes_no("Open #{app_url}?")
-              when :yes
-                io.puts ""
-                io.task("Opening #{app_url}") do
-                  OSHelper.open(app_url)
-                end
-              when :no
-                io.puts ""
-                io.puts "No problem, navigate to the following URL:"
-                io.puts ""
-                io.puts "    #{IO::ANSI.colorize(app_url, :blue)}"
-              end
-            else
-              io.puts ""
-              io.puts "Please navigate to:"
-              io.puts ""
-              io.puts "    #{IO::ANSI.colorize(app_url, :blue)}"
-            end
-
-            io.puts ""
-            io.puts "Once you obtain your API key, you can run the installer like"
-            io.puts ""
-            io.puts "    #{IO::ANSI.colorize("bundle exec timber install my-api-key", :blue)}"
-            io.puts ""
-            io.puts "See you soon! 🎈"
-            io.puts ""
-          else
-            api.event(:api_key_provided)
-            io.api = api
-
-            app = api.application!
-
-            Root.new(io, api).run(app)
-          end
-        rescue Exception => e
-          api.event(:exception, message: e.message, stacktrace: e.backtrace)
-          raise e
-        end
-      end
-    end
-  end
-end

data/lib/timber/cli/installers/config_file.rb

@@ -1,51 +0,0 @@
-begin
-  require "lograge"
-rescue Exception
-end
-
-require "timber/cli/config_file"
-require "timber/cli/installer"
-require "timber/cli/io/messages"
-
-module Timber
-  class CLI
-    module Installers
-      class ConfigFile < Installer
-        def run(app, path)
-          config_file = Timber::CLI::ConfigFile.new(path, file_helper)
-
-          if config_file.exists?
-            io.task_complete("#{config_file.path} already created")
-            return true
-          end
-
-          if lograge?
-            task_message = "Enabling logrageify in #{config_file.path}"
-            io.task(task_message) { config_file.logrageify! }
-          elsif action_view?
-            task_message = "Silencing template renders in #{config_file.path}"
-            io.task(task_message) { config_file.silence_template_renders! }
-          end
-
-          task_message = "Creating #{config_file.path}"
-          io.task(task_message) { config_file.create! }
-        end
-
-        private
-          def lograge?
-            require "lograge"
-            true
-          rescue Exception
-            false
-          end
-
-          def action_view?
-            require("action_view")
-            true
-          rescue Exception
-            false
-          end
-      end
-    end
-  end
-end

data/lib/timber/cli/installers/other.rb

@@ -1,59 +0,0 @@
-require "timber/cli/installer"
-require "timber/cli/io/messages"
-
-module Timber
-  class CLI
-    module Installers
-      class Other < Installer
-        def run(app)
-          case get_delivery_strategy(app)
-          when :http
-            api_key_storage_preference = get_api_key_storage_preference
-            api_key_code = get_api_key_code(api_key_storage_preference)
-            install_http(api_key_code)
-          when :stdout
-            install_stdout
-          end
-
-          ask_to_proceed
-        end
-
-        private
-          def install_stdout
-            io.puts ""
-            io.puts IO::Messages.separator
-            io.puts ""
-            io.puts "To integrate Timber, simply use the Timber::Logger. Just set your"
-            io.puts "global logger to something like this:"
-            io.puts ""
-            io.puts IO::ANSI.colorize("    LOGGER = Timber::Logger.new(STDOUT)", :blue)
-            io.puts ""
-            io.ask_to_proceed
-          end
-
-          def install_http(api_key_code)
-            io.puts ""
-            io.puts IO::Messages.separator
-            io.puts ""
-            io.puts "To integrate Timber, simply use the Timber::Logger. Just set your"
-            io.puts "global logger to something like this:"
-            io.puts ""
-            io.puts IO::ANSI.colorize("    log_device = Timber::LogDevices::HTTP.new(#{api_key_code})", :blue)
-            io.puts IO::ANSI.colorize("    LOGGER = Timber::Logger.new(log_device)", :blue)
-            io.puts ""
-            io.ask_to_proceed
-          end
-
-          def ask_to_proceed
-            io.puts ""
-            io.puts IO::Messages.separator
-            io.puts ""
-            io.puts "We're going to send a few test messages to ensure communication is working."
-            io.puts ""
-            io.ask_to_proceed
-            io.puts ""
-          end
-      end
-    end
-  end
-end