vtk 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83a1b06084a090c2a973975063ae3584e5be741cd8231907aec5445e5ef9fdeb
-  data.tar.gz: ea5f7ebfd58fa183fe765d99a5e8efd81511ac0950b645f2008d7f0fd4c05cba
+  metadata.gz: dbb2159bd782736d6f9647826b073ab189e0e7d40d69dcb1664c16f62a688f09
+  data.tar.gz: 36386f949cd2c08013e97d3689ebc6f2c86c95ce0ca9fd7344223c35cb3ff261
 SHA512:
-  metadata.gz: f669995c82560deaa6651800c8025ee6a9bde95706a0671a1aea066ebcfc4b857673ba71c783b39de57e16c2685f3d29e8b63f98d3d798e8351a9aa7938981bc
-  data.tar.gz: 510020062d3c3f804f05eaf4135ace5443fb77da4043700ac7373db0e933ff5c57f356c2e396d294106709794615094e771a71127c791514739c1804222b5c80
+  metadata.gz: b375532131584051a1ad0c3036f68bab2304e8bdeb47cbfe7e3806fba24a5838be3e2229663cc836ae429eb17ebc2dc86a771589d83934226ea011dd80a8edc5
+  data.tar.gz: e28c0bbfa60f7ef3b15948e355171a8e9f2b8cb17fca8f4094217b75423b337e1e693d7226b42a80cc2b1165da08f7ac3951a284c26c68fc5178da2fef5504d9

data/.rubocop.yml

@@ -6,4 +6,5 @@ Layout/LineLength:
 
 Metrics/BlockLength:
   Exclude:
-    - 'spec/integration/module_spec.rb'
+    - 'spec/**/*.rb'
+    - '*.gemspec'

data/CHANGELOG.md

@@ -1,13 +1,61 @@
 # Changelog
 
-## [Unreleased](https://github.com/department-of-veterans-affairs/vtk/tree/HEAD)
+## [v0.2.6](https://github.com/department-of-veterans-affairs/vtk/tree/v0.2.6) (2021-02-03)
 
-[Full Changelog](https://github.com/department-of-veterans-affairs/vtk/compare/oclif...HEAD)
+[Full Changelog](https://github.com/department-of-veterans-affairs/vtk/compare/v0.2.5...v0.2.6)
 
 **Merged pull requests:**
 
+- Update changelog docs and raketask [\#13](https://github.com/department-of-veterans-affairs/vtk/pull/13) ([LindseySaari](https://github.com/LindseySaari))
+- add gem to auto generate changelog [\#12](https://github.com/department-of-veterans-affairs/vtk/pull/12) ([LindseySaari](https://github.com/LindseySaari))
+
+## [v0.2.5](https://github.com/department-of-veterans-affairs/vtk/tree/v0.2.5) (2021-02-03)
+
+[Full Changelog](https://github.com/department-of-veterans-affairs/vtk/compare/v0.2.4...v0.2.5)
+
+## [v0.2.4](https://github.com/department-of-veterans-affairs/vtk/tree/v0.2.4) (2021-01-26)
+
+[Full Changelog](https://github.com/department-of-veterans-affairs/vtk/compare/v0.2.3...v0.2.4)
+
+**Merged pull requests:**
+
+- added Docker instructions to the README [\#10](https://github.com/department-of-veterans-affairs/vtk/pull/10) ([thilton-oddball](https://github.com/thilton-oddball))
+- use system command [\#7](https://github.com/department-of-veterans-affairs/vtk/pull/7) ([LindseySaari](https://github.com/LindseySaari))
 - Add additional module subcommands [\#6](https://github.com/department-of-veterans-affairs/vtk/pull/6) ([LindseySaari](https://github.com/LindseySaari))
 - Check for Rails dependency [\#5](https://github.com/department-of-veterans-affairs/vtk/pull/5) ([LindseySaari](https://github.com/LindseySaari))
+
+## [v0.2.3](https://github.com/department-of-veterans-affairs/vtk/tree/v0.2.3) (2021-01-05)
+
+[Full Changelog](https://github.com/department-of-veterans-affairs/vtk/compare/v0.2.2...v0.2.3)
+
+**Merged pull requests:**
+
 - one more crack at fixing the README [\#4](https://github.com/department-of-veterans-affairs/vtk/pull/4) ([thilton-oddball](https://github.com/thilton-oddball))
+
+## [v0.2.2](https://github.com/department-of-veterans-affairs/vtk/tree/v0.2.2) (2021-01-05)
+
+[Full Changelog](https://github.com/department-of-veterans-affairs/vtk/compare/v0.1.0...v0.2.2)
+
+**Merged pull requests:**
+
 - fixing markdown in README … [\#3](https://github.com/department-of-veterans-affairs/vtk/pull/3) ([thilton-oddball](https://github.com/thilton-oddball))
+
+## [v0.1.0](https://github.com/department-of-veterans-affairs/vtk/tree/v0.1.0) (2021-01-04)
+
+[Full Changelog](https://github.com/department-of-veterans-affairs/vtk/compare/oclif...v0.1.0)
+
+**Merged pull requests:**
+
 - Start afresh with tty [\#2](https://github.com/department-of-veterans-affairs/vtk/pull/2) ([LindseySaari](https://github.com/LindseySaari))
+
+## [oclif](https://github.com/department-of-veterans-affairs/vtk/tree/oclif) (2020-08-10)
+
+[Full Changelog](https://github.com/department-of-veterans-affairs/vtk/compare/79143038509757799edb2bb9be2f925b7d985221...oclif)
+
+**Merged pull requests:**
+
+- Open Jenkins [\#1](https://github.com/department-of-veterans-affairs/vtk/pull/1) ([cvalarida](https://github.com/cvalarida))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -26,6 +26,23 @@ To add additional functionality to your module, the commands listed below are av
     $ vtk module service <module name>
     
 This above command runs a custom rails generator. For more information see the [module generator documentation](https://github.com/department-of-veterans-affairs/vets-api/blob/master/lib/generators/module/USAGE)
+
+### SOCKS
+
+Handles connecting to VA network via SOCKS.
+
+```
+$ vtk socks on
+----> Connecting...
+----> Connected to SOCKS.
+```
+
+To disconnect, run:
+
+```
+$ vtk socks off
+----> Disconnected from SOCKS.
+```
     
 ### Help
 
@@ -33,3 +50,27 @@ For helpful information about commands and subcommands run the following:
 
     $ vtk -h
     $ vtk module -h
+
+### Docker
+
+If using the vtk gem in Docker, you may first need to run the following commands to avoid any errors:
+
+	$ make docker-clean
+	$ make build
+	$ make bash
+	
+### Contributing
+1. Clone the repo
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Run the tests (bundle exec rake)
+4. Commit your changes 
+5. Push to the branch (git push origin my-new-feature)
+6. Create new Pull Request
+
+### Releasing
+1. Merge in your approved pull requests
+2. Update the version to be whatever it should (in lib/vtk/version.rb) be and commit
+   - The version bump could also be part of your PR
+3. ``` bundle exec rake release ``` 
+   - This will tag the release and publish to RubyGems
+4. Update the changelog — (```github_changelog_generator -u department-of-veterans-affairs -p vtk```)

data/Rakefile

@@ -10,3 +10,11 @@ require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]
+
+desc 'Tags version, pushes to remote, and pushes gem'
+task :release do
+  sh 'git', 'tag', "v#{Vtk::VERSION}"
+  sh "git push origin v#{Vtk::VERSION}"
+  sh 'rake build'
+  sh "ls pkg/vtk-#{Vtk::VERSION}.gem | xargs -n 1 gem push"
+end

data/lib/vtk/cli.rb

@@ -18,6 +18,9 @@ module Vtk
     end
     map %w[--version -v] => :version
 
+    require_relative 'commands/socks'
+    register Vtk::Commands::Socks, 'socks', 'socks [SUBCOMMAND]', 'Handles connecting to VA network via SOCKS'
+
     require_relative 'commands/module'
     register Vtk::Commands::Module, 'module', 'module [SUBCOMMAND]', 'Command description...'
   end

data/lib/vtk/commands/module/controller.rb

@@ -23,7 +23,7 @@ module Vtk
         private
 
         def create_controller(name)
-          `rails g module_component #{name} controller`
+          system("rails g module_component #{name} controller")
         end
       end
     end

data/lib/vtk/commands/module/model.rb

@@ -23,7 +23,7 @@ module Vtk
         private
 
         def create_model(name)
-          `rails g module_component #{name} model`
+          system("rails g module_component #{name} model")
         end
       end
     end

data/lib/vtk/commands/module/serializer.rb

@@ -23,7 +23,7 @@ module Vtk
         private
 
         def create_serializer(name)
-          `rails g module_component #{name} serializer`
+          system("rails g module_component #{name} serializer")
         end
       end
     end

data/lib/vtk/commands/module/service.rb

@@ -23,7 +23,7 @@ module Vtk
         private
 
         def create_service(name)
-          `rails g module_component #{name} service`
+          system("rails g module_component #{name} service")
         end
       end
     end

data/lib/vtk/commands/socks.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Vtk
+  module Commands
+    # Handles connecting to VA network via SOCKS
+    class Socks < Thor
+      namespace :socks
+
+      desc 'off', 'Disconnects from VA SOCKS'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      method_option :port, aliases: '-p', type: :string,
+                           desc: 'Port that SOCKS server is running on'
+      def off(*)
+        if options[:help]
+          invoke :help, ['off']
+        else
+          require_relative 'socks/off'
+          Vtk::Commands::Socks::Off.new(options).execute
+        end
+      end
+
+      desc 'on', 'Connects to VA SOCKS'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      method_option :port, aliases: '-p', type: :string,
+                           desc: 'Port to run SOCKS server on'
+      def on(*)
+        if options[:help]
+          invoke :help, ['on']
+        else
+          require_relative 'socks/on'
+          Vtk::Commands::Socks::On.new(options).execute
+        end
+      end
+    end
+  end
+end

data/lib/vtk/commands/socks/off.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+
+module Vtk
+  module Commands
+    class Socks
+      # Turns off SOCKS connection to VA network
+      class Off < Vtk::Command
+        attr_reader :options
+
+        def initialize(options)
+          @options = options
+
+          super()
+        end
+
+        def execute(_input: $stdin, output: $stdout)
+          pids_killed = running_pids.map { |pid| kill_pid pid }
+
+          if pids_killed.any? && pids_killed.all?
+            output.puts '----> Disconnected from SOCKS.'
+          else
+            output.puts '----> No SOCKS connection found.'
+          end
+        end
+
+        private
+
+        def running_pids
+          `lsof -Pi :#{options['port'] || 2001} -sTCP:LISTEN -t`.chomp.split "\n"
+        end
+
+        def kill_pid(pid)
+          system "kill -9 #{pid}"
+        end
+      end
+    end
+  end
+end

data/lib/vtk/commands/socks/on.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+
+module Vtk
+  module Commands
+    class Socks
+      # Turns on SOCKS connection to VA network
+      class On < Vtk::Command
+        attr_reader :input, :output, :port
+
+        def initialize(options)
+          @options = options
+          @port = options['port'] || '2001'
+
+          super()
+        end
+
+        def execute(_input: $stdin, output: $stdout)
+          @input = input
+          @output = output
+
+          return output.puts '----> Already connected to SOCKS.' if connected?
+
+          connect_to_socks
+          ensure_connection
+        end
+
+        private
+
+        def connected?
+          system "curl --max-time 2 -sL --proxy socks5h://127.0.0.1:#{port} sentry.vfs.va.gov 2> /dev/null | " \
+            'grep -q sentry-logo'
+        end
+
+        def connect_to_socks
+          exit if system "lsof -Pi :#{port} -sTCP:LISTEN -t > /dev/null"
+
+          Process.spawn "nohup ssh -vvv -o ServerAliveInterval=60 -o ConnectTimeout=5 socks -D #{port} -N" \
+            '> /tmp/socks.log 2>&1 &'
+        end
+
+        def ensure_connection
+          output.print '----> Connecting'
+          10.times do
+            sleep 1
+            output.print '.'
+            next unless connected?
+
+            return output.puts "\r----> Connected to SOCKS."
+          end
+
+          output.puts "\r----> ERROR: Could not connect to SOCKS."
+          output.puts "----> Verbose Output from SSH log:\n\n"
+
+          output.puts File.read '/tmp/socks.log'
+        end
+      end
+    end
+  end
+end

data/lib/vtk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vtk
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/vtk.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = 'https://github.com/department-of-veterans-affairs/vsp-toolkit/blob/master/CHANGELOG.md'
+  spec.metadata['changelog_uri'] = 'https://github.com/department-of-veterans-affairs/vtk/blob/master/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -29,6 +29,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'thor', '> 0.20.3'
 
+  spec.add_development_dependency 'github_changelog_generator', '~> 1.15.0'
+  spec.add_development_dependency 'pry', '~> 0.13.0'
   spec.add_development_dependency 'rake', '~> 13.0.0'
   spec.add_development_dependency 'rspec', '~> 3.10.0'
   spec.add_development_dependency 'rubocop', '~> 1.6.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vtk
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Eric Boehs
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -26,6 +26,34 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 0.20.3
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +159,9 @@ files:
 - lib/vtk/commands/module/model.rb
 - lib/vtk/commands/module/serializer.rb
 - lib/vtk/commands/module/service.rb
+- lib/vtk/commands/socks.rb
+- lib/vtk/commands/socks/off.rb
+- lib/vtk/commands/socks/on.rb
 - lib/vtk/templates/.gitkeep
 - lib/vtk/templates/module/add/.gitkeep
 - lib/vtk/version.rb
@@ -141,7 +172,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/department-of-veterans-affairs/vsp-toolkit
   source_code_uri: https://github.com/department-of-veterans-affairs/vsp-toolkit
-  changelog_uri: https://github.com/department-of-veterans-affairs/vsp-toolkit/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/department-of-veterans-affairs/vtk/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -157,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.1
 signing_key:
 specification_version: 4
 summary: A CLI for the VSP platform