Gemnigma 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c972d271fb7395b7d645684a4e95991456479375
+  data.tar.gz: 85a3ca12bd9117a3d328386e7b0988ccca761b6e
+SHA512:
+  metadata.gz: 7cfa961d91ed50852aadcc41edb87009787dc5190a4f5249505b4e9a77e031dc7209543e025ef04032e3c33de9d006a39c03dab3d02ed5b97ef8600b58525f68
+  data.tar.gz: d9728b6ff7bb168039d03489a441463c1e8f032674d6f7c618dcf7ad1e57883b877ba5850223b5adcfdf8d11b436758c70589f31c4614f4d809b263f9774c21f

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: TqZXn6K9ZgspMdKbRI1xJKQpKCmsVYtY8

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.1.5
+  
+cache: bundler
+
+script: "bundle exec rake spec"
+
+notifications: 
+  email:
+    recipients:
+      - chinedudaniel72@yahoo.com
+    on_failure: change
+    on_success: never
+
+after_success:
+  - coveralls

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in Gemnigma.gemspec
+gemspec

data/Gemnigma.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'Gemnigma/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "Gemnigma"
+  spec.version       = Gemnigma::VERSION
+  spec.authors       = ["Chinedu"]
+  spec.email         = ["chinedudaniel7@gmail.com"]
+  spec.summary       = %q{ Encrypt and decrypt text files on your system }
+  spec.homepage      = ""
+  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"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "coveralls"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Chinedu
+
+MIT License
+
+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.md

@@ -0,0 +1,87 @@
+# Gemnigma [![Build Status](https://travis-ci.org/andela-cdaniel/Gemnigma.svg?branch=master)](https://travis-ci.org/andela-cdaniel/Gemnigma) [![Coverage Status](https://coveralls.io/repos/andela-cdaniel/Gemnigma/badge.svg?branch=master&service=github)](https://coveralls.io/github/andela-cdaniel/Gemnigma?branch=master)
+
+The Gemnigma gem is an encryption engine for encoding messages. It is built using the Ruby programming language and intended to be used from within the command line.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'Gemnigma'
+```
+
+And then execute from the command line:
+
+    $ bundle
+
+Or install it directly from the command line yourself as:
+
+    $ gem install Gemnigma
+
+## How the encryption works
+
+The encryption is based on rotation of letters based on a a key and the date that message was generated. The character map is made up of alphanumeric characters (alphabets all in lowercase), space character, period character and the comma 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)
+
+## Usage
+
+Encrypt a message by providing an input file and an output file:
+
+```
+Gemnigma encrypt message.txt encrypted.txt
+```
+
+Decrypt a message by providing an input file, an output file, a key and a date offset:
+
+```
+Gemnigma decrypt encrypted.txt decrypted.txt 41521 7225
+```
+
+Crack a message when the key is not known by providing an input file, an
+output file, and a date:
+
+```
+Gemnigma crack encrypted.txt cracked.txt 51015
+```
+
+List the contents of a directory by calling Gemnigma list and passing in options from "all", "file" or "folder"
+
+```
+Gemnigma list file
+```
+
+Call the help documentation at any time by typing Gemnigma help
+
+```
+Gemnigma help
+```
+
+## Contributing
+
+1. Fork it: [Fork Gemnigma on Github](https://github.com/andela-cdaniel/Gemnigma/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+Gemnigma is released under the [MIT License](https://github.com/andela-cdaniel/Gemnigma/blob/master/LICENSE.txt)

data/Rakefile

@@ -0,0 +1,8 @@
+require "rspec/core/rake_task"
+require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'doc']
+end
+
+task :default => :spec

data/bin/Gemnigma

@@ -0,0 +1,184 @@
+#!/usr/bin/env ruby
+
+require "Gemnigma"
+
+class StartApplication
+  def init_application
+    @option = ARGV[0]
+
+    if ARGV.length == 0
+      help
+    end
+
+    if ARGV.length == 1
+      case @option
+        when "-v"
+          version
+        when "--version"
+          version
+        when "-h"
+          help
+        when "--help"
+          help
+        when "-ls"
+          list
+        when "list"
+          list
+        else
+          help
+      end
+    end
+
+    if ARGV.length > 1
+      case @option  
+        when "-e"
+          encrypt
+        when "encrypt"
+          encrypt
+        when "-d"
+          decrypt
+        when "decrypt"
+          decrypt
+        when "-c"
+          crack
+        when "crack"
+          crack
+        when "-ls"
+          list
+        when "list"
+          list
+        else
+          help
+      end
+    end
+
+  end
+
+  private 
+
+  def version
+    version = Gemnigma::VERSION
+    p version
+  end
+
+  def help
+    puts "Usage:\nGemnigma [option] [*arguments]"
+    puts "\nOptions:\n\t-h, [--help]" + "#Displays this help message and quits".rjust(50)
+    puts "\t-v, [--version]" + "#Display Gemnigma version number and quit".rjust(51)
+    puts "\t-ls,[list]" + "#List files in the current working directory".rjust(57)
+    puts "\t-e, [encrypt]" + "#Encrypt a file in the current directory".rjust(50)
+    puts "\t-d, [decrypt]" + "#Decrypt an encrypted file in the current directory".rjust(61)
+    puts "\t-c, [crack]" + "#Cracks an encrypted file in the current directory".rjust(62)
+
+    puts "\nEncrypting files:"
+    puts "To Encrypt files in the current directory, call Gemnigma -e or Gemnigma --encrypt and\npass in "\
+         "the file to be encrypted and a new file to store the encrypted message.\n\n"\
+         "Example:\n Gemnigma -e message.txt encrypted.txt"
+
+    puts "\nDecrypting files:"
+    puts "To decrypt files in the current directory, call Gemnigma -d or Gemnigma --decrypt and\n"\
+          "pass in the file to store the decrypted contents of an encrypted file, you are also\n"\
+          "required to pass in the date that the file was generated and the key used to generate\n"\
+          "the encrypted file.\n\n"\
+          "Example:\n Gemnigma -d encrypted.txt decrypted.txt 41521 #{Time.now.strftime("%d%m%y").to_i}"
+
+    puts "\nCracking files:"
+    puts "To crack files, call Gemnigma -c or Gemnigma --crack. You must specify the date encrypted"\
+         "file was generated and file to be written to\n\n"\
+         "Example:\nGemnigma -c encrypted.txt cracked.txt #{Time.now.strftime("%d%m%y").to_i}"
+  end
+
+  def encrypt
+    enc = Gemnigma::Encrypt.new
+    enc.get_cmd_args
+  end
+
+  def decrypt
+    dec = Gemnigma::Decrypt.new
+    dec.get_cmd_args
+  end
+
+  def crack
+    crack = Gemnigma::Crack.new
+    crack.get_cmd_args
+  end
+
+  def list_all
+    result = %x["ls"]
+    result_arr = result.split("\n")
+
+    result_arr.map! do |item|
+      if File.file? item
+        "[File] " + item
+      else
+        "[Folder] " + item
+      end
+    end
+    puts "All items in current working directory: \n\n"
+    puts result_arr
+    puts "\nTotal amount items in this directory: #{result_arr.length}"
+  end
+
+  def list_file
+    result = %x["ls"]
+    result_arr = result.split("\n")
+
+    result_arr.map! do |item|
+      if File.file? item
+        "[File] " + item
+      else
+        ""
+      end
+    end
+    puts "All files in current working directory: \n\n"
+    result_arr.delete("")
+    puts result_arr
+    puts "\nTotal amount of files in this directory: #{result_arr.length}"
+  end
+
+  def list_folder
+    result = %x["ls"]
+    result_arr = result.split("\n")
+    result_arr.map! do |item|
+      if File.directory? item
+        "[Folder] " + item
+      else
+        ""
+      end
+    end
+    puts "All folders in current working directory: \n\n"
+    result_arr.delete("")
+    puts result_arr
+    puts "\nTotal amount of folders in this directory: #{result_arr.length}"
+  end
+
+  def list_help
+    puts "Usage:\n Gemnigma list [option]"
+    puts "\nOptions:\n\thelp," + "#Displays this help message and quits".rjust(49)
+    puts "\tall," + "#Display all files and folder in the current working directory".rjust(75)
+    puts "\tfile," + "#Display only files in the current working directory".rjust(64)
+    puts "\tfolder," + "#Display all folders in the current working directory".rjust(63)
+  end
+
+  def list
+    list_all if ARGV.length == 1 || (ARGV.length == 2 && ARGV[1] == "all")
+
+    list_file if ARGV.length == 2 && ARGV[1] == "file"
+
+    list_folder if ARGV.length == 2 && ARGV[1] == "folder"
+
+    list_help if ARGV.length == 2 && ARGV[1] == "help"
+
+    if ARGV.length == 2 && !(ARGV[1] == "all" || ARGV[1] == "file" || ARGV[1] == "folder" || ARGV[1] == "help")
+      puts "Not a valid option"
+    end
+
+    if ARGV.length > 2
+      puts "Too many options passed in. Not valid"
+    end
+
+  end
+  
+end
+
+StartApplication.new.init_application

data/helpers/char_map.rb

@@ -0,0 +1,11 @@
+module Gemnigma
+  module CharMap
+    def self.generate_char_map
+      alphabets = ("a".."z")
+      numbers = ("0".."9")
+      others = [" ", ".", ","]
+      character_map = [alphabets.to_a, numbers.to_a, others].flatten
+      character_map
+    end
+  end
+end

data/helpers/cipher_decrypt.rb

@@ -0,0 +1,9 @@
+require_relative "cipher_encrypt"
+
+module Gemnigma
+  module CipherDecrypt
+    def self.rotate_backward(num)
+      CipherEncrypt.rotate_forward(num).invert
+    end
+  end
+end

data/helpers/cipher_encrypt.rb

@@ -0,0 +1,10 @@
+require_relative "char_map"
+
+module Gemnigma
+  module CipherEncrypt
+    def self.rotate_forward(num)
+      rotated = CharMap.generate_char_map.rotate(num)
+      Hash[CharMap.generate_char_map.zip(rotated)]
+    end
+  end
+end

data/helpers/key.rb

@@ -0,0 +1,25 @@
+module Gemnigma
+  class Key
+    attr_reader :key
+
+    def initialize(key=41521)
+      if (key.to_s.length == 5) && (key.class == Fixnum)
+        @key = key
+      else
+        puts "Not a valid key, defaulting to 41521"
+        @key = 41521
+      end
+    end
+
+    def key_map
+      generate_key_map
+    end
+
+    private
+
+    def generate_key_map
+      @key_map = @key.to_s.chars.each_cons(2).map(&:join).map(&:to_i)
+    end
+  
+  end
+end

data/helpers/messages.rb

@@ -0,0 +1,44 @@
+module Gemnigma
+  class Messages
+    def initialize(io=$stdout)
+      @io = io
+    end
+
+    def puts(msg)
+      @io.puts msg
+    end
+
+    def few_args
+      puts "Not enough arguments passed in. Run Gemnigma --help for instructions on usage\nExiting..."
+    end
+
+    def too_much_args
+      puts "Too many arguments passed in. Run Gemnigma --help for instructions on usage\nExiting..."
+    end
+
+    def file_not_in_existence(file)
+      puts "#{file}: File does not exist\nExiting..."
+    end
+
+    def file_in_existence(input_file, output_file)
+      puts "#{input_file} exists... Checking #{output_file}"
+    end
+
+    def creating_new_file(file)
+      puts "#{file} will be created, proceeding..."
+    end
+
+    def overwrite_warning(file)
+      puts "#{file} exists already, do you want to overwrite it? (Y) or (N): "
+    end
+
+    def wrong_date(date)
+      puts "#{date} doesn't match the specified date format\nExiting..."
+    end
+
+    def success_message(output_file, key, date)
+      puts "\n........................................................"
+      puts "\nCreated '#{output_file}' with secret key #{key} and date #{date}"
+    end
+  end
+end

data/helpers/offset.rb

@@ -0,0 +1,26 @@
+module Gemnigma
+  class Offset
+
+    def date
+      @current = Time.now
+    end
+
+    def offset
+      squared_date.to_s.chars.last(4).map(&:to_i)
+    end
+
+    def full_date
+      formatted_date
+    end
+
+    private
+
+    def formatted_date
+      date.strftime("%d%m%y").to_i
+    end
+
+    def squared_date
+      formatted_date ** 2
+    end
+  end
+end

data/helpers/rotator_decrypt.rb

@@ -0,0 +1,16 @@
+require_relative "cipher_decrypt"
+require_relative "rotator_encrypt"
+
+module Gemnigma
+  class RotatorDecrypt < RotatorEncrypt
+    def rot_decrypt(word)
+      mapping = map_word_to_key(word)
+      
+      mapping.map! do |arr|
+        Gemnigma::CipherDecrypt.rotate_backward(arr.last)[arr.first]
+      end
+
+      mapping.join
+    end
+  end
+end

data/helpers/rotator_encrypt.rb

@@ -0,0 +1,62 @@
+require_relative "cipher_encrypt"
+require_relative "key"
+require_relative "offset"
+
+module Gemnigma
+  class RotatorEncrypt
+    attr_reader :key_map
+    
+    def initialize(key = Gemnigma::Key.new)
+
+      if key.methods.include? :key_map
+        @key_map = key.key_map
+      else
+        puts "Invalid key, using default key: 41521"
+        @key_map = Gemnigma::Key.new.key_map
+      end
+
+    end
+
+    def rot_encrypt(word)
+      mapping = map_word_to_key(word)
+      
+      mapping.map! do |arr|
+        Gemnigma::CipherEncrypt.rotate_forward(arr.last)[arr.first]
+      end
+
+      mapping.join
+    end
+
+    private
+
+    def get_offset
+      Gemnigma::Offset.new.offset
+    end
+
+    def map_key_to_offset
+      @key_map.zip(get_offset)
+    end
+
+    def char_rotation
+      map_key_to_offset.map do |arr|
+        arr.inject(&:+)
+      end
+    end
+
+    def map_word_to_key(word)
+      result = []
+      count_key = 0
+
+      word.downcase.split("").each_with_index do |letter, index|
+        if count_key >= char_rotation.length
+          count_key = 0
+        end
+        result << [letter, char_rotation[count_key]]
+        count_key += 1
+      end
+
+      result
+    end
+
+  end
+end

data/helpers/validate_file_arg.rb

@@ -0,0 +1,38 @@
+require_relative "messages"
+
+module Gemnigma
+  module ValidateFileArg
+    def validate
+      @input_file = ARGV[1]
+      @output_file = ARGV[2]
+
+      unless File.file? @input_file
+        Messages.new.file_not_in_existence(@input_file)
+        return
+      end
+
+      if File.file? @input_file
+        Messages.new.file_in_existence(@input_file, @output_file)
+        unless File.file? @output_file
+          Messages.new.creating_new_file(@output_file)
+          yield if block_given?
+        else
+          Messages.new.overwrite_warning(@output_file)
+          user_choice = $stdin.gets.chomp.downcase
+
+          if user_choice == "y"
+            yield if block_given?
+          elsif user_choice == "n"
+            puts "Operation aborted\nExiting..."
+            return
+          else
+            puts "Not a valid choice.\nOperation aborted.\nExiting..."
+            return
+          end
+
+        end
+      end
+
+    end
+  end
+end