quantum_rng 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a6be9de6482f66518e8a72dc0d461d308748fbe
+  data.tar.gz: c545e0895e9fd61a11b30e33fca187c44673c02b
+SHA512:
+  metadata.gz: e4724cfdaf07f674ddf179380101283e7db52e4277ae5b301f8c8032a2648e4265742ee2d7d66fb019367d8b321b0b9232f3dc227475906a2bf82c67ceb6c7b0
+  data.tar.gz: b748b52492e00eab0ccf98e7a44037e0459cf4385af9608a411b36b5bf0101a9fe3e47d318d8d0f893616a214ff42211a0f856259fe2dc5fe8996049d80a5e14

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in quantum_rng.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Ben Christianson
+
+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,70 @@
+# QuantumRNG
+A Ruby gem that leverages the ANU Quantum Random Numbers API
+
+### So, you want random numbers...
+Computers are great at creating pseudorandom numbers, but true randomness requires a little bit more effort.
+
+That's where the fine folks at the [ANU Quantum Random Numbers Server](http://qrng.anu.edu.au/index.php) come in. They've provided a handy JSON API for accessing what they guess are truly random numbers. You can read more about the science behind this and why they believe they've achieved true randomness at their site.
+
+## Installation
+```
+gem install quantum_rng
+```
+
+If you're using Bundler, include the gem in your `Gemfile`:
+```
+gem 'quantum_rng'
+```
+
+## Usage
+
+| Method | Argument(s)           | Description                                  |
+| ------ | :-------------------: | -------------------------------------------- |
+| uint8  | count = 1             | `count` numbers between 0 and 255            |
+| uint16 | count = 1             | `count` numbers between 0 and 65535          |
+| hex16  | block_size, count = 1 | `count` hex numbers of `block_size` bytes    |
+| random | count = 1             | `count` numbers between 0 and 1, inclusive   |
+| int    | max, count = 1        | `count` integers in the range `[0, max)`     |
+| float  | max, count = 1        | `count` real numbers in the range `[0, max)` |
+
+Every method returns an array of numbers.
+
+## Errors
+* If you are unable to connect to the ANU RNG server for any reason, this gem won't function at all.
+* Requesting too many numbers (usually where `count > 1025`) or passing invalid arguments will likely cause a RuntimeError. In future versions, this behavior will be softened.
+
+## Examples
+```ruby
+  # A single random uint8
+  QuantumRNG.uint8
+  # 5 random uint8
+  QuantumRNG.uint8(5)
+
+  # A single random uint16
+  QuantumRNG.uint16
+  # 5 random uint16
+  QuantumRNG.uint16(5)
+
+  # A single 1-byte hex number
+  QuantumRNG.hex16(1)
+  # 5 random 1-byte hex numbers
+  QuantumRNG.hex16(1, 5)
+
+  # A single random between 0 and 1, inclusive
+  QuantumRNG.random
+  # 5 randoms between 0 and 1, inclusive
+  QuantumRNG.random(5)
+
+  # A single random int less than 100
+  QuantumRNG.int(100)
+  # 5 ints less than 100
+  QuantumRNG.int(100, 5)
+
+  # A single random float less than 100
+  QuantumRNG.float(100)
+  # 5 random floats less than 100
+  QuantumRNG.float(100, 5)
+```
+
+# TODO
+Future versions will include better error handling.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "quantum_rng"
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/lib/quantum_rng.rb

@@ -0,0 +1,46 @@
+require "quantum_rng/version"
+require 'net/http'
+require 'json'
+
+module QuantumRNG
+
+  @@base = "http://qrng.anu.edu.au/API/jsonI.php?"
+
+  def self.uint8(count = 1)
+    uri = URI.parse "#{@@base}length=#{count}&type=uint8"
+    parse_api(uri)
+  end
+
+  def self.uint16(count = 1)
+    uri = URI.parse "#{@@base}length=#{count}&type=uint16"
+    parse_api(uri)
+  end
+
+  def self.hex16(block_size, count = 1)
+    uri = URI.parse "#{@@base}length=#{count}&type=hex16&size=#{block_size}"
+    parse_api(uri)
+  end
+
+  def self.random(count = 1)
+    result = uint16(count).map { | r | r / 65535.0 }
+  end
+
+  def self.int(max, count = 1)
+    random(count).map { | r | (r * max).to_i }
+  end
+
+  def self.float(max, count = 1)
+    random(count).map { | r | (r * max).to_f }
+  end
+
+  private
+    def self.parse_api(uri)
+      packet = JSON.parse Net::HTTP.get uri
+      if packet["success"]
+        rng = packet["data"]
+      else
+        raise "[ERROR] #{JSON.pretty_generate(packet)}"
+      end
+      rng
+    end
+end

data/lib/quantum_rng/version.rb

@@ -0,0 +1,3 @@
+module QuantumRng
+  VERSION = "0.1.0"
+end

data/quantum_rng.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quantum_rng/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "quantum_rng"
+  spec.version       = QuantumRng::VERSION
+  spec.authors       = ["Ben Christianson"]
+  spec.email         = ["thhuntertgm@gmail.com"]
+
+  spec.summary       = %q{A random number generator that leverages the ANU Quantum Random Nubmers API.}
+  spec.description   = %q{Please see http://qrng.anu.edu.au/FAQ.php#api for more information on the bare JSON API, as well as the science behind it.}
+  spec.homepage      = "https://github.com/alephtwo/quantum_rng"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: quantum_rng
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Christianson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Please see http://qrng.anu.edu.au/FAQ.php#api for more information on
+  the bare JSON API, as well as the science behind it.
+email:
+- thhuntertgm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/quantum_rng.rb
+- lib/quantum_rng/version.rb
+- quantum_rng.gemspec
+homepage: https://github.com/alephtwo/quantum_rng
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A random number generator that leverages the ANU Quantum Random Nubmers API.
+test_files: []