nexpose_ticketing 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5565130dee6d656e6dcf137e5b15292b463121a3
-  data.tar.gz: 02b652f6921f322fba0b06a1318250dee45659f2
+  metadata.gz: 684b4c23181af744dd2a5dc0d1cc7fa2f8a0409a
+  data.tar.gz: 2f49abe91a7d79b6903f0641a0018c7d3c7696c4
 SHA512:
-  metadata.gz: 01eed6d474199dd80e903d074e6d9d29023cf5f4df33336d28e7a07a1f2f4508ac1e2574637cc1bd148aed5308f22615c2006c763a6ee2ec488c3624b71419c9
-  data.tar.gz: 74c9d16fe8097cbfb5baf30dd8190953ed3629a9ef08b41f7ccea40d54e886aa52147ca91bf296e1e563f8524d4429e8ea3c913301bc010fb25a58df779933c0
+  metadata.gz: 4ed8c8a8ff7d8f9e1be52c2cd4dc137ca8f49ab3d03a6b99aa9843a07398ad7d242703b936fb0ee3f8a2ae9bb24570a60abe3a81f690a75e3a8c74591cd858fb
+  data.tar.gz: b7cba80df97d006976e13b258948ef8c8248d879634ee97a842ac555e4958611d600c399592077e78f350e0d53265595a70f7a8d9c65cc0eaaaf977e7fe795b0

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    nexpose_ticketing (1.3.0)
+      nexpose (~> 3.1, >= 3.1.0)
+      nokogiri (~> 1.6)
+      savon (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    akami (1.2.2)
+      gyoku (>= 0.4.0)
+      nokogiri
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    gyoku (1.1.1)
+      builder (>= 2.1.2)
+    httpi (2.1.1)
+      rack
+      rubyntlm (~> 0.3.2)
+    macaddr (1.7.1)
+      systemu (~> 2.6.2)
+    mini_portile2 (2.0.0)
+    nexpose (3.3.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    nori (2.4.0)
+    rack (1.6.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubyntlm (0.3.4)
+    savon (2.5.1)
+      akami (~> 1.2.0)
+      builder (>= 2.1.2)
+      gyoku (~> 1.1.0)
+      httpi (~> 2.1.0)
+      nokogiri (>= 1.4.0)
+      nori (~> 2.4.0)
+      uuid (~> 2.3.7)
+      wasabi (~> 3.3.0)
+    systemu (2.6.5)
+    uuid (2.3.8)
+      macaddr (~> 1.0)
+    wasabi (3.3.1)
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nexpose_ticketing!
+  rspec (~> 3.2, >= 3.2.0)
+  rspec-mocks (~> 3.2, >= 3.2.0)
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -62,6 +62,18 @@ To set custom locations for the key and IV files, update the following values wi
 
 To set a custom path after the integration has already executed, the files must be moved to the new location manually.
 
+#### Encrypting the Configuration without running the Integration
+The Nexpose Ticketing integration can encrypt its configuration file without running the gem. This allows users to secure their login information for future use e.g for use in a cron-schedule. 
+ 
+The command to do so is:  
+```
+nexpose_ticketing servicename -e
+```  
+or  
+```
+nexpose_ticketing servicename --encrypt_config
+```
+
 ## Contributions
 
 To develop your own implementation for Ticketing service 'foo':
@@ -90,12 +102,16 @@ We welcome contributions to this package. We ask only that pull requests and pat
 
 ## Changelog
 
+### 1.5.2
+26-05-17  
+Command line options have been added to the gem. Several are common to all Nexpose gem integrations. Call the gem with '-h' or '--help' to view these options.
+
 ### 1.5.1
 16-05-17
 Minor update to change storage location of log files.
 
 ### 1.5.0
-16-05-17
+16-05-17  
 Added an encryption configuration file. 
 Usernames and passwords within the configuration files are now encrypted when the application runs.
 

data/bin/nexpose_ticketing

@@ -1,16 +1,12 @@
 #!/usr/bin/env ruby
 require 'yaml'
 require 'nexpose_ticketing'
-require 'nexpose_ticketing/utilities/nx_logger'
 require 'nexpose_ticketing/version'
-require 'optparse'
+require 'nexpose_ticketing/utilities/nx_logger'
 require_relative '../lib/nexpose_ticketing/utilities/config_parser'
+require 'nexpose_ticketing/utilities/gem_options'
 
 options = {}
-OptionParser.new do |opts|
-  opts.banner = 'Usage: nexpose_ticketing [service name]'
-end.parse!
-
 if ARGV.count == 0
   puts 'Ticketing system name required.'
   exit -1
@@ -32,6 +28,14 @@ end
 ticket_service = YAML.load_file(service_config_path)
 enc_path = ticket_service[:encryption_options][:directory]
 
+# Setup CLI Options
+config_paths = [config_path, service_config_path]
+GemOptions.create_parser
+          .with_banner_and_options('nexpose_ticketing service_name')
+          .with_configuration_encryption(config_paths, enc_path)
+          .with_help_and_version('Nexpose Ticketing', NexposeTicketing::VERSION)
+          .parse
+
 # Now we can load the config as normal
 service_options = ConfigParser.get_config(config_path, enc_path)
 

data/lib/nexpose_ticketing/utilities/gem_options.rb

@@ -0,0 +1,91 @@
+require 'optparse'
+
+class GemOptions
+
+  @parser
+
+  def self.create_parser
+    @parser = OptionParser.new
+    self
+  end
+
+  # How the gem is used e.g 'nexpose ticketing jira [options]'
+  def self.with_banner(gem_usage_string)
+    @parser.banner = "Usage: #{gem_usage_string} [options]"
+    @parser.separator ''
+    self
+  end
+
+  # Header for options list
+  def self.with_options
+    @parser.separator 'Options:'
+    self
+  end
+
+  # Creates banner and options
+  def self.with_banner_and_options(gem_usage_string)
+    with_banner(gem_usage_string)
+    with_options
+    self
+  end
+
+  # For setting encryption switch. Can be set to work with two configurations
+  # Config_paths is an array
+  def self.with_configuration_encryption(config_paths, enc_path = nil)
+    @parser.on('-e',
+            '--encrypt_config',
+            'Encrypt the configuration file(s) without running the gem') do |e|
+      ConfigParser.get_config(config_paths.first, enc_path) unless enc_path.nil?
+      ConfigParser.get_config(config_paths.last)
+      puts "\nConfiguration File(s) Encrypted"
+      exit
+    end
+    self
+  end
+
+  def self.with_help
+    @parser.on_tail('-h', '--help', 'Show this message') do |h|
+      puts @parser
+      exit
+    end
+    self
+  end
+
+  def self.with_version(gem, version)
+    @parser.on_tail('--version', 'Version Information') do |v|
+      puts "#{gem} #{version}"
+      exit
+    end
+    self
+  end
+
+  def self.with_help_and_version(gem, version)
+    with_help
+    with_version(gem, version)
+    self
+  end
+
+  # Method to allow integrations to create own options, with both short and long
+  # switches and description.
+  # Handler is the block to run when option is called.
+  def self.with_other_option(short_switch, long_switch, description, &handler)
+    @parser.on("-#{short_switch}", "--#{long_switch}", description) do |opt|
+      handler.call
+    end
+  end
+
+  # Method to allow integrations to create own options, with only one size of
+  # switch and description.
+  # '-' for short switches and '--' for long switches is required.
+  # Handler is the block to run when option is called.
+  def self.with_single_switch_option(identifier, switch, description, &handler)
+    @parser.on("#{identifier}#{switch}", description) do |opt|
+      handler.call
+    end
+  end
+
+  # Parses the options to make them available
+  def self.parse
+    @parser.parse!
+  end
+end

data/lib/nexpose_ticketing/version.rb

@@ -1,3 +1,3 @@
 module NexposeTicketing
-  VERSION = '1.5.1'
+  VERSION = '1.5.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexpose_ticketing
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Damian Finol
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-16 00:00:00.000000000 Z
+date: 2017-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nexpose
@@ -152,6 +152,7 @@ extra_rdoc_files:
 - README.md
 files:
 - Gemfile
+- Gemfile.lock
 - README.md
 - bin/nexpose_ticketing
 - lib/nexpose_ticketing.rb
@@ -180,6 +181,7 @@ files:
 - lib/nexpose_ticketing/ticket_repository.rb
 - lib/nexpose_ticketing/ticket_service.rb
 - lib/nexpose_ticketing/utilities/config_parser.rb
+- lib/nexpose_ticketing/utilities/gem_options.rb
 - lib/nexpose_ticketing/utilities/nx_logger.rb
 - lib/nexpose_ticketing/version.rb
 homepage: https://github.com/rapid7/nexpose_ticketing
@@ -202,8 +204,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Ruby Nexpose Ticketing Engine.
 test_files: []
+has_rdoc: