pipeline_publisher_ruby 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c2b5a29d81a388358a956549afccaf737530b3a
+  data.tar.gz: 460f48be698fbf5647cc1dd051731dcdfa8881c3
+SHA512:
+  metadata.gz: 3dc0570feb70306824daf8626405dd1f80202e3b62ae66a11623d3ba97984dbcb63fad15ec4aee06b469c76012d26266dc874c26178e2a475b7149cd520c17fd
+  data.tar.gz: 52538098097548d0fc6a82adb83e562a2ce246b46f14a065013ab641b12529cb206570f02b46816786bf71199ba74a7377500f0a4e2064446b8b7a31a7709381

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -0,0 +1,101 @@
+# 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](https://github.com/swagger-api/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:
+
+```shell
+gem build pipeline_publisher_ruby.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+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](https://rubygems.org/).
+
+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:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# 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**](docs/MessagesApi.md#messages_post) | **POST** /messages | Creates a message on the pipeline
+*PipelinePublisher::StreamMetricsApi* | [**stream_metrics_get**](docs/StreamMetricsApi.md#stream_metrics_get) | **GET** /stream_metrics | Fetches metrics about the stream
+
+
+## Documentation for Models
+
+ - [PipelinePublisher::InlineResponse200](docs/InlineResponse200.md)
+ - [PipelinePublisher::InlineResponse200MessagesReceived](docs/InlineResponse200MessagesReceived.md)
+ - [PipelinePublisher::Message](docs/Message.md)
+
+
+## Documentation for Authorization
+
+
+### basic
+
+- **Type**: HTTP basic authentication
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/InlineResponse200.md

@@ -0,0 +1,8 @@
+# PipelinePublisher::InlineResponse200
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages_received** | [**InlineResponse200MessagesReceived**](InlineResponse200MessagesReceived.md) |  | [optional] 
+
+

data/docs/InlineResponse200MessagesReceived.md

@@ -0,0 +1,10 @@
+# PipelinePublisher::InlineResponse200MessagesReceived
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**since_timestamp** | **String** |  | [optional] 
+**until_timestamp** | **String** |  | [optional] 
+**count** | **Integer** |  | [optional] 
+
+

data/docs/Message.md

@@ -0,0 +1,11 @@
+# PipelinePublisher::Message
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**noun** | **String** |  | 
+**meta** | **Object** |  | [optional] 
+**identifiers** | **Object** |  | 
+**data** | **Object** |  | [optional] 
+
+

data/docs/MessagesApi.md

@@ -0,0 +1,59 @@
+# PipelinePublisher::MessagesApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**messages_post**](MessagesApi.md#messages_post) | **POST** /messages | Creates a message on the pipeline
+
+
+# **messages_post**
+> messages_post(message)
+
+Creates a message on the pipeline
+
+### Example
+```ruby
+# 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
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **message** | [**Message**](Message.md)| Note: At least one key/value pair for identifiers field is required. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+

data/docs/StreamMetricsApi.md

@@ -0,0 +1,63 @@
+# PipelinePublisher::StreamMetricsApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**stream_metrics_get**](StreamMetricsApi.md#stream_metrics_get) | **GET** /stream_metrics | Fetches metrics about the stream
+
+
+# **stream_metrics_get**
+> InlineResponse200 stream_metrics_get(opts)
+
+Fetches metrics about the stream
+
+### Example
+```ruby
+# 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::StreamMetricsApi.new
+
+opts = { 
+  count_since_timestamp: "count_since_timestamp_example", # String | ISO 8601 compliant timestamp to perform message count calculations from. Example: 2018-04-12T23:54:57.595123Z
+  count_until_timestamp: "count_until_timestamp_example" # String | ISO 8601 compliant timestamp to perform message count calculations until. Example: 2018-04-12T23:54:57.595123Z
+}
+
+begin
+  #Fetches metrics about the stream
+  result = api_instance.stream_metrics_get(opts)
+  p result
+rescue PipelinePublisher::ApiError => e
+  puts "Exception when calling StreamMetricsApi->stream_metrics_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **count_since_timestamp** | **String**| ISO 8601 compliant timestamp to perform message count calculations from. Example: 2018-04-12T23:54:57.595123Z | [optional] 
+ **count_until_timestamp** | **String**| ISO 8601 compliant timestamp to perform message count calculations until. Example: 2018-04-12T23:54:57.595123Z | [optional] 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[basic](../README.md#basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/pipeline_publisher_ruby.rb

@@ -0,0 +1,44 @@
+=begin
+#API v1.0.2
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1.0.2
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+# Common files
+require 'pipeline_publisher_ruby/api_client'
+require 'pipeline_publisher_ruby/api_error'
+require 'pipeline_publisher_ruby/version'
+require 'pipeline_publisher_ruby/configuration'
+
+# Models
+require 'pipeline_publisher_ruby/models/inline_response_200'
+require 'pipeline_publisher_ruby/models/inline_response_200_messages_received'
+require 'pipeline_publisher_ruby/models/message'
+
+# APIs
+require 'pipeline_publisher_ruby/api/messages_api'
+require 'pipeline_publisher_ruby/api/stream_metrics_api'
+
+module PipelinePublisher
+  class << self
+    # Customize default settings for the SDK using block.
+    #   PipelinePublisher.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/pipeline_publisher_ruby/api/messages_api.rb

@@ -0,0 +1,75 @@
+=begin
+#API v1.0.2
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1.0.2
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require "uri"
+
+module PipelinePublisher
+  class MessagesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Creates a message on the pipeline
+    # 
+    # @param message Note: At least one key/value pair for identifiers field is required.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def messages_post(message, opts = {})
+      messages_post_with_http_info(message, opts)
+      return nil
+    end
+
+    # Creates a message on the pipeline
+    # 
+    # @param message Note: At least one key/value pair for identifiers field is required.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def messages_post_with_http_info(message, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: MessagesApi.messages_post ..."
+      end
+      # verify the required parameter 'message' is set
+      if @api_client.config.client_side_validation && message.nil?
+        fail ArgumentError, "Missing the required parameter 'message' when calling MessagesApi.messages_post"
+      end
+      # resource path
+      local_var_path = "/messages"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(message)
+      auth_names = ['basic']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MessagesApi#messages_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end