From b0efb7e27f57e2c73d53ba0c0172e888a1234bdf Mon Sep 17 00:00:00 2001 From: Jason Davis-Cooke Date: Mon, 19 Jan 2015 07:31:47 -0500 Subject: [PATCH] Rubocop cleanup --- Gemfile | 3 +- Rakefile | 19 ++-- bin/zamioculcas | 139 ++++++++++++------------ lib/zanzibar.rb | 67 +++++------- lib/zanzibar/version.rb | 2 +- spec/spec/spec_helper.rb | 192 ++++++++++++++++---------------- spec/zanzibar_spec.rb | 229 +++++++++++++++++++-------------------- zanzibar.gemspec | 25 +++-- 8 files changed, 331 insertions(+), 345 deletions(-) diff --git a/Gemfile b/Gemfile index 0f68d13..2376a88 100644 --- a/Gemfile +++ b/Gemfile @@ -7,8 +7,9 @@ group :test do gem 'savon_spec' gem 'rspec' gem 'webmock' - gem "codeclimate-test-reporter" + gem 'codeclimate-test-reporter' gem 'zanzibar', path: '.' + gem 'rubocop' end # Specify your gem's dependencies in zanzibar.gemspec diff --git a/Rakefile b/Rakefile index cc077b1..8477839 100644 --- a/Rakefile +++ b/Rakefile @@ -1,8 +1,11 @@ -require "bundler/gem_tasks" -require "bundler/setup" # load up our gem environment (incl. local zanzibar) -require 'rspec/core/rake_task' -require 'zanzibar/version' - -task :default => [:test] - -RSpec::Core::RakeTask.new(:test) +require 'bundler/gem_tasks' +require 'bundler/setup' # load up our gem environment (incl. local zanzibar) +require 'rspec/core/rake_task' +require 'zanzibar/version' +require 'rubocop/rake_task' + +task default: [:test] + +RSpec::Core::RakeTask.new(:test) + +RuboCop::RakeTask.new diff --git a/bin/zamioculcas b/bin/zamioculcas index c2231ec..0909502 100644 --- a/bin/zamioculcas +++ b/bin/zamioculcas @@ -1,70 +1,69 @@ -#! ruby - -require 'zanzibar' -require 'optparse' - -options = { - :domain => 'local' -} - -OptionParser.new do |opts| - opts.banner = "Usage: zamioculcas -d domain [-w wsdl] [-k] [-p] [secret_id]" - - opts.on("-d", "--domain DOMAIN", "Specify domain") do |v| - options[:domain] = v - end - - opts.on("-w", "--wsdl WSDL", "Specify WSDL location") do |v| - options[:wsdl] = v - end - - opts.on("-s", "--server SERVER", "Secret server hostname or IP") do |v| - options[:server] = v - end - - opts.on("-k", "--no-check-certificate", "Don't run SSL certificate checks") do |v| - options[:globals] = {:ssl_verify_mode => :none} - end - - opts.on("-p", "--password PASSWORD", "Specify password") do |v| - options[:pwd] = v - end - - opts.on("-t", "--type TYPE", "Specify the type of secret") do |v| - options[:type] = v - end - - opts.on("-u", "--user USER", "Specify the username") do |v| - options[:username] = v - end - -end.parse! - -raise OptionParser::MissingArgument if options[:server].nil? -options[:type] = "password" if options[:type].nil? - -unless STDIN.tty? || options[:pwd] - options[:pwd] = $stdin.read.strip -end - -secret_id = Integer(ARGV.pop) -if(!secret_id) - fail "no secret!" -end - -unless options[:wsdl] || options[:server].nil? - options[:wsdl] = "https://#{options[:server]}/webservices/sswebservice.asmx?wsdl" -end - -scrt = Zanzibar::Zanzibar.new(options) - -case options[:type] -when "password" - $stdout.write "#{scrt.get_password(secret_id)}\n" -when "privatekey" - scrt.download_private_key(:scrt_id=>secret_id) -when "publickey" - scrt.download_public_key(:scrt_id=>secret_id) -else - $stderr.write "#{options[:type]} is not a known type." -end +#! ruby + +require 'zanzibar' +require 'optparse' + +options = { + domain: 'local' +} + +OptionParser.new do |opts| + opts.banner = 'Usage: zamioculcas -d domain [-w wsdl] [-k] [-p] [secret_id]' + + opts.on('-d', '--domain DOMAIN', 'Specify domain') do |v| + options[:domain] = v + end + + opts.on('-w', '--wsdl WSDL', 'Specify WSDL location') do |v| + options[:wsdl] = v + end + + opts.on('-s', '--server SERVER', 'Secret server hostname or IP') do |v| + options[:server] = v + end + + opts.on('-k', '--no-check-certificate', "Don't run SSL certificate checks") do |_v| + options[:globals] = { ssl_verify_mode: :none } + end + + opts.on('-p', '--password PASSWORD', 'Specify password') do |v| + options[:pwd] = v + end + + opts.on('-t', '--type TYPE', 'Specify the type of secret') do |v| + options[:type] = v + end + + opts.on('-u', '--user USER', 'Specify the username') do |v| + options[:username] = v + end +end.parse! + +fail OptionParser::MissingArgument if options[:server].nil? +options[:type] = 'password' if options[:type].nil? + +unless STDIN.tty? || options[:pwd] + options[:pwd] = $stdin.read.strip +end + +secret_id = Integer(ARGV.pop) +unless secret_id + fail 'no secret!' +end + +unless options[:wsdl] || options[:server].nil? + options[:wsdl] = "https://#{options[:server]}/webservices/sswebservice.asmx?wsdl" +end + +scrt = Zanzibar::Zanzibar.new(options) + +case options[:type] +when 'password' + $stdout.write "#{scrt.get_password(secret_id)}\n" +when 'privatekey' + scrt.download_private_key(scrt_id: secret_id) +when 'publickey' + scrt.download_public_key(scrt_id: secret_id) +else + $stderr.write "#{options[:type]} is not a known type." +end diff --git a/lib/zanzibar.rb b/lib/zanzibar.rb index e7d7bdf..1b5f2d4 100644 --- a/lib/zanzibar.rb +++ b/lib/zanzibar.rb @@ -1,19 +1,16 @@ -require "zanzibar/version" +require 'zanzibar/version' require 'savon' require 'io/console' require 'fileutils' module Zanzibar - ## # Class for interacting with Secret Server class Zanzibar - ## # @param args{:domain, :wsdl, :pwd, :username, :globals{}} def initialize(args = {}) - if args[:username] @@username = args[:username] else @@ -26,7 +23,7 @@ module Zanzibar @@wsdl = get_wsdl_location end if args[:pwd] - @@password = args[:pwd] + @@password = args[:pwd] else @@password = prompt_for_password end @@ -43,7 +40,7 @@ module Zanzibar # @param globals{}, optional def init_client(globals = {}) - globals = {} if globals == nil + globals = {} if globals.nil? @@client = Savon.client(globals) do wsdl @@wsdl end @@ -54,39 +51,36 @@ module Zanzibar def prompt_for_password puts "Please enter password for #{@@username}:" - return STDIN.noecho(&:gets).chomp + STDIN.noecho(&:gets).chomp end ## Gets the wsdl document location if none is provided in the constructor # @return [String] the location of the WDSL document def prompt_for_wsdl_location - puts "Enter the URL of the Secret Server WSDL:" - return STDIN.gets.chomp + puts 'Enter the URL of the Secret Server WSDL:' + STDIN.gets.chomp end ## Gets the domain of the Secret Server installation if none is provided in the constructor # @return [String] the domain of the secret server installation def prompt_for_domain - puts "Enter the domain of your Secret Server:" - return STDIN.gets.chomp + puts 'Enter the domain of your Secret Server:' + STDIN.gets.chomp end - ## Get an authentication token for interacting with Secret Server. These are only good for about 10 minutes so just get a new one each time. # Will raise an error if there is an issue with the authentication. # @return the authentication token for the current user. def get_token - begin - response = @@client.call(:authenticate, message: { username: @@username, password: @@password, organization: "", domain: @@domain }) - .hash[:envelope][:body][:authenticate_response][:authenticate_result] - raise "Error generating the authentication token for user #{@@username}: #{response[:errors][:string]}" if response[:errors] - response[:token] - rescue Savon::Error => err - raise "There was an error generating the authentiaton token for user #{@@username}: #{err}" - end + response = @@client.call(:authenticate, message: { username: @@username, password: @@password, organization: '', domain: @@domain }) + .hash[:envelope][:body][:authenticate_response][:authenticate_result] + fail "Error generating the authentication token for user #{@@username}: #{response[:errors][:string]}" if response[:errors] + response[:token] + rescue Savon::Error => err + raise "There was an error generating the authentiaton token for user #{@@username}: #{err}" end ## Get a secret returned as a hash @@ -95,13 +89,11 @@ module Zanzibar # @return [Hash] the secret hash retrieved from the wsdl def get_secret(scrt_id, token = nil) - begin - secret = @@client.call(:get_secret, message: { token: token || get_token, secretId: scrt_id}).hash[:envelope][:body][:get_secret_response][:get_secret_result] - raise "There was an error getting secret #{scrt_id}: #{secret[:errors][:string]}" if secret[:errors] - return secret - rescue Savon::Error => err - raise "There was an error getting the secret with id #{scrt_id}: #{err}" - end + secret = @@client.call(:get_secret, message: { token: token || get_token, secretId: scrt_id }).hash[:envelope][:body][:get_secret_response][:get_secret_result] + fail "There was an error getting secret #{scrt_id}: #{secret[:errors][:string]}" if secret[:errors] + return secret + rescue Savon::Error => err + raise "There was an error getting the secret with id #{scrt_id}: #{err}" end ## Retrieve a simple password from a secret @@ -110,13 +102,11 @@ module Zanzibar # @return [String] the password for the given secret def get_password(scrt_id) - begin - secret = get_secret(scrt_id) - secret_items = secret[:secret][:items][:secret_item] - return get_secret_item_by_field_name(secret_items,"Password")[:value] - rescue Savon::Error => err - raise "There was an error getting the password for secret #{scrt_id}: #{err}" - end + secret = get_secret(scrt_id) + secret_items = secret[:secret][:items][:secret_item] + return get_secret_item_by_field_name(secret_items, 'Password')[:value] + rescue Savon::Error => err + raise "There was an error getting the password for secret #{scrt_id}: #{err}" end def write_secret_to_file(path, secret_response) @@ -151,23 +141,21 @@ module Zanzibar # Raise on error # @param [Hash] args, :scrt_id, :type (one of "Private Key", "Public Key", "Attachment"), :scrt_item_id - optional, :path - optional - def download_secret_file(args = {}) token = get_token FileUtils.mkdir_p(args[:path]) if args[:path] path = args[:path] ? args[:path] : '.' ## The File.join below doesn't handle nils well, so let's take that possibility away. begin response = @@client.call(:download_file_attachment_by_item_id, message: - { token: token, secretId: args[:scrt_id], secretItemId: args[:scrt_item_id] || get_scrt_item_id(args[:scrt_id], args[:type], token)}) - .hash[:envelope][:body][:download_file_attachment_by_item_id_response][:download_file_attachment_by_item_id_result] - raise "There was an error getting the #{args[:type]} for secret #{args[:scrt_id]}: #{response[:errors][:string]}" if response[:errors] + { token: token, secretId: args[:scrt_id], secretItemId: args[:scrt_item_id] || get_scrt_item_id(args[:scrt_id], args[:type], token) }) + .hash[:envelope][:body][:download_file_attachment_by_item_id_response][:download_file_attachment_by_item_id_result] + fail "There was an error getting the #{args[:type]} for secret #{args[:scrt_id]}: #{response[:errors][:string]}" if response[:errors] write_secret_to_file(path, response) rescue Savon::Error => err raise "There was an error getting the #{args[:type]} for secret #{args[:scrt_id]}: #{err}" end end - ## Methods to maintain backwards compatibility def download_private_key(args = {}) args[:type] = 'Private Key' @@ -183,6 +171,5 @@ module Zanzibar args[:type] = 'Attachment' download_secret_file(args) end - end end diff --git a/lib/zanzibar/version.rb b/lib/zanzibar/version.rb index a71656b..d22407a 100644 --- a/lib/zanzibar/version.rb +++ b/lib/zanzibar/version.rb @@ -1,3 +1,3 @@ module Zanzibar - VERSION = "0.1.10" + VERSION = '0.1.10' end diff --git a/spec/spec/spec_helper.rb b/spec/spec/spec_helper.rb index 6ba1043..f684b32 100644 --- a/spec/spec/spec_helper.rb +++ b/spec/spec/spec_helper.rb @@ -1,97 +1,95 @@ -# This file was generated by the `rspec --init` command. Conventionally, all -# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`. -# The generated `.rspec` file contains `--require spec_helper` which will cause this -# file to always be loaded, without a need to explicitly require it in any files. -# -# Given that it is always loaded, you are encouraged to keep this file as -# light-weight as possible. Requiring heavyweight dependencies from this file -# will add to the boot time of your test suite on EVERY test run, even for an -# individual file that may not need all of that loaded. Instead, consider making -# a separate helper file that requires the additional dependencies and performs -# the additional setup, and require it from the spec files that actually need it. -# -# The `.rspec` file also contains a few flags that are not defaults but that -# users commonly want. -# -# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration -require 'webmock/rspec' -require "codeclimate-test-reporter" -CodeClimate::TestReporter.start - -RSpec.configure do |config| - # rspec-expectations config goes here. You can use an alternate - # assertion/expectation library such as wrong or the stdlib/minitest - # assertions if you prefer. - config.expect_with :rspec do |expectations| - # This option will default to `true` in RSpec 4. It makes the `description` - # and `failure_message` of custom matchers include text for helper methods - # defined using `chain`, e.g.: - # be_bigger_than(2).and_smaller_than(4).description - # # => "be bigger than 2 and smaller than 4" - # ...rather than: - # # => "be bigger than 2" - expectations.include_chain_clauses_in_custom_matcher_descriptions = true - end - - # rspec-mocks config goes here. You can use an alternate test double - # library (such as bogus or mocha) by changing the `mock_with` option here. - config.mock_with :rspec do |mocks| - # Prevents you from mocking or stubbing a method that does not exist on - # a real object. This is generally recommended, and will default to - # `true` in RSpec 4. - mocks.verify_partial_doubles = true - end - - config.after(:suite) do - WebMock.disable_net_connect!(:allow => 'codeclimate.com') - end - -# The settings below are suggested to provide a good initial experience -# with RSpec, but feel free to customize to your heart's content. -=begin - # These two settings work together to allow you to limit a spec run - # to individual examples or groups you care about by tagging them with - # `:focus` metadata. When nothing is tagged with `:focus`, all examples - # get run. - config.filter_run :focus - config.run_all_when_everything_filtered = true - - # Limits the available syntax to the non-monkey patched syntax that is recommended. - # For more details, see: - # - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax - # - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/ - # - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching - config.disable_monkey_patching! - - # This setting enables warnings. It's recommended, but in some cases may - # be too noisy due to issues in dependencies. - config.warnings = true - - # Many RSpec users commonly either run the entire suite or an individual - # file, and it's useful to allow more verbose output when running an - # individual spec file. - if config.files_to_run.one? - # Use the documentation formatter for detailed output, - # unless a formatter has already been configured - # (e.g. via a command-line flag). - config.default_formatter = 'doc' - end - - # Print the 10 slowest examples and example groups at the - # end of the spec run, to help surface which specs are running - # particularly slow. - config.profile_examples = 10 - - # Run specs in random order to surface order dependencies. If you find an - # order dependency and want to debug it, you can fix the order by providing - # the seed, which is printed after each run. - # --seed 1234 - config.order = :random - - # Seed global randomization in this process using the `--seed` CLI option. - # Setting this allows you to use `--seed` to deterministically reproduce - # test failures related to randomization by passing the same `--seed` value - # as the one that triggered the failure. - Kernel.srand config.seed -=end -end +# This file was generated by the `rspec --init` command. Conventionally, all +# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`. +# The generated `.rspec` file contains `--require spec_helper` which will cause this +# file to always be loaded, without a need to explicitly require it in any files. +# +# Given that it is always loaded, you are encouraged to keep this file as +# light-weight as possible. Requiring heavyweight dependencies from this file +# will add to the boot time of your test suite on EVERY test run, even for an +# individual file that may not need all of that loaded. Instead, consider making +# a separate helper file that requires the additional dependencies and performs +# the additional setup, and require it from the spec files that actually need it. +# +# The `.rspec` file also contains a few flags that are not defaults but that +# users commonly want. +# +# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration +require 'webmock/rspec' +require 'codeclimate-test-reporter' +CodeClimate::TestReporter.start + +RSpec.configure do |config| + # rspec-expectations config goes here. You can use an alternate + # assertion/expectation library such as wrong or the stdlib/minitest + # assertions if you prefer. + config.expect_with :rspec do |expectations| + # This option will default to `true` in RSpec 4. It makes the `description` + # and `failure_message` of custom matchers include text for helper methods + # defined using `chain`, e.g.: + # be_bigger_than(2).and_smaller_than(4).description + # # => "be bigger than 2 and smaller than 4" + # ...rather than: + # # => "be bigger than 2" + expectations.include_chain_clauses_in_custom_matcher_descriptions = true + end + + # rspec-mocks config goes here. You can use an alternate test double + # library (such as bogus or mocha) by changing the `mock_with` option here. + config.mock_with :rspec do |mocks| + # Prevents you from mocking or stubbing a method that does not exist on + # a real object. This is generally recommended, and will default to + # `true` in RSpec 4. + mocks.verify_partial_doubles = true + end + + config.after(:suite) do + WebMock.disable_net_connect!(allow: 'codeclimate.com') + end + + # The settings below are suggested to provide a good initial experience + # with RSpec, but feel free to customize to your heart's content. + # # These two settings work together to allow you to limit a spec run + # # to individual examples or groups you care about by tagging them with + # # `:focus` metadata. When nothing is tagged with `:focus`, all examples + # # get run. + # config.filter_run :focus + # config.run_all_when_everything_filtered = true + # + # # Limits the available syntax to the non-monkey patched syntax that is recommended. + # # For more details, see: + # # - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax + # # - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/ + # # - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching + # config.disable_monkey_patching! + # + # # This setting enables warnings. It's recommended, but in some cases may + # # be too noisy due to issues in dependencies. + # config.warnings = true + # + # # Many RSpec users commonly either run the entire suite or an individual + # # file, and it's useful to allow more verbose output when running an + # # individual spec file. + # if config.files_to_run.one? + # # Use the documentation formatter for detailed output, + # # unless a formatter has already been configured + # # (e.g. via a command-line flag). + # config.default_formatter = 'doc' + # end + # + # # Print the 10 slowest examples and example groups at the + # # end of the spec run, to help surface which specs are running + # # particularly slow. + # config.profile_examples = 10 + # + # # Run specs in random order to surface order dependencies. If you find an + # # order dependency and want to debug it, you can fix the order by providing + # # the seed, which is printed after each run. + # # --seed 1234 + # config.order = :random + # + # # Seed global randomization in this process using the `--seed` CLI option. + # # Setting this allows you to use `--seed` to deterministically reproduce + # # test failures related to randomization by passing the same `--seed` value + # # as the one that triggered the failure. + # Kernel.srand config.seed +end diff --git a/spec/zanzibar_spec.rb b/spec/zanzibar_spec.rb index 492218c..7d39a72 100644 --- a/spec/zanzibar_spec.rb +++ b/spec/zanzibar_spec.rb @@ -1,116 +1,113 @@ -require 'zanzibar' -require 'savon' -require 'webmock' -require 'rspec' -require 'webmock/rspec' - -include WebMock::API - -describe "Zanzibar Test" do - - client = Zanzibar::Zanzibar.new(:domain => "zanzitest.net", :pwd=>'password', :wsdl => "spec/scrt.wsdl") - auth_xml = File.read('spec/responses/authenticate_response.xml') - secret_xml = File.read('spec/responses/get_secret_response.xml') - secret_with_key_xml = File.read('spec/responses/get_secret_with_keys_response.xml') - secret_with_attachment_xml = File.read('spec/responses/get_secret_with_attachment_response.xml') - private_key_xml = File.read('spec/responses/download_private_key_response.xml') - public_key_xml = File.read('spec/responses/download_public_key_response.xml') - attachment_xml = File.read('spec/responses/attachment_response.xml') - - - it 'should return an auth token' do - stub_request(:any, "https://www.zanzitest.net/webservices/sswebservice.asmx"). - to_return(:body => auth_xml, :status => 200) - - expect(client.get_token).to eq("imatoken") - end - - it 'should get a secret' do - stub_request(:any, "https://www.zanzitest.net/webservices/sswebservice.asmx"). - to_return(:body => auth_xml, :status => 200).then. - to_return(:body => secret_xml, :status => 200) - - expect(client.get_secret(1234)[:secret][:name]).to eq("Zanzi Test Secret") - end - - it 'should get a password' do - stub_request(:any, "https://www.zanzitest.net/webservices/sswebservice.asmx"). - to_return(:body => auth_xml, :status => 200).then. - to_return(:body => secret_xml, :status => 200) - - expect(client.get_password(1234)).to eq("zanziUserPassword") - end - - it 'should download a private key' do - stub_request(:any, "https://www.zanzitest.net/webservices/sswebservice.asmx"). - to_return(:body => auth_xml, :status => 200).then. - to_return(:body => secret_with_key_xml, :status => 200).then. - to_return(:body => private_key_xml, :status => 200) - - client.download_secret_file(:scrt_id => 2345, :type => 'Private Key') - expect(File.exist? 'zanzi_key') - expect(File.read('zanzi_key')).to eq("-----BEGIN RSA PRIVATE KEY -----\nzanzibarTestPassword\n-----END RSA PRIVATE KEY-----\n") - File.delete('zanzi_key') - end - - it 'should download a private key legacy' do - stub_request(:any, "https://www.zanzitest.net/webservices/sswebservice.asmx"). - to_return(:body => auth_xml, :status => 200).then. - to_return(:body => secret_with_key_xml, :status => 200).then. - to_return(:body => private_key_xml, :status => 200) - - client.download_private_key(:scrt_id => 2345) - expect(File.exist? 'zanzi_key') - expect(File.read('zanzi_key')).to eq("-----BEGIN RSA PRIVATE KEY -----\nzanzibarTestPassword\n-----END RSA PRIVATE KEY-----\n") - File.delete('zanzi_key') - end - - - it 'should download a public key' do - stub_request(:any, "https://www.zanzitest.net/webservices/sswebservice.asmx"). - to_return(:body => auth_xml, :status => 200).then. - to_return(:body => secret_with_key_xml, :status => 200).then. - to_return(:body => public_key_xml, :status => 200) - - client.download_secret_file(:scrt_id => 2345, :type => 'Public Key') - expect(File.exist? 'zanzi_key.pub') - expect(File.read('zanzi_key.pub')).to eq("1234PublicKey5678==\n") - File.delete('zanzi_key.pub') - end - - it 'should download a public key legacy' do - stub_request(:any, "https://www.zanzitest.net/webservices/sswebservice.asmx"). - to_return(:body => auth_xml, :status => 200).then. - to_return(:body => secret_with_key_xml, :status => 200).then. - to_return(:body => public_key_xml, :status => 200) - - client.download_public_key(:scrt_id => 2345) - expect(File.exist? 'zanzi_key.pub') - expect(File.read('zanzi_key.pub')).to eq("1234PublicKey5678==\n") - File.delete('zanzi_key.pub') - end - - it 'should download an attachment' do - stub_request(:any, "https://www.zanzitest.net/webservices/sswebservice.asmx"). - to_return(:body => auth_xml, :status => 200).then. - to_return(:body => secret_with_attachment_xml, :status => 200).then. - to_return(:body => attachment_xml, :status => 200) - - client.download_secret_file(:scrt_id => 3456, :type => 'Attachment') - expect(File.exist? 'attachment.txt') - expect(File.read('attachment.txt')).to eq("I am a secret attachment\n") - File.delete('attachment.txt') - end - - it 'should download an attachment legacy' do - stub_request(:any, "https://www.zanzitest.net/webservices/sswebservice.asmx"). - to_return(:body => auth_xml, :status => 200).then. - to_return(:body => secret_with_attachment_xml, :status => 200).then. - to_return(:body => attachment_xml, :status => 200) - - client.download_attachment(:scrt_id => 3456) - expect(File.exist? 'attachment.txt') - expect(File.read('attachment.txt')).to eq("I am a secret attachment\n") - File.delete('attachment.txt') - end -end +require 'zanzibar' +require 'savon' +require 'webmock' +require 'rspec' +require 'webmock/rspec' + +include WebMock::API + +describe 'Zanzibar Test' do + client = Zanzibar::Zanzibar.new(domain: 'zanzitest.net', pwd: 'password', wsdl: 'spec/scrt.wsdl') + auth_xml = File.read('spec/responses/authenticate_response.xml') + secret_xml = File.read('spec/responses/get_secret_response.xml') + secret_with_key_xml = File.read('spec/responses/get_secret_with_keys_response.xml') + secret_with_attachment_xml = File.read('spec/responses/get_secret_with_attachment_response.xml') + private_key_xml = File.read('spec/responses/download_private_key_response.xml') + public_key_xml = File.read('spec/responses/download_public_key_response.xml') + attachment_xml = File.read('spec/responses/attachment_response.xml') + + it 'should return an auth token' do + stub_request(:any, 'https://www.zanzitest.net/webservices/sswebservice.asmx') + .to_return(body: auth_xml, status: 200) + + expect(client.get_token).to eq('imatoken') + end + + it 'should get a secret' do + stub_request(:any, 'https://www.zanzitest.net/webservices/sswebservice.asmx') + .to_return(body: auth_xml, status: 200).then + .to_return(body: secret_xml, status: 200) + + expect(client.get_secret(1234)[:secret][:name]).to eq('Zanzi Test Secret') + end + + it 'should get a password' do + stub_request(:any, 'https://www.zanzitest.net/webservices/sswebservice.asmx') + .to_return(body: auth_xml, status: 200).then + .to_return(body: secret_xml, status: 200) + + expect(client.get_password(1234)).to eq('zanziUserPassword') + end + + it 'should download a private key' do + stub_request(:any, 'https://www.zanzitest.net/webservices/sswebservice.asmx') + .to_return(body: auth_xml, status: 200).then + .to_return(body: secret_with_key_xml, status: 200).then + .to_return(body: private_key_xml, status: 200) + + client.download_secret_file(scrt_id: 2345, type: 'Private Key') + expect(File.exist? 'zanzi_key') + expect(File.read('zanzi_key')).to eq("-----BEGIN RSA PRIVATE KEY -----\nzanzibarTestPassword\n-----END RSA PRIVATE KEY-----\n") + File.delete('zanzi_key') + end + + it 'should download a private key legacy' do + stub_request(:any, 'https://www.zanzitest.net/webservices/sswebservice.asmx') + .to_return(body: auth_xml, status: 200).then + .to_return(body: secret_with_key_xml, status: 200).then + .to_return(body: private_key_xml, status: 200) + + client.download_private_key(scrt_id: 2345) + expect(File.exist? 'zanzi_key') + expect(File.read('zanzi_key')).to eq("-----BEGIN RSA PRIVATE KEY -----\nzanzibarTestPassword\n-----END RSA PRIVATE KEY-----\n") + File.delete('zanzi_key') + end + + it 'should download a public key' do + stub_request(:any, 'https://www.zanzitest.net/webservices/sswebservice.asmx') + .to_return(body: auth_xml, status: 200).then + .to_return(body: secret_with_key_xml, status: 200).then + .to_return(body: public_key_xml, status: 200) + + client.download_secret_file(scrt_id: 2345, type: 'Public Key') + expect(File.exist? 'zanzi_key.pub') + expect(File.read('zanzi_key.pub')).to eq("1234PublicKey5678==\n") + File.delete('zanzi_key.pub') + end + + it 'should download a public key legacy' do + stub_request(:any, 'https://www.zanzitest.net/webservices/sswebservice.asmx') + .to_return(body: auth_xml, status: 200).then + .to_return(body: secret_with_key_xml, status: 200).then + .to_return(body: public_key_xml, status: 200) + + client.download_public_key(scrt_id: 2345) + expect(File.exist? 'zanzi_key.pub') + expect(File.read('zanzi_key.pub')).to eq("1234PublicKey5678==\n") + File.delete('zanzi_key.pub') + end + + it 'should download an attachment' do + stub_request(:any, 'https://www.zanzitest.net/webservices/sswebservice.asmx') + .to_return(body: auth_xml, status: 200).then + .to_return(body: secret_with_attachment_xml, status: 200).then + .to_return(body: attachment_xml, status: 200) + + client.download_secret_file(scrt_id: 3456, type: 'Attachment') + expect(File.exist? 'attachment.txt') + expect(File.read('attachment.txt')).to eq("I am a secret attachment\n") + File.delete('attachment.txt') + end + + it 'should download an attachment legacy' do + stub_request(:any, 'https://www.zanzitest.net/webservices/sswebservice.asmx') + .to_return(body: auth_xml, status: 200).then + .to_return(body: secret_with_attachment_xml, status: 200).then + .to_return(body: attachment_xml, status: 200) + + client.download_attachment(scrt_id: 3456) + expect(File.exist? 'attachment.txt') + expect(File.read('attachment.txt')).to eq("I am a secret attachment\n") + File.delete('attachment.txt') + end +end diff --git a/zanzibar.gemspec b/zanzibar.gemspec index 8a92012..f5082e4 100644 --- a/zanzibar.gemspec +++ b/zanzibar.gemspec @@ -4,22 +4,23 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) require 'zanzibar/version' Gem::Specification.new do |spec| - spec.name = "zanzibar" + spec.name = 'zanzibar' spec.version = Zanzibar::VERSION - spec.authors = ["Jason Davis-Cooke"] - spec.email = ["jdaviscooke@cimpress.com"] - spec.summary = "Retrieve secrets from Secret Server" - spec.description = "Programatically get secrets from Secret Server via the Web Service API" - spec.homepage = "https://github.com/Cimpress-MCP/zanzibar" - spec.license = "Apache 2.0" + spec.authors = ['Jason Davis-Cooke'] + spec.email = ['jdaviscooke@cimpress.com'] + spec.summary = 'Retrieve secrets from Secret Server' + spec.description = 'Programatically get secrets from Secret Server via the Web Service API' + spec.homepage = 'https://github.com/Cimpress-MCP/zanzibar' + spec.license = 'Apache 2.0' 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"] + spec.require_paths = ['lib'] - spec.add_dependency "rubyntlm", "~> 0.4.0" - spec.add_development_dependency "bundler", "~> 1.7" - spec.add_development_dependency "rake", "~> 10.0" - spec.add_runtime_dependency "savon", "~> 2.8.0" + spec.add_dependency 'rubyntlm', '~> 0.4.0' + spec.add_development_dependency 'bundler', '~> 1.7' + spec.add_development_dependency 'rake', '~> 10.0' + spec.add_development_dependency 'rubocop', '~>0.18.1' + spec.add_runtime_dependency 'savon', '~> 2.8.0' end