quantum_rng 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a6be9de6482f66518e8a72dc0d461d308748fbe
-  data.tar.gz: c545e0895e9fd61a11b30e33fca187c44673c02b
+  metadata.gz: 5054e7772ed7a8bea7806318efb18700c5f64490
+  data.tar.gz: 94f84e8975ea24cfa1f2110599f52d267750b705
 SHA512:
-  metadata.gz: e4724cfdaf07f674ddf179380101283e7db52e4277ae5b301f8c8032a2648e4265742ee2d7d66fb019367d8b321b0b9232f3dc227475906a2bf82c67ceb6c7b0
-  data.tar.gz: b748b52492e00eab0ccf98e7a44037e0459cf4385af9608a411b36b5bf0101a9fe3e47d318d8d0f893616a214ff42211a0f856259fe2dc5fe8996049d80a5e14
+  metadata.gz: 0ea1361b69d4e858c850c3c5b2ecf5d90f410e7f866aab0502c02ef40d1ba721004cf9d0711c205757010d616241cc8ec8a1ff523f517f166dda4e3519047c7f
+  data.tar.gz: c3d8de5de6a5aa63c7379df34b8105f04cbe7bc9fdbe9395c8bfcba4d878483ae68d81fb9c1352ff2f43a87c640f83955b3de14ac80b291a3355d6e9d6a541b4

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/README.md

@@ -1,5 +1,9 @@
 # QuantumRNG
-A Ruby gem that leverages the ANU Quantum Random Numbers API
+A Ruby gem that leverages the [ANU Quantum Random Numbers Server API](http://qrng.anu.edu.au/index.php).
+
+# Acknowledgements
+This gem exists entirely as an interface to the ANU Quantum Random Numbers API. **All of the heavy lifting is done on their side, and any credit belongs entirely to them.** I have just generalized access to the JSON API. 
+Please give them a visit: [http://photonics.anu.edu.au/qoptics/Research/qrng.php](http://photonics.anu.edu.au/qoptics/Research/qrng.php)
 
 ### So, you want random numbers...
 Computers are great at creating pseudorandom numbers, but true randomness requires a little bit more effort.
@@ -18,14 +22,14 @@ 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)` |
+| Method | Argument(s)               | Description                                     |
+| ------ | :-----------------------: | ----------------------------------------------- |
+| uint8  | `count = 1`               | `count` integers between 0 and 255              |
+| uint16 | `count = 1`               | `count` integers between 0 and 65535            |
+| hex16  | `block_size`, `count = 1` | `count` hex numbers of `block_size` bytes       |
+| random | `count = 1`               | `count` real 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.
 
@@ -67,4 +71,4 @@ Every method returns an array of numbers.
 ```
 
 # TODO
-Future versions will include better error handling.
+Future versions will include better error handling.

data/Rakefile

@@ -1,2 +1,8 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
 
+desc "Run tests"
+task :default => :test

data/bin/console

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

data/lib/quantum_rng.rb

@@ -1,46 +1,46 @@
-require "quantum_rng/version"
+require 'quantum_rng/version'
 require 'net/http'
 require 'json'
 
+# QuantumRNG gets random numbers from the ANU Quantum RNG API.
 module QuantumRNG
-
-  @@base = "http://qrng.anu.edu.au/API/jsonI.php?"
+  @base = 'http://qrng.anu.edu.au/API/jsonI.php?'
 
   def self.uint8(count = 1)
-    uri = URI.parse "#{@@base}length=#{count}&type=uint8"
+    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"
+    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}"
+    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 }
+    uint16(count).map { |r| r / 65_535.0 }
   end
 
   def self.int(max, count = 1)
-    random(count).map { | r | (r * max).to_i }
+    random(count).map { |r| (r * max).to_i }
   end
 
   def self.float(max, count = 1)
-    random(count).map { | r | (r * max).to_f }
+    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
+
+  def self.parse_api(uri)
+    packet = JSON.parse Net::HTTP.get uri
+    if packet['success']
+      packet['data']
+    else
+      fail "[ERROR] #{JSON.pretty_generate(packet)}"
     end
-end
+  end
+end

data/lib/quantum_rng/version.rb

@@ -1,3 +1,4 @@
+# Gem Version
 module QuantumRng
-  VERSION = "0.1.0"
+  VERSION = '0.1.5'
 end

data/quantum_rng.gemspec

@@ -4,21 +4,21 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'quantum_rng/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "quantum_rng"
+  spec.name          = 'quantum_rng'
   spec.version       = QuantumRng::VERSION
-  spec.authors       = ["Ben Christianson"]
-  spec.email         = ["thhuntertgm@gmail.com"]
+  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.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.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.8"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quantum_rng
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Ben Christianson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler