uri-amqp 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: af3666a553e305914130cac061e885ca8be5a219
4
+ data.tar.gz: 2a199bd2ca05731ae98c57a5e772c7b82da543dc
5
+ SHA512:
6
+ metadata.gz: d16c45bbf768cd35bae040b4a20da35aa08b5ebb981d16698eef4aed81bc791babe3b4f1ba3a4d58f97fc919d5947bf162b87d516c5896ce66721dd973b519e8
7
+ data.tar.gz: d64c114b72cbf2a9ea5d0c38d3d3bb049277ff1065ed50d5711d1d7a866f74ff3a31f1ea3e05adf666fb0ba8ab904cae7634baa51e553300f8a9cf4e9e64c646
data/.gitignore ADDED
@@ -0,0 +1,13 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
12
+
13
+ Gemfile.lock
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,10 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4
5
+ - 2.3
6
+ - 2.2
7
+ before_install: gem install bundler -v 1.16.0
8
+
9
+ notifications:
10
+ email: false
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at andrew.babichev@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in uri-amqp.gemspec
6
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Andrew Babichev
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,91 @@
1
+ # URI::AMQP
2
+
3
+ [Custom URI](https://ruby-doc.org/stdlib-2.4.2/libdoc/uri/rdoc/URI.html#module-URI-label-Adding+custom+URIs) implementation for AMQP
4
+
5
+
6
+ ## Installation
7
+
8
+ Add this line to your application's Gemfile:
9
+
10
+ ```ruby
11
+ gem 'uri-amqp'
12
+ ```
13
+
14
+ And then execute:
15
+
16
+ $ bundle
17
+
18
+ Or install it yourself as:
19
+
20
+ $ gem install uri-amqp
21
+
22
+ ## Usage
23
+
24
+ As any other URI (HTTP, FTP, LDAP) you may call `URI.parse` with string argument and it will automatically detect scheme and return `URI::AMQP` or `URI::AMQPS` instance.
25
+
26
+ ```ruby
27
+ uri = URI.parse("amqps://user:pass@host/vhost?heartbeat=10&connection_timeout=100&channel_max=1000&certfile=/examples/tls/client_cert.pem&keyfile=/examples/tls/client_key.pem")
28
+ => #<URI::AMQPS amqps://user:pass@host/vhost?heartbeat=10&connection_timeout=100&channel_max=1000&certfile=/examples/tls/client_cert.pem&keyfile=/examples/tls/client_key.pem>
29
+ uri.scheme
30
+ => "amqp"
31
+ uri.user
32
+ => "user"
33
+ uri.password
34
+ => "pass"
35
+ uri.host
36
+ => "host"
37
+ uri.vhost
38
+ => "vhost"
39
+ uri.vhost
40
+ => "vhost"
41
+ uri.heartbeat
42
+ => 10
43
+ uri.connection_timeout
44
+ => 100
45
+ uri.channel_max
46
+ => 1000
47
+ uri.verify
48
+ => false
49
+ uri.fail_if_no_peer_cert
50
+ => false
51
+ uri.cacertfile
52
+ => nil
53
+ uri.certfile
54
+ => "/examples/tls/client_cert.pem"
55
+ uri.keyfile
56
+ => "/examples/tls/client_key.pem"
57
+ ```
58
+
59
+ There are also implemented some checks:
60
+
61
+ ```
62
+ uri = URI.parse("amqp://host/vhost/hurricane")
63
+ => URI::InvalidComponentError: bad vhost (expected only leading "/"): /vhost/hurricane
64
+
65
+ uri = URI.parse("amqp://host/vhost?certfile=/examples/tls/client_cert.pem&keyfile=/examples/tls/client_key.pem")
66
+ => URI::InvalidComponentError: bad certfile (expected only in "amqps" schema): /examples/tls/client_cert.pem
67
+ ```
68
+
69
+ ### References
70
+
71
+ # https://www.rabbitmq.com/uri-spec.html
72
+ # https://www.rabbitmq.com/uri-query-parameters.html
73
+ # https://www.rabbitmq.com/ssl.html
74
+
75
+ ## Development
76
+
77
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
78
+
79
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
80
+
81
+ ## Contributing
82
+
83
+ Bug reports and pull requests are welcome on GitHub at https://github.com/Tensho/uri-amqp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
84
+
85
+ ## License
86
+
87
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
88
+
89
+ ## Code of Conduct
90
+
91
+ Everyone interacting in the URI::AMQP project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Tensho/uri-amqp/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "uri/amqp"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/lib/uri/amqp.rb ADDED
@@ -0,0 +1,170 @@
1
+ require "cgi"
2
+ require "uri/generic"
3
+
4
+ module URI
5
+ class AMQP < Generic
6
+ VERSION = "1.0.0"
7
+
8
+ DEFAULT_PORT = 5672
9
+
10
+ COMPONENT = %i[
11
+ scheme
12
+ userinfo host port
13
+ vhost
14
+ query
15
+ ].freeze
16
+
17
+ def initialize(*arg)
18
+ super(*arg)
19
+
20
+ parse_path
21
+ parse_query
22
+ end
23
+
24
+ attr_reader :vhost, :heartbeat, :connection_timeout, :channel_max, :verify, :fail_if_no_peer_cert, :cacertfile, :certfile, :keyfile
25
+
26
+ def vhost=(value)
27
+ check_vhost(value)
28
+ set_vhost(value)
29
+ end
30
+
31
+ def heartbeat=(value)
32
+ set_heartbeat(value)
33
+ end
34
+
35
+ def connection_timeout=(value)
36
+ set_connection_timeout(value)
37
+ end
38
+
39
+ def channel_max=(value)
40
+ set_channel_max(value)
41
+ end
42
+
43
+ def verify=(value)
44
+ check_verify(value)
45
+ set_verify(value)
46
+ end
47
+
48
+ def fail_if_no_peer_cert=(value)
49
+ check_fail_if_no_peer_cert(value)
50
+ set_fail_if_no_peer_cert(value)
51
+ end
52
+
53
+ def cacertfile=(value)
54
+ check_cacertfile(value)
55
+ set_cacertfile(value)
56
+ end
57
+
58
+ def certfile=(value)
59
+ check_certfile(value)
60
+ set_certfile(value)
61
+ end
62
+
63
+ def keyfile=(value)
64
+ check_keyfile(value)
65
+ set_keyfile(value)
66
+ end
67
+
68
+ # URI::AMQP doesn't have path
69
+ def hierarchical?
70
+ false
71
+ end
72
+
73
+ protected
74
+
75
+ def set_userinfo(user, password = nil)
76
+ user &&= CGI::unescape(user)
77
+ password &&= CGI::unescape(password)
78
+ super(user, password)
79
+ end
80
+
81
+ def set_user(value)
82
+ super(value && CGI::unescape(value))
83
+ end
84
+
85
+ def set_host(value)
86
+ super(value && CGI::unescape(value))
87
+ end
88
+
89
+ def set_vhost(value)
90
+ @vhost = if value
91
+ value.delete!('/')
92
+ CGI::unescape(value)
93
+ end
94
+ end
95
+
96
+ def set_heartbeat(value)
97
+ @heartbeat = value && value.to_i
98
+ end
99
+
100
+ def set_connection_timeout(value)
101
+ @connection_timeout = value && value.to_i
102
+ end
103
+
104
+ def set_channel_max(value)
105
+ @channel_max = value && value.to_i
106
+ end
107
+
108
+ def set_verify(value)
109
+ @verify = !!(value)
110
+ end
111
+
112
+ def set_fail_if_no_peer_cert(value)
113
+ @fail_if_no_peer_cert = !!(value)
114
+ end
115
+
116
+ def set_cacertfile(value)
117
+ @cacertfile = value
118
+ end
119
+
120
+ def set_certfile(value)
121
+ @certfile = value
122
+ end
123
+
124
+ def set_keyfile(value)
125
+ @keyfile = value
126
+ end
127
+
128
+ private
129
+
130
+ def parse_path
131
+ return if path.empty?
132
+
133
+ self.vhost = @path.dup
134
+ end
135
+
136
+ def parse_query
137
+ return if @query.nil?
138
+
139
+ # CONSIDER: CGI::parse(@query)
140
+ params = Hash[@query.scan(/(.+?)=([^&]+)&*/)]
141
+
142
+ self.heartbeat = params["heartbeat"]
143
+ self.connection_timeout = params["connection_timeout"]
144
+ self.channel_max = params["channel_max"]
145
+ self.verify = params["verify"]
146
+ self.fail_if_no_peer_cert = params["fail_if_no_peer_cert"]
147
+ self.cacertfile = params["cacertfile"]
148
+ self.certfile = params["certfile"]
149
+ self.keyfile = params["keyfile"]
150
+ end
151
+
152
+ def check_vhost(value)
153
+ raise InvalidComponentError, "bad vhost (expected only leading \"/\"): #{value}" if value && !(value =~ %r{^/[^/]*$})
154
+ end
155
+
156
+ %i[
157
+ verify
158
+ fail_if_no_peer_cert
159
+ cacertfile
160
+ certfile
161
+ keyfile
162
+ ].each do |tls_param|
163
+ define_method "check_#{tls_param}" do |value|
164
+ raise InvalidComponentError, "bad #{tls_param} (expected only in \"amqps\" schema): #{value}" if value
165
+ end
166
+ end
167
+ end
168
+
169
+ @@schemes["AMQP"] = AMQP
170
+ end
data/lib/uri/amqps.rb ADDED
@@ -0,0 +1,24 @@
1
+ require "uri/amqp"
2
+
3
+ module URI
4
+ class AMQPS < AMQP
5
+ DEFAULT_PORT = 5671
6
+
7
+ def check_verify(_)
8
+ end
9
+
10
+ def check_fail_if_no_peer_cert(_)
11
+ end
12
+
13
+ def check_cacertfile(_)
14
+ end
15
+
16
+ def check_certfile(_)
17
+ end
18
+
19
+ def check_keyfile(_)
20
+ end
21
+ end
22
+
23
+ @@schemes["AMQPS"] = AMQPS
24
+ end
data/uri-amqp.gemspec ADDED
@@ -0,0 +1,40 @@
1
+ lib = File.expand_path("../lib", __FILE__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+
4
+ require "uri/amqp"
5
+ require "uri/amqps"
6
+
7
+ Gem::Specification.new do |spec|
8
+ spec.name = "uri-amqp"
9
+ spec.version = URI::AMQP::VERSION
10
+ spec.authors = ["Andrew Babichev"]
11
+ spec.email = ["andrew.babichev@gmail.com"]
12
+
13
+ spec.summary = %q{URI::AMQP}
14
+ spec.description = %q{AMQP URI}
15
+ spec.homepage = "https://github.com/Tensho/uri-amqp"
16
+ spec.license = "MIT"
17
+
18
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
19
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
20
+ if spec.respond_to?(:metadata)
21
+ spec.metadata["allowed_push_host"] = "https://rubygems.org"
22
+ else
23
+ raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
24
+ end
25
+
26
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
27
+ f.match(%r{^(test|spec|features)/})
28
+ end
29
+ spec.bindir = "exe"
30
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
31
+ spec.require_paths = ["lib"]
32
+
33
+ spec.required_ruby_version = "> 2.2"
34
+
35
+ spec.add_development_dependency "bundler", "~> 1.16"
36
+ spec.add_development_dependency "rake", "~> 10.0"
37
+ spec.add_development_dependency "rspec", "~> 3.0"
38
+ spec.add_development_dependency "rspec-its", "~> 1.2.0"
39
+ spec.add_development_dependency "pry-byebug"
40
+ end
metadata ADDED
@@ -0,0 +1,128 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: uri-amqp
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Andrew Babichev
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-12-19 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.16'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.16'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec-its
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 1.2.0
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 1.2.0
69
+ - !ruby/object:Gem::Dependency
70
+ name: pry-byebug
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ description: AMQP URI
84
+ email:
85
+ - andrew.babichev@gmail.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".travis.yml"
93
+ - CODE_OF_CONDUCT.md
94
+ - Gemfile
95
+ - LICENSE.txt
96
+ - README.md
97
+ - Rakefile
98
+ - bin/console
99
+ - bin/setup
100
+ - lib/uri/amqp.rb
101
+ - lib/uri/amqps.rb
102
+ - uri-amqp.gemspec
103
+ homepage: https://github.com/Tensho/uri-amqp
104
+ licenses:
105
+ - MIT
106
+ metadata:
107
+ allowed_push_host: https://rubygems.org
108
+ post_install_message:
109
+ rdoc_options: []
110
+ require_paths:
111
+ - lib
112
+ required_ruby_version: !ruby/object:Gem::Requirement
113
+ requirements:
114
+ - - ">"
115
+ - !ruby/object:Gem::Version
116
+ version: '2.2'
117
+ required_rubygems_version: !ruby/object:Gem::Requirement
118
+ requirements:
119
+ - - ">="
120
+ - !ruby/object:Gem::Version
121
+ version: '0'
122
+ requirements: []
123
+ rubyforge_project:
124
+ rubygems_version: 2.6.13
125
+ signing_key:
126
+ specification_version: 4
127
+ summary: URI::AMQP
128
+ test_files: []