timber 2.0.24 → 2.1.0.rc1

data/lib/timber/cli/application.rb

@@ -1,28 +0,0 @@
-require "json"
-
-module Timber
-  class CLI
-    class Application
-
-      attr_reader :api_key, :environment, :framework_type, :heroku_drain_url, :language_type,
-        :name, :platform_type
-
-      def initialize(api)
-        res = api.application!
-        parsed_body = JSON.parse(res.body)
-        application_data = parsed_body.fetch("data")
-        @api_key = application_data.fetch("api_key")
-        @environment = application_data.fetch("environment")
-        @framework_type = application_data.fetch("framework_type")
-        @heroku_drain_url = application_data.fetch("heroku_drain_url")
-        @language_type = application_data.fetch("language_type")
-        @name = application_data.fetch("name")
-        @platform_type = application_data.fetch("platform_type")
-      end
-
-      def heroku?
-        platform_type == "heroku"
-      end
-    end
-  end
-end

data/lib/timber/cli/install.rb

@@ -1,196 +0,0 @@
-require "fileutils"
-
-module Timber
-  class CLI
-    class Install
-      EXCLUDED_ENVIRONMENTS = ["test"].freeze
-
-      class << self
-        include IOHelper
-
-        def run(api_key)
-          puts colorize(Messages.header, :green)
-          puts colorize(Messages.separator, :green)
-          puts colorize(Messages.contact, :green)
-          puts colorize(Messages.separator, :green)
-          puts ""
-
-          if !api_key
-            puts Messages.no_api_key_provided
-            return
-          end
-
-          api = API.new(api_key)
-
-          api.event!(:started)
-
-          app = Application.new(api)
-
-          puts Messages.application_details(app)
-          puts ""
-
-          case ask_yes_no("Are the above details correct?", api)
-          when :yes
-            if app.heroku?
-              update_environment_config("production", :stdout, api)
-
-              puts ""
-              puts Messages.separator
-              puts ""
-              puts Messages.heroku_install(app)
-              puts ""
-
-              ask_yes_no("Ready to proceed?", api)
-              puts ""
-
-            else
-              puts ""
-              puts Messages.separator
-              puts ""
-              puts "How would you like configure Timber?"
-              puts ""
-              puts "1) Using environment variables"
-              puts "2) Configuring in my app"
-              puts ""
-
-              case ask("Enter your choice: (1/2) ", api)
-              when "1"
-                update_environment_config("production", :http, api, :api_key_code => "ENV['TIMBER_API_KEY']")
-
-                puts ""
-                puts Messages.http_environment_variables(app.api_key)
-                puts ""
-
-                ask_yes_no("Ready to proceed?", api)
-                puts ""
-
-              when "2"
-                update_environment_config("production", :http, api, :api_key_code => "'#{app.api_key}'")
-
-              end
-
-              send_test_messages(api_key)
-            end
-
-
-            api.wait_for_logs do |iteration|
-              write Messages.task_start("Waiting for logs")
-              write Messages.spinner(iteration)
-            end
-
-            puts colorize(Messages.task_complete("Waiting for logs"), :green)
-
-            puts ""
-            puts Messages.separator
-            puts ""
-            puts Messages.commit_and_deploy_reminder
-
-            api.event!(:success)
-
-            collect_feedback(api)
-
-            puts ""
-            puts Messages.separator
-            puts ""
-            puts Messages.free_data
-            puts ""
-
-          when :no
-            puts ""
-            puts "Bummer. Head to this URL to update the details:"
-            puts ""
-            puts "    #{Messages.edit_app_url(app)}"
-            puts ""
-            puts "exiting..."
-            return false
-          end
-        end
-
-        private
-          def update_environment_config(name, log_device_type, api, options = {})
-            path = File.join("config", "environments", "#{name}.rb")
-
-            puts ""
-            task_message = "Configuring Timber in #{path}"
-            write Messages.task_start(task_message)
-
-            init_logger_code = defined?(::ActiveSupport::TaggedLogging) ? "ActiveSupport::TaggedLogging.new(logger)" : "logger"
-
-            logger_code = \
-              case log_device_type
-              when :http
-                api_key_code = options[:api_key_code] || raise(ArgumentError.new("the :api_key_code option is required"))
-
-                code = <<-CODE
-  # Install the Timber.io logger, send logs over HTTP
-  log_device = Timber::LogDevices::HTTP.new(#{api_key_code})
-  logger = Timber::Logger.new(log_device)
-  logger.level = config.log_level
-  config.logger = #{init_logger_code}
-CODE
-                code.rstrip
-
-              when :stdout
-                code = <<-CODE
-  # Install the Timber.io logger, send logs to STDOUT
-  logger = Timber::Logger.new(STDOUT)
-  logger.level = config.log_level
-  config.logger = #{init_logger_code}
-CODE
-                code.rstrip
-              end
-
-
-            current_contents = File.read(path)
-
-            if !current_contents.include?("Timber::Logger.new")
-              new_contents = current_contents.sub(/\nend/, "\n\n#{logger_code}\nend")
-              File.write(path, new_contents)
-              api.event!(:file_written, path: path)
-            end
-
-            puts colorize(Messages.task_complete(task_message), :green)
-          end
-
-          def send_test_messages(api_key)
-            write Messages.task_start("Sending test logs")
-
-            http_device = LogDevices::HTTP.new(api_key)
-            logger = Logger.new(http_device)
-            logger.info("Welcome to Timber!")
-            logger.info("This is a test log to ensure the pipes are working")
-            logger.info("Be sure to commit and deploy your app to start seeing real logs")
-
-            puts colorize(Messages.task_complete("Sending test logs"), :green)
-          end
-
-          def collect_feedback(api)
-            puts ""
-            puts Messages.separator
-            puts ""
-
-            rating = ask("How would rate this install experience? 1 (bad) - 5 (perfect)", api)
-
-            case rating
-            when "4", "5"
-              api.event!(:feedback, rating: rating.to_i)
-              puts ""
-              puts Messages.we_love_you_too
-
-            when "1", "2", "3"
-              puts ""
-              puts Messages.bad_experience_message
-              puts ""
-
-              comments = ask("Type your comments (enter sends)", api)
-
-              api.event!(:feedback, rating: rating.to_i, comments: comments)
-
-              puts ""
-              puts "Thank you! We take feedback seriously and will work to improve this."
-            end
-          end
-      end
-    end
-  end
-end

data/lib/timber/cli/io_helper.rb

@@ -1,65 +0,0 @@
-module Timber
-  class CLI
-    module IOHelper
-      def ask(message, api)
-        api.event!(:waiting_for_input, prompt: message)
-
-        write message + " "
-        input = gets
-
-        api.event!(:received_input, prompt: message, value: input)
-
-        input
-      end
-
-      def ask_yes_no(message, api)
-        case ask(message + " (y/n)", api)
-        when "y", "Y"
-          :yes
-        when "n", "N"
-          :no
-        else
-          puts "Woops! That's not a valid input. Please try again."
-          ask_yes_no(message, api)
-        end
-      end
-
-      def colorize(text, color)
-        return text if Gem.win_platform?
-
-        code =
-          case color
-          when :blue then 34
-          when :red then 31
-          when :green then 32
-          when :yellow then 33
-          else 0
-          end
-
-        "\e[#{code}m#{text}\e[0m"
-      end
-
-      def gets
-        value = stdin.gets
-        value ? value.chomp.downcase : ""
-      end
-
-      def puts(message)
-        stdout.puts(message)
-      end
-
-      def write(message)
-        stdout.write(message)
-      end
-
-      private
-        def stdout
-          $stdout
-        end
-
-        def stdin
-          $stdin
-        end
-    end
-  end
-end

data/lib/timber/cli/messages.rb

@@ -1,180 +0,0 @@
-# encoding: utf-8
-
-module Timber
-  class CLI
-    module Messages
-      include IOHelper
-
-      extend self
-
-      APP_URL = "https://app.timber.io"
-      DOCS_URL = "https://timber.io/docs"
-      REPO_URL = "https://github.com/timberio/timber-ruby"
-      SUPPORT_EMAIL = "support@timber.io"
-      TWITTER_HANDLE = "@timberdotio"
-      WEBSITE_URL = "https://timber.io"
-      MAX_LENGTH = 80.freeze
-
-      def application_details(app)
-        message = <<-MESSAGE
-Woot! Your API 🔑  is valid:
-
-Name:      #{app.name} (#{app.environment})
-Framework: #{app.framework_type}
-Platform:  #{app.platform_type}
-MESSAGE
-message.rstrip
-      end
-
-      def edit_app_url(app)
-        "#{APP_URL}"
-      end
-
-      def bad_experience_message
-message = <<-MESSAGE
-Bummer! That is certainly not the experience we were going for.
-
-Could you tell us why you a bad experience?
-
-(this will be sent directly to the Timber engineering team)
-MESSAGE
-message.rstrip
-      end
-
-      def commit_and_deploy_reminder
-message = <<-MESSAGE
-Last step! Commit and deploy:
-
-    #{colorize("git commit -m 'Install Timber' config/environments/production.rb", :blue)}
-
-    #{colorize("push and deploy", :blue)} 🚀
-MESSAGE
-message.rstrip
-end
-
-      def console_url(app)
-message = <<-MESSAGE
-Your console URL: https://app.timber.io/organizations/timber/apps/#{app.slug}/console
-MESSAGE
-      end
-
-      def contact
-message = <<-MESSAGE
-Website:       #{WEBSITE_URL}
-Documentation: #{DOCS_URL}
-Support:       #{SUPPORT_EMAIL}
-MESSAGE
-message.rstrip
-      end
-
-      def http_environment_variables(api_key)
-message = <<-MESSAGE
-Great! Add this variable to your environment:
-
-    #{colorize("export TIMBER_API_KEY=\"#{api_key}\"", :blue)}
-
-MESSAGE
-message.rstrip
-      end
-
-      def free_data
-message = <<-MESSAGE
-As a welcome gift, we've credited your account with ✨ 50mb✨. Get more:
-
-* Get ✨ 250mb✨ for tweeting your experience to #{TWITTER_HANDLE}
-* Get ✨ 100mb✨ for starring our repo: #{REPO_URL}
-* Get ✨ 100mb✨ for following #{TWITTER_HANDLE} on twitter
-MESSAGE
-message.rstrip
-end
-
-      def header
-message = <<-MESSAGE
-🌲 Timber.io Ruby Installer
-
- ^  ^  ^   ^      ___I_      ^  ^   ^  ^  ^   ^  ^
-/|\\/|\\/|\\ /|\\    /\\-_--\\    /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\
-/|\\/|\\/|\\ /|\\   /  \\_-__\\   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\
-/|\\/|\\/|\\ /|\\   |[]| [] |   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\
-MESSAGE
-message.rstrip
-      end
-
-      def heroku_install(app)
-message = <<-MESSAGE
-To send logs from Heroku please run this command in a separate window:
-
-    #{colorize("heroku drains:add #{app.heroku_drain_url}", :blue)}
-
-MESSAGE
-message.rstrip
-      end
-
-      def no_api_key_provided
-message = <<-MESSAGE
-Hey there! Welcome to Timber. In order to proceed, you'll need an API key.
-If you already have one, you can run this installer like:
-
-    #{colorize("bundle exec timber install my-api-key", :blue)}
-
-#{obtain_key_instructions}
-MESSAGE
-        message.rstrip
-      end
-
-      def obtain_key_instructions
-message = <<-MESSAGE
-Don't have a key? Head over to:
-
-    #{colorize("https://app.timber.io", :blue)}
-
-Once there, create an application. Your API key will be displayed afterwards.
-For more detailed instructions, checkout our docs page:
-
-https://timber.io/docs/app/obtain-api-key/
-
-If you're confused, don't hesitate to contact us: #{SUPPORT_EMAIL}
-
-MESSAGE
-message.rstrip
-      end
-
-      def separator
-        "--------------------------------------------------------------------------------"
-      end
-
-      def spinner(iteration)
-        rem = iteration % 3
-        case rem
-        when 0
-          "/"
-        when 1
-          "-"
-        when 2
-          "\\"
-        end
-      end
-
-      def success
-        "✓ Success!"
-      end
-
-      def task_complete(message)
-        remainder = MAX_LENGTH - message.length - success.length
-
-        dots = "." * remainder
-        "\r#{message}#{dots}#{success}"
-      end
-
-      def task_start(message)
-        remainder = MAX_LENGTH - message.length - success.length
-
-        "\r#{message}" + ("." * remainder)
-      end
-
-      def we_love_you_too
-        "Thanks! We 💖 you too!"
-      end
-    end
-  end
-end