rubyoctopus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f4b94d7686aebfc20a914a94f7b91d12babc320cc26e9c44d7bcbc0029c13f4c
+  data.tar.gz: ab1ecc8c2f71af3e1d61b36bd34384197ed7e122ba7a35f49b2666546d5924f4
+SHA512:
+  metadata.gz: '01691662ffc474f98b30ace2bea769d0ebf32d82e1437189c4be2b2b94944298daac5a0f6e3b9684ec2a9153a943c5863af25bd81a54518e81a893305b658676'
+  data.tar.gz: 3493475ed86fc5d3163154b526430855a12cfdda453272639573db468253ffa75469399f58e473143ff2e1655737e49d3287527433c737415e26aded3621f9d8

data/.devcontainer/Dockerfile

@@ -0,0 +1,17 @@
+# [Choice] Ruby version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.0, 2, 2.7, 2.6, 3-bullseye, 3.0-bullseye, 2-bullseye, 2.7-bullseye, 2.6-bullseye, 3-buster, 3.0-buster, 2-buster, 2.7-buster, 2.6-buster
+ARG VARIANT=2-bullseye
+FROM mcr.microsoft.com/vscode/devcontainers/ruby:0-${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+RUN gem install bundler
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/base.Dockerfile

@@ -0,0 +1,43 @@
+# [Choice] Ruby version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.0, 2, 2.7, 2.6, 3-bullseye, 3.0-bullseye, 2-bullseye, 2.7-bullseye, 2.6-bullseye, 3-buster, 3.0-buster, 2-buster, 2.7-buster, 2.6-buster
+ARG VARIANT=2-bullseye
+FROM ruby:${VARIANT}
+
+# Copy library scripts to execute
+COPY library-scripts/*.sh library-scripts/*.env /tmp/library-scripts/
+
+# [Option] Install zsh
+ARG INSTALL_ZSH="false"
+# [Option] Upgrade OS packages to their latest versions
+ARG UPGRADE_PACKAGES="true"
+# Install needed packages and setup non-root user. Use a separate RUN statement to add your own dependencies.
+ARG USERNAME=vscode
+ARG USER_UID=1000
+ARG USER_GID=$USER_UID
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    # Remove imagemagick due to https://security-tracker.debian.org/tracker/CVE-2019-10131
+    && apt-get purge -y imagemagick imagemagick-6-common \
+    # Install common packages, non-root user, rvm, core build tools
+    && bash /tmp/library-scripts/common-debian.sh "${INSTALL_ZSH}" "${USERNAME}" "${USER_UID}" "${USER_GID}" "${UPGRADE_PACKAGES}" "true" "true" \
+    && bash /tmp/library-scripts/ruby-debian.sh "none" "${USERNAME}" "true" "true" \
+    && apt-get autoremove -y && apt-get clean -y && rm -rf /var/lib/apt/lists/*
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+ENV NVM_DIR=/usr/local/share/nvm
+ENV NVM_SYMLINK_CURRENT=true \
+    PATH=${NVM_DIR}/current/bin:${PATH}
+RUN bash /tmp/library-scripts/node-debian.sh "${NVM_DIR}" "${NODE_VERSION}" "${USERNAME}" \
+    && apt-get clean -y && rm -rf /var/lib/apt/lists/*
+
+ # Remove library scripts for final image
+RUN rm -rf /tmp/library-scripts
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+# RUN gem install <your-gem-names-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/devcontainer.json

@@ -0,0 +1,36 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.209.6/containers/ruby
+{
+	"name": "Ruby",
+	"build": {
+		"dockerfile": "Dockerfile",
+		"args": { 
+			// Update 'VARIANT' to pick a Ruby version: 3, 3.0, 2, 2.7, 2.6
+			// Append -bullseye or -buster to pin to an OS version.
+			// Use -bullseye variants on local on arm64/Apple Silicon.
+			"VARIANT": "2.6",
+			// Options
+			"NODE_VERSION": "none"
+		}
+	},
+
+	// Set *default* container specific settings.json values on container create.
+	"settings": {},
+
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"rebornix.Ruby"
+	],
+	
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "bin/setup",
+
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode",
+	"features": {
+		"git": "latest"
+	}
+}

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-01-26
+
+- Initial release

data/Gemfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubyoctopus.gemspec
+gemspec
+
+# rubocop:disable Style/HashSyntax
+gem "rubocop", "~> 1.21", :group => %i[development test]
+# rubocop:enable Style/HashSyntax
+
+group :development do
+  gem "dotenv"
+end
+
+group :test do
+  gem "simplecov", require: false
+
+  gem "rake", "~> 13.0"
+
+  gem "rspec", "~> 3.0"
+end

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    rubyoctopus (0.1.0)
+      faraday (~> 1.0)
+      faraday_middleware (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    dotenv (2.7.6)
+    faraday (1.9.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    multipart-post (2.1.1)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.24.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  aarch64-linux
+  universal-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubyoctopus!
+  simplecov
+
+BUNDLED WITH
+   2.3.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Ruby-Octopus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+[![Ruby](https://github.com/Ruby-Octopus/ruby-octopus/actions/workflows/main.yml/badge.svg)](https://github.com/Ruby-Octopus/ruby-octopus/actions/workflows/main.yml)
+# RubyOctopus
+
+RubyOctopus is a REST client for [Octopus Deploy](https://octopus.com/) written in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubyoctopus'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubyoctopus
+
+## Usage
+
+Create an instance of the `OctopusClient` class by passing your Octopus API URL and an API key to it.
+
+```ruby
+example = RubyOctopus::OctopusClient.new("octopus_domain_here/api", "API-key_goes_here")
+```
+
+TODO: Add more examples, as the class gets built out more.
+
+## Development
+
+(OPTIONAL) Can use Visual Studio Code to Open Folder in Container via their Remote - Containers extension.
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Ruby-Octopus/ruby-octopus.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/rubyoctopus/model/environmentresource.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RubyOctopus
+  module Model
+    # A class modeling an Environment in Octopus.
+    class EnvironmentResource
+      attr_accessor :id, :space_id, :name, :description, :sort_order, :use_guided_failure,
+                    :allow_dynamic_infrastructure, :extension_settings, :links
+
+      def initialize(attribute_values)
+        @id = attribute_values["Id"]
+        @space_id = attribute_values["SpaceId"]
+        @name = attribute_values["Name"]
+        @description = attribute_values["Description"]
+        @sort_order = attribute_values["SortOrder"]
+        @use_guided_failure = attribute_values["UseGuidedFailure"]
+        @allow_dynamic_infrastructure = attribute_values["AllowDynamicInfrastructure"]
+        @extension_settings = attribute_values["ExtensionSettings"]
+        @links = attribute_values["Links"]
+      end
+    end
+  end
+end

data/lib/rubyoctopus/octopusclient.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "octopusconnection"
+
+module RubyOctopus
+  # Base class to use to perform actions against an Octopus instance.
+  class OctopusClient
+    attr_reader :connection
+
+    def initialize(url, api_key)
+      @connection = OctopusConnection.new(url, api_key)
+    end
+  end
+end

data/lib/rubyoctopus/octopusconnection.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+
+module RubyOctopus
+  # Base class to use to perform actions against an Octopus instance.
+  class OctopusConnection
+    # Users might want to check which domain an instance is targeting.
+    attr_reader :url
+
+    def initialize(url, api_key)
+      @url = url
+      @conn = Faraday.new(
+        url: url,
+        headers: { "X-Octopus-ApiKey": api_key }
+      ) do |faraday|
+        faraday.adapter Faraday.default_adapter
+        faraday.response :json
+      end
+    end
+
+    def get(resource_type)
+      @conn.get(resource_type)
+    end
+  end
+end

data/lib/rubyoctopus/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RubyOctopus
+  VERSION = "0.1.0"
+end

data/lib/rubyoctopus.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "rubyoctopus/version"
+require_relative "rubyoctopus/octopusclient"
+require_relative "rubyoctopus/model/environmentresource"
+
+module RubyOctopus
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/samples/get_environments.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "dotenv/load"
+
+require_relative "../lib/rubyoctopus"
+
+# Set these values in your .env
+client = RubyOctopus::OctopusClient.new(ENV["OCTOPUS_URL"], ENV["OCTOPUS_API_KEY"])
+
+# Gets the first page of environments from the server
+response = client.connection.get("Environments")
+puts "Received a #{response.status} response from server"
+
+environments = if response.status == 200
+                 response.body["Items"].map { |item| RubyOctopus::Model::EnvironmentResource.new(item) }
+               end
+
+environments.each { |environment| puts "#{environment.id}: #{environment.name}" }

data/sig/rubyoctopus.rbs

@@ -0,0 +1,4 @@
+module RubyOctopus
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: rubyoctopus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mason Emery
+- Jeff Merckens
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: 
+email:
+- thepolytheist@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/base.Dockerfile"
+- ".devcontainer/devcontainer.json"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/rubyoctopus.rb
+- lib/rubyoctopus/model/environmentresource.rb
+- lib/rubyoctopus/octopusclient.rb
+- lib/rubyoctopus/octopusconnection.rb
+- lib/rubyoctopus/version.rb
+- samples/get_environments.rb
+- sig/rubyoctopus.rbs
+homepage: https://github.com/Ruby-Octopus/ruby-octopus
+licenses: []
+metadata:
+  homepage_uri: https://github.com/Ruby-Octopus/ruby-octopus
+  source_code_uri: https://github.com/Ruby-Octopus/ruby-octopus
+  changelog_uri: https://github.com/Ruby-Octopus/ruby-octopus/blob/main/CHANGELOG.md
+  github_repo: git@github.com:Ruby-Octopus/ruby-octopus.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: RubyOctopus is a REST client for Octopus Deploy written in Ruby.
+test_files: []