crypt-tea 1.2.0 → 1.3.0

data/{README.txt → README.rdoc}

@@ -1,20 +1,24 @@
 = Crypt::XXTEA
 
-* http://github.com/sprsquish/crypt--xxtea
+* http://crypt-tea.rubyforge.org/
 
 == DESCRIPTION:
 
-  An implementation of the Tiny Encryption Algorithm that's
-  compatible with PHP's xxTEA
-
-== REQUIREMENTS:
-
-* rubygems
+  An implementation of the Tiny Encryption Algorithm that's compatible with PHP's xxTEA
 
 == INSTALL:
 
 * sudo gem install crypt-tea
 
+== USAGE:
+
+  require 'rubygems'
+  require 'crypt-tea'
+  key = Crypt::XXTEA.new('super secret key')
+  plaintext = 'some text that needs to be encrypted'
+  cyphertext = key.encrypt(plaintext)
+  key.decrypt(cyphertext) == plaintext
+
 == LICENSE:
 
 (The MIT License)

data/lib/crypt_tea.rb

@@ -1,2 +1 @@
-$:.unshift File.dirname(__FILE__)
-require 'crypt_tea/xxtea'
+require File.join(File.dirname(__FILE__), *%w[crypt_tea xxtea])

data/lib/crypt_tea/xxtea.rb

@@ -1,6 +1,5 @@
 module Crypt
   class XXTEA
-    VERSION = '1.2.0'
     DELTA = 0x9E3779B9
 
     def initialize(new_key)
@@ -18,7 +17,8 @@ module Crypt
       end
     end
 
-    def self.str_to_longs(s, include_count = false)
+    def self.str_to_longs(s, include_count = false) # :nodoc:
+      s = s.dup
       length = s.length
       ((4 - s.length % 4) & 3).times { s << "\0" } # Pad to a multiple of 4
       unpacked = s.unpack('V*').collect { |n| int32 n }
@@ -26,41 +26,49 @@ module Crypt
       unpacked
     end
 
-    def str_to_longs(s, include_count = false)
+    def str_to_longs(s, include_count = false) # :nodoc:
       self.class.str_to_longs s, include_count
     end
 
 
     ##
     # convert array of longs back to string
-    def self.longs_to_str(l, count_included = false)
+    def self.longs_to_str(l, count_included = false) # :nodoc:
       s = l.pack('V*')
       s = s[0...(l[-1])] if count_included
       s
     end
 
-    def longs_to_str(l, count_included = false)
+    def longs_to_str(l, count_included = false) # :nodoc:
       self.class.longs_to_str l, count_included
     end
 
 
-    def self.int32(n)
+    def self.int32(n) # :nodoc:
       n -= 4_294_967_296 while (n >= 2_147_483_648)
       n += 4_294_967_296 while (n <= -2_147_483_648)
       n.to_i
     end
 
-    def int32(n)
+    def int32(n) # :nodoc:
       self.class.int32 n
     end
 
-    def mx(z, y, sum, p, e)
+    def mx(z, y, sum, p, e) # :nodoc:
       int32(
         ((z >> 5 & 0x07FFFFFF) ^ (y << 2)) +
         ((y >> 3 & 0x1FFFFFFF) ^ (z << 4))
       ) ^ int32((sum ^ y) + (@key[(p & 3) ^ e] ^ z))
     end
 
+    ##
+    # Encrypt the +plaintext+ using the +key+
+    def self.encrypt(key, plaintext)
+      self.new(key).encrypt(plaintext)
+    end
+
+    ##
+    # Encrypt the +plaintext+
     def encrypt(plaintext)
       return '' if plaintext.length == 0
 
@@ -93,9 +101,14 @@ module Crypt
       longs_to_str(v).unpack('a*').pack('m').delete("\n") # base64 encode it without newlines
     end
 
-    #
-    # decrypt: Use Corrected Block TEA to decrypt ciphertext using password
-    #
+    ##
+    # Decrypt the +ciphertext+ using the +key+
+    def self.decrypt(key, ciphertext)
+      self.new(key).decrypt(ciphertext)
+    end
+
+    ##
+    # Decrypt the +ciphertext+
     def decrypt(ciphertext)
       return '' if ciphertext.length == 0
 

data/test/benchmark.rb

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'benchmark'
+require File.join(File.dirname(__FILE__), *%w[.. lib crypt_tea])
+
+KEY = Crypt::XXTEA.new 'abigfattestkey'
+STRINGS = {}
+
+CHARS = [('a'..'z'),('A'..'Z'),('0'..'9')].map{|i| i.to_a}.flatten
+def rand_string(size)
+  (0...size).map { CHARS[rand(CHARS.length)] }.join
+end
+
+Benchmark.bm do |x|
+  [1, 10, 100, 1_000, 10_000, 100_000].each do |size|
+    STRINGS[size] = rand_string(size)
+    x.report(size.to_s.rjust(6)) { KEY.decrypt(KEY.encrypt(STRINGS[size])) }
+  end
+end
+
+__END__
+
+Ruby 1.8.6
+        user       system     total    real
+     1  0.000000   0.000000   0.000000 (  0.002733)
+    10  0.000000   0.000000   0.000000 (  0.003002)
+   100  0.010000   0.010000   0.020000 (  0.007730)
+  1000  0.070000   0.000000   0.070000 (  0.077805)
+ 10000  0.720000   0.010000   0.730000 (  0.738411)
+100000  7.780000   0.040000   7.820000 (  7.932519)
+
+Ruby 1.9.1p129
+        user       system     total    real
+     1  0.010000   0.000000   0.010000 (  0.013437)
+    10  0.000000   0.000000   0.000000 (  0.001345)
+   100  0.000000   0.000000   0.000000 (  0.003279)
+  1000  0.040000   0.000000   0.040000 (  0.040562)
+ 10000  0.390000   0.010000   0.400000 (  0.402591)
+100000  3.170000   0.020000   3.190000 (  3.243170)
+
+jRuby 1.2.0
+        user       system     total    real
+     1  0.026000   0.000000   0.026000 (  0.026000)
+    10  0.018000   0.000000   0.018000 (  0.018000)
+   100  0.040000   0.000000   0.040000 (  0.040000)
+  1000  0.220000   0.000000   0.220000 (  0.220000)
+ 10000  0.682000   0.000000   0.682000 (  0.682000)
+100000  1.281000   0.000000   1.281000 (  1.281000)
+
+jRuby 1.3.0RC2
+        user       system     total    real
+     1  0.026000   0.000000   0.026000 (  0.025000)
+    10  0.020000   0.000000   0.020000 (  0.020000)
+   100  0.040000   0.000000   0.040000 (  0.041000)
+  1000  0.255000   0.000000   0.255000 (  0.254000)
+ 10000  0.499000   0.000000   0.499000 (  0.500000)
+100000  1.805000   0.000000   1.805000 (  1.806000)

data/test/test_xxtea.rb

@@ -1,42 +1,62 @@
-$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'rubygems'
+require 'minitest/spec'
+require File.join(File.dirname(__FILE__), *%w[.. lib crypt_tea])
 
-require 'test/unit'
-require 'crypt_tea'
+MiniTest::Unit.autorun
 
-class XXTEATest < Test::Unit::TestCase
-  def setup
-    @key = Crypt::XXTEA.new 'abigfattestkey'
+describe Crypt::XXTEA do
+  before do
+    @key_text = 'abigfattestkey'
+    @key = Crypt::XXTEA.new @key_text
     @plaintext = "Oh say can you see, by the dawn's early light"
     @cyphertext = "V32cYZc5yLXepm9lxzr4kgGM/eSVurwV0yQWi4uFs0uB2UBlJ19ZRKKMkbMr7DLGc3n1XQ=="
   end
 
-  def test_str_to_long
-    assert_equal [1953719668, 6778473, 7], Crypt::XXTEA.str_to_longs('testing', true)
+  it 'converts strings to longs' do
+    Crypt::XXTEA.str_to_longs('testing', true).must_equal [1953719668, 6778473, 7]
   end
 
-  def test_longs_to_str
-    assert_equal 'testing', Crypt::XXTEA.longs_to_str([1953719668, 6778473, 7], true)
+  it 'converts longs to strings' do
+    Crypt::XXTEA.longs_to_str([1953719668, 6778473, 7], true).must_equal 'testing'
   end
 
-  def test_key_length
-    assert_raise(RuntimeError) { Crypt::XXTEA.new '12345678901234567' }
-    assert_raise(RuntimeError) { Crypt::XXTEA.new '' }
+  it 'raises an error when the key is too long' do
+    proc { Crypt::XXTEA.new '12345678901234567' }.must_raise RuntimeError
   end
 
-  def test_encrypt
-    assert_equal @cyphertext, @key.encrypt(@plaintext)
+  it 'raises an error when the key is blank' do
+    proc { Crypt::XXTEA.new '' }.must_raise RuntimeError
   end
 
-  def test_decrypt
-    assert_equal @plaintext, @key.decrypt(@cyphertext)
+  it 'works properly with small keys' do
+    key = Crypt::XXTEA.new '123'
+    cyphertext = key.encrypt(@plaintext)
+    key.decrypt(cyphertext).must_equal @plaintext
   end
 
-  def test_tiny_plaintext
-    assert_equal '1', @key.decrypt(@key.encrypt('1'))
+  it 'properly encrypts when instantiated' do
+    @key.encrypt(@plaintext).must_equal @cyphertext
   end
 
-  def test_huge_plaintext
+  it 'properly decrypts when instantiated' do
+    @key.decrypt(@cyphertext).must_equal @plaintext
+  end
+
+  it 'properly en/decrypts tiny text' do
+    txt = '1'
+    @key.decrypt(@key.encrypt(txt)).must_equal txt
+  end
+
+  it 'properly en/decrypts huge text' do
     str = '1234567890' * 1_000
-    assert_equal str, @key.decrypt(@key.encrypt(str))
+    @key.decrypt(@key.encrypt(str)).must_equal str
+  end
+
+  it 'properly encrypts with a class method' do
+    Crypt::XXTEA.encrypt(@key_text, @plaintext).must_equal @cyphertext
+  end
+
+  it 'properly decrypts with a class method' do
+    Crypt::XXTEA.decrypt(@key_text, @cyphertext).must_equal @plaintext
   end
 end

metadata

@@ -1,80 +1,38 @@
 --- !ruby/object:Gem::Specification 
 name: crypt-tea
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Jeff Smick
-- James Zhang
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDNDCCAhygAwIBAgIBADANBgkqhkiG9w0BAQUFADBAMRIwEAYDVQQDDAlzcHJz
-  cXVpc2gxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
-  bTAeFw0wODA0MDIxOTIyNTlaFw0wOTA0MDIxOTIyNTlaMEAxEjAQBgNVBAMMCXNw
-  cnNxdWlzaDEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYD
-  Y29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApOw6SFYnQLR9Nehv
-  Tk1z7N5lMpqPu7A/0NVtAjE7FYOrus0dkTmvoV2jdJAjJu5UsH88fPK5WSlBsjPi
-  7eHAsCW666JN49H5lzO+U5BkyrTNyU1IbRtjiaYQWaty6EgXg8DK/86JZ7xzCrHa
-  8N6Emr/PFUeMIvRFx9Fe86AEAM7eU5SOlXT2aEGoxVJ+EoLHP/9LhsZCBQJe4R8V
-  REAAh9sXxFOAy+GxxzdfynaAcztLqtgbGGjH7M556KzssK05cYv2OKiUuUBfFP7I
-  85b5FTALafbyNgiJ33T/jmrLliqSQnFnCpO8Z9RMLi76KLFDi94qx0OAOXQqt9nA
-  BHn9fQIDAQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU
-  9W9c33x/OyxZXjtZjtsnkpJLWdYwDQYJKoZIhvcNAQEFBQADggEBAGameI2S4h+W
-  haqOQrWnk4r4TyS6H+NQVU6WDOGfvxfRAfHe3fvMwwFj99JhxmHeGZBLDtFAbuou
-  J8eMWMJ5bfDxr5jm1slp5y8lZa1bxKhZrh7Cic75JaQjG+IRmcq83nOqVPQYOGCD
-  NdbmYwxq06l2iSHLGkWPdtj1XbbVIG3X2YQ7qTz68A2U0Zh5s5+oXTp7lCWmM4s9
-  oSXucdvUZrG6FcqqtaDLz/fSjMCgUPBe6a3vcgvGV+B7AQ7MOABU58dPUCFXSQR/
-  uT42BT+P+4TaAbBCICCSIM0yVs8a3jJ8aVdwre3Xc0bvcdMpZ22wNeaB6Lo3/v51
-  M6zkPH2hkWs=
-  -----END CERTIFICATE-----
+cert_chain: []
 
-date: 2009-05-27 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.12.2
-    version: 
-description: |-
-  An implementation of the Tiny Encryption Algorithm that's
-    compatible with PHP's xxTEA
-email: 
-- sprsquish@gmail.com
-- james@aftershocksf.com
+date: 2009-06-05 00:00:00 -07:00
+default_executable: xxtea
+dependencies: []
+
+description: An implementation of the Tiny Encryption Algorithm that's compatible with PHP's xxTEA
+email: sprsquish@gmail.com
 executables: 
 - xxtea
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
+- README.rdoc
 files: 
-- History.txt
-- Manifest.txt
-- README.txt
-- Rakefile
 - bin/xxtea
 - lib/crypt_tea.rb
 - lib/crypt_tea/xxtea.rb
-- test/test_xxtea.rb
+- README.rdoc
 has_rdoc: true
-homepage: http://github.com/sprsquish/crypt--xxtea
+homepage: http://crypt-tea.rubyforge.org
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -92,9 +50,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: crypt-tea
-rubygems_version: 1.3.3
+rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
-summary: An implementation of the Tiny Encryption Algorithm that's compatible with PHP's xxTEA
+summary: xxTEA implemented in pure ruby
 test_files: 
+- test/benchmark.rb
 - test/test_xxtea.rb

data.tar.gz.sig

@@ -1,3 +0,0 @@
-�2=}4���Y��|�q�����~U�+-��L VK6�=p���-dRs����j�'�_c�)��P;�,n��7?��������ǓEjK�$�j�f%'�Cl�l<�
C��.��T�
-Ō�*J�����Ѷ�((�F�1p����h<��ۘh"w��<��Z`%N(-Q�ϧ^�u��f4��!�s��$
-����b!H���}��N�QEO8���&(��ġ���R-]5�*,���r�6��D��{=F�0��

data/History.txt

@@ -1,18 +0,0 @@
-=== 1.2.0 / 2009-05-27
-
-* Ruby 1.9 Compliant!
-
-=== 1.1.0 / 2009-04-06
-
-* BUGFIX
-
-  * ensure extra characters on the end of decrypted strings are removed
-  * Thanks to James Zhang for reporting this
-
-
-=== 1.0.0 / 2008-04-02
-
-* 1 major enhancement
-
-  * Birthday!
-

data/Manifest.txt

@@ -1,8 +0,0 @@
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-bin/xxtea
-lib/crypt_tea.rb
-lib/crypt_tea/xxtea.rb
-test/test_xxtea.rb

data/Rakefile

@@ -1,8 +0,0 @@
-require 'rubygems'
-require 'hoe'
-require './lib/crypt_tea.rb'
-
-Hoe.new('crypt-tea', Crypt::XXTEA::VERSION) do |p|
-  p.developer('Jeff Smick', 'sprsquish@gmail.com')
-  p.developer('James Zhang', 'james@aftershocksf.com')
-end