algosec-sdk 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9084c00c73ae8f10e2b6f76d51a28b37ad4bf427
-  data.tar.gz: 55a2673e55f1fce9f55dd54c31ac388871911aab
+  metadata.gz: d57a7f42feec59ab1260d8b662d201048b341515
+  data.tar.gz: f116ced6c0739e3823ced4f4e10b82219131025b
 SHA512:
-  metadata.gz: ba8ea7d72dde6fddba0c5f93dbe318ede6d0a0ae53903bee470cb8fa23246fbb46ecd86616da873ccbadbf95277138adfc90eef5f5c6a173074dbc3e6de13398
-  data.tar.gz: 565c39137f6f8d2c9a24e3e82889899dfa7778b6726494359b1ecb1f127eb7489cebc35d630abfb9cf67a07515fb0b5241a7bb2536969971b112989eaa5ee558
+  metadata.gz: 982599fbbf3ac54e546469470dac5d86d6456dddfd1669032b10df17e290759f51c46afe5a7e01b964aaae5de343bb966cc35db939ceb625d31503f212ae4a55
+  data.tar.gz: b8a0bd17374d44d8d642bc3b9a3bd7b13fd2d9f2d8e24d21e6cd39ccb0a2bfa11bd3ea61457c0ba1ae142b1e7c6a80e99feafda1f1e235fca7203ab40668044d

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.1.0
+current_version = 1.2.0
 commit = True
 tag = True
 

data/.rubocop.yml

@@ -1,6 +1,6 @@
 # See default at https://github.com/bbatsov/rubocop/blob/master/config/default.yml
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.2
 
 Metrics/ClassLength:
   Max: 200
@@ -9,7 +9,7 @@ Metrics/LineLength:
   Max: 120
 
 Metrics/ModuleLength:
-  Max: 200
+  Max: 220
 
 Metrics/ParameterLists:
   Max: 6

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
 notifications:
-  - false
+  email:
+    on_success: never
+    on_failure: always

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler'
 require 'bundler/gem_tasks'
 require 'bundler/setup'

data/algosec-sdk.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # http://guides.rubygems.org/specification-reference
 require_relative './lib/algosec-sdk/version'
 
@@ -23,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop', '> 0.49.0'
+  spec.add_development_dependency 'rubocop', '~> 0.58.2'
   spec.add_development_dependency 'simplecov'
 end

data/lib/algosec-sdk.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'algosec-sdk/version'
 require_relative 'algosec-sdk/client'
 require_relative 'algosec-sdk/exceptions'

data/lib/algosec-sdk/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 require_relative 'rest'
 # Load all helpers:

data/lib/algosec-sdk/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # (c) Copyright 2018 AlgoSec Systems
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/algosec-sdk/helpers/business_flow_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'flow_comparisons'
 require 'set'
 require 'ipaddress'
@@ -30,6 +32,41 @@ module ALGOSEC_SDK
       response_handler(rest_post('/BusinessFlow/rest/v1/login'))
     end
 
+    # Create an application
+    # @param [String] name The application's name.
+    # @param [Array<String>] custom_fields Existing custom fields to assign to the application.
+    # @param [Array<String>] contacts Existing contacts to assign to the application.
+    # @param [Array<String>] labels Existing labels to assign to the application.
+    # @param [Array<String>] flows The flows to add to the application upon creation.
+    # @raise [RuntimeError] if the request failed
+    # @return Newly created Application object
+    def create_application(
+      name,
+      custom_fields = [],
+      contacts = [],
+      labels = [],
+      flows = []
+    )
+      new_application = {
+        name: name,
+        custom_fields: custom_fields,
+        contacts: contacts,
+        labels: labels,
+        flows: flows
+      }
+      response = rest_post('/BusinessFlow/rest/v1/applications/new', body: new_application)
+      response_handler(response)
+    end
+
+    # Decommission an application
+    # @param [String] app_revision_id
+    # @raise [RuntimeError] if the request failed
+    # @return true
+    def decommission_application(app_revision_id)
+      response = rest_post("/BusinessFlow/rest/v1/applications/#{app_revision_id}/decommission")
+      response_handler(response)
+    end
+
     # Get list of application flows for an application revision id
     # @param [String, Symbol] app_revision_id
     # @raise [RuntimeError] if the request failed
@@ -138,14 +175,37 @@ module ALGOSEC_SDK
       requested_flow
     end
 
+    # Get all applications
+    # @raise [RuntimeError] if the request failed
+    # @return [Array<Hash>] application objects
+    def get_applications
+      response = rest_get('/BusinessFlow/rest/v1/applications/')
+      response_handler(response)
+    end
+
+    # Get application by name
+    # @param [String, Symbol] app_name
+    # @raise [RuntimeError] if the request failed
+    # @return [Hash] application object
+    def get_application_by_name(app_name)
+      response = rest_get("/BusinessFlow/rest/v1/applications/name/#{app_name}")
+      response_handler(response)
+    end
+
     # Get latest application revision id by application name
     # @param [String, Symbol] app_name
     # @raise [RuntimeError] if the request failed
     # @return [Boolean] application revision id
     def get_app_revision_id_by_name(app_name)
-      response = rest_get("/BusinessFlow/rest/v1/applications/name/#{app_name}")
-      app = response_handler(response)
-      app['revisionID']
+      get_application_by_name(app_name)['revisionID']
+    end
+
+    # Get application id by it's name
+    # @param [String, Symbol] app_name
+    # @raise [RuntimeError] if the request failed
+    # @return [Boolean] application id
+    def get_app_id_by_name(app_name)
+      get_application_by_name(app_name)['applicationId']
     end
 
     # Apply application draft

data/lib/algosec-sdk/helpers/flow_comparisons.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module ALGOSEC_SDK

data/lib/algosec-sdk/rest.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'net/http'
 require 'openssl'
@@ -57,7 +59,6 @@ module ALGOSEC_SDK
     rescue SocketError => e
       msg = "Failed to connect to AlgoSec host #{@host}!\n"
       @logger.error msg
-      e.message.prepend(msg)
       raise e
     end
 

data/lib/algosec-sdk/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # Gem version defined here
 module ALGOSEC_SDK
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/rakelib/end-to-end-integration.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 desc 'Test API SDK end-to-end against an AlgoSec machine'
 task :e2e, %i[app host user password] => [] do |_t, args|
   require 'algosec-sdk'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algosec-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Almog Cohen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-17 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -98,16 +98,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 0.58.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 0.58.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement