replicatedvendor 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66ce44f072def3a8306532b2a6ce2e982710b675
-  data.tar.gz: 1882812683286bb9eea5ecadfa8cc6efbb68fd8a
+  metadata.gz: dcdb64816845eb9c4221f623e0f70ea6a362612e
+  data.tar.gz: 33451e97fdd9e4985da9e2ceaedf5b19f9ea83d8
 SHA512:
-  metadata.gz: 7435f080201126ee900d894600055f8ac1f2a48ded1ff91c86c7f100405c94fab16ca3af4012720fee16ad9513901ad5e74492846ad110f1e18c1cb29107266c
-  data.tar.gz: dbc107b18684764a9162e3351fa78530988730bca2853f99694e384424a40434f3830e9a60996fb8cc7cc837401547503301ab6e3a624b25edd9452e2965428a
+  metadata.gz: f401e421a07ca78b47d2bc82ec48f4bf87796704270c39066181fb6327bbb8fce0f485138d987e132f972a119fe8395dd08d8be954a01c6d85a65e1828afa138
+  data.tar.gz: 53c691bdca6f3f51c4d874c32753f8a321a47dd466eae4720706a255567b35f0d082705f33d24856a8822b43e0996aefddbbf4133d3d16a1076667fb56a79536

data/lib/api/apimodule.rb

@@ -1,3 +1,5 @@
+require_relative "./apiuri.rb"
+
 class ApiModule
 	def initialize(client = nil)
 		@client = client

data/lib/{apiuri.rb → api/apiuri.rb}

@@ -4,15 +4,11 @@ class ApiUri
    VENDOR_HOST = "api.replicated.com"
    VENDOR_BASE_PATH = "/vendor/v1"
 
-   def self.build_uri(module_name, endpoint = nil, params = nil)
+   def self.build_uri(endpoint, params = nil)
       uri_base = "https://" << VENDOR_HOST
       uri = URI(uri_base)
 
-      path = VENDOR_BASE_PATH << "/" << module_name
-      if endpoint
-         path = path << "/" << endpoint
-      end
-      uri.path = path
+      uri.path = VENDOR_BASE_PATH << "/" << endpoint
 
       if params
          uri.query = URI.encode_www_form(params)

data/lib/api/app/app.rb

@@ -1,52 +1,54 @@
 class App < ApiModule
 	def initialize(client)
 		super(client)
-		@ENDPOINT = client.ENDPOINT + "/" + "app"
 	end
 
-	def list_branding(appid)
-		endpoint = self.ENDPOINT + "/" + appid + "/branding"
-		return self.client.request("GET", endpoint)
+	def list_branding(app_id:)
+		method = "GET"
+		endpoint = "app/" + app_id + "/branding"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
 	end
 
-	def create_branding(appid:)
-		endpoint = self.ENDPOINT + "/" + appid + "/branding"
-		return self.client.request("POST", endpoint)
+	def create_branding(app_id:)
+		method = "POST"
+		endpoint = "app/" + app_id + "/branding"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
 	end
 
-	def list_license_fields(appid:)
-		endpoint = self.ENDPOINT + "/" + appid + "/licensefield"
-		return self.client.request("GET", endpoint)
+	def list_license_fields(app_id:)
+		method = "GET"
+		endpoint = "app/" + app_id + "/licensefield"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
 	end
 
-	def create_license_field(appid:, default:, hidden:, name:, required:, title:, type:)
-		endpoint = self.ENDPOINT + "/" + appid + "/licensefield"
-		return self.client.request("POST", endpoint, {
-			"default": default,
-			"hidden": hidden,
-			"name": name,
-			"required": required,
-			"title": title,
-			"type": type,
-		})
+	def create_license_field(app_id:, options:)
+		method = "POST"
+		endpoint = "app/" + app_id + "/licensefield"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri, options)
 	end
 
-	def edit_license_field(appid, license_field_name, default, hidden, title)
-		endpoint = self.ENDPOINT + "/" + appid + "/licensefield/" + license_field_name
-		return self.client.request("PUT", endpoint, {
-			"default": default,
-			"hidden": hidden,
-			"title": title,
-		})
+	def edit_license_field(app_id:, license_field_name:, options:)
+		method = "PUT"
+		endpoint = "app/" + app_id + "/licensefield/" + license_field_name
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri, options)
 	end
 
-	def delete_license_field(appid, license_field_name)
-		endpoint = self.ENDPOINT + "/" + appid + "/licensefield/" + license_field_name
-		return self.client.request("DELETE", endpoint)
+	def delete_license_field(app_id:, license_field_name:)
+		method = "DELETE"
+		endpoint = "app/" + app_id + "/licensefield/" + license_field_name
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
 	end
 
-	def list_license(appid)
-		endpoint = self.ENDPOINT + "/" + appid + "/licenses"
-		return self.client.request("GET", endpoint)
+	def list_license(app_id:)
+		method = "GET"
+		endpoint = "app/" + app_id + "/licenses"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
 	end
 end

data/lib/api/apps/apps.rb

@@ -1,37 +1,33 @@
 class Apps < ApiModule
 	def initialize(client)
 		super(client)
-		@ENDPOINT = client.ENDPOINT + "/" + "app"
 	end
 
 	def list()
 		method = "GET"
-		return self.client.request(method, self.ENDPOINT)
+		endpoint = "app"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
 	end
 
-	def delete(appid)
+	def delete(app_id:)
 		method = "DELETE"
-		unless appid.is_a? Integer
-			raise "Non integer appid"
-		end
-		endpoint = self.ENDPOINT + "/" + appid
-		return self.client.request(method, endpoint)
+		endpoint = "app/" + app_id
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
 	end
 
-	def delete_branding(appid)
+	def delete_branding(app_id:)
 		method = "DELETE"
-		unless appid.is_a? Integer
-			raise "Non integer appid"
-		end
-		endpoint = self.ENDPOINT + "/" + appid + "/branding"
-		return self.client.request(method, endpoint)
+		endpoint = "app/" + app_id + "/branding"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
 	end
 
-	def create(name)
+	def create(options:)
 		method = "POST"
-		unless appid.is_a? String
-			raise "Non string app name"
-		end
-		return self.client.request(method, self.ENDPOINT, {"name" => name})
+		endpoint = "app"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri, options)
 	end
 end

data/lib/api/auditlog/auditlog.rb

@@ -3,9 +3,11 @@ class AuditLog < ApiModule
 		super(client)
 	end
 
-	def get_token(targetid)
+	# Expects query parameter target_id
+	def get_token(options:)
+		method = "GET"
 		endpoint = "auditlogtoken"
-		params = {"target_id" => targetid}
-		return self.client.request("GET", endpoint, params)
+		uri = ApiUri::build_uri(endpoint, options)
+		return self.client.request(method, uri)
 	end
 end

data/lib/api/auth/auth.rb

@@ -0,0 +1,29 @@
+class Auth < ApiModule
+	def login(options:)
+		method = "POST"
+		endpoint = "user/login"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+
+	def login_otp(options:)
+		method = "POST"
+		endpoint = "user/login/otp"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+
+	def logout()
+		method = "POST"
+		endpoint = "user/logout"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def signup(options:)
+		method = "POST"
+		endpoint = "user/signup"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+end

data/lib/api/channel/channel.rb

@@ -0,0 +1,36 @@
+class Channel < ApiModule
+	def create_channel(app_id:, options:)
+		method = "POST"
+		endpoint = "app/" + app_id + "/channel"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+
+	def update_channel(app_id:, channel_id:, options:)
+		method = "POST"
+		endpoint = "app/" + app_id + "/channel/" + channel_id
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+
+	def archive_channel(app_id:, channel_id:)
+		method = "POST"
+		endpoint = "app/" + app_id + "/channel/" + channel_id + "/archive"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def update_release(app_id:, channel_id:, sequence:, options:)
+		method = "POST"
+		endpoint = "app/" + app_id + "/channel/" + channel_id + "/release/" + sequence
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+
+	def list_releases(app_id:, channel_id:)
+		method = "GET"
+		endpoint = "app/" + app_id + "/channel/" + channel_id + "/releases"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+end

data/lib/api/license/license.rb

@@ -0,0 +1,136 @@
+class License < ApiModule
+	def create(options:)
+		method = "POST"
+		endpoint = "license"
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+
+	def get(license_id:)
+		method = "GET"
+		endpoint = "license/" << license_id
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def update(license_id:, options:)
+		method = "PUT"
+		endpoint = "license/" << license_id
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+
+	def archive(license_id:)
+		method = "DELETE"
+		endpoint = "license/" << license_id
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def update_airgap(license_id:)
+		method  = "POST"
+		endpoint = "license/" << license_id << "/airgap/password"
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def update_billing(license_id:, options:)
+		method = "PUT"
+		endpoint = "license/" << license_id << "/billing"	
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def create_billing_event(license_id:, options:)
+		method = "POST"
+		endpoint = "license/" << license_id << "/billling_event"
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+
+	def update_billing_event(license_id:, billing_event_id:, options:)
+		method = "PUT"
+		endpoint = "license/" << license_id << "/billing_event/" <<
+			billing_event_id
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+
+	def update_channel(license_id:, options:)
+		method = "PUT"
+		endpoint = "license/" << license_id << "/channel"
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+
+	def update_expiration(license_id:, options:)
+		method = "PUT"
+		endpoint = "license/" << license_id << "/expire"
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+
+	def set_license_field(license_id:, options:)
+		method = "PUT"
+		endpoint = "license/" << license_id << "/field"
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+
+	def get_license_fields(license_id:)
+		method = "GET"
+		endpoint = "license/" << license_id << "/fields"
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def update_license_fields(license_id:, options:)
+		method = "PUT"
+		endpoint = "license/" << license_id << "/field"
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+
+	def get_license_instance(license_id:, instance_id:)
+		method = "GET"
+		endpoint = "license/" << license_id << "/instance/" << instance_id
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def list_tracked_license_instances(license_id:)
+		method = "GET"
+		endpoint = "license/" << license_id << "/instances"
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def list_untracked_license_instances(license_id:)
+		method = "GET"
+		endpoint = "license/" << license_id << "/instances/untracked"
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def revoke_license(license_id:)
+		method = "PUT"
+		endpoint = "license/" << license_id << "/revoke"
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def unarchive_license(license_id:)
+		method = "PUT"
+		endpoint = "license/" << license_id << "/unarchive"
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+   # Warning: this returns an RLI in Base64
+	def download_license(license_id:)
+		method = "GET"
+		endpoint = "licensekey/" << license_id
+		uri = ApiUri.build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+end

data/lib/api/release/release.rb

@@ -0,0 +1,50 @@
+class Release < ApiModule
+	def create(appid:,  options:)
+		method = "POST"
+		endpoint = "app/" << appid << "/release"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def archive(appid:, squence:)
+		method = "POST"
+		endpoint = "app/" << appid << "/" << sequence << "/archive"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def get_preflight_checks(appid:, sequence:)
+		method = "GET"
+		endpoint = "app/" << appid << "/" << sequence << "/preflightchecks"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def promote(appid:, sequence:, options:)
+		method = "POST"
+		endpoint = "app/" << appid << "/" << sequence << "/promote"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+
+	def get_properties(appid:, sequence:)
+		method = "GET"
+		endpoint = "app/" << appid << "/" << sequence << "/properties"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def get_config(appid:, sequence:)
+		method = "GET"
+		endpoint = "app/" << appid << "/" << sequence << "/raw"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def update_config(appid:, sequence:)
+		method = "PUT"
+		endpoint = "app/" << appid << "/" << sequence << "/raw"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+end

data/lib/api/releases/releases.rb

@@ -0,0 +1,15 @@
+class Releases < ApiModule
+	def list_releases(app_id:)
+		method = "GET"
+		endpoint = "app/" + app_id + "/releases"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri)
+	end
+
+	def get_releases(app_id:, options:)
+		method = "GET"
+		endpoint = "app/" + app_id + "/releases/paged"
+		uri = ApiUri::build_uri(endpoint, options)
+		return self.client.request(method, uri)
+	end
+end

data/lib/api/team/team.rb

@@ -0,0 +1,12 @@
+class Team < ApiModule
+	def initialize(client)
+		super(client)
+	end
+
+	def invite_to_team(appid:, options:)
+		method = "POST"
+		endpoint = "team/invite/" << appid << "/signup"
+		uri = ApiUri::build_uri(endpoint)
+		return self.client.request(method, uri, options)
+	end
+end

data/lib/api.rb

@@ -14,42 +14,38 @@ class VendorApi
 	end
 
 	def apps
-
+		return Apps.new(@client)
 	end
 
 	def auditlog
-
-	end
-
-	def auditlog
-
+		return AuditLog.new(@client)
 	end
 
 	def auth
-
+		return Auth.new(@client)
 	end
 
 	def channel
-
+		return Channel.new(@client)
 	end
 
 	def license
-
+		return License.new(@client)
 	end
 
 	def licenes
-
+		return Licenses.new(@client)
 	end
 
 	def release
-
+		return Release.new(@client)
 	end
 
 	def releases
-
+		return Releases.new(@client)
 	end
 
 	def team
-
+		return Team.new(@client)
 	end
 end

data/lib/client/client.rb

@@ -4,7 +4,7 @@ require "ostruct"
 require "json"
 
 class ApiClient
-	ENDPOINT = "https://api.replicated.com/vendor/v1"
+	VENDOR_HOST = "api.replicated.com"
 	VERB_MAP = {
 		:get	 => Net::HTTP::Get,
 		:post	=> Net::HTTP::Post,
@@ -12,17 +12,18 @@ class ApiClient
 		:delete => Net::HTTP::Delete
 	}
 
-	def initialize(endpoint = ENDPOINT)
-		uri = URI.parse(endpoint)
-		@http = Net::HTTP.new(uri.host, uri.port)
+	def initialize
+		# Create persistent HTTP connection
+		@http = Net::HTTP.new(VENDOR_HOST, URI::HTTPS::DEFAULT_PORT,
+		 :use_ssl => uri.scheme == 'https')
 	end
 
 	def set_token(api_token)
 		@api_token = api_token
 	end
 
-	def request_json(method, path, params)
-		response = request(method, path, params)
+	def request_json(method, uri, params = nil)
+		response = request(method, uri, params)
 		body = JSON.parse(response.body)
 
 		OpenStruct.new(:code => response.code, :body => body)
@@ -30,14 +31,12 @@ class ApiClient
 		response
 	end
 
-	def request(method, path, params)
+	def request(method, uri, params)
 		method_sym = method.downcase.to_sym
-		case method_sym
-		when :get
-			full_path = encode_path_params(path, params)
-			request = VERB_MAP[method_sym].new(full_path)
-		else
-			request = VERB_MAP[method_sym].new(path)
+
+		request = VERB_MAP[method_sym].new(uri)
+
+		unless method_sym.is_eql? :get
 			request.set_form_data(params)
 		end
 
@@ -47,9 +46,4 @@ class ApiClient
 
 		@http.request(request)
 	end
-
-	def encode_path_params(path, params)
-		encoded = URI.encode_www_form(params)
-		[path, encoded].join("?")
-	end
 end

data/replicatedvendor.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'replicatedvendor'
-  s.version     = '0.0.1'
+  s.version     = '0.0.2'
   s.licenses    = ['MIT']
   s.summary     = "A ruby wrapper for the replicated vendor api"
   s.description = "A ruby wrapper for the replicated vendor api: https://replicated-vendor-api.readme.io/v1.0/reference"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: replicatedvendor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Guy Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-10 00:00:00.000000000 Z
+date: 2017-10-12 00:00:00.000000000 Z
 dependencies: []
 description: 'A ruby wrapper for the replicated vendor api: https://replicated-vendor-api.readme.io/v1.0/reference'
 email: guy.moore.normal@mgmail.com
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - lib/api.rb
 - lib/api/apimodule.rb
+- lib/api/apiuri.rb
 - lib/api/app/app.rb
 - lib/api/apps/apps.rb
 - lib/api/auditlog/auditlog.rb
@@ -29,9 +30,7 @@ files:
 - lib/api/release/release.rb
 - lib/api/releases/releases.rb
 - lib/api/team/team.rb
-- lib/apiuri.rb
 - lib/client/client.rb
-- lib/util/assert.rb
 - replicatedvendor.gemspec
 homepage: https://rubygems.org/gems/replicatedvendor
 licenses:

data/lib/util/assert.rb

@@ -1,13 +0,0 @@
-class Assert
-	def self.int(var)
-		unless appid.is_a? Integer
-			raise "Expected integer"
-		end
-	end
-
-	def self.bool(var)
-		unless appid.is_a? Boolean
-			raise "Expected boolean"
-		end
-	end
-end