warm-blanket 1.0.0

data/lib/warm_blanket/requester.rb

@@ -0,0 +1,98 @@
+# WarmBlanket: Ruby gem for warming up web services on boot
+# Copyright (C) 2017 Talkdesk, Inc. <tech@talkdesk.com>
+#
+# This file is part of WarmBlanket.
+#
+# WarmBlanket is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# WarmBlanket is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with WarmBlanket.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'faraday'
+
+module WarmBlanket
+  # Issues one request per call to the configured endpoint
+  class Requester
+
+    InvalidHTTPVerb = Class.new(StandardError)
+
+    private
+
+    SUPPORTED_VERBS = [:get, :post, :put].freeze
+    private_constant :SUPPORTED_VERBS
+
+    attr_reader :base_url
+    attr_reader :default_headers
+    attr_reader :endpoints
+    attr_reader :logger
+    attr_reader :connection_factory
+
+    attr_accessor :next_endpoint_position
+
+    public
+
+    def initialize(base_url:, default_headers:, endpoints:, logger: WarmBlanket.config.logger, connection_factory: Faraday)
+      @base_url = base_url
+      @default_headers = default_headers
+      @endpoints = endpoints
+      @logger = logger
+      @connection_factory = connection_factory
+      @next_endpoint_position = 0
+    end
+
+    def call
+      connection = connection_factory.new(url: base_url)
+
+      endpoint = next_endpoint
+
+      http_verb = extract_verb(endpoint)
+
+      logger.debug "Requesting #{endpoint.fetch(http_verb)}"
+
+      response = connection.public_send(http_verb) do |request|
+        apply_headers(request, default_headers)
+        apply_headers(request, endpoint[:headers])
+        request.url(endpoint.fetch(http_verb))
+        request.body = endpoint[:body] if endpoint[:body]
+      end
+
+      if response.status == 200
+        logger.debug "Request successful"
+      else
+        logger.warn "Request to #{endpoint.fetch(http_verb)} failed with code #{response.status}"
+      end
+
+      nil
+    end
+
+    private
+
+    def apply_headers(request, headers)
+      headers&.each do |header, value|
+        request.headers[header.to_s] = value
+      end
+    end
+
+    def next_endpoint
+      next_endpoint = endpoints[next_endpoint_position]
+      self.next_endpoint_position = (next_endpoint_position + 1) % endpoints.size
+      next_endpoint
+    end
+
+    def extract_verb(endpoint)
+      SUPPORTED_VERBS.each do |verb|
+        return verb if endpoint.key?(verb)
+      end
+
+      raise InvalidHTTPVerb, "Unsupported or missing HTTP verb for request: #{endpoint.inspect}"
+    end
+  end
+end

data/lib/warm_blanket/version.rb

@@ -0,0 +1,23 @@
+# WarmBlanket: Ruby gem for warming up web services on boot
+# Copyright (C) 2017 Talkdesk, Inc. <tech@talkdesk.com>
+#
+# This file is part of WarmBlanket.
+#
+# WarmBlanket is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# WarmBlanket is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with WarmBlanket.  If not, see <http://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+module WarmBlanket
+  VERSION = '1.0.0'
+end

data/lib/warm_blanket/wait_for_port.rb

@@ -0,0 +1,67 @@
+# WarmBlanket: Ruby gem for warming up web services on boot
+# Copyright (C) 2017 Talkdesk, Inc. <tech@talkdesk.com>
+#
+# This file is part of WarmBlanket.
+#
+# WarmBlanket is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# WarmBlanket is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with WarmBlanket.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'socket'
+require 'time'
+
+module WarmBlanket
+  # Waits for given port to be available
+  class WaitForPort
+
+    InvalidPort = Class.new(StandardError)
+
+    private
+
+    attr_reader :hostname
+    attr_reader :port
+    attr_reader :logger
+    attr_reader :time_deadline
+
+    public
+
+    def initialize(hostname: 'localhost', port:, time_deadline: (Time.now + 90), logger: WarmBlanket.config.logger)
+      port = Integer(port) rescue nil
+      raise InvalidPort, "Invalid port (#{port.inspect})" unless (1...2**16).include?(port)
+
+      @hostname = hostname
+      @port = port
+      @logger = logger
+      @time_deadline = time_deadline
+    end
+
+    def call
+      logger.debug "Waiting for #{hostname}:#{port} to be available"
+
+      while true
+        socket = nil
+        begin
+          socket = TCPSocket.new(hostname, port)
+          logger.debug "Service at #{hostname}:#{port} is up"
+          return true
+        rescue StandardError => e
+          logger.debug "Exception while waiting for port to be available #{e.class}: #{e.message}"
+        ensure
+          socket&.close
+        end
+
+        return false if Time.now >= time_deadline
+        sleep 1
+      end
+    end
+  end
+end

data/warm-blanket.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'warm_blanket/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'warm-blanket'
+  spec.version       = WarmBlanket::VERSION
+  spec.authors       = ['Talkdesk Engineering']
+  spec.email         = ['tech@talkdesk.com']
+  spec.license       = 'LGPL-3.0+'
+
+  spec.summary       = 'Ruby gem for warming up web services on boot'
+  spec.description   = 'Ruby gem for warming up web services on boot'
+  spec.homepage      = 'https://github.com/Talkdesk/warm-blanket'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+  spec.add_development_dependency 'timecop', '~> 0.9'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug' unless RUBY_PLATFORM == 'java'
+  spec.add_development_dependency 'pry-debugger-jruby' if RUBY_PLATFORM == 'java'
+
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'dry-configurable', '~> 0.7'
+  spec.add_dependency 'logging', '~> 2.1'
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: warm-blanket
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Talkdesk Engineering
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: webmock
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  name: timecop
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: pry
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: pry-debugger-jruby
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  name: faraday
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  name: dry-configurable
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  name: logging
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Ruby gem for warming up web services on boot
+email:
+- tech@talkdesk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- COPYING
+- COPYING.LESSER
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/pry
+- bin/rspec
+- lib/warm-blanket.rb
+- lib/warm_blanket/orchestrator.rb
+- lib/warm_blanket/requester.rb
+- lib/warm_blanket/version.rb
+- lib/warm_blanket/wait_for_port.rb
+- warm-blanket.gemspec
+homepage: https://github.com/Talkdesk/warm-blanket
+licenses:
+- LGPL-3.0+
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.11
+signing_key:
+specification_version: 4
+summary: Ruby gem for warming up web services on boot
+test_files: []