knife-bastion 1.0.0 → 1.1.0

data/README.md

@@ -1,5 +1,8 @@
 # knife-bastion
 
+[![Code Climate](https://codeclimate.com/github/eligible/knife-bastion/badges/gpa.svg)](https://codeclimate.com/github/eligible/knife-bastion)
+[![Gem Version](https://badge.fury.io/rb/knife-bastion.svg)](https://badge.fury.io/rb/knife-bastion)
+
 This plugin allows Knife to access Chef server over a secure SSH connection,
 without exposing Chef server port to your VPN network.
 
@@ -83,6 +86,27 @@ wrong with your box):
 knife bastion status
 ```
 
+### Using knife-bastion Outside of Chef
+
+This gem can be used to connect to any server utilizing generic
+proxy client. The bastion should be started the same way as it is
+described above.
+
+Example:
+
+```ruby
+require 'knife-bastion/client_proxy'
+require 'rest_client'
+
+# initialize RestClient::Resource object and wrap it into a bastion proxy
+api = KnifeBastion::ClientProxy.new(
+  RestClient::Resource.new('https://domain.com/api/v1')
+)
+
+# use api the same way as it would be used as a RestClient::Resource
+api['posts/1/comments'].post 'Good article.', content_type: 'text/plain'
+```
+
 ## Contributing
 
 1. Fork it

data/lib/knife-bastion/chef_socks_proxy.rb

@@ -1,3 +1,5 @@
+require_relative 'client_proxy'
+
 # Load socksify gem, required to make Chef work with SOCKS proxy
 begin
   require 'socksify'
@@ -7,47 +9,6 @@ rescue LoadError
   exit! 1
 end
 
-# Simple class, that delegates all the calls to the base client object, except
-# for `request`. The latter is overwritten to first configure SOCKS proxy,
-# and if connection fails - show warning about the bastion setup.
-class BastionChefClientProxy < BasicObject
-  NETWORK_ERRORS = [
-    ::SocketError,
-    ::Errno::ETIMEDOUT,
-    ::Errno::ECONNRESET,
-    ::Errno::ECONNREFUSED,
-    ::Timeout::Error,
-    ::OpenSSL::SSL::SSLError,
-  ]
-
-  def initialize(client)
-    @client = client
-  end
-
-  def request(*args, &block)
-    with_socks_proxy do
-      @client.request(*args, &block)
-    end
-  end
-
-  def method_missing(method, *args, &block)
-    @client.send(method, *args, &block)
-  end
-
-  def with_socks_proxy
-    old_socks_server, old_socks_port = ::TCPSocket::socks_server, ::TCPSocket::socks_port
-    ::TCPSocket::socks_server, ::TCPSocket::socks_port = '127.0.0.1', ::Chef::Config[:knife][:bastion_local_port] || 4443
-    yield
-  rescue *NETWORK_ERRORS
-    puts ::HighLine.color("WARNING:", [:bold, :red]) + " Failed to contact Chef server!"
-    puts "You might need to start bastion connection with #{::HighLine.color("knife bastion start", [:bold, :magenta])} to access Chef."
-    puts
-    raise
-  ensure
-    ::TCPSocket::socks_server, ::TCPSocket::socks_port = old_socks_server, old_socks_port
-  end
-end
-
 # Override `http_client` method in `Chef::HTTP` to return proxy object instead
 # of normal client object.
 Chef::HTTP.class_eval do
@@ -57,6 +18,16 @@ Chef::HTTP.class_eval do
   protected
 
   def http_client(*args)
-    BastionChefClientProxy.new(http_client_without_bastion(*args))
+    client = http_client_without_bastion(*args)
+    options = {
+      local_port: ::Chef::Config[:knife][:bastion_local_port],
+      error_handler: -> (_) {
+        puts ::HighLine.color("WARNING:", [:bold, :red]) + " Failed to contact Chef server!"
+        puts "You might need to start bastion connection with #{::HighLine.color("knife bastion start", [:bold, :magenta])} to access Chef."
+        puts
+        raise
+      }
+    }
+    KnifeBastion::ClientProxy.new(client, options)
   end
 end

data/lib/knife-bastion/client_proxy.rb

@@ -0,0 +1,60 @@
+require 'socket'
+require 'timeout'
+require 'highline'
+require 'openssl'
+
+module KnifeBastion
+  # Simple class, that delegates all the calls to the base client
+  # object. The latter is overwritten to first configure SOCKS proxy,
+  # and if connection fails - show warning about the bastion setup.
+  class ClientProxy < BasicObject
+    NETWORK_ERRORS = [
+      ::SocketError,
+      ::Errno::ETIMEDOUT,
+      ::Errno::ECONNRESET,
+      ::Errno::ECONNREFUSED,
+      ::Timeout::Error,
+      ::OpenSSL::SSL::SSLError,
+    ].freeze
+
+    # Initializes an instance of the generic client proxy which sends all the
+    #   network traffic through the SOCKS proxy.
+    # @param [Object] client the client object which communicates with the
+    #   server over the network.
+    # @param [Hash] options the configuration of the client proxy.
+    # @option options [Integer] :local_port (4443) The local port of the SOCKS
+    #   proxy.
+    # @option options [Proc] :error_handler network errors handler.
+    #   By default it prints out a message which explains that the error may
+    #   occur becase the bastion proxy has not been started.
+    def initialize(client, options = {})
+      @client = client
+
+      @local_port = options[:local_port] || 4443
+      @network_errors_handler = options[:error_handler] || -> (_) {
+        ::Kernel.puts ::HighLine.color("WARNING:", [:bold, :red]) + " Failed to contact server!"
+        ::Kernel.puts "You might need to start bastion connection with #{::HighLine.color("knife bastion start", [:bold, :magenta])} to access server."
+        ::Kernel.puts
+        ::Kernel.raise
+      }
+    end
+
+    # Wraps all original client calls into a with_socks_proxy method.
+    def method_missing(method, *args, &block)
+      with_socks_proxy do
+        @client.send(method, *args, &block)
+      end
+    end
+
+    # Routes all network connections through the bastion proxy.
+    def with_socks_proxy
+      old_socks_server, old_socks_port = ::TCPSocket::socks_server, ::TCPSocket::socks_port
+      ::TCPSocket::socks_server, ::TCPSocket::socks_port = '127.0.0.1', @local_port
+      yield
+    rescue *NETWORK_ERRORS => e
+      @network_errors_handler.call(e)
+    ensure
+      ::TCPSocket::socks_server, ::TCPSocket::socks_port = old_socks_server, old_socks_port
+    end
+  end
+end

data/lib/knife-bastion/version.rb

@@ -1,6 +1,6 @@
 module Knife
   module Bastion
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
     MAJOR, MINOR, TINY = VERSION.split('.')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-bastion
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Dmytro Shteflyuk
@@ -30,7 +30,7 @@ cert_chain:
   DHSQkPQADqf52XlDQ7I6fBAn6E2bH38Wvwpu593AvE02KRKqaK8XEtBBldE4d/It
   2ysZ/sPJras9LFb2MpjJNRCdXr3z2ed6QwuLnsyEfuk=
   -----END CERTIFICATE-----
-date: 2016-08-22 00:00:00.000000000 Z
+date: 2016-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -110,7 +110,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -123,6 +125,7 @@ files:
 - lib/chef/knife/bastion_stop.rb
 - lib/knife-bastion/activate.rb
 - lib/knife-bastion/chef_socks_proxy.rb
+- lib/knife-bastion/client_proxy.rb
 - lib/knife-bastion/version.rb
 homepage: https://github.com/eligible/knife-bastion
 licenses: