service_skeleton 1.0.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 020137b90b172033166a44e4e8f94094a2cb35f8886a185dbfaa8a47a29cff71
-  data.tar.gz: 85da8294b7d0c158404ef42ffb4969a7f02560ad35b4a5b9713bacbfb50ab9f4
+  metadata.gz: e244f5193b33614d8466ccb26d2d2d10f8d8d7917c94af1d8a2ddbd492c96cab
+  data.tar.gz: 1a80f5e1ed63a03bc4eb9920bc83a4f175fcd383f7aab1c5e732da2e764416ed
 SHA512:
-  metadata.gz: 39d9073b15a24f9b13ffc6bcaa7c60756e425301749fdf6b90e08b132bd7eadeb1ac90c75e0398e2704d57e1bc849edb9ecdfd78270d98b033a51dd7277addc0
-  data.tar.gz: 7cc439b11c6f36df6b2b0282e6f7661ef3c78caa496396ce1260a7d6ab66ccc7aef9a7d5debdd5e38ae2ff74d9833c7bf465f0167d74e7e649b952e882c73858
+  metadata.gz: 7f06bfeab8ad7401e2cdfde6ca9b2d89bf2946a65cc319b2861608a3b23a71cab91b9c438f7d212ed8326413a939dbc885d9bbd59871a78172c33e51c8b467a6
+  data.tar.gz: 3b3f6caf8be8d1cb07505b1a84f8212621faddf890c89f21988bc611d5e795e023eacb99ea31ab64de0afbf8c919fcfb1da64269494d3e3a9891ba8aa54b6039

data/.github/workflows/ci.yml

@@ -1,46 +1,52 @@
-name: CI
+name: Service Skeleton Tests
 
 on:
   pull_request:
   push:
     branches:
-      - "v1_0"
+      - master
+    tags:
+      - v*
 
 jobs:
   build:
     runs-on: ubuntu-latest
-
+    name: Ruby ${{ matrix.ruby }}
     strategy:
       matrix:
-        ruby:
-          - 2.5
-
+        ruby: ["2.5", "2.6", "2.7"]
     steps:
       - uses: actions/checkout@v2
-
-      - name: Setup ruby
-        uses: ruby/setup-ruby@v1
+        with:
+          fetch-depth: 0 # Fetch all history. Needed for `git describe`
+      - uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - name: Lint
+      - name: Bundler cache
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-
+      - name: Setup gems
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle install --jobs 4
+      - name: Rubocop
         run: bundle exec rubocop
-
       - name: Tests
-        run: bundle exec rake test
-
+        run: bundle exec rspec
+      - name: Ultravisor Tests
+        run: bundle exec rspec ultravisor/spec
   publish:
-    if: github.event_name == 'push' && (github.ref == 'refs/heads/v1_0')
+    if: contains(github.ref, 'refs/tags/v')
     needs: build
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v2
-
       - name: Release Gem
-        uses: discourse/publish-rubygems-action@v2-beta
+        uses: discourse/publish-rubygems-action@v1
         env:
-          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
-          GIT_EMAIL: team@discourse.org
-          GIT_NAME: discoursebot
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/.gitignore

@@ -1,2 +1,9 @@
 Gemfile.lock
+/pkg
+/doc
+/.yardoc
 /coverage
+/.bundle
+/tmp
+
+.rubocop-https---raw-githubusercontent-com-discourse-discourse-master--rubocop-yml

data/README.md

@@ -448,8 +448,7 @@ portion is the all-uppercase [service name](#the-service-name).
 
         INFO,buggy=DEBUG,/noisy/i=ERROR
 
-  Logging levels can be changed at runtime, via [signals](#default-signals) or
-  [the HTTP admin interface](#http-admin-interface).
+  Logging levels can be changed at runtime via [signals](#default-signals).
 
 * **`<SERVICENAME>_LOGSTASH_SERVER`** (string; default `""`) -- if set to a
   non-empty string, we will engage the services of the [loggerstash
@@ -686,57 +685,6 @@ When the service is shutdown, all signal handlers will be automatically
 unhooked, which saves you having to do it yourself.
 
 
-## HTTP Admin Interface
-
-In these modern times we live in, it seems everything from nuclear reactors to
-toasters can be controlled from a browser.  Why should your services be any
-different?
-
-
-### HTTP Admin Configuration
-
-In the spirit of "secure by default", you must explicitly enable the HTTP admin
-interface, and configure an authentication method.  To do that, use the
-following environment variables, where `<SERVICENAME>_` is the all-uppercase
-version of [the service name](#the-service-name).
-
-* **`<SERVICENAME>_HTTP_ADMIN_PORT`** (integer; range 1..65535; default: `""`)
-  -- if set to a valid port number (`1` to `65535` inclusive), the HTTP admin
-  interface will listen on that port, if also enabled by configuring
-  authentication.
-
-* **`<SERVICENAME>_HTTP_ADMIN_BASIC_AUTH`** (string; default: `""`) -- if set
-  to a string containing a username and password separated by a colon, then
-  authentication via [HTTP Basic auth](https://tools.ietf.org/html/rfc7617)
-  will be supported.  Note that in addition to this setting, an admin port must
-  also be specified in order for the admin interface to be enabled.
-
-* **`<SERVICENAME>_HTTP_ADMIN_PROXY_USERNAME_HEADER`** (string; default: `""`)
-  -- if set to a non-empty string, then incoming requests will be examined for
-  a HTTP header with the specified name.  If such a header exists and has a
-  non-empty value, then the request will be deemed to have been authenticated
-  by an upstream authenticating proxy (such as
-  [`discourse-auth-proxy`](https://github.com/discourse/discourse-auth-proxy))
-  as the user given in the header value.  Note that in addition to this
-  setting, an admin port must also be specified in order for the admin
-  interface to be enabled.
-
-
-### HTTP Admin Usage
-
-The HTTP admin interface provides both an interactive, browser-based mode,
-as well as a RESTful interface, which should, in general, provide equivalent
-functionality.
-
-* Visiting the service's `IP address:port` in a web browser will bring up an HTML
-  interface showing all the features that are available.  Usage should
-  (hopefully) be self-explanatory.
-
-* Visiting the service's `IP address:port` whilst accepting `application/json`
-  responses will provide a directory of links to available endpoints which you
-  can use to interact with the HTTP admin interface programmatically.
-
-
 # Contributing
 
 Patches can be sent as [a Github pull

data/lib/service_skeleton/ultravisor_loggerstash.rb

@@ -4,16 +4,8 @@ module ServiceSkeleton
   module UltravisorLoggerstash
     def logstash_writer
       #:nocov:
-      @ultravisor[:logstash_writer].unsafe_instance(wait: false)
+      @ultravisor[:logstash_writer].unsafe_instance
       #:nocov:
     end
-
-    # logstash_writer will be nil if the logstash_writer worker is not running
-    # Ultravisor's restart policy ensures this will never happen at runtime. But
-    # it does happen during startup and shutdown. In this case, we want to skip
-    # writing to logstash, not block forever. STDOUT logging will continue.
-    def loggerstash_log_message(*args)
-      super if !logstash_writer.nil?
-    end
   end
 end

data/service_skeleton.gemspec

@@ -1,15 +1,9 @@
 # frozen_string_literal: true
 
-begin
-  require 'git-version-bump'
-rescue LoadError
-  nil
-end
-
 Gem::Specification.new do |s|
   s.name = "service_skeleton"
 
-  s.version = '1.0.5'
+  s.version = '2.0.0'
 
   s.platform = Gem::Platform::RUBY
 
@@ -32,14 +26,12 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 2.5.0"
 
   s.add_runtime_dependency "frankenstein", "~> 2.0"
-  s.add_runtime_dependency "loggerstash", ">= 0.0.9", "< 1"
+  s.add_runtime_dependency "loggerstash", "~> 1"
   s.add_runtime_dependency "prometheus-client", "~> 2.0"
   s.add_runtime_dependency "sigdump", "~> 0.2"
   s.add_runtime_dependency "to_regexp", "~> 0.2"
 
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'github-release'
-  s.add_development_dependency 'git-version-bump'
   s.add_development_dependency 'guard-rspec'
   s.add_development_dependency 'guard-rubocop'
   s.add_development_dependency 'rack-test'

data/ultravisor/lib/ultravisor/child.rb

@@ -185,13 +185,13 @@ class Ultravisor
       !!(@restart == :always || (@restart == :on_failure && termination_exception))
     end
 
-    def unsafe_instance(wait: true)
+    def unsafe_instance
       unless @access == :unsafe
         raise Ultravisor::ThreadSafetyError,
               "#unsafe_instance called on a child not declared with access: :unsafe"
       end
 
-      current_instance(wait: wait)
+      current_instance
     end
 
     def cast
@@ -394,9 +394,9 @@ class Ultravisor
       end
     end
 
-    def current_instance(wait: true)
+    def current_instance
       @spawn_m.synchronize do
-        while wait && @instance.nil?
+        while @instance.nil?
           @spawn_cv.wait(@spawn_m)
         end
 

data/ultravisor/spec/spec_helper.rb

@@ -49,8 +49,4 @@ RSpec.configure do |config|
   config.mock_with :rspec do |mocks|
     mocks.verify_partial_doubles = true
   end
-
-  config.after(:each) do
-    Thread.current.name = nil
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: service_skeleton
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 2.0.0
 platform: ruby
 authors:
 - Matt Palmer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: frankenstein
@@ -29,20 +29,14 @@ dependencies:
   name: loggerstash
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.9
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.9
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
@@ -101,34 +95,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: github-release
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: git-version-bump
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -368,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: The bare bones of a service