bkerley-affine 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Bryce Kerley
+
+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,11 @@
+= affine
+
+Simple affine cipher
+
+    a = Affine::Cipher.new(2176782371, 65182241782, 123235151)
+    r = rand(123235150) # (should be smaller then the modulus)
+    r == a.decipher(a.encipher r)
+
+== Copyright
+
+Copyright (c) 2009 Bryce Kerley. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "affine"
+    gem.summary = %Q{Simple affine cipher for Ruby}
+    gem.email = "bkerley@brycekerley.net"
+    gem.homepage = "http://github.com/bkerley/affine"
+    gem.authors = ["Bryce Kerley"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "affine #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 0
+:major: 0

data/lib/affine/cipher.rb

@@ -0,0 +1,36 @@
+module Affine
+  class Cipher
+    def initialize(modulus, a_key, b_key)
+      raise CoprimeError.new(modulus, a_key) if modulus.gcd(a_key) != 1
+      @modulus = modulus
+      @a_key = a_key
+      @b_key = b_key
+      @a_inv = extended_gcd(a_key, modulus)
+    end
+    def encipher(plaintext)
+      raise RangeError.new(plaintext, @modulus) if plaintext > @modulus
+      ((@a_key * plaintext) + @b_key) % @modulus
+    end
+    def decipher(ciphertext)
+      raise RangeError.new(ciphertext, @modulus) if ciphertext > @modulus
+      (@a_inv * (ciphertext - @b_key)) % @modulus
+    end
+
+    private
+    # from http://snippets.dzone.com/posts/show/6074
+    def extended_gcd(b,m,_recursion_depth=0)
+      if b % m == 0
+        temp = [0,1]
+        return temp
+      else
+        temp = extended_gcd(m, b % m, _recursion_depth+1)
+        temp2 = [temp[1], temp[0]-temp[1] * ((b/m).to_i)]
+        if _recursion_depth == 0
+          return temp2[0] % m
+        else
+          return temp2
+        end
+      end
+    end
+  end
+end

data/lib/affine/errors.rb

@@ -0,0 +1,14 @@
+module Affine
+  class AffineError < StandardError
+  end
+  class CoprimeError < AffineError
+    def initialize(a, b)
+      super("Expected #{a} to be coprime with #{b}")
+    end
+  end
+  class RangeError < AffineError
+    def initialize(n, mod)
+      super("Expected input #{n} to be smaller than modulus #{mod}")
+    end
+  end
+end

data/lib/affine.rb

@@ -0,0 +1,5 @@
+require 'affine/errors'
+require 'affine/cipher'
+module Affine
+
+end

data/test/affine_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+class AffineTest < Test::Unit::TestCase
+  context 'affine cipher 5,8 mod 26' do
+    setup do
+      @a = Affine::Cipher.new(26, 5, 8)
+    end
+
+    should 'be created correctly' do
+      assert_nothing_raised do
+        Affine::Cipher.new(26, 5, 8)
+      end
+    end
+
+    should 'encipher ITSCOOL correctly' do
+      # example from http://en.wikipedia.org/wiki/Affine_cipher
+      plain = 'ITSCOOL'.split('').map{ |c| c[0] - 65}
+      coded = plain.map{ |c| @a.encipher c }
+      check ='WZUSAAL'.split('').map{ |c| c[0] - 65}
+      assert_equal check, coded
+    end
+    should 'decipiher WZUSAAL correctly' do
+      # example from http://en.wikipedia.org/wiki/Affine_cipher
+      check ='WZUSAAL'.split('').map{ |c| c[0] - 65}
+      coded = check.map{ |c| @a.decipher c }
+      plain = 'ITSCOOL'.split('').map{ |c| c[0] - 65}
+      assert_equal plain, coded
+    end
+  end
+
+  context 'affine cipher 65182241782, 123235151 mod 2176782371' do
+    setup do
+      @a = Affine::Cipher.new(2176782371, 65182241782, 123235151)
+    end
+    should 'get created correctly' do
+      assert_nothing_raised do
+        Affine::Cipher.new(2176782371, 65182241782, 123235151)
+      end
+    end
+    should 'pass a few random identity checks' do
+      # I'm not doing this by hand
+      1000.times do
+        r = rand(123235150)
+        assert_equal r, @a.decipher(@a.encipher r)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'affine'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: bkerley-affine
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bryce Kerley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-14 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: bkerley@brycekerley.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/affine.rb
+- lib/affine/cipher.rb
+- lib/affine/errors.rb
+- test/affine_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/bkerley/affine
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simple affine cipher for Ruby
+test_files: 
+- test/affine_test.rb
+- test/test_helper.rb