stringent 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 120c7da87ce418a33d3983fa1c23524d2d87c1ae
+  data.tar.gz: 670a04abc57026643adbbe5d7fd78313c946ac43
+SHA512:
+  metadata.gz: 65090a3035d60661f032294124c6b619c94b262d8a357aac0ddebafc35613200b8bb5478c47e304985a37b656c9205dd9d59235199a99b90accdb3d9fd2e30a1
+  data.tar.gz: f75a34b1bf48682460095904ae3a7d9979ea03d7724bdbd2bb7ad804b1907832bcea3d1a2dbcca1aa767453fc08516a47bcaf5f5e08f9df81ddb20e438799027

data/.gems

@@ -0,0 +1 @@
+cutest -v 1.2.2

data/CHANGELOG

@@ -0,0 +1 @@
+

data/CONTRIBUTING

@@ -0,0 +1,19 @@
+This code tries to solve a particular problem with a very simple
+implementation. We try to keep the code to a minimum while making
+it as clear as possible. The design is very likely finished, and
+if some feature is missing it is possible that it was left out on
+purpose. That said, new usage patterns may arise, and when that
+happens we are ready to adapt if necessary.
+
+A good first step for contributing is to meet us on IRC and discuss
+ideas. We spend a lot of time on #lesscode at freenode, always ready
+to talk about code and simplicity. If connecting to IRC is not an
+option, you can create an issue explaining the proposed change and
+a use case. We pay a lot of attention to use cases, because our
+goal is to keep the code base simple. Usually the result of a
+conversation is the creation of a different tool.
+
+Please don't start the conversation with a pull request. The code
+should come at last, and even though it may help to convey an idea,
+more often than not it draws the attention to a particular
+implementation.

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Michel Martens
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+Stringent
+=========
+
+Generate a string with a target entropy
+
+Description
+-----------
+
+Stringent uses `SecureRandom` to generate a pseudo-random number
+with a target entropy, and proceeds to encode it with a given table
+of symbols. The target entropy defaults to 256 bits, and the table
+of symbols defaults to case sensitive alphanumeric characters. Both
+values can be can be passed as parameters.
+
+The entropy parameter means that there are `2^entropy` possible
+outputs for a given call. However, it doesn not mean that each bit
+is actually generated using one bit of entropy, since `SecureRandom`
+may use `/dev/urandom` which, while unguessable, may have less than
+1 bit of entropy for each bit of output.
+
+Usage
+-----
+
+Generate a random string with the default values for target entropy
+and symbols table:
+
+```ruby
+>> Stringent.generate
+=> "kEPcWwph6OkyHIKZtw4DwnWnlJo0Q6QoDp8Iykshrfm"
+```
+
+Generate a random string with a custom target entropy:
+
+```ruby
+>> Stringent.generate(entropy: 32)
+=> "Kqd6e0"
+```
+
+Generate a random string with a custom target entropy and a custom
+table:
+
+```ruby
+>> Stringent.generate(entropy: 16, table: "01")
+=> "1000100110000000"
+```
+
+Installation
+------------
+
+```
+$ gem install stringent
+```

data/lib/stringent.rb

@@ -0,0 +1,15 @@
+require "securerandom"
+
+module Stringent
+  TABLE = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'.freeze
+
+  def self.generate(entropy: 256, table: TABLE)
+    number = SecureRandom.random_number(2 ** entropy)
+    length = (entropy / Math.log2(table.size)).ceil
+
+    Array.new(length) {
+      number, modulo = number.divmod(table.size)
+      table[modulo]
+    }.join
+  end
+end

data/makefile

@@ -0,0 +1,4 @@
+.PHONY: test
+
+test:
+	cutest ./test/*.rb

data/stringent.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name              = "stringent"
+  s.version           = "0.0.1"
+  s.summary           = "Generate a string with a target entropy"
+  s.description       = "Generate a string with a target entropy"
+  s.authors           = ["Michel Martens"]
+  s.email             = ["michel@soveran.com"]
+  s.homepage          = "https://github.com/soveran/stringent"
+  s.license           = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_development_dependency "cutest"
+end

data/test/all.rb

@@ -0,0 +1,6 @@
+require_relative "../lib/stringent"
+
+test do
+  assert_equal 1, Stringent.generate(entropy: 1, table: '01').size
+  assert_equal 2, Stringent.generate(entropy: 2, table: '01').size
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: stringent
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate a string with a target entropy
+email:
+- michel@soveran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gems
+- CHANGELOG
+- CONTRIBUTING
+- LICENSE
+- README.md
+- lib/stringent.rb
+- makefile
+- stringent.gemspec
+- test/all.rb
+homepage: https://github.com/soveran/stringent
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Generate a string with a target entropy
+test_files: []