structured_noise 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: c9427b754e9602a9352204548c2212777978000c
4
+ data.tar.gz: ea83f3b2221865ac08d87348b9d9cfb8992b9b49
5
+ SHA512:
6
+ metadata.gz: 5fc34c49908bf64baeeb3d04435302893fac211292280892d534b9187b30cb78fca11080fd243bd5eba5fb112abc0869f1b5f8c37ba997344265246ae3ee66e8
7
+ data.tar.gz: 462725d8a4e810e51ae21994df073064089480c42e3cc3e54ca7cf695825dfc497d78cd181bb25f9537b9cff01f021b627384cf317143ebe6e87eb4d6c173be5
data/.gitignore ADDED
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.2
5
+ before_install: gem install bundler -v 1.14.6
@@ -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 jess@optoro.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,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in structured_noise.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Jess Szmajda
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,44 @@
1
+ # StructuredNoise
2
+
3
+ This is a utility to generate Avro-schema-templated noise
4
+
5
+ ### Features:
6
+
7
+ README-driven development ;)
8
+
9
+ * Reads an avro scheme indicated by `--schema` and writes noise to STDOUT
10
+ * If given `--base64` it converts the avro binary data to Basee64 before sending it to STDOUT
11
+ * Respects a `--messages-per-second` command
12
+
13
+ ####TODO FEATURES:
14
+
15
+ * `--template filename` should support a JSON-structure template for Avro messages, with 'fill in the blanks' as like.. * or something.
16
+ * `--malicious-compliance` will toggle generating edge-case data compliant with given Avro types
17
+
18
+ ## Installation
19
+
20
+ This is a debug tool. You probably don't want to install it in an applicaton
21
+
22
+ Install it with:
23
+
24
+ $ gem install structured_noise
25
+
26
+ ## Usage
27
+
28
+ See Features above
29
+
30
+ ## Development
31
+
32
+ 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.
33
+
34
+ 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).
35
+
36
+ ## Contributing
37
+
38
+ Bug reports and pull requests are welcome on GitHub at https://github.com/joshsz/structured_noise. 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.
39
+
40
+
41
+ ## License
42
+
43
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
44
+
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 "structured_noise"
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
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "structured_noise"
4
+
5
+ cli = StructuredNoise::CLI.new(__FILE__, ARGV)
6
+ cli.run!
@@ -0,0 +1,32 @@
1
+ module StructuredNoise
2
+ class CLI
3
+ def initialize(scriptname, args)
4
+ @options = StructuredNoise::Options.new(scriptname, args)
5
+ end
6
+
7
+ def run!
8
+ die_if_no_schema!
9
+
10
+ operating_environment.load_schema
11
+ operating_environment.generate_output
12
+ end
13
+
14
+ def operating_environment
15
+ @operating_environment ||=
16
+ StructuredNoise::Generator.new(
17
+ schema: @options.schema,
18
+ base64: @options.base64,
19
+ messages_per_second: @options.messages_per_second
20
+ )
21
+ end
22
+
23
+ def die_if_no_schema!
24
+ unless @options.schema
25
+ puts "Please define a schema."
26
+ puts ""
27
+ puts @options.parser
28
+ exit
29
+ end
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,119 @@
1
+ require 'json'
2
+ require 'avro'
3
+ require 'avro-patches'
4
+ require 'base64'
5
+ module StructuredNoise
6
+ class Generator
7
+ MAGIC_BYTE = [0].pack("C").freeze
8
+
9
+ def initialize(schema:, base64: false, messages_per_second: 0)
10
+ @schema_file_name = schema
11
+ @output_base64 = base64
12
+ @messages_per_second = messages_per_second
13
+ @schemas = {}
14
+ end
15
+
16
+ def load_schema
17
+ json = JSON.parse(File.read(canonical_schema_file_name))
18
+ @schema_name = json["name"]
19
+ @namespace = json["namespace"] || ""
20
+
21
+ @avro_schema = Avro::Schema.real_parse(json)
22
+ end
23
+
24
+ def generate_output
25
+ with_timing do
26
+ message = encode(generate_random_fields)
27
+ if @output_base64
28
+ message = Base64.encode64(message)
29
+ end
30
+ puts message
31
+ end
32
+ end
33
+
34
+ def generate_random_fields
35
+ @avro_schema.fields.inject(Hash.new) do |hash, field|
36
+ type_gen = TypeGenerator.new(field)
37
+ hash[field.name] = type_gen.generate_value
38
+ hash
39
+ end
40
+ end
41
+
42
+ def encode(fields)
43
+ stream = StringIO.new
44
+ writer = Avro::IO::DatumWriter.new(@avro_schema)
45
+ encoder = Avro::IO::BinaryEncoder.new(stream)
46
+
47
+ # Always start with the magic byte.
48
+ encoder.write(MAGIC_BYTE)
49
+
50
+ # The schema id is encoded as a 4-byte big-endian integer.
51
+ fullname = Avro::Name.make_fullname(@schema_name, @namespace)
52
+ #encoder.write([fullname].pack("N"))
53
+ encoder.write([1].pack("N"))
54
+
55
+ # The actual message comes last.
56
+ writer.write(fields, encoder)
57
+
58
+ stream.string
59
+ end
60
+
61
+ def with_timing
62
+ while true
63
+ yield
64
+ if(@messages_per_second)
65
+ sleep (1 / @messages_per_second)
66
+ end
67
+ end
68
+ end
69
+
70
+ def canonical_schema_file_name
71
+ File.join(File.dirname(__FILE__), '..', '..', @schema_file_name)
72
+ end
73
+
74
+ class TypeGenerator
75
+ def initialize(field)
76
+ @field = field
77
+ end
78
+
79
+
80
+ def generate_value(type = @field.type)
81
+ case type.type_sym
82
+ when :null; nil
83
+ when :boolean; generate_boolean
84
+ when :string; generate_string
85
+ when :int; generate_int
86
+ when :long; generate_long
87
+ when :float; generate_float
88
+ when :double; generate_double
89
+ when :bytes; generate_bytes
90
+ when :fixed; generate_fixed
91
+ when :enum; generate_enum
92
+ when :array; generate_array
93
+ when :map; generate_map
94
+ when :union; generate_union(@field)
95
+ #when :record, :error, :request;
96
+ else
97
+ raise Avro::AvroError.new("Unknown type: #{writers_schema.type}")
98
+ end
99
+ end
100
+
101
+ def generate_long; generate_int; end
102
+
103
+ def generate_int
104
+ (0..100).to_a.sample
105
+ end
106
+
107
+ def generate_string
108
+ letters = ('a'..'z').to_a
109
+ generate_int.times.map{ letters.sample }.join
110
+ end
111
+
112
+ def generate_union(field)
113
+ selected_type = field.type.schemas.sample
114
+ generate_value(selected_type)
115
+ end
116
+ end
117
+
118
+ end
119
+ end
@@ -0,0 +1,37 @@
1
+ require 'optparse'
2
+
3
+ module StructuredNoise
4
+ class Options
5
+ attr_accessor :schema, :base64, :messages_per_second
6
+ attr_reader :parser
7
+
8
+ def initialize(scriptname, args)
9
+ @base64 = false
10
+ @parser = build_parser(scriptname)
11
+ @parser.parse!(args)
12
+ end
13
+
14
+ private
15
+
16
+ def build_parser(scriptname)
17
+ this = self
18
+ OptionParser.new do |opt|
19
+ opt.banner = "Usage: #{scriptname} [OPTIONS]"
20
+ opt.separator ""
21
+ opt.separator "Options:"
22
+
23
+ opt.on("--schema SCHEMA", "avro schema (.avsc) file to load") do |schema_file|
24
+ this.schema = schema_file
25
+ end
26
+
27
+ opt.on("--base64", "encode output as base64") do |b64|
28
+ this.base64 = true
29
+ end
30
+
31
+ opt.on("--messages-per-second SECONDS", "how many messages to send per second") do |mps|
32
+ this.messages_per_second = mps.to_f
33
+ end
34
+ end
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,3 @@
1
+ module StructuredNoise
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,8 @@
1
+ require "structured_noise/generator"
2
+ require "structured_noise/options"
3
+ require "structured_noise/cli"
4
+ require "structured_noise/version"
5
+
6
+ module StructuredNoise
7
+ # Your code goes here...
8
+ end
@@ -0,0 +1,30 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'structured_noise/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "structured_noise"
8
+ spec.version = StructuredNoise::VERSION
9
+ spec.authors = ["Jess Szmajda"]
10
+ spec.email = ["jess@optoro.com"]
11
+
12
+ spec.summary = %q{Tool to generate Avro-encoded noise}
13
+ spec.description = %q{Tool to generate Avro-encoded noise}
14
+ spec.homepage = "https://github.com/jszmajda"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_dependency "avro", "~> 1.8"
25
+ spec.add_dependency "avro-patches", "~> 0.3"
26
+ spec.add_development_dependency "bundler", "~> 1.14"
27
+ spec.add_development_dependency "rake", "~> 10.0"
28
+ spec.add_development_dependency "rspec", "~> 3.0"
29
+ spec.add_development_dependency "pry"
30
+ end
metadata ADDED
@@ -0,0 +1,146 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: structured_noise
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Jess Szmajda
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-11-15 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: avro
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.8'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.8'
27
+ - !ruby/object:Gem::Dependency
28
+ name: avro-patches
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '0.3'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '0.3'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.14'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.14'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '3.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '3.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: pry
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ description: Tool to generate Avro-encoded noise
98
+ email:
99
+ - jess@optoro.com
100
+ executables:
101
+ - structured_noise
102
+ extensions: []
103
+ extra_rdoc_files: []
104
+ files:
105
+ - ".gitignore"
106
+ - ".rspec"
107
+ - ".travis.yml"
108
+ - CODE_OF_CONDUCT.md
109
+ - Gemfile
110
+ - LICENSE.txt
111
+ - README.md
112
+ - Rakefile
113
+ - bin/console
114
+ - bin/setup
115
+ - exe/structured_noise
116
+ - lib/structured_noise.rb
117
+ - lib/structured_noise/cli.rb
118
+ - lib/structured_noise/generator.rb
119
+ - lib/structured_noise/options.rb
120
+ - lib/structured_noise/version.rb
121
+ - structured_noise.gemspec
122
+ homepage: https://github.com/jszmajda
123
+ licenses:
124
+ - MIT
125
+ metadata: {}
126
+ post_install_message:
127
+ rdoc_options: []
128
+ require_paths:
129
+ - lib
130
+ required_ruby_version: !ruby/object:Gem::Requirement
131
+ requirements:
132
+ - - ">="
133
+ - !ruby/object:Gem::Version
134
+ version: '0'
135
+ required_rubygems_version: !ruby/object:Gem::Requirement
136
+ requirements:
137
+ - - ">="
138
+ - !ruby/object:Gem::Version
139
+ version: '0'
140
+ requirements: []
141
+ rubyforge_project:
142
+ rubygems_version: 2.6.10
143
+ signing_key:
144
+ specification_version: 4
145
+ summary: Tool to generate Avro-encoded noise
146
+ test_files: []