├── .gitignore ├── .rspec ├── .travis.yml ├── CODEOWNERS ├── Gemfile ├── Guardfile ├── LICENSE.txt ├── README.md ├── Rakefile ├── bin └── net_http_unix ├── lib ├── net_http_unix.rb ├── net_http_unix │ └── version.rb └── net_x │ └── http_unix.rb ├── net_http_unix.gemspec └── spec ├── net_http_unix_spec.rb ├── net_x └── http_unix_spec.rb └── spec_helper.rb /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | *.gem 3 | *.rbc 4 | .bundle 5 | .config 6 | .yardoc 7 | Gemfile.lock 8 | InstalledFiles 9 | _yardoc 10 | coverage 11 | doc/ 12 | lib/bundler/man 13 | pkg 14 | rdoc 15 | spec/reports 16 | test/tmp 17 | test/version_tmp 18 | tmp 19 | -------------------------------------------------------------------------------- /.rspec: -------------------------------------------------------------------------------- 1 | --format documentation 2 | --color 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | --- 2 | os: linux 3 | language: ruby 4 | rvm: 5 | - 2.5.7 6 | - 2.4.9 7 | - 2.1.9 8 | -------------------------------------------------------------------------------- /CODEOWNERS: -------------------------------------------------------------------------------- 1 | # Set the networking team as the main owners of the module 2 | * @puppetlabs/networking 3 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | # Specify your gem's dependencies in net_http_unix.gemspec 4 | gemspec 5 | 6 | if File.exists? "#{__FILE__}.local" 7 | eval(File.read("#{__FILE__}.local"), binding) 8 | end 9 | # vim:ft=ruby 10 | -------------------------------------------------------------------------------- /Guardfile: -------------------------------------------------------------------------------- 1 | # A sample Guardfile 2 | # More info at https://github.com/guard/guard#readme 3 | 4 | guard :rspec do 5 | watch(%r{^spec/.+_spec\.rb$}) 6 | watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" } 7 | watch('spec/spec_helper.rb') { "spec" } 8 | end 9 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # NetX::HTTPUnix 2 | 3 | This gem is a small wrapper around Ruby's `Net::HTTP` interface that provides 4 | support for unix domain sockets. If you need to issue HTTP requests to a HTTP 5 | server listening on a local unix domain socket then this library is for you. 6 | 7 | Simply `require 'net_x/http_unix'` in place of `require 'net/http'` and use 8 | `NetX::HTTPUnix` as you would `Net::HTTP`. Address strings starting with 9 | 'unix://' will automatically be handled by a unix domain socket instead of a 10 | TCP socket. 11 | 12 | ## Installation 13 | 14 | Add this line to your application's Gemfile: 15 | 16 | gem 'net_http_unix' 17 | 18 | And then execute: 19 | 20 | $ bundle 21 | 22 | Or install it yourself as: 23 | 24 | $ gem install net_http_unix 25 | 26 | ## Usage 27 | 28 | Use the library just like you would `Net::HTTP.start` and `Net::HTTP.new`, but 29 | with `NetX::HTTPUnix.start` and `NetX::HTTPUnix.new`. 30 | 31 | For example a traditional SSL client works as expected: 32 | 33 | ```ruby 34 | require 'net_http_unix' 35 | req = Net::HTTP::Get.new("/status.json") 36 | client = NetX::HTTPUnix.new('github.com', 443) 37 | client.use_ssl = true 38 | client.verify_mode = OpenSSL::SSL::VERIFY_NONE 39 | resp = client.request(req) 40 | puts resp.body 41 | {"status":"ok","configuration_id":0} 42 | ``` 43 | 44 | And the corresponding `unix:///path/to/foo.sock` URI syntax: 45 | 46 | ```ruby 47 | require 'net_http_unix' 48 | req = Net::HTTP::Get.new("/status.json") 49 | client = NetX::HTTPUnix.new('unix:///tmp/unicorn.sock') 50 | resp = client.request(req) 51 | puts resp.body 52 | {"status":"ok","configuration_id":0,"socket":true} 53 | ``` 54 | 55 | ## Contributing 56 | 57 | 1. Fork it 58 | 2. Create your feature branch (`git checkout -b my-new-feature`) 59 | 3. Commit your changes (`git commit -am 'Add some feature'`) 60 | 4. Push to the branch (`git push origin my-new-feature`) 61 | 5. Create new Pull Request 62 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require "bundler/gem_tasks" 2 | require "rspec/core/rake_task" 3 | 4 | RSpec::Core::RakeTask.new(:spec) 5 | 6 | task :default => :spec 7 | -------------------------------------------------------------------------------- /bin/net_http_unix: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | require 'net_http_unix' 4 | -------------------------------------------------------------------------------- /lib/net_http_unix.rb: -------------------------------------------------------------------------------- 1 | require "net_http_unix/version" 2 | require "net_x/http_unix" 3 | require "net/http" 4 | 5 | module NetHttpUnix 6 | # Your code goes here... 7 | end 8 | -------------------------------------------------------------------------------- /lib/net_http_unix/version.rb: -------------------------------------------------------------------------------- 1 | module NetHttpUnix 2 | VERSION = "0.2.2" 3 | end 4 | -------------------------------------------------------------------------------- /lib/net_x/http_unix.rb: -------------------------------------------------------------------------------- 1 | require 'net/http' 2 | module NetX 3 | class HTTPUnix < Net::HTTP 4 | BufferedIO = ::Net::BufferedIO 5 | UNIX_REGEXP = %r{^unix://}i 6 | 7 | def initialize(address, port=nil) 8 | super(address, port) 9 | case address 10 | when UNIX_REGEXP 11 | @socket_type = 'unix' 12 | @socket_path = address.sub(UNIX_REGEXP, '') 13 | # Address and port are set to localhost so the HTTP client constructs 14 | # a HOST request header nginx will accept. 15 | @address = 'localhost' 16 | @port = 80 17 | else 18 | @socket_type = 'inet' 19 | end 20 | end 21 | 22 | def connect 23 | if @socket_type == 'unix' 24 | connect_unix 25 | else 26 | super 27 | end 28 | end 29 | 30 | ## 31 | # connect_unix is an alternative implementation of Net::HTTP#connect specific 32 | # to the use case of using a Unix Domain Socket. 33 | def connect_unix 34 | D "opening connection to #{@socket_path}..." 35 | s = Timeout.timeout(@open_timeout) { UNIXSocket.open(@socket_path) } 36 | D "opened" 37 | @socket = BufferedIO.new(s) 38 | @socket.read_timeout = @read_timeout 39 | @socket.continue_timeout = @continue_timeout 40 | @socket.debug_output = @debug_output 41 | on_connect 42 | end 43 | end 44 | end 45 | -------------------------------------------------------------------------------- /net_http_unix.gemspec: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | lib = File.expand_path('../lib', __FILE__) 3 | $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) 4 | require 'net_http_unix/version' 5 | 6 | Gem::Specification.new do |spec| 7 | spec.name = "net_http_unix" 8 | spec.version = NetHttpUnix::VERSION 9 | spec.authors = ["Jeff McCune"] 10 | spec.email = ["jeff@puppetlabs.com"] 11 | spec.description = %q{Wrapper around Net::HTTP with AF_UNIX support} 12 | spec.summary = %q{Wrapper around Net::HTTP with AF_UNIX support} 13 | spec.homepage = "http://github.com/puppetlabs/net_http_unix" 14 | spec.license = "Apache 2.0" 15 | 16 | spec.files = `git ls-files -z`.split("\x0") 17 | spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) } 18 | spec.test_files = spec.files.grep(%r{^(test|spec|features)/}) 19 | spec.require_paths = ["lib"] 20 | 21 | spec.add_development_dependency "bundler", "> 1.3", "< 3.0.0" 22 | spec.add_development_dependency "rake" 23 | spec.add_development_dependency "rspec" 24 | spec.add_development_dependency "yard" 25 | end 26 | -------------------------------------------------------------------------------- /spec/net_http_unix_spec.rb: -------------------------------------------------------------------------------- 1 | require 'spec_helper' 2 | 3 | describe NetHttpUnix do 4 | it 'should have a version number' do 5 | expect(NetHttpUnix::VERSION).not_to be_nil 6 | end 7 | end 8 | 9 | # describe Net::HTTP::Unix do 10 | # end 11 | -------------------------------------------------------------------------------- /spec/net_x/http_unix_spec.rb: -------------------------------------------------------------------------------- 1 | require 'spec_helper' 2 | require 'net_x/http_unix' 3 | require 'tempfile' 4 | 5 | describe NetX::HTTPUnix do 6 | let(:socket_url) { "unix://#{@socket_path}" } 7 | let(:get_request) { Net::HTTP::Get.new("/") } 8 | 9 | before :all do 10 | tmpfile = Tempfile.open('socket') 11 | @socket_path = tmpfile.path 12 | tmpfile.close 13 | tmpfile.unlink 14 | 15 | semaphore = Mutex.new 16 | servers_starting = 2 17 | 18 | @server_thread_tcp = Thread.new do 19 | TCPServer.open(2000) do |server| 20 | semaphore.synchronize { servers_starting -= 1 } 21 | while conn = server.accept 22 | conn.puts "HTTP/1.1 200 OK" 23 | conn.puts "" 24 | conn.puts "Hello from TCP server" 25 | conn.close_write 26 | end 27 | end 28 | end 29 | 30 | @server_thread_unix = Thread.new do 31 | UNIXServer.open(@socket_path) do |server| 32 | semaphore.synchronize { servers_starting -= 1 } 33 | while conn = server.accept 34 | conn.puts "HTTP/1.1 200 OK" 35 | conn.puts "" 36 | conn.puts "Hello from UNIX server" 37 | conn.close_write 38 | end 39 | end 40 | end 41 | 42 | sleep(0.01) while servers_starting > 0 43 | end 44 | 45 | after :all do 46 | Thread.kill(@server_thread_unix) 47 | Thread.kill(@server_thread_tcp) 48 | end 49 | 50 | describe ".start" do 51 | it "accepts '127.0.0.1', 2000 host and port" do 52 | resp = described_class.start('127.0.0.1', 2000) do |http| 53 | http.request(get_request) 54 | end 55 | expect(resp.body).to eq("Hello from TCP server\n") 56 | end 57 | 58 | it "accepts unix:///path/to/socket URI" do 59 | resp = described_class.start(socket_url) do |http| 60 | http.request(get_request) 61 | end 62 | expect(resp.body).to eq("Hello from UNIX server\n") 63 | end 64 | end 65 | 66 | describe ".new" do 67 | it "accepts '127.0.0.1', 2000 host and port" do 68 | http = described_class.new("127.0.0.1", 2000) 69 | 70 | resp = http.request(get_request) 71 | expect(resp.body).to eq("Hello from TCP server\n") 72 | end 73 | 74 | it "accepts unix:///path/to/socket URI" do 75 | http = described_class.new(socket_url) 76 | 77 | resp = http.request(get_request) 78 | expect(resp.body).to eq("Hello from UNIX server\n") 79 | end 80 | end 81 | end 82 | -------------------------------------------------------------------------------- /spec/spec_helper.rb: -------------------------------------------------------------------------------- 1 | $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__) 2 | require 'net_http_unix' 3 | --------------------------------------------------------------------------------