ratsel 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33bd72862b50995d74e3e2a8eb41060c4c1a1326
-  data.tar.gz: b27e88682a2cffb389238dc9ff6fe9eba5f187bd
+  metadata.gz: 1d391b1a71dd2f6afb1b5766b181fd31dd1d656c
+  data.tar.gz: 1ce2b4a3f829f426544c2b3396b18b4e7b66b73f
 SHA512:
-  metadata.gz: 274e78b12b807439e08a3b74ad5b3c6d3c46db3a0c3aaa10153c20fe39f76a4912fb0ae7238a93a4983ba90451cf57e1a06696dc8def16138c01c4f42a682dad
-  data.tar.gz: 1dda2f31cf68850b01d3889d011bd9f3d85c98c39fe1408fcd285c63b6f566ab553edea690e85ca6d42406d63fefda0342feb7113d79d35fc3a18dcfdf396df9
+  metadata.gz: 769b18c89e6932cf393107ea90b04aa37df53187546d43995ad25530287db15c6ca86778845bfc522776b569cb26e8c4f320b7ac0016731c7432c884dafe02c9
+  data.tar.gz: 4dfe71be8e3a4c61e068c34e127ad1cd021b861978f44762b3e53d07319cc91adcc8b3dfc139147cb3e0225985c2e425c9b12f884b8ff11d0ac676210e5537c2

data/.codeclimate.yml

@@ -0,0 +1,21 @@
+engines:
+  duplications:
+    enabled: true
+    config:
+      languages:
+        ruby:
+          mass_threshold: 20
+  eslint:
+    enabled: true
+    checks:
+      import/extensions:
+        enabled: true
+ratings:
+  paths:
+      - "**.rb"
+exclude_paths:
+- "Gemfile"
+- "Gemfile.lock"
+- "ratsel.gemspec"
+- .gitignore
+- "lib/ratsel/test.txt"

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: mCQfeXHNkBqg72S74JEtfejnZvHdXlOTP

data/.travis.yml

@@ -1,5 +1,5 @@
-sudo: false
 language: ruby
 rvm:
   - 2.4.1
-before_install: gem install bundler -v 1.15.4
+after_success:
+  - cat ./coverage/lcov.info

data/README.md

@@ -1,4 +1,50 @@
-# Ratsel
+# Rätsel
 [![Coverage Status](https://coveralls.io/repos/github/vynessa/ratsel/badge.svg?branch=develop)](https://coveralls.io/github/vynessa/ratsel?branch=develop)
+[![Gem Version](https://badge.fury.io/rb/ratsel.svg)](https://badge.fury.io/rb/ratsel)
+[![Build Status](https://travis-ci.org/vynessa/ratsel.svg?branch=develop)](https://travis-ci.org/vynessa/ratsel)
 
-Ratsel is German for `Enigma`
+## Introduction
+Rätsel is German for `Enigma`. Rätsel is an encryption tool that can take in messages, encrypt them for transmission, then decrypt messages we get from others.
+
+### Features
+<ul>
+<li>Messages can be encrypted</li>
+<li>Encrypted messages can be decrypted provided the encyption key and date are passed in</li>
+<li>Encrypted messages can be cracked without the encryption key</li>
+</ul>
+
+## Getting started with the project
+* Visit the [Wiki](https://github.com/vynessa/ratsel/wiki/Getting-Started-with-the-Project) to find out how to make use of this project.
+
+## How to use the application
+To utilize the functionality of this tool, on command line, run the following:
+* To encrypt, run `encrypt <file> [<output>]`
+* To decrypt, run `decrypt <encrypted-file> [<output>] <key> <date>`
+* To crack, run `crack <encrypted-file> [<output>] <date>`
+
+## Sample Encryption and Decryption
+* Suppose we have a text file in a lib directory `test.txt` with the content below:
+    ```hello hello ..end..```
+* On running encrypt with our output as `new.txt`
+    ```encrypt lib/test.txt lib/new.txt```
+* The result will be 
+    ```6a43a6zv h7ow7w527q```
+* Running decrypt and passing the output file, encryption key and date, we will then have:
+    ```hello hello ..end..```
+
+## Naming conventions
+* Visit the [Wiki](https://github.com/vynessa/ratsel/wiki) to find branch, commit messages and pull request naming conventions.
+## Contributing to the project
+* Fork this repository to your github account
+* Clone the repository -  `git clone https://github.com/<your-repo-name>/ratsel.git`
+* Create your feature branch - `git checkout -b your-branch-name`
+* Commit your changes - `git commit -m “[Enter message]“` or `git commit` for the interactive interface
+* Push to the remote branch - `git push origin your-branch-name`
+* Open a pull request (See [wiki](https://github.com/vynessa/ratsel/wiki/Pull-Request-Naming-and-Description-Convention) for pull request(s) naming convention)
+I look forward to your pull requests!
+
+## License
+[MIT License](https://github.com/vynessa/ratsel/blob/develop/LICENSE)
+
+## Author
+* **[Vanessa Ejikeme](https://www.linkedin.com/in/vanessa-ejikeme-68078b74/)**

data/lib/ratsel/crack.rb

@@ -1,55 +1,36 @@
-require_relative "helpers/accessor"
-require_relative "helpers/cipher"
-require_relative "helpers/helpers"
-require_relative "helpers/message"
-require_relative "decrypt"
-
 module Ratsel
   class Crack
     include SendMessage
-    attr_reader :decrypted_txt, :cracked_txt, :encryption_date, :encryption_key
+    attr_reader :encrypted_txt, :cracked_txt, :encryption_date, :encryption_key
 
-    def initialize(decrypted_txt, cracked_txt, encryption_date)
+    def initialize(encrypted_txt, cracked_txt, encryption_date)
       @encryption_key = nil
       @encryption_date = encryption_date
-      @decrypted_txt = decrypted_txt
+      @encrypted_txt = encrypted_txt
       @cracked_txt = cracked_txt
-      @character_map = Cipher.character_map
     end
 
     def crack
-      end_char = '..end..'
-      decrypted_message = Accessor.read_file_text(decrypted_txt)
-
-      decrypted_message_4 = decrypted_message.last(4)
-      decrypted_message_4.rotate!(4 - (decrypted_message.size % 4))
-      end_char_4 = end_char.split("").last(4)
-      end_char_4.rotate!(4 - (decrypted_message.size % 4))
-      offsets = Helpers.offsets_array(@encryption_date).join('')
-
-      differences = get_differences(
-        decrypted_message_4,
-        decrypted_message_4,
+      last_char = '..end..'
+      encrypted_message = Ratsel::Accessor.read_file_text(encrypted_txt)
+
+      encrypted_message_last_4 = encrypted_message.last(4)
+      last_4_char = last_char.split("").last(4)
+      encrypted_message_last_4.rotate!(4 - (encrypted_message.size % 4))
+      last_4_char.rotate!(4 - (encrypted_message.size % 4))
+      offsets = Ratsel::Helpers.offsets_array(@encryption_date)
+
+      differences = Ratsel::Helpers.get_differences(
+        encrypted_message_last_4,
+        last_4_char,
         offsets
-      )
-
-      key = Helpers.get_key(differences)
-      puts key
-      Decrypt.new(decrypted_txt, cracked_txt, key, encryption_date).decrypt
-    end
-
-    def get_differences(decrypted_message, end_char, offsets)
-      differences = []
-
-      4.times do |i|
-        diff = (@character_map.index(decrypted_message[i]) -
-        @character_map.index(end_char[i]))
+        )
 
-        diff -= offsets[i].to_i
-        differences[i] = diff.to_s.rjust(2, '0')
-      end
+      # Get the missing key
+      key = Ratsel::Helpers.get_key(differences)
 
-      differences
+      # Initialize Decrypt method with the missing key
+      Ratsel::Decrypt.new(encrypted_txt, cracked_txt, key, encryption_date).decrypt
     end
   end
 end

data/lib/ratsel/decrypt.rb

@@ -2,7 +2,6 @@ require_relative "helpers/accessor"
 require_relative "helpers/cipher"
 require_relative "helpers/helpers"
 require_relative "helpers/message"
-
 require 'json'
 
 module Ratsel
@@ -10,12 +9,8 @@ module Ratsel
     include SendMessage
     attr_reader :encryption_key, :encrypted_txt, :decrypt_txt, :character_map,
                 :sum_rotation_offset, :encryption_date
-    def initialize(
-      encrypted_txt,
-      decrypt_txt,
-      encryption_key,
-      encryption_date
-    )
+                
+    def initialize(encrypted_txt, decrypt_txt, encryption_key, encryption_date)
       @encryption_key = encryption_key
       @encrypted_txt = encrypted_txt
       @decrypt_txt = decrypt_txt
@@ -50,9 +45,7 @@ module Ratsel
 
       message(decrypt_txt, encryption_key, encryption_date)
 
-      File.open(decrypt_txt, "a") do |line|
-        line.write("#{decrypted_message}")    
-      end
+      Accessor.write_encrypted_texts(decrypt_txt, decrypted_message)
         
       decrypted_message
     end

data/lib/ratsel/encrypt.rb

@@ -21,32 +21,35 @@ module Ratsel
     end
 
     def encrypt
-      message = Accessor.read_file_text(@message_txt)
-      encrypted_message = ''
-      sliced_message_array = []
+      begin
+        message = Accessor.read_file_text(@message_txt)
+        encrypted_message = ''
+        sliced_message_array = []
 
-      message.each_slice(4) { |message|
-        sliced_message_array << message.join('')
-      }
+        message.each_slice(4) { |message|
+          sliced_message_array << message.join('')
+        }
 
-      sliced_message_array.each_with_index { |batch, index|
-        message_batch = batch.downcase.split('')
-        n = message_batch.length
-    
-        n.times { |i|
-          char_rotate = @character_map.rotate(@character_map.index(message_batch.shift))
-          rotated_array = char_rotate.rotate(@sum_rotation_offset[i])
-          encrypted_message << rotated_array.shift
+        sliced_message_array.each_with_index { |batch, index|
+          message_batch = batch.downcase.split('')
+          n = message_batch.length
+      
+          n.times { |i|
+            char_rotate = @character_map.rotate(@character_map.index(message_batch.shift))
+            rotated_array = char_rotate.rotate(@sum_rotation_offset[i])
+            encrypted_message << rotated_array.shift
+          }
         }
-      }
 
-      message(encrypted_txt, encryption_key, encryption_date)
+        message(encrypted_txt, encryption_key, encryption_date)
+
+        Accessor.write_encrypted_texts(encrypted_txt, encrypted_message)
+    
+        encrypted_message
 
-      File.open(encrypted_txt, "a") do |line|
-        line.write("#{encrypted_message}")    
+      rescue TypeError => e
+        puts "#{e}\nMake sure the characters in your text file are numbers, letters, a period, space or comma."
       end
-        
-      encrypted_message
     end
   end
 end

data/lib/ratsel/helpers/accessor.rb

@@ -3,18 +3,15 @@ module Ratsel
     # Read text from file
     def self.read_file_text(text_file)
       message = ''
-      File.open(text_file, 'rb').each { |line| message += line }
+      File.open(text_file).each { |line| message += line }
       new_message = message.downcase.split('')
     end
 
-    # Encryted info
-    def self.write_encrypted_texts(text_file)
-      encrypted_object = []
-      File.open(text_file).each { |line|
-        encrypted_object << line
-      }
-
-      encrypted_object
+    # Encrypted info
+    def self.write_encrypted_texts(encrypted_txt, encrypted_message)
+      File.open(encrypted_txt, "w") do |line|
+        line.write("#{encrypted_message}")    
+      end
     end
   end
 end

data/lib/ratsel/helpers/cipher.rb

@@ -5,7 +5,7 @@ module Ratsel
       'f', 'g', 'h', 'i', 'j', 'k',
       'l', 'm', 'n', 'o', 'p', 'q',
       'r', 's', 't', 'u', 'v', 'w',
-      'x', 'y', 'z', '1', '2', '3', '4', '5',
+      'x', 'y', 'z', '0', '1', '2', '3', '4', '5',
       '6', '7', '8', '9', ' ', '.', ',']
     end
   end

data/lib/ratsel/helpers/helpers.rb

@@ -1,5 +1,3 @@
-require_relative "helpers"
-# require_relative "cipher"
 module Ratsel
   class Helpers
     # Get offsets array from the date of message transmission
@@ -35,7 +33,22 @@ module Ratsel
       sum_array
     end
 
-    # Get key
+    def self.get_differences(encrypted_message, end_char, offsets)
+      @character_map = Ratsel::Cipher.character_map
+      differences = []
+
+      4.times do |i|
+        diff = (@character_map.index(encrypted_message[i]) -
+        @character_map.index(end_char[i]))
+
+        diff -= offsets[i].to_i
+        differences[i] = diff.to_s.rjust(2, '0')
+      end
+
+      differences
+    end
+
+    # Get encryption key
     def self.get_key(differences)
       key_array = []
       differences.each_with_index do |value, index|

data/lib/ratsel/version.rb

@@ -1,3 +1,3 @@
 module Ratsel
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/ratsel.gemspec

@@ -34,4 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "coveralls", '~> 0'
+  spec.add_development_dependency "simplecov", '~> 0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ratsel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Vanessa Ejikeme
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-07 00:00:00.000000000 Z
+date: 2018-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
 description: Ratsel is used in encryption and decrypting text from a file.
 email:
 - vanessa.ejikeme@gmail.com
@@ -76,6 +90,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"