cloudreactor_api_client 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc683a7bd63c353942d0f7e72891d49eb93c8c78eeef82a184e2cec19337de2d
-  data.tar.gz: 684eff3feb5aee6712c7c08663a2713b47622911347eb8a5794b62f3d50f23ac
+  metadata.gz: 28a47db9dc24badcd8700fedf6faa51ff5634673b69483a454d565e29af3d654
+  data.tar.gz: 4a956e4d3cf6d1a0575d29512e3f4b6d844e89af67c4816d4ccab5037580e20e
 SHA512:
-  metadata.gz: d928e48d84c6c8d8cde6c4ebe4da1cedc88eff27cb610f1ea6e11ece1858a4916524bbf255ebea98294ed7a90fcba46a9d1e3693d93ac1b6478d256087f750c2
-  data.tar.gz: 4074301b99e6ff24dfac28b9a6a1fc2cd7246ee9f64e6d79029ba1b137a87cb6d78596503d82f5acdd4f87e5aef34972af17fe79ffce8321c07ea17e5f22ebdd
+  metadata.gz: b584519bebceaeebc76670aca674c540ab981f4571b70cc5fb9a215f5f3c058c13aa7ee695b215eae04d5ae4c7a9a2b20b18bceba974a70e12c80f9aeb2db30b
+  data.tar.gz: c943df9a612804544a2b446f924ad04ef5073ef68f485218b1c828d351727d69308a1e1d4bca2a96dafe2842fab31b1f65925a2a9ad149459baf3f2bc5b66f41

data/README.md

@@ -1,7 +1,9 @@
 # cloudreactor-ruby-client-wrapperio
 
+![Gem](https://img.shields.io/gem/v/cloudreactor_api_client)
 ![Ruby CI](https://github.com/CloudReactor/cloudreactor-ruby-client-wrapperio/workflows/Ruby%20CI/badge.svg?branch=master)
 ![GitHub](https://img.shields.io/github/license/CloudReactor/cloudreactor-ruby-client-wrapperio)
+![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/CloudReactor/cloudreactor-ruby-client-wrapperio)
 
 ## Overview
 
@@ -64,13 +66,17 @@ picked up correctly.
 ### Example usage
 
 ```ruby
+# This is necessary even in Rails, due to the module name not matching the
+# package name.
+require 'cloudreactor_wrapper_io'
+
 # Use the environment variables
 # PROC_WRAPPER_ENABLE_STATUS_UPDATE_LISTENER
 # PROC_WRAPPER_STATUS_UPDATE_SOCKET_PORT
 # PROC_WRAPPER_STATUS_UPDATE_SOCKET_BIND_PORT
 # to determine configuration. These environment variables are typically passed
 # to the proc_wrapper module which then passes them on to your process.
-status_updater = new CloudReactorWrapperIO::StatusUpdater()
+status_updater = CloudReactorWrapperIO::StatusUpdater.new()
 
 begin
   status_updater.send_update(

data/cloudreactor_api_client.md

@@ -7,7 +7,7 @@ CloudReactor API Documentation
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 0.2.0
-- Package version: 0.1.1
+- Package version: 0.1.2
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://cloudreactor.io/](https://cloudreactor.io/)
 
@@ -24,16 +24,16 @@ gem build cloudreactor_api_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudreactor_api_client-0.1.1.gem
+gem install ./cloudreactor_api_client-0.1.2.gem
 ```
 
-(for development, run `gem install --dev ./cloudreactor_api_client-0.1.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudreactor_api_client-0.1.2.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cloudreactor_api_client', '~> 0.1.1'
+    gem 'cloudreactor_api_client', '~> 0.1.2'
 
 ### Install from Git
 

data/lib/cloudreactor_api_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.4.0
 =end
 
 module CloudReactorAPIClient
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/cloudreactor_wrapper_io/status_updater.rb

@@ -2,13 +2,39 @@ require 'json'
 require 'logger'
 require 'socket'
 
+# @note You must require the cloudreactor_wrapper_io module to use this service,
+# even in Rails!
+# @example
+#   require 'cloudreactor_wrapper_io'
+#   status_updater = CloudReactorWrapperIO::StatusUpdater.new()
+#   begin
+#     status_updater.send_update(
+#       success_count: 1,
+#       error_count: 2,
+#       last_status_message: 'running'
+#     )
+#   ensure
+#     status_updater.close()
+#   end
 module CloudReactorWrapperIO
+  # A service used to update the CloudReactor service of the status of
+  # a currently running process. The service sends UDP messages to a
+  # process wrapper, which then forwards the updates to CloudReactor.
+  # @author Jeff Tsay (jeff@cloudreactor.io)
   class StatusUpdater
     DEFAULT_STATUS_UPDATE_PORT = 2373
 
     attr_reader :enabled
     attr_reader :port
 
+    # Create a new instance.
+    # @param enabled [Boolean, nil] true to enable updates. If nil, will use the
+    #   PROC_WRAPPER_ENABLE_STATUS_UPDATE_LISTENER environment variable.
+    # @param port [Integer, nil] the port number to use. If nil, will use the
+    #   PROC_WRAPPER_STATUS_UPDATE_SOCKET_PORT environment variable, or 2373
+    #   if the environment variable is not available.
+    # @param logger [Logger, nil] the logger to use. If nil, will use
+    #   Rails.logger if available, otherwise will create a new Logger.
     def initialize(enabled: nil, port: nil, logger: nil)
       @logger = logger
 
@@ -60,6 +86,20 @@ module CloudReactorWrapperIO
       end
     end
 
+
+    # Sends an update message to the process wrapper. The process wrapper should
+    # merge updates together until it is time to send a heartbeat to the
+    # server, so it should be safe to call this method rapidly.
+    # Messages are not guaranteed to be sent successfully, but in practice
+    # they almost always are.
+    #
+    # @param success_count [Integer, nil] The number of successful items so far
+    # @param error_count [Integer, nil] The number of failed items so far
+    # @param skipped_count [Integer, nil] The number of skipped items so far
+    # @param expected_count [Integer, nil] The number of expected items
+    # @param last_status_message [String, nil] A status message
+    # @param [Hash, nil] extra_props Additional properties to send
+    # @return [Boolean] True if the update was sent, false othewise
     def send_update(success_count: nil, error_count: nil, skipped_count: nil,
       expected_count: nil, last_status_message: nil, extra_props: nil)
       unless @enabled
@@ -108,6 +148,7 @@ module CloudReactorWrapperIO
       end
     end
 
+    # Close any resources associated with this instance.
     def close
       if @socket
         @socket.shutdown

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudreactor_api_client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jeff Tsay