enygma 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f76a0055e8c3902ff594eef74db248e3841263a
-  data.tar.gz: d60c6eecd0b61b3dc531f4d7d5edfc72404fd6aa
+  metadata.gz: 81fe400dc15ce3b9e134048aa3a474a1ceee4c51
+  data.tar.gz: 78d8f268727f989a103f719fabb4bfd9311330f8
 SHA512:
-  metadata.gz: 89bc34b5057e4889970a789d7ee6a918db8002133ce84e149f84cadde8c98b28625546a0230fb109b058e3f164e4d418a845dc41af020efb07d633a9f35050ce
-  data.tar.gz: 1fce60030010026281f58c97e2683a53a8cb6353641decf7779e48f71275089e6ccc599cbecb371d882d54f649cd46e5c534e15e40d74dcffda057208d554537
+  metadata.gz: 1431acd831b3be2ae33209bebb22d1a1853ea49ec0a286c5b7d7629f7d6080620923130876b18bbe20c3c6b69317f59ce632ed1378994ec0b18f91f114854af4
+  data.tar.gz: 9a2e9bc051d0d0dd217a33355991f078633b297db827cfaa9e3bb31aa53ae5c3e7a6ca598bfb296e3af1e42c984d99af4f80d0044861f2a375f62b15828b8211

data/README.md

@@ -1,29 +1,6 @@
-# Enygma [![Coverage Status](https://coveralls.io/repos/andela-echigbo/enygma/badge.svg?branch=master&service=github)](https://coveralls.io/github/andela-echigbo/enygma?branch=master) [![Circle CI](https://circleci.com/gh/andela-echigbo/enygma.svg?style=shield)](https://circleci.com/gh/andela-echigbo/enygma)
+# Enygma [![Coverage Status](https://coveralls.io/repos/andela-echigbo/enygma/badge.svg?branch=master&service=github)](https://coveralls.io/github/andela-echigbo/enygma?branch=master) [![Circle CI](https://circleci.com/gh/andela-echigbo/enygma.svg?style=shield)](https://circleci.com/gh/andela-echigbo/enygma) [![Code Climate](https://codeclimate.com/github/andela-echigbo/enygma/badges/gpa.svg)](https://codeclimate.com/github/andela-echigbo/enygma)
 
-Enygma is an encryptor engine built (as a gem) with ruby programming language. It follows the principles of [Enigma Encryption Machine](https://en.wikipedia.org/wiki/Enigma_machine) to encrypt and decrypt files. The gem also offers the feature of crack a file.
-
-## How the encryption works
-
-The encryption is based on rotation of letters using a key and the date of the encryption. The character map is made up of lower case alphabets (a - z), numbers(0 - 9), space character, comma, and period character.
-
-### The Key
-
-* Each message uses a unique encryption key
-* The key is five digits, like 41521
-* The first two digits of the key are the "A" rotation (41)
-* The second and third digits of the key are the "B" rotation (15)
-* The third and fourth digits of the key are the "C" rotation (52)
-* The fourth and fifth digits of the key are the "D" rotation (21)
-
-### The Offset
-
-* The date of message transmission is also factored into the encryption
-* Consider the date in the format DDMMYY, like 020315
-* Square the numeric form (412699225) and find the last four digits (9225)
-* The first digit is the "A offset" (9)
-* The second digit is the "B offset" (2)
-* The third digit is the "C offset" (2)
-* The fourth digit is the "D offset" (5)
+Enygma is an encryption engine built (as a gem) with ruby programming language. It follows the principles of [Enigma Encryption Machine](https://en.wikipedia.org/wiki/Enigma_machine) to encrypt and decrypt files. The gem also offers the feature of cracking a file.
 
 ## Installation
 
@@ -48,14 +25,14 @@ This gem provides you with three command line actions, `encrypt`, `decrypt`, and
 
 When you have installed the enygma gem, you can encrypt a file by changing to the directory that contantains the file, and run any of the following commands
 
-### Encryption
+#### Encryption
     $ encrypt <filename> [<destination-filename>]
 
-### Decryption
+#### Decryption
     $ decrypt <cypher-filename> [<plain-filename>] <key> <date>
 
-### Cracking
-    $crack <cypher-filename> [<plain-filename>] <date>
+#### Cracking
+    $ crack <cypher-filename> [<plain-filename>] <date>
 
 ## Options
 `<filename>`    The file path of the of the file you want to encrypt. This can be the absolute filepath if you are in a different directory.
@@ -92,7 +69,7 @@ To crack a file named `file.encrypted.txt`
 
     $ crack file.encrypted.txt 231190
 
-    =>#Created file.cracked.txt with key 12345 and date 231190
+    =>#Created file.decrypted.txt with key 12345 and date 231190
 
 
 ## Contributing
@@ -107,7 +84,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/andela
 6. Wait
 
 ## Limitations
-* The character set of this gem is limited. Lower case alphabets, numbers, space, comma and period characters.
+* The character set of this gem is limited; lower case alphabets, numbers, space, comma and period characters.
 * The application generates the the key for the encryption, and does not allow user to choose their prefered digit combinations
 
 ## Improvement

data/enygma.gemspec

@@ -9,21 +9,21 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Emmanuel Chigbo"]
   spec.email         = ["emmanuel.chigbo@andela.com"]
 
-  spec.summary       = "A file encryption gem"
-  spec.description   = "This gem uses Enigma algorithm to
- encrypt and decrypt a file. It also provides you
- with the ability to crack a file that was encrypted with 'enygma'"
+  spec.summary       = "A file encryption and decryption gem"
+  spec.description   = "This gem uses Enigma algorithm to encrypt and decrypt"\
+   "a file. It also provides you with the ability to crack a file that was"\
+   " encrypted with 'enygma'"
   spec.homepage      = "https://github.com/andela-echigbo/enygma"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
                            .reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "bin"
-  spec.executables   = %w(encrypt decrypt crack)
+  spec.executables   = %w(encrypt decrypt crack setup console)
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency 'bundler', '~> 1.10', '>= 1.10.6'
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency 'rspec', '~> 0'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency "coveralls", "0.8.2"
 end

data/lib/enygma.rb

@@ -1,10 +1,10 @@
-require "enygma/version"
-require "enygma/encryptor"
-require "enygma/decryptor"
 require "enygma/cracker"
+require "enygma/decryptor"
+require "enygma/encryptor"
 require "enygma/helpers/filer"
 require "enygma/helpers/key_gen"
 require "enygma/helpers/offset"
 require "enygma/helpers/rotator"
 require "enygma/mixins/character_mapper"
 require "enygma/mixins/confirmation"
+require "enygma/version"

data/lib/enygma/cracker.rb

@@ -1,12 +1,13 @@
-require 'enygma/mixins/character_mapper'
-require 'enygma/helpers/offset'
+require 'enygma/decryptor'
 require 'enygma/helpers/filer'
 require 'enygma/helpers/key_gen'
-require 'enygma/decryptor'
+require 'enygma/helpers/offset'
+require 'enygma/mixins/character_mapper'
 
 module Enygma
   class Cracker
     PLAIN_LAST_7_CHARACTERS = "..end.."
+
     def initialize(cypher_filename, encryption_date, plain_filename = nil)
       @cypher_filename = cypher_filename
       @plain_filename = plain_filename
@@ -16,30 +17,34 @@ module Enygma
     end
 
     def crack
-      character_array = Filer.read(@cypher_filename)
-      cypher_last_4_characters = character_array.last(4)
-      cypher_last_4_characters.rotate!(4 - (character_array.size % 4))
-      plain_last_4_characters = PLAIN_LAST_7_CHARACTERS.split('').last(4)
-      plain_last_4_characters.rotate!(4 - (character_array.size % 4))
-      offset_characters = @offset.split('')
-      diff_array = get_difference_array(cypher_last_4_characters,
-                                        plain_last_4_characters,
-                                        offset_characters
+      cypher_characters = Filer.read(@cypher_filename)
+      cypher_last_4_characters = cypher_characters.last(4)
+      cypher_last_4_characters.rotate!(4 - (cypher_characters.size % 4))
+      plain_last_4_characters = PLAIN_LAST_7_CHARACTERS.split("").last(4)
+      plain_last_4_characters.rotate!(4 - (cypher_characters.size % 4))
+      offset_characters = @offset.split("")
+      differences = get_differences(
+        cypher_last_4_characters,
+        plain_last_4_characters,
+        offset_characters
       )
-      key = KeyGen.get_key(diff_array)
+
+      key = KeyGen.get_key(differences)
       Decryptor.new(@cypher_filename, key, @encryption_date, @plain_filename).
-          decrypt
+        decrypt
     end
 
-    def get_difference_array(cypher_array, plain_array, offset_array)
-      difference = []
+    def get_differences(cypher_array, plain_array, offset_array)
+      differences = []
       4.times do |i|
         diff = Enygma::CHARACTER_MAP.index(cypher_array[i]) -
-            Enygma::CHARACTER_MAP.index(plain_array[i])
+          Enygma::CHARACTER_MAP.index(plain_array[i])
+
         diff -= offset_array[i].to_i
-        difference[i] = diff.to_s.rjust(2, '0')
+        differences[i] = diff.to_s.rjust(2, '0')
       end
-      difference
+
+      differences
     end
   end
 end

data/lib/enygma/decryptor.rb

@@ -1,7 +1,7 @@
-require 'enygma/mixins/character_mapper'
-require 'enygma/helpers/offset'
 require 'enygma/helpers/filer'
+require 'enygma/helpers/offset'
 require 'enygma/helpers/rotator'
+require 'enygma/mixins/character_mapper'
 require 'enygma/mixins/confirmation'
 
 module Enygma
@@ -9,8 +9,12 @@ module Enygma
     include Confirmation
     attr_reader :plain_filename, :cypher_filename, :encryption_key,
                 :encryption_date, :decrypted
-    def initialize(cypher_filename, encryption_key, encryption_date,
-                   plain_filename = nil
+
+    def initialize(
+      cypher_filename,
+      encryption_key,
+      encryption_date,
+      plain_filename = nil
     )
       @cypher_filename = cypher_filename
       @plain_filename = plain_filename
@@ -23,30 +27,36 @@ module Enygma
     def decrypt
       begin
         cypher_characters = Filer.read(@cypher_filename)
-        cypher_characters.each_slice(4) do |batch|
-          decrypt_batch(batch)
-        end
-        @plain_filename = Filer.write(@plain_filename, @decrypted,
-                                      @cypher_filename, "decrypted"
+        cypher_characters.each_slice(4) { |batch| decrypt_batch(batch) }
+        @plain_filename = Filer.write(
+          @plain_filename,
+          @decrypted,
+          @cypher_filename,
+          "decrypted"
         )
-        show_confirmation_message(@plain_filename, @encryption_key,
-                                  @encryption_date
+
+        show_confirmation_message(
+          @plain_filename,
+          @encryption_key,
+          @encryption_date
         )
       rescue StandardError => e
-        puts "Could not open the file you supplied.
-Make sure you are correctly typing the correct path #{e.message}"
+        puts "Could not open the file you supplied."\
+        "Make sure you are correctly typing the correct path #{e.message}"
       end
     end
 
     def decrypt_batch(batch)
       key_characters = @encryption_key.split("")
-      offset_characters = @offset.split('')
+      offset_characters = @offset.split("")
       batch.each_with_index do |_value, index|
-        new_index = Rotator.rotate(key_characters[index],
-                                   key_characters[index + 1],
-                                   offset_characters[index],
-                                   batch[index]
+        new_index = Rotator.rotate(
+          key_characters[index],
+          key_characters[index + 1],
+          offset_characters[index],
+          batch[index]
         ) { |x, y| x - y }
+
         @decrypted += Enygma::CHARACTER_MAP[new_index]
       end
     end

data/lib/enygma/encryptor.rb

@@ -1,7 +1,7 @@
-require 'enygma/mixins/character_mapper'
-require 'enygma/helpers/offset'
 require 'enygma/helpers/filer'
+require 'enygma/helpers/offset'
 require 'enygma/helpers/rotator'
+require 'enygma/mixins/character_mapper'
 require 'enygma/mixins/confirmation'
 
 module Enygma
@@ -9,10 +9,11 @@ module Enygma
     include Confirmation
     attr_reader :filename, :cypher_filename, :offset, :encryption_key,
                 :encryption_date, :encrypted
+
     def initialize(filename, cypher_filename = nil)
       @filename = filename
       @cypher_filename = cypher_filename
-      @encryption_key =  rand(10**5).to_s.rjust(5,'0')
+      @encryption_key =  rand(10**5).to_s.rjust(5, '0')
       @encryption_date = Time.now.strftime("%d%m%y")
       @offset = Offset.get_offset(@encryption_date)
       @encrypted = ""
@@ -21,18 +22,22 @@ module Enygma
     def encrypt
       begin
         plain_characters = Filer.read(@filename)
-        plain_characters.each_slice(4) do |batch|
-          encrypt_batch(batch)
-        end
-        @cypher_filename = Filer.write(@cypher_filename, @encrypted, @filename,
-                                       "encrypted"
+        plain_characters.each_slice(4) { |batch| encrypt_batch(batch) }
+        @cypher_filename = Filer.write(
+          @cypher_filename,
+          @encrypted,
+          @filename,
+          "encrypted"
         )
-        show_confirmation_message(@cypher_filename, @encryption_key,
-                                  @encryption_date
+
+        show_confirmation_message(
+          @cypher_filename,
+          @encryption_key,
+          @encryption_date
         )
       rescue StandardError => e
-        puts "Could not open the file you supplied.
-Make sure you are correctly typing the correct path. #{e.message}"
+        puts "Could not open the file you supplied."\
+        "Make sure you are correctly typing the correct path. #{e.message}"
       end
     end
 
@@ -40,10 +45,13 @@ Make sure you are correctly typing the correct path. #{e.message}"
       key_characters = @encryption_key.split('')
       offset_characters = @offset.split('')
       batch.each_with_index do |_value, index|
-        new_index = Rotator.rotate(key_characters[index],
-                                   key_characters[index + 1],
-                                   offset_characters[index], batch[index]
+        new_index = Rotator.rotate(
+          key_characters[index],
+          key_characters[index + 1],
+          offset_characters[index],
+          batch[index]
         ) { |x, y| x + y }
+
         @encrypted += Enygma::CHARACTER_MAP[new_index]
       end
     end

data/lib/enygma/helpers/filer.rb

@@ -5,12 +5,14 @@ module Enygma
       content.split('')
     end
 
+    # TODO: use options params instead
     def self.write(dest_file, content, source_file = '', action = '')
       unless dest_file
-        name_split_array = source_file.split('.')
-        name_split_array.delete("encrypted")
-        dest_file = name_split_array.insert(-2, action).join('.')
+        name_split = source_file.split('.')
+        name_split.delete("encrypted")
+        dest_file = name_split.insert(-2, action).join('.')
       end
+
       File.open(dest_file, "w") { |file| file.write(content) }
       dest_file
     end

data/lib/enygma/helpers/key_gen.rb

@@ -1,4 +1,5 @@
 require "enygma/mixins/character_mapper"
+
 module Enygma
   class KeyGen
     def self.get_key(differences)
@@ -7,21 +8,34 @@ module Enygma
         break if index == differences.size - 1
         value1 = value
         value2 = differences[index + 1]
-        until value1.to_i >= 100 || tracker[index]
-          until value2.to_i >= 100 || tracker[index]
-            if value1[1] == value2[0]
-              differences[index] = value1
-              differences[index + 1] = value2
-              tracker[index] = true
-            else
-              value2 = (value2.to_i + Enygma::CHARACTER_MAP.size).to_s
-            end
+
+        compare(index, value1, value2, tracker, differences)
+      end
+
+      "%d%d%d%d" % [
+        differences[0],
+        differences[1][-1],
+        differences[2][-1],
+        differences[3][-1]
+      ]
+    end
+
+    private
+    def self.compare(index, value1, value2, tracker, differences)
+      until value1.to_i >= 100 || tracker[index]
+        until value2.to_i >= 100 || tracker[index]
+          if value1[1] == value2[0]
+            differences[index] = value1
+            differences[index + 1] = value2
+            tracker[index] = true
+          else
+            value2 = (value2.to_i + Enygma::CHARACTER_MAP.size).to_s
           end
-          value2 = differences[index + 1]
-          value1 = (value1.to_i + Enygma::CHARACTER_MAP.size).to_s
         end
+
+        value2 = differences[index + 1]
+        value1 = (value1.to_i + Enygma::CHARACTER_MAP.size).to_s
       end
-      "#{differences[0]}#{differences[1][-1]}#{differences[2][-1]}#{differences[3][-1]}"
     end
   end
 end

data/lib/enygma/helpers/rotator.rb

@@ -1,12 +1,16 @@
 require "enygma/mixins/character_mapper"
+
 module Enygma
   class Rotator
-    def self.rotate(key_character_1, key_character_2, offset_character,
-        character
+    def self.rotate(
+      key_character_1,
+      key_character_2,
+      offset_character,
+      character
     )
       character_index = Enygma::CHARACTER_MAP.index(character)
       total_shift = (key_character_1 + key_character_2).to_i +
-          offset_character.to_i
+        offset_character.to_i
       rotation = yield(character_index, total_shift)
       rotation % Enygma::CHARACTER_MAP.size
     end

data/lib/enygma/mixins/character_mapper.rb

@@ -1,3 +1,3 @@
 module Enygma
-  CHARACTER_MAP = ('a'..'z').to_a + ('0'..'9').to_a + [' ', '.', ',']
+  CHARACTER_MAP = ("\n".."z").to_a
 end

data/lib/enygma/version.rb

@@ -1,3 +1,3 @@
 module Enygma
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enygma
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Emmanuel Chigbo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-21 00:00:00.000000000 Z
+date: 2015-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -48,14 +48,14 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -72,16 +72,16 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.8.2
-description: |-
-  This gem uses Enigma algorithm to
-   encrypt and decrypt a file. It also provides you
-   with the ability to crack a file that was encrypted with 'enygma'
+description: This gem uses Enigma algorithm to encrypt and decrypta file. It also
+  provides you with the ability to crack a file that was encrypted with 'enygma'
 email:
 - emmanuel.chigbo@andela.com
 executables:
 - encrypt
 - decrypt
 - crack
+- setup
+- console
 extensions: []
 extra_rdoc_files: []
 files:
@@ -137,5 +137,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: A file encryption gem
+summary: A file encryption and decryption gem
 test_files: []