deployment-tracker-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee3443749ac5fc7299f335f7bae763b9b836fb6c
+  data.tar.gz: ed9d05c3273fa078bf64cf9e4cf0d1de776f947a
+SHA512:
+  metadata.gz: 1f095e9beb7dbfbce8a4d60e19e2f6e7170b8d520391e0a778eac6e3cf5588202e6e05eab57bfa9399493411f56ed2aa678fa0f1c2601a38f51929bdb731b989
+  data.tar.gz: d0a215625f27768d47ac861269d01d2a89ff9b86001d7e65c324acf7124fd0d2334c0e14f6bcf2f599793da9441364ba7965bbd2a9a703bb75327133803bf154

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2015 Cimpress
+
+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.

data/README.md

@@ -0,0 +1,71 @@
+# deployment-tracker-client.rb
+
+Ruby API Client for [deployment-tracker](https://github.com/Cimpress-MCP/deployment-tracker)
+
+This repo will run swagger code generation on an instance of the deployment-tracker running
+locally and then transform the code a bit to make it readily distributable as a gem. There
+appear to be a number of bugs in the swagger codegen ruby generator that have been plastered
+over with a bunch of ugly `gsub!`s in the Rakefile.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deployment-tracker-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deployment-tracker-client
+
+## Usage
+
+```ruby
+require "deployment-tracker-client"
+require "SecureRandom"
+require "pp"
+
+SwaggerClient::Swagger.configure do |config|
+  config.host = "http://127.0.0.1:8080"
+end
+
+api = DeploymentTrackerClient::DefaultApi
+pp api.get_deployments(0, 3) # Print the 3 most recent deployments
+
+id = SecureRandom.uuid
+host = `hostname`.chomp
+user = `whoami`.chomp
+deployment = DeploymentTrackerClient::Deployment.new({
+    deployment_id: id,
+    engine: "deployment_tracker_test_suite",
+    engine_version: DeploymentTrackerClient::VERSION,
+    user: user,
+    host: host,
+    environment: "dev",
+    package: "my_package",
+    version: "1.2.3"
+  })
+puts "POSTING DEPLOYMENT #{id}"
+api.post_deployment id, deployment
+pp api.get_deployment id
+```
+
+## Vesioning
+This ruby client library major.minor version will be API compatible with the
+same major, minor pair of the deployment-tracker service. Older clients will
+remain backward compatible within major releases, but aren't guaranteed to be
+forward compatible. This means that the 0.6.x version of this library should work
+with any version of the service greater than 0.6 but less than 1.0
+
+## Contributing
+
+1. Fork it ( https://github.com/Cimpress-MCP/deployment-tracker-client.rb/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,49 @@
+require "bundler/gem_tasks"
+require "rake/clean"
+
+CLEAN.include("lib/deployment-tracker-client/api", "lib/deployment-tracker-client/models", "lib/swagger_client", "lib/swagger_client.rb")
+
+task default: :build
+
+desc "Generate swagger codegen code"
+task :gen do
+  unless ENV.key?("SWAGGER_CODEGEN_JAR") && File.exist?(ENV["SWAGGER_CODEGEN_JAR"])
+    fail "Unable to locate SWAGGER_CODEGEN_JAR at #{ENV['SWAGGER_CODEGEN_JAR']}. \
+Build it from https://github.com/swagger-api/swagger-codegen and set the SWAGGER_CODEGEN_JAR environment variable."
+  end
+  system("java -jar #{ENV['SWAGGER_CODEGEN_JAR']} generate -i http://127.0.0.1:8080 -l ruby -o . -c codegen_conf.json")
+
+  # Delete the swagger_client.gemspec, we don't need it
+  File.delete("swagger_client.gemspec")
+
+  %w(api models).each do |dir|
+    # Copy folder into the deployment-tracker-client directory
+    FileUtils.mv("./lib/swagger_client/#{dir}", "./lib/deployment-tracker-client/#{dir}", force: true)
+    Dir.foreach("./lib/deployment-tracker-client/#{dir}")	do |file|
+      file = File.join("./lib/deployment-tracker-client/#{dir}", file)
+      next unless File.file?(file)
+      contents = File.read(file)
+      contents.gsub!("module SwaggerClient", "module DeploymentTrackerClient")
+      contents.gsub!(" Swagger::", "SwaggerClient::Swagger::")
+      contents.gsub!("SwaggerClient.const_get", "DeploymentTrackerClient.const_get")
+      File.open(file, "w") do |f|
+        f.write(contents)
+      end
+    end
+  end
+
+  # Needs to be require_relative
+  contents = File.read("./lib/swagger_client.rb")
+  contents.gsub!("require ", "require_relative ")
+  contents.gsub!(/# Models.*?module SwaggerClient/m, "module SwaggerClient")
+  File.open("./lib/swagger_client.rb", "w") do |f|
+    f.write(contents)
+  end
+
+  # Remove empty case statement.
+  contents = File.read("./lib/swagger_client/swagger/request.rb")
+  contents.gsub!(/case auth_name.*?end/m, "")
+  File.open("./lib/swagger_client/swagger/request.rb", "w") do |f|
+    f.write(contents)
+  end
+end

data/codegen_conf.json

@@ -0,0 +1,4 @@
+{
+  "modelPackage":"deployment-tracker-client",
+  "apiPackage":"deployment-tracker-client"
+}

data/deployment-tracker-client.rb.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "deployment-tracker-client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "deployment-tracker-client"
+  spec.version       = DeploymentTrackerClient::VERSION
+  spec.authors       = ["Cimpress MCP Infrastructure"]
+  spec.email         = ["mcp_infrastructure@cimpress.com"]
+  spec.summary       = "Ruby API client for deployment-tracker"
+  spec.homepage      = "https://github.com/Cimpress-MCP/deployment-tracker-client.rb"
+  spec.license       = "Apache 2"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  # These were stolen from the swagger_client generated gemspec
+  spec.add_runtime_dependency "typhoeus", "~> 0.2", ">= 0.2.1"
+  spec.add_runtime_dependency "addressable", "~> 2.2", ">= 2.2.4"
+  spec.add_runtime_dependency "json", "~> 1.4", ">= 1.4.6"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/examples/basic.rb

@@ -0,0 +1,27 @@
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "deployment-tracker-client"
+require "SecureRandom"
+require "pp"
+
+SwaggerClient::Swagger.configure do |config|
+  config.host = "http://127.0.0.1:8080"
+end
+
+api = DeploymentTrackerClient::DefaultApi
+pp api.get_deployments(0, 3)
+
+id = SecureRandom.uuid
+host = `hostname`.chomp
+user = `whoami`.chomp
+deployment = DeploymentTrackerClient::Deployment.new(deployment_id: id,
+                                                     engine: "deployment_tracker_test_suite",
+                                                     engine_version: DeploymentTrackerClient::VERSION,
+                                                     user: user,
+                                                     host: host,
+                                                     environment: "dev",
+                                                     package: "my_package",
+                                                     version: "1.2.3")
+puts "POSTING DEPLOYMENT #{id}"
+api.post_deployment id, deployment
+pp api.get_deployment id