strongmind-pipeline-publisher

pipeline_publisher_ruby

PipelinePublisher - the Ruby gem for the API v1.0.2

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This SDK is automatically generated by the Swagger Codegen project:

• API version: v1.0.2
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build pipeline_publisher_ruby.gemspec

Then either install the gem locally:

gem install ./pipeline_publisher_ruby-1.0.0.gem

(for development, run gem install --dev ./pipeline_publisher_ruby-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'pipeline_publisher_ruby', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'pipeline_publisher_ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'pipeline_publisher_ruby'

# Setup authorization
PipelinePublisher.configure do |config|
  # Configure HTTP basic authorization: basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = PipelinePublisher::MessagesApi.new

message = PipelinePublisher::Message.new # Message | Note: At least one key/value pair for identifiers field is required.


begin
  #Creates a message on the pipeline
  api_instance.messages_post(message)
rescue PipelinePublisher::ApiError => e
  puts "Exception when calling MessagesApi->messages_post: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://localhost

Class	Method	HTTP request	Description
PipelinePublisher::MessagesApi	messages_post	POST /messages	Creates a message on the pipeline
PipelinePublisher::StreamMetricsApi	stream_metrics_get	GET /stream_metrics	Fetches metrics about the stream

Documentation for Models

• PipelinePublisher::InlineResponse200
• PipelinePublisher::InlineResponse200MessagesReceived
• PipelinePublisher::Message

Documentation for Authorization

basic

• Type: HTTP basic authentication