random_sources 1.0

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Juanjo Bazán
+
+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.rdoc

@@ -0,0 +1,45 @@
+= Random Sources
+
+Random Sources is a Ruby gem that provides genuine random numbers, generated by processes fundamentally governed by inherent uncertainty instead of some pseudo-random number algorithm. It uses http services from different online providers.
+
+== Getting started
+
+Install the gem: 
+    $ [sudo] gem install random_sources
+
+Then depending on your project you may:
+
+Require the gem (if a ruby project):  
+    require 'random_sources'
+or add it to your Gemfile (if you're on Rails): 
+    gem 'random_sources', :git => 'git://github.com/xuanxu/random_sources.git'
+  
+
+== Usage
+
+Your entry point is the RandomSources module. With it you can get a list of supported providers and instantiate any of them:
+
+    RandomSources.list                   #=> "HotBits, RandomOrg"
+    
+    RandomSources.generator 'RandomOrg'  #=> <RandomSources::RandomOrg>
+    
+Once you have your generator you can ask for the random bytes:
+
+    generator = RandomSources.generator 'RandomOrg'
+    
+    # five integers between 1 and 100: 
+    generator.integers(:num => 5, :min => 1, :max => 100)  
+    # => [45, 61, 22, 96, 70]
+    
+    # two strings of 10 unique characters including digits and uppercase letters:
+    generator.strings(:num => 2, :unique => 'on', :digits => 'on', :upperalpha => 'on', :loweralpha =>'off')
+    # => ["6ESR61Y1", "K7520E6L"]
+    
+You can get integers, strings, sequences, bytes, etc... For a list of all the options of any supported source, check the doc in {the wiki}[http://wiki.github.com/xuanxu/random_sources/]
+
+== Credits
+
+Author:: Juanjo Bazán 
+Copyright:: Copyright (c) 2010 Juanjo Bazán
+License:: Released under the MIT license.
+

data/lib/providers/hot_bits.rb

@@ -0,0 +1,49 @@
+require 'rexml/document'
+require 'rexml/xpath'
+
+module RandomSources
+
+  # The HotBits class uses the http service provided by http://www.fourmilab.ch/hotbits/
+  #
+  # The service offers genuine random numbers generated by timing successive pairs of radioactive decays detected by a Geiger-Muller tube.
+  #
+  # The service assigns a quota of available random bits per IP.
+  #
+  # Use the service properly and check the website if you need more details about the terms of usage.
+  class HotBits
+    attr_reader :website
+
+    def initialize
+      @website = "http://www.fourmilab.ch/hotbits/"
+    end
+
+    # Short info about the online source.
+    def info
+      "HotBits is an Internet resource that brings genuine random numbers, generated by a process fundamentally governed by the inherent uncertainty in the quantum mechanical laws of nature:
+       HotBits are generated by timing successive pairs of radioactive decays detected by a Geiger-Muller tube interfaced to a computer. The website is mantained by John Walker."
+    end
+
+    # Random bytes generator.
+    #
+    # It returns an Array of integers with values between 0 and 255
+    #
+    # It receives the number of random bytes to generate (max 2048, default 10) 
+    def bytes(num=10)
+      num = [[2048, num.to_i].min , 0].max
+      numbers = []
+
+      response = REXML::Document.new( open("https://www.fourmilab.ch/cgi-bin/Hotbits?fmt=xml&nbytes=#{num}"))
+      status = REXML::XPath.first( response, "//status")
+      case status.attributes['result'].to_i 
+      when 200
+       data = REXML::XPath.first( response, "//random-data" ).text.split
+       data.each{|byte| numbers << byte.hex}
+      when 503
+       raise StandardError.new "#{status.text}"
+      end
+
+      numbers
+    end
+  end  
+
+end

data/lib/providers/random_org.rb

@@ -0,0 +1,168 @@
+module RandomSources
+  
+  # The RandomOrg class uses the http service provided by http://www.random.org.
+  #
+  # RANDOM.ORG offers numbers with randomness coming from atmospheric noise.
+  #
+  # The service assigns a daily quota of available random bits for IP.
+  #
+  # Use the service properly and check the website if you need more details about the terms of usage.
+  class RandomOrg
+    attr_reader :website
+    
+    def initialize
+      @website = "http://www.random.org/"
+    end
+    
+    # Short info about the online source.
+    def info
+      "RANDOM.ORG offers numbers with randomness coming from atmospheric noise.
+      The service was built and is being operated by Mads Haahr of the School of Computer Science and Statistics at Trinity College, Dublin in Ireland."
+    end
+  
+    # Random Integers Generator.
+    # 
+    # Configuration options:
+    # * <tt>:num</tt> - The number of integers requested. Posibles values: [1,1e4]. Default: 10
+    # * <tt>:min</tt> - The smallest value allowed for each integer. Posibles values: [-1e9,1e9]. Default: 1
+    # * <tt>:max</tt> - The smallest value allowed for each integer. Posibles values: [-1e9,1e9]. Default: 100
+    # * <tt>:base</tt> - The base that will be used to print the numbers. Posibles values: 2, 8, 10, 16 (binary, octal, decimal or hexadecimal). Default: 10
+    #
+    # It returns an Array of integers with the size indicated by <tt>:num</tt>
+    #
+    #   integers(:num => 15, :max => 2, :min => 200, base => 8)  #=> array of 15 base 8 numbers between 2 and 200
+    #   integers(:num => 4, :max => 33)                          #=> [31, 25, 28, 6]
+    #
+    def integers(options = {})
+      url_params = { :max => clean(options[:max]) || 100, 
+                     :min => clean(options[:min]) || 1, 
+                     :num => clean(options[:num]) || 10, 
+                     :base => clean(options[:base]) || 10, 
+                     :rnd => 'new',
+                     :format => 'plain',
+                     :col => 1
+                   }
+
+      numbers=[]
+
+      check_for_http_errors{
+        response=open("#{@website}integers/?max=#{url_params[:max]}&min=#{url_params[:min]}&base=#{url_params[:base]}&col=#{url_params[:col]}&rnd=#{url_params[:rnd]}&format=#{url_params[:format]}&num=#{url_params[:num]}") 
+        response.each_line{|line| numbers << line.to_i}
+      }
+      
+      numbers
+    end
+    
+     # The Sequence Generator
+     # 
+     # It will randomize a given interval of integers, i.e., arrange them in random order.
+     # 
+     # It needs two params:
+     # * <tt>min</tt> - The lower bound of the interval (inclusive). Posibles values: [-1e9,1e9]
+     # * <tt>max</tt> - The upper bound of the interval (inclusive). Posibles values: [-1e9,1e9]
+     #
+     # The length of the sequence (the largest minus the smallest value plus 1) can be no greater than 10,000.
+     #
+     # It returns an Array of all the integers of the given interval arranged randomly
+     # 
+     #   sequence(2, 15)  #=> [13, 2, 10, 4, 9, 15 ,12, 3, 5, 7, 6, 14, 8, 11]
+    def sequence(min, max)
+      url_params = { :max => clean(max) || 10, 
+                     :min => clean(min) || 1, 
+                     :rnd => 'new',
+                     :format => 'plain',
+                     :col => 1
+                   }
+      sequence_numbers=[]
+
+      check_for_http_errors{
+       response=open("#{@website}sequences/?max=#{url_params[:max]}&min=#{url_params[:min]}&col=#{url_params[:col]}&rnd=#{url_params[:rnd]}&format=#{url_params[:format]}")
+       response.each_line{|line| sequence_numbers << line.to_i}
+      }
+
+      sequence_numbers
+    end
+    
+    # Random Strings Generator.
+    # 
+    # It will generate truly random strings of various length and character compositions.
+    #
+    # Configuration options:
+    # * <tt>:num</tt> - The number of strings requested. Posibles values: [1,1e4]. Default: 10
+    # * <tt>:len</tt> - The length of the strings. All the strings produced will have the same length. Posibles values: [1,20]. Default: 8
+    # * <tt>:digits</tt> - Determines whether digits (0-9) are allowed to occur in the strings. Posibles values: ['on', 'off']. Default: on
+    # * <tt>:upperalpha</tt> - Determines whether uppercase alphabetic characters (A-Z) are allowed to occur in the strings. Posibles values: ['on', 'off']. Default: on
+    # * <tt>:loweralpha</tt> - Determines lowercase alphabetic characters (a-z) are allowed to occur in the strings. Posibles values: ['on', 'off']. Default: on
+    # * <tt>:unique</tt> - Determines whether the strings picked should be unique (as a series of raffle tickets drawn from a hat) or not (as a series of die rolls). 
+    # If unique is set to on, then there is the additional constraint that the number of strings requested (num) must be less than or equal to the number of strings 
+    # that exist with the selected length and characters. Posibles values: ['on', 'off']. Default: on
+    # 
+    # It returns an Array of Strings of the size indicated with <tt>:num</tt>
+    # 
+    #   strings(:num => 15, :len => 2, :digits => 'off', upperalpha => 'off')  #=> array of 15 strings of size 2 composed by diggits and lowercase letters with no repetition.
+    #   strings(:num => 4, :len => 10)                                         #=> ["iloqQz2nGa", "D2mgs12kD6", "yMe1eDsinJ", "ZQPaEol6xr"]
+    def strings(options = {})
+      url_params = { :num => clean(options[:num]) || 10,
+                     :len => clean(options[:len]) || 8, 
+                     :digits => check_on_off(options[:digits]) || 'on',
+                     :unique => check_on_off(options[:unique]) || 'on',
+                     :upperalpha => check_on_off(options[:upperalpha]) || 'on',
+                     :loweralpha => check_on_off(options[:loweralpha]) || 'on',
+                     :rnd => 'new',
+                     :format => 'plain'
+                   }
+
+      strings=[]
+
+      check_for_http_errors{
+        response=open("#{@website}strings/?num=#{url_params[:num]}&len=#{url_params[:len]}&digits=#{url_params[:digits]}&unique=#{url_params[:unique]}&upperalpha=#{url_params[:upperalpha]}&loweralpha=#{url_params[:loweralpha]}&rnd=#{url_params[:rnd]}&format=#{url_params[:format]}") 
+        response.each_line{|line| strings << line.strip}
+      }
+      
+      strings
+    end
+    
+    # The Quota Checker.
+    #
+    # This method allows you to examine your quota at any point in time. 
+    # The quota system of random.org works on the basis of IP addresses. 
+    # Each IP address has a base quota of 1,000,000 daily bits.
+    #
+    # If your quota is greater than or equal to zero, the next request for random numbers will be fully completed, even if the request will result in the quota becoming negative. 
+    # Hence, no partial responses will be sent as a result of exhausting ehe quota; the server will either return a full response or an error response.
+    #
+    # Every day, shortly after midnight UTC, all quotas with less than 1,000,000 bits receive a free top-up of 200,000 bits. 
+    # If the server has spare capacity, you may get an additional free top-up earlier, but you should not count on it.
+    # If you need extra bits urgently (or require many bits) you can purchase once-off top-ups from the Quota Page: http://www.random.org/quota.
+    #
+    # The method returns the number of bits left of your quota as an integer.
+    def quota
+      url_params = { :format => 'plain' }
+      check_for_http_errors{
+       response=open("#{@website}quota/?format=#{url_params[:format]}") 
+       return response.to_i
+      }
+    end
+
+    private 
+
+    def clean(p) #:nodoc:
+      (p.nil? || p.to_s=='') ? nil : p.to_i
+    end
+    
+    def check_on_off(p) #:nodoc:
+      return nil if p.nil?
+      ['ON', 'OFF'].include?(p.upcase) ? p : nil 
+    end  
+    
+    def check_for_http_errors #:nodoc:
+      begin
+        yield
+      rescue OpenURI::HTTPError => boom 
+       raise StandardError.new("Error from server: "+boom.io.read.strip)   
+      end
+    end
+    
+  end
+  
+end

data/lib/random_sources.rb

@@ -0,0 +1,22 @@
+require 'open-uri'
+providers_dir = File.dirname(__FILE__) + '/../lib/providers'
+$LOAD_PATH.unshift(providers_dir)
+Dir[File.join(providers_dir, "*.rb")].each {|file| require File.basename(file)}
+
+module RandomSources
+  # List of all the random sources providers supported
+  #
+  # It returns a string of names separated by commas. You can use any of the names to instantiate a class with the <tt>generator</tt> method
+  def self.list
+    self.constants*', '
+  end  
+  
+  # Instantiate and returns the class managing the online provider specified as param.
+  # 
+  # If you don't know the names of the providers you can get them via the <tt>list</tt> method.
+  def self.generator(provider)
+    return self.const_get(provider).new if self.constants.include?(provider.to_sym)
+    raise NameError.new("Provider not available or name not recognized. Check the list of supported providers with RandomSources.list", provider.to_s) 
+  end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: random_sources
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- "Juanjo Baz\xC3\xA1n"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-18 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: The Random Sources library provides genuine random numbers, generated by processes fundamentally governed by inherent uncertainty instead of some pseudo-random number algorithm. It uses http services from different online providers.
+email: jjbazan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE.txt
+- README.rdoc
+- lib/providers/hot_bits.rb
+- lib/providers/random_org.rb
+- lib/random_sources.rb
+has_rdoc: true
+homepage: http://github.com/xuanxu/random_sources
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Genuine random numbers and strings.
+test_files: []
+