email-vigenere 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76a7e01160b0145c629284cadf8aaa52e3eb492a
-  data.tar.gz: 47c3223efa9d67ea459250ae17db83088508e73f
+  metadata.gz: 6ef0d5cc0f2b9a98587bea279b8808c2b2a0071a
+  data.tar.gz: 702dc01e676d9d1840f9c64f18cc251f4b68c28a
 SHA512:
-  metadata.gz: 197fa3bb649dd665d2dde4d9453aa66280290aa1c2145ff6afd6ecfad4f892a6f87256f02da92760f93ff5b579511e1b7709fbb3551db4ab18b4348068e404a4
-  data.tar.gz: 84b4e599408a7ac5db4b65a5092345e4ca0c42628e3e780e549d94d2427ac1c62f64cb5c3a2040f7da6e28306a687cde48efd2c26115903ed6cb52bfbd2fa316
+  metadata.gz: 529530cd099fab6a1e3b1c2223f3cd2e0a54178629cc16f4d66e351d387542b1a903af5784ad604c6c71a7ef159f5efc26b2272010dd83a7a48c8c6fc8c63495
+  data.tar.gz: adf34e28bd552cc239eb7fb3710fa0fb49c66cca6dcf3563b02e068e43bf6ac7e5a6f0b0e6ea0c3ed055b6708a197f14b3e899c3868a5a8498a6aeaca0c83272

data/README.md

@@ -1 +1,43 @@
 # vigenere
+
+This is a simple gem for encoding email addresses with a vigenere cipher in a way that can be decoded later.
+
+It can create an email address that contains an encoded version of the from and to email addresses. Then it can also parse such an address to later retrieve the original from and to addresses.
+
+The key tells how much to rotate each letter by, so the trivial key 'a' (or 'aaaa', etc.) will not rotate at all and the encoded version will match the original.
+
+## Encoding
+
+Use the ```encode``` method to encode with the cipher.
+
+```
+VIGENERE::EmailCipher.new(key: 'foo').encode('hello')
+```
+
+## Decoding
+
+Use ```decode``` to decode an encoded string to get the original
+
+```
+VIGENERE::EmailCipher.new(key: 'foo').decode('mszqC')
+```
+
+## Encoding a pair of email addresses
+
+Use ```create_email_address``` to create an email address that contains the original 2 email addresses encoded with the vigenere cipher. It takes the from address, the to address, and the domain as arguments.
+
+```
+VIGENERE::EmailCipher.new(key: 'foo').create_email_address('test@example.com','test2@example.com','proxydomain.com')
+```
+
+This will generate ```ysGyoa7jLo5ADqsoiqCr_ysGya8o6sLfa6AuzsfrqtA@proxydomain.com```
+
+## Getting the original pair of email addresses back
+
+Then when we have an encoded email address like this, we can parse it for the original addresses with ```parse```
+
+```
+VIGENERE::EmailCipher.new(key: 'foo').parse('ysGyoa7jLo5ADqsoiqCr_ysGya8o6sLfa6AuzsfrqtA@proxydomain.com')
+```
+
+This will return a hash like this: ```{:from=>"test@example.com", :to=>"test2@example.com"}```

data/lib/vigenere/email_cipher.rb

@@ -93,5 +93,27 @@ module VIGENERE
       end
       alpha_decode decoded
     end
+
+    def split_addresses str
+      from = str[0, str.index('_')]
+      to = str[str.index('_')+1, str.length]
+
+      addresses = { from: from, to: to }
+    end
+
+    def parse email_address
+      encoded_addresses_string = email_address[0, email_address.index('@')]
+
+      encoded_addresses = split_addresses encoded_addresses_string
+
+      from_addr = decode(encoded_addresses[:from])
+      to_addr = decode(encoded_addresses[:to])
+
+      {from: from_addr, to: to_addr}
+    end
+
+    def create_email_address(from, to, domain)
+      "#{encode(from)}_#{encode(to)}@#{domain}"
+    end
   end
 end

data/lib/vigenere/version.rb

@@ -1,3 +1,3 @@
 module VIGENERE
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/email_cipher_spec.rb

@@ -2,6 +2,10 @@ require_relative '../lib/vigenere/email_cipher'
 
 RSpec.describe VIGENERE::EmailCipher do
 
+  def vigenere_key
+    '239^83&.7t7988J*'
+  end
+
   def encode_trivial str
     VIGENERE::EmailCipher.new(key: 'aaaaa').encode(str)
   end
@@ -15,9 +19,32 @@ RSpec.describe VIGENERE::EmailCipher do
   end
 
   def decode str
+    puts "key foo hello: #{VIGENERE::EmailCipher.new(key: 'foo').parse('ysGyoa7jLo5ADqsoiqCr_ysGya8o6sLfa6AuzsfrqtA@proxydomain.com')}"
     VIGENERE::EmailCipher.new(key: 'hello').decode(str)
   end
 
+  def encoded args={}
+    key = vigenere_key
+    key = args[:key] if args[:key] != nil
+    from = 'abc@def.com'
+    from = args[:from] if args[:from] != nil
+    to = 'ghi@jkl.com'
+    to = args[:to] if args[:to] != nil
+    ec = VIGENERE::EmailCipher.new(key: key)
+    "#{ec.encode(from)}_#{ec.encode(to)}@gofundbase.com"
+  end
+
+  def encoded_reply_address args={}
+    key = vigenere_key
+    key = args[:key] if args[:key] != nil
+    from = 'abc@def.com'
+    from = args[:from] if args[:from] != nil
+    to = 'ghi@jkl.com'
+    to = args[:to] if args[:to] != nil
+    ec = VIGENERE::EmailCipher.new(key: key)
+    "#{ec.encode(to)}_#{ec.encode(from)}@gofundbase.com"
+  end
+
   describe 'cycle' do
     it 'should cycle until the given length' do
       expect(VIGENERE::EmailCipher.new(key: 'hello').cycle(5)).to eq('hello')
@@ -75,4 +102,37 @@ RSpec.describe VIGENERE::EmailCipher do
       expect(decode encode 'hello@&a.com').to eq('hello@&a.com')
     end
   end
+
+  describe 'create email address' do
+    it 'should come up with a new email address for the receiver to reply to the sender' do
+      ec = VIGENERE::EmailCipher.new(key: vigenere_key)
+      expect(ec.create_email_address('ghi@jkl.com', 'abc@def.com', 'gofundbase.com')).to eq(encoded_reply_address)
+    end
+
+    it 'should be parsed correctly' do
+      ec = VIGENERE::EmailCipher.new(key: vigenere_key)
+      reply_addr = ec.create_email_address('ghi@jkl.com', 'abc@def.com', 'gofundbase.com')
+      expect(ec.parse(reply_addr)).to eq(from: 'ghi@jkl.com', to: 'abc@def.com')
+    end
+
+    it 'should work with underscores' do
+      ec = VIGENERE::EmailCipher.new(key: vigenere_key)
+      reply_addr = ec.create_email_address('gh_i@jk_l.com', 'a_bc@de_f.com', 'gofundbase.com')
+      expect(ec.parse(reply_addr)).to eq(from: 'gh_i@jk_l.com', to: 'a_bc@de_f.com')
+    end
+
+    it 'should work with dashes' do
+      ec = VIGENERE::EmailCipher.new(key: vigenere_key)
+      reply_addr = ec.create_email_address('gh-i@jk-l.com', 'a-bc@de-f.com', 'gofundbase.com')
+      expect(ec.parse(reply_addr)).to eq(from: 'gh-i@jk-l.com', to: 'a-bc@de-f.com')
+    end
+  end
+
+  describe 'parse email address' do
+    it 'should derive the original email addresses' do
+      expected = {from: 'abc@def.com', to: 'ghi@jkl.com'}
+      ec = VIGENERE::EmailCipher.new(key: vigenere_key)
+      expect(ec.parse(encoded)).to eq(expected)
+    end
+  end
 end

data/vigenere.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vigenere/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'email-vigenere'
+  spec.version       =  VIGENERE::VERSION
+  spec.authors       = ['Fundbase']
+  spec.email         = ['support@fundbase.com']
+  spec.summary       = %q{ Encoding/Decoding text with Vigenere Cipher}
+  spec.description   = %q{Easily Encode/Decode text with Vigenere Cipher}
+  spec.homepage      = 'https://github.com/Fundbase/vigenere'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email-vigenere
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Fundbase
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-29 00:00:00.000000000 Z
+date: 2015-03-30 00:00:00.000000000 Z
 dependencies: []
 description: Easily Encode/Decode text with Vigenere Cipher
 email:
@@ -28,6 +28,7 @@ files:
 - lib/vigenere/version.rb
 - spec/email_cipher_spec.rb
 - spec/spec_helper.rb
+- vigenere.gemspec
 homepage: https://github.com/Fundbase/vigenere
 licenses:
 - MIT
@@ -48,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Encoding/Decoding text with Vigenere Cipher