kinetic_sdk 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e8eb050d18a73811319295d6d60794a3683ae95
+  data.tar.gz: 51ce513d4a3e2d38fe12d356e3d70f528db8dac4
+SHA512:
+  metadata.gz: febab2779f3d476d60b287770512635813bf7b8f9a45ffbf1f9c2d24ece8c2526ebf79218f4341c20d4e966579f9003d9097774751e2ab35d9b0eafaadeb7336
+  data.tar.gz: 9b368596ac22f72c2a175ce7fe36033cc46918ab371f76c49a230c7d4fd582e3aa72516e5f6be7c313cc5823bbcf340b40e604ca7dbd1215fb3468bad7b049f2

data/GettingStarted.md

@@ -0,0 +1,64 @@
+# Getting Started with Kinetic SDK
+
+This is a guide for getting up and running quickly with the Kinetic SDK.
+
+## About
+
+The Kinetic SDK is a library that provides easy to use methods for interacting with the REST API built into Kinetic Data applications. The intention is for the end user to create a Ruby program/script, and include the Kinetic SDK into the program. This guide shows how to do that.
+
+## How To
+
+This document assumes you have the necessary requirements installed on your client computer before proceeding.
+
+This guide also assumes you have the `git` program installed on your client machine in order to obtain the latest kinetic-sdk-rb code from Github.
+
+If you do not have git and don't want to install it, you can download a zip file of the [latest Kinetic SDK code](https://github.com/kineticdata/kinetic-sdk-rb/archive/master.zip). You would then unzip this file, and copy the extracted `kinetic-sdk-rb-master` directory to the `my_project/vendor/kinetic-sdk-rb` directory.
+
+### Prepare a Ruby program
+
+Prepare your Ruby program/script to use the Kinetic SDK.
+
+```bash
+# create the project directory
+
+mkdir my_project
+
+# clone the kinetic-sdk-rb repository from GitHub
+# see above to download the zip file if you don't have the git client
+
+git clone https://github.com/kineticdata/kinetic-sdk-rb.git my_project/vendor/kinetic-sdk-rb
+
+# copy the sample driver to your project's root directory
+
+cp my_project/vendor/kinetic-sdk-rb/samples/driver/driver.rb my_project/driver.rb
+```
+
+### Try the driver
+
+Modify the sample driver program with your Kinetic Request CE (or other Kinetic Application) information, and try it out.
+
+```bash
+# make sure to change back to the project root directory
+
+cd my_project
+
+# run the driver file
+
+ruby driver.rb
+```
+
+### Inline documentation
+
+If you would like to generate the inline documentation for this SDK, perform the following steps.
+
+```bash
+# install the bundler gem, and then then necessary documentation gems
+cd my_project/vendor/kinetic-sdk-rb
+gem install bundler
+bundle install
+
+# generate and open the inline Ruby documentation for the SDK
+
+bundle exec rake doc
+open rdoc/index.html
+```

data/README.md

@@ -0,0 +1,383 @@
+# Ruby SDK for Kinetic Data application APIs
+
+This library allows access to Kinetic Data application APIs from Ruby without having to write explicit HTTP requests.
+
+## About
+
+The Kinetic Ruby SDK is a library that consists of and SDK for each supported Kinetic Data application, and a helper HTTP library to make the HTTP requests.
+
+### Supported Applications
+
+The following Kinetic Data applications are supported in this SDK library:
+
+* Kinetic Request CE 1.0.4+
+* Kinetic Task 4.0+
+* Kinetic Bridgehub 1.0+
+* Kinetic Filehub 1.0+
+* Kinetic Discussions 1.0+
+
+## Getting Started
+
+See the [Getting Started Guide](GettingStarted.md) for getting started quickly.
+
+## Requirements
+
+The following are a list of requirements to use this SDK:
+
+### Ruby
+
+The Kinetic Ruby SDK requires Ruby 2.2+, which includes JRuby 9.0+. You can determine the version of Ruby you are using with the following command:
+
+```bash
+ruby -v
+```
+
+## Usage
+
+Each Kinetic Data application SDK is meant to be used independent of other application SDKs. With this in mind, each application SDK must be initialized individually.
+
+All of the HTTP methods return a {KineticSdk::Utils::KineticHttpResponse} object that contains additional methods to obtain information about the request status, the reponse body content, the response headers, and access to the raw response object.
+
+### Installing and requiring the SDK
+
+## Installation
+
+If you are using Bundler, add this line to your application's Gemfile:
+
+```ruby
+gem 'kinetic_sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kinetic_sdk
+
+Then in your application, include the SDK with the following code:
+
+```ruby
+require 'kinetic_sdk'
+```
+
+If you cloned or downloaded the Kinetic SDK source repository, then you can include
+the SDK with the following code.
+
+```ruby
+# Assumes the SDK is installed to vendor/kinetic-sdk-rb
+require File.join(File.expand_path(File.dirname(__FILE__)), 'vendor', 'kinetic-sdk-rb', 'kinetic-sdk')
+```
+
+### Kinetic BridgeHub SDK example
+
+```ruby
+bridgehub_sdk = KineticSdk::Bridgehub.new({
+  app_server_url: "http://localhost:8080/kinetic-bridgehub",
+  username: "configuration-user",
+  password: "password",
+  options: {
+    log_level: "info",
+    max_redirects: 3
+  }
+})
+response = bridgehub_sdk.find_bridges()
+bridges = response.content['bridges']
+
+puts response.code            # String value of HTTP response code ("200", "400", "500", etc...)
+puts response.status          # Ruby Fixnum value of response.code (200, 400, 500, etc...)
+puts response.content         # Ruby Hash
+puts response.content_string  # JSON formatted response body
+```
+
+### Kinetic FileHub SDK example
+
+```ruby
+filehub_sdk = KineticSdk::Filehub.new({
+  app_server_url: "http://localhost:8080/kinetic-filehub",
+  username: "configuration-user",
+  password: "password",
+  options: {
+    log_level: "info",
+    max_redirects: 3
+  }
+})
+response = filehub_sdk.find_filestores()
+filestores = response.content['filestores']
+
+puts response.code            # String value of HTTP response code ("200", "400", "500", etc...)
+puts response.status          # Ruby Fixnum value of response.code (200, 400, 500, etc...)
+puts response.content         # Ruby Hash
+puts response.content_string  # JSON formatted response body
+```
+
+### Kinetic Request CE SDK example of a Space User
+
+```ruby
+space_sdk = KineticSdk::RequestCe.new({
+  app_server_url: "http://localhost:8080/kinetic",
+  space_slug: "foo",
+  username: "space-user-1",
+  password: "password",
+  options: {
+    log_level: "info",
+    max_redirects: 3
+  }
+})
+response = space_sdk.find_kapps()
+kapps = response.content['kapps']
+
+puts response.code            # String value of HTTP response code ("200", "400", "500", etc...)
+puts response.status          # Ruby Fixnum value of response.code (200, 400, 500, etc...)
+puts response.content         # Ruby Hash
+puts response.content_string  # JSON formatted response body
+```
+
+### Kinetic Request CE SDK example of a System User
+
+```ruby
+system_sdk = KineticSdk::RequestCe.new({
+  app_server_url: "http://localhost:8080/kinetic",
+  username: "configuration-user",
+  password: "password",
+  options: {
+    log_level: "info",
+    max_redirects: 3
+  }
+})
+response = system_sdk.add_space('My Company Space', 'my-company')
+
+puts response.code            # String value of HTTP response code ("200", "400", "500", etc...)
+puts response.status          # Ruby Fixnum value of response.code (200, 400, 500, etc...)
+puts response.content         # Ruby Hash
+puts response.content_string  # JSON formatted response body
+```
+
+### Kinetic Request CE SDK example of a Subdomain
+
+This example requires a proxy server configured to rewrite the space slug subdomain to the expected Request CE API route.
+
+```ruby
+space_sdk = KineticSdk::RequestCe.new({
+  space_server_url: "https://foo.myapp.io",
+  space_slug: "foo",
+  username: "space-user-1",
+  password: "password",
+  options: {
+    log_level: "info",
+    max_redirects: 3
+  }
+})
+response = space_sdk.find_kapps()
+kapps = response.content['kapps']
+
+puts response.code            # String value of HTTP response code ("200", "400", "500", etc...)
+puts response.status          # Ruby Fixnum value of response.code (200, 400, 500, etc...)
+puts response.content         # Ruby Hash
+puts response.content_string  # JSON formatted response body
+```
+
+### Kinetic Task SDK example
+
+```ruby
+task_sdk = KineticSdk::Task.new({
+  app_server_url: "http://localhost:8080/kinetic-task",
+  username: "user-1",
+  password: "password",
+  options: {
+    export_directory: "/opt/exports/task-server-a",
+    log_level: "info",
+    max_redirects: 3
+  }
+})
+response = task_sdk.environment()
+
+puts response.code            # String value of HTTP response code ("200", "400", "500", etc...)
+puts response.status          # Ruby Fixnum value of response.code (200, 400, 500, etc...)
+puts response.content         # Ruby Hash
+puts response.content_string  # JSON formatted response body
+```
+
+### Kinetic Discussions SDK example of a Space User
+
+```ruby
+discussions_sdk = KineticSdk::Discussions.new({
+  app_server_url: "http://localhost:8080",
+  space_slug: "foo",
+  username: "space-user-1",
+  password: "password",
+  options: {
+    log_level: "info",
+    export_directory: "/Users/jboespflug/tmp/discussions",
+    oauth_client_id: "kinops",
+    oauth_client_secret: "kinops",
+    max_redirects: 3
+  }
+})
+response = discussions_sdk.find_discussions()
+discussions = response.content['discussions']
+
+puts response.code            # String value of HTTP response code ("200", "400", "500", etc...)
+puts response.status          # Ruby Fixnum value of response.code (200, 400, 500, etc...)
+puts response.content         # Ruby Hash
+puts response.content_string  # JSON formatted response body
+```
+
+### Kinetic Discussions SDK example of a Subdomain
+
+This example requires a proxy server configured to rewrite the space slug subdomain to the expected Discussions API route.
+
+```ruby
+discussions_sdk = KineticSdk::Discussions.new({
+  space_server_url: "https://foo.myapp.io",
+  space_slug: "foo",
+  username: "space-user-1",
+  password: "password",
+  options: {
+    log_level: "info",
+    export_directory: "/Users/jboespflug/tmp/discussions",
+    oauth_client_id: "kinops",
+    oauth_client_secret: "kinops",
+    max_redirects: 3
+  }
+})
+response = discussions_sdk.find_discussions()
+discussions = response.content['discussions']
+
+puts response.code            # String value of HTTP response code ("200", "400", "500", etc...)
+puts response.status          # Ruby Fixnum value of response.code (200, 400, 500, etc...)
+puts response.content         # Ruby Hash
+puts response.content_string  # JSON formatted response body
+```
+
+## SSL Options
+
+Starting in Kinetic SDK version 0.0.2, server certificate validation is turned off by default.  In version 0.0.1 it was enabled, but this caused problems with self-signed certificates and there was no way to disable it.
+
+Beginning with version 0.0.2, there are now two additional options that can be passed when constructing the SDK object.
+
+* `ssl_verify_mode`: allows server certificate validation when the value `peer` is used. (default `none`).
+* `ssl_ca_file`: allows specifying the server certificate key file (PEM format). Used when server certificate validation is enabled (`ssl_verify_mode: "peer"`).
+
+May be used with all application SDKs.
+
+**Example 1 using Kinetic Request CE without server certificate validation:**
+
+```ruby
+space_sdk = KineticSdk::RequestCe.new({
+  ...
+  options: {}
+})
+```
+
+**Example 2 using Kinetic Request CE without server certificate validation:**
+
+```ruby
+space_sdk = KineticSdk::RequestCe.new({
+  ...
+  options: {
+    ssl_verify_mode: "none"
+  }
+})
+```
+
+**Example using Kinetic Request CE with server certificate validation and known CAs:**
+
+```ruby
+space_sdk = KineticSdk::RequestCe.new({
+  ...
+  options: {
+    ssl_verify_mode: "peer"
+  }
+})
+```
+
+**Example using Kinetic Request CE with server certificate validation and a self-signing CA:**
+
+```ruby
+space_sdk = KineticSdk::RequestCe.new({
+  ...
+  options: {
+    ssl_verify_mode: "peer",
+    ssl_ca_file: "/path/to/self-signing-ca.pem"
+  }
+})
+```
+
+## Advanced Usage
+
+If you need to make a custom HTTP call for some reason, there is a class that allows you to do that. Simply make sure the KineticSdk is required in your program. See the [Getting Started Guide](GettingStarted.md) for details.
+
+Then you need to instantiate a new instance of the {KineticSdk::Utils::KineticHttp} class, and call the desired HTTP method with the appropriate information. Each response will be returned as a {KineticSdk::Utils::KineticHttpResponse} object.
+
+```ruby
+# instantiate the KineticHttp class without authentication
+http = KineticSdk::Utils::KineticHttp.new
+
+# instantiate the KineticHttp class with Basic authentication
+http = KineticSdk::Utils::KineticHttp.new("john.doe@company.com", "s3cretP@ssw0rd")
+
+# call the appropriate method
+
+# custom HTTP delete
+response = http.delete("https://my-server.com", default_headers)
+
+# custom HTTP get
+response = http.get(
+  "https://my-server.com",
+  { foo: 'foo', bar: 'bar' },
+  default_headers)
+
+# custom HTTP patch
+response = http.patch(
+  "https://my-server.com",
+  { foo: 'foo', bar: 'bar' },
+  default_headers)
+
+# custom HTTP post
+response = http.post(
+  "https://my-server.com",
+  { foo: 'foo', bar: 'bar' },
+  { "Custom Header" => "a custom value" }.merge(default_headers))
+
+# custom HTTP post multipart/form-data (for file uploads)
+response = http.post_multipart(
+  "https://my-server.com",
+  { file: File.new('/path/file.txt', 'rb') },
+  { "Custom Header" => "a custom value" }.merge(default_headers))
+
+# custom HTTP put
+response = http.put(
+  "https://my-server.com",
+  { foo: 'foo', bar: 'bar' },
+  default_headers)
+```
+
+## Additional Documentation
+
+The RDoc documentation for the SDK can be generated by running a rake command. This will provide detailed information for each module, class, and method. The output can be found in the generated `rdoc` directory.
+
+In order to do this however, the `yard` gem is required and must first be installed.
+
+This SDK includes a [Gemfile](./Gemfile) that can be used with the `bundler` gem to ensure the proper version is installed.
+
+Install the Bundler gem:
+
+    gem install bundler
+
+_IMPORTANT NOTE_: If using [rbenv](https://github.com/rbenv/rbenv) to manage Ruby versions, run the following command.
+
+    rbenv rehash
+
+Finally, install the dependency gems:
+
+    bundle install
+
+Now that the required documentation generation gem is installed, a simple Rake command can be run to generate the inline documentation. For this SDK, the following commands are all equivalent:
+
+```ruby
+bundle exec rake
+bundle exec rake doc
+bundle exec rake yard
+```

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+if !Gem::Specification.find_all_by_name('kinetic_sdk').empty?
+  require "bundler/setup"
+else
+  $:.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+end
+require "kinetic_sdk"
+
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gems/kontena-websocket-client-0.1.1/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in kontena-websocket-client.gemspec
+gemspec

data/gems/kontena-websocket-client-0.1.1/LICENSE

@@ -0,0 +1,190 @@
+Copyright 2017 Kontena, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS