urlcrypt 0.1.0 → 0.1.1

data/README.md

@@ -1,6 +1,7 @@
 # URLcrypt
 
-[![Build Status](https://travis-ci.org/madrobby/URLcrypt.png?branch=master)](https://travis-ci.org/madrobby/URLcrypt)
+[![Build Status](https://travis-ci.org/cheerful/URLcrypt.png?branch=master)](https://travis-ci.org/cheerful/URLcrypt)
+[![Coverage Status](https://coveralls.io/repos/cheerful/URLcrypt/badge.png?branch=master)](https://coveralls.io/r/cheerful/URLcrypt)
 
 Ever wanted to securely transmit (not too long) pieces of arbitrary binary data
 in a URL? **URLcrypt** makes it easy!
@@ -8,42 +9,45 @@ in a URL? **URLcrypt** makes it easy!
 This gem is based on the [base32](https://github.com/stesla/base32) gem from Samuel Tesla.
 
 URLcrypt uses **256-bit AES symmetric encryption**
-to securely encrypt data, and encodes and decodes 
+to securely encrypt data, and encodes and decodes
 **Base 32 strings that can be used directly in URLs**.
 
-This can be used to securely store user ids, download expiration dates and 
-other arbitrary data like that when you access a web application from a place 
+This can be used to securely store user ids, download expiration dates and
+other arbitrary data like that when you access a web application from a place
 that doesn't have other authentication or persistence mechanisms (like cookies):
- 
+
   * Loading a generated image from your web app in an email
   * Links that come with an expiration date (à la S3)
   * Mini-apps that don't persist data on the server
 
 Works with Ruby 1.8, 1.9 and 2.0.
 
-**Important**: As a general guideline, URL lengths shouldn't exceed about 2000 
+**Important**: As a general guideline, URL lengths shouldn't exceed about 2000
 characters in length, as URLs longer than that will not work in some browsers
 and with some (proxy) servers. This limits the amount of data you can store
 with URLcrypt.
 
 **WORD OF WARNING: THERE IS NO GUARANTEE WHATSOEVER THAT THIS GEM IS ACTUALLY SECURE AND WORKS. USE AT YOUR OWN RISK.**
 
+URLcrypt is an extraction from [Freckle Time Tracking](http://letsfreckle.com/),
+where it is used to generate URLs for dynamically generated images in emails.
+
 Patches are welcome; please include tests!
 
 ## Installation
 
-Add the `urlcrypt` gem to your Gemfile.
+Add `urlcrypt` to your Gemfile.
 
-## Simple Example
+## Example
 
 ```ruby
 # encrypt and encode with 256-bit AES
 # one-time setup, set this to a securely random key with at least 256 bits, see below
-URLcrypt::key = '...' 
+URLcrypt.key = '...'
 
 # now encrypt and decrypt!
-URLcrypt::encrypt('chunky bacon!')        # => "sgmt40kbmnh1663nvwknxk5l0mZ6Av2ndhgw80rkypnp17xmmg5hy"
-URLcrypt::decrypt('sgmt40kbmnh1663nvwknxk5l0mZ6Av2ndhgw80rkypnp17xmmg5hy')
+URLcrypt.encrypt('chunky bacon!')        # => "sgmt40kbmnh1663nvwknxk5l0mZ6Av2ndhgw80rkypnp17xmmg5hy"
+URLcrypt.decrypt('sgmt40kbmnh1663nvwknxk5l0mZ6Av2ndhgw80rkypnp17xmmg5hy')
   # => "chunky bacon!"
 
 # encoding without encryption (don't use for anything sensitive!), doesn't need key set
@@ -55,14 +59,14 @@ URLcrypt.decode('mnAhk6tlp2qg2yldn8xcc')  # => "chunky bacon!"
 
 The easiest way to generate a secure key is to use `rake secret` in a Rails app:
 
-```
-% rake secret
+```sh
+$ rake secret
 ba7f56f8f9873b1653d7f032cc474938fd749ee8fbbf731a7c41d698826aca3cebfffa832be7e6bc16eaddc3826602f35d3fd6b185f261ee8b0f01d33adfbe64
 ```
 
 To use the key with URLcrypt, you'll need to convert that from a hex string into a real byte array:
 
-```
+```ruby
 URLcrypt::key = ['longhexkeygoeshere'].pack('H*')
 ```
 
@@ -71,8 +75,8 @@ URLcrypt::key = ['longhexkeygoeshere'].pack('H*')
 If you want to run the automated tests for URLcrypt, issue this command from the
 distribution directory.
 
-```
-% rake test:all
+```sh
+$ rake test:all
 ```
 
 ## Why not Base 64, or an other radix/base library?
@@ -81,13 +85,13 @@ URLcrypt uses a modified Base 32 algorithm that doesn't use padding characters,
 and doesn't use vowels to avoid bad words in the generated string.
 
 The main reason why Base 32 is useful is that Ruby's built-in Base 64 support
-is, IMO, looking ugly in URLs and requires several characters that need to be 
+is, IMO, looking ugly in URLs and requires several characters that need to be
 URL-escaped.
 
-Unfortunately, some other gems out there that in theory could handle this 
+Unfortunately, some other gems out there that in theory could handle this
 (like the radix gem) fail with strings that start with a "\0" byte.
 
 
 ## References
 
-* Base 32: RFC 3548: http://www.faqs.org/rfcs/rfc3548.html
+* Base 32: RFC 3548: http://www.faqs.org/rfcs/rfc3548.html

data/Rakefile

@@ -24,6 +24,7 @@ require 'rake/clean'
 require 'rake/testtask'
 require 'rubygems'
 require 'rubygems/package_task'
+require 'bundler'
 
 task :default => ['test:all']
 
@@ -37,7 +38,7 @@ gemspec = Gem::Specification.new do |s|
   s.require_paths << 'lib'
   s.requirements << 'none'
   s.summary = "Securely encode and decode short pieces of arbitrary binary data in URLs."
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 end
 
 Gem::PackageTask.new(gemspec) do |pkg|

data/lib/URLcrypt.rb

@@ -54,10 +54,11 @@ module URLcrypt
   end
   
   def self.decrypt(data)
-    parts = data.split('Z').map{|part| decode(part)}
+    iv, encrypted = data.split('Z').map{|part| decode(part)}
+    fail DecryptError, "not a valid string to decrypt" unless iv && encrypted
     decrypter = cipher(:decrypt)
-    decrypter.iv = parts[0]
-    decrypter.update(parts[1]) + decrypter.final 
+    decrypter.iv = iv
+    decrypter.update(encrypted) + decrypter.final 
   end
     
   def self.encrypt(data)
@@ -75,4 +76,5 @@ module URLcrypt
       cipher
     end
 
-end
+  class DecryptError < ::ArgumentError; end
+end

data/test/URLcrypt_test.rb

@@ -1,8 +1,16 @@
 # encoding: utf-8
+require 'bundler'
+Bundler.require(:default, :test)
+
+require 'coveralls'
+Coveralls.wear!
+
 require 'test/unit'
-require 'URLcrypt'
 
 class TestURLcrypt < Test::Unit::TestCase
+  
+  require 'URLcrypt'
+  
   def assert_bytes_equal(string1, string2)
     bytes1 = string1.bytes.to_a.join(':')
     bytes2 = string2.bytes.to_a.join(':')
@@ -56,4 +64,10 @@ class TestURLcrypt < Test::Unit::TestCase
     assert_equal(URLcrypt::decrypt(encrypted), original)
   end
 
+  def test_decrypt_error
+    error = assert_raises(URLcrypt::DecryptError) do
+      ::URLcrypt::decrypt("just some plaintext")
+    end
+    assert_equal error.message, "not a valid string to decrypt"
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: urlcrypt
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Thomas Fuchs
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-03-18 00:00:00 Z
+date: 2015-03-18 00:00:00 Z
 dependencies: []
 
 description: