zola 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6301afbe531bd706cf6a42159824cf231ffe67bb
+  data.tar.gz: 8f7fed6bdb7db61cf3ce6c330f28ae4911ce970d
+SHA512:
+  metadata.gz: b1c56d28741f17e1f865bc30ee534e459846d3b00309fb00642b7040dd20cfb67ac11dfd767c017b07061051b0ec16b8af6a13e47d41428c2f65287af7e43581
+  data.tar.gz: 277be9cb6fef00db99bbb3925157ada4ef79bb51dd4ba54a73a10df60f3a23893c4c9c51f04d5767ec9ced44e7e789673e398a6664f90431e24b88d545d7d363

data/.codeclimate.yml

@@ -0,0 +1,5 @@
+languages:
+   Ruby: true
+
+exclude_paths:
+- "spec/*"

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6
+script: bundle exec rspec spec
+
+notifications:
+  email:
+    recipients:
+      - akeem.oduola@andela.com
+    on_failure: change
+    on_success: never
+addons:
+  code_climate:
+    repo_token: 9aSeUbKK9ourgX8S8fRW

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zola.gemspec
+group  :test do
+  gem "codeclimate-test-reporter", require: nil
+end
+gemspec

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 oakeem
+
+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,81 @@
+# Zola
+[![Code Climate](https://codeclimate.com/github/andela-aoduola/zola/badges/gpa.svg)](https://codeclimate.com/github/andela-aoduola/zola)
+[![Coverage Status](https://coveralls.io/repos/andela-aoduola/zola/badge.svg?branch=master&service=github)](https://coveralls.io/github/andela-aoduola/zola?branch=master)<br />
+Welcome to the Zola gem!
+Zola is an encryption engine for encrypting, decrypting, and cracking messages.
+The Zola gem can be used for encoding messages. It is built using the Ruby programming language and as a command line tool.
+It contains an encrypt ruby file that when called with two file names as command line arguments, it encrypts the first file and saves it in the other.
+It also contains a decrypt ruby file that when called with two file names as command line arguments, it decrypts the first file  with a user supplied key and saves it in the other.
+Lastly, zola includes a little twist where you can actually crack an encrypted file without a key.
+
+## How the encryption works
+
+The encryption is based on rotation of letters based on a key and the date that message was sent. The character map is made up of all the lowercase letters, then the numbers, then space, then period, then comma.
+
+### 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)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zola'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zola
+
+## Usage
+
+To use add the directory of the bin folder of this gem to your Systems Path/Environment variables.
+You can then call `encrypt`, `decrypt` or `crack`, on the file you want to work on, and also with a destination file name.
+File to be encrypted, decrypted or cracked must be in your working directory.
+
+Example: To call encrypt on a message.txt file in my desktop folder
+
+    $ cd desktop
+
+    $ encrypt message.txt encrypted.txt
+
+    =>#Created encrypted.txt with the key 12345 and date 300815
+
+You can also write the absolute path of the file if you don't want to change working directory.
+
+    $ encrypt desktop/message.txt encrypted.txt
+
+## Contributing
+
+1. Fork it ( https://github.com/[andela-aoduola]/zola/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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[andela-aoduola]/zola. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/crack

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zola"
+
+# quit unless our script gets two command line arguments
+unless ARGV.length == 2
+  puts "Dude, not the right number of arguments."
+  puts "Usage: encrypt message.txt encrypted.txt"
+  exit
+end
+input = ARGV[0]
+output = ARGV[1]
+
+Zola::Crack.new(input, output).execute

data/bin/decrypt

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zola"
+
+# quit unless our script gets two command line arguments
+unless ARGV.length == 2
+  puts "Dude, not the right number of arguments."
+  puts "Usage: encrypt message.txt encrypted.txt"
+  exit
+end
+input = ARGV[0]
+output = ARGV[1]
+
+Zola::Decryptor.new(input, output).execute

data/bin/encrypt

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "zola"
+
+# quit unless our script gets two command line arguments
+unless ARGV.length == 2
+  puts "Dude, not the right number of arguments."
+  puts "Usage: encrypt message.txt encrypted.txt"
+  exit
+end
+input = ARGV[0]
+output = ARGV[1]
+
+Zola::Encryptor.new(input, output).execute

data/lib/crack.rb

@@ -0,0 +1,64 @@
+module Zola
+  class Crack < Encryptor
+    attr_accessor :known, :char_hash
+    def initialize(input_file, output_file)
+      @known = "..end.."
+      @characters =  [*'0'..'9', *'a'..'z',' ','.',","]
+      @date = 0
+      @number_of_ciphers = 4
+      @char_hash = Hash[@characters.map.with_index { |char, i| [char, i] }]
+      super(input_file, output_file)
+    end
+    def execute
+      read_in_message
+      get_cipher_rotations
+      process_message
+      output_message
+    end
+    def get_cipher_rotations
+      # get the index positions of the known keywords letters, and corresponding encrypted keywords letters
+      known_indexes = get_indexes(@known)
+      encrypted_part = @message[-@known.length, @known.length]
+      encrypted_indexes = get_indexes(encrypted_part)
+      # subtract the paired indexes to get the number of rotations between the encrypted and unencrypted letters
+      rotations = get_rotations(known_indexes, encrypted_indexes)
+
+      # reverse the rotations so that the encrypted letter points to its unencrypted letter
+      inverted_rotations = reverse_rotations(rotations)
+
+      # figure out what position each cipher is using
+      r = -@message.length % @number_of_ciphers
+      @keys = inverted_rotations.rotate(r)
+    end
+
+    def cipher(rotation)
+      rotated_characters = @characters.rotate(rotation)
+      Hash[rotated_characters.zip(@characters)]
+    end
+
+    def get_indexes(message)
+      message.each_char.map do |char|
+        @char_hash[char]
+      end
+    end
+
+    def get_rotations(known , encrypted)
+      rotations = known.zip(encrypted).map do |i|
+                    difference = i[0] - i[1]
+                    # if it takes negative rotations, get the positive counter rotations
+                    difference = @characters.length + difference if difference < 0
+                    difference
+      end
+      rotations.flatten.last(4)
+    end
+
+    def reverse_rotations(rotations)
+      len = @characters.length
+      rotations.map{ |number| len - number }
+    end
+    def output_message
+      File.open(@output_file, "w") { |f| f.write(@processed_message)}
+      puts "Created #{@output_file} with ciphers #{@keys}"
+    end
+  end
+end

data/lib/decrypt.rb

@@ -0,0 +1,23 @@
+module Zola
+  class Decryptor < Encryptor
+    def get_key
+      print "Enter encryption key: "
+      @key = $stdin.gets.chomp
+    end
+    def get_date
+      @date = File.ctime(input_file).strftime("%d%m%y").to_i
+    end
+    def cipher(rotation)
+      rotated_characters = @characters.rotate(rotation)
+      Hash[rotated_characters.zip(@characters)]
+    end
+    def execute
+      read_in_message
+      get_key
+      get_date
+      generate_keys
+      process_message
+      output_message
+    end
+  end
+end

data/lib/encrypt.rb

@@ -0,0 +1,96 @@
+module Zola
+  class Encryptor
+    attr_accessor :input_file, :output_file, :message, :key, :date,:keys, :processed_message
+
+    def initialize(input_file, output_file)
+      @input_file = input_file
+      @output_file = output_file
+      @message = ""
+      @processed_message = ""
+      @key = ""
+      @date = 0
+      @keys = []
+      @characters =  [*'0'..'9', *'a'..'z',' ','.',","]
+    end
+
+    def get_key
+      @key = 5.times.map { Random.rand(9) }.join
+    end
+
+    def get_date
+      @date = Time.now.strftime("%d%m%y").to_i
+    end
+
+    def generate_keys
+      key = generate_key
+      offset = generate_offset
+      @keys << key[0] + offset[0]
+      @keys << key[1] + offset[1]
+      @keys << key[2] + offset[2]
+      @keys << key[3] + offset[3]
+      @keys
+    end
+    def generate_key
+      key = []
+      key << @key[0..1].to_i
+      key << @key[1..2].to_i
+      key << @key[2..3].to_i
+      key << @key[3..4].to_i
+      key
+    end
+    def generate_offset
+      (@date ** 2).to_s.split(//).map(&:to_i).last(4)
+    end
+    def cipher(rotation)
+      rotated_characters = @characters.rotate(rotation)
+      Hash[@characters.zip(rotated_characters)]
+    end
+
+    def process_letter(letter,rotation)
+      cipher_for_rotation = cipher(rotation)
+      cipher_for_rotation[letter]
+    end
+
+    def read_in_message
+      if File.exist?(@input_file)
+        @message = File.open(@input_file, "r") { |f| f.read}
+      else
+        Kernel.abort("ABORTED! File: #{@input_file} Not Found in current directory")
+      end
+    end
+
+    def check_message
+      @message.downcase!
+      pattern = /[^a-z0-9 ,.]/
+      if !(@message =~ pattern).nil?
+        Kernel.abort("ABORTED! Invalid character(s) in message")
+      end
+    end
+
+    def process_message
+      count = 0
+      strlen = @message.length
+      for i in 0...strlen do
+        @processed_message += process_letter(@message[i], @keys[count])
+        count +=1
+        if count == 4
+          count = 0
+        end
+      end
+      @processed_message
+    end
+    def execute
+      read_in_message
+      check_message
+      get_date
+      get_key
+      generate_keys
+      process_message
+      output_message
+    end
+    def output_message
+      File.open(@output_file, "w") { |f| f.write(@processed_message)}
+      puts "Created #{@output_file} with the key #{@key} and date #{@date}"
+    end
+  end
+end

data/lib/zola.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+#require "zola/version"
+require_relative "encrypt"
+require_relative "decrypt"
+require_relative "crack"

data/lib/zola/version.rb

@@ -0,0 +1,3 @@
+module Zola
+  VERSION = "0.1.0"
+end

data/zola.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zola/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zola"
+  spec.version       = Zola::VERSION
+  spec.authors       = ["Oduola Akeem"]
+  spec.email         = ["akeem.oduola@andela.com"]
+
+  spec.summary       = %q{ Zola is an encryption engine for encrypting, decrypting, and cracking messages.}
+  spec.homepage      = "https://github.com/andela-aoduola/zola"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "wdm", "~> 0.1.1"
+  spec.add_development_dependency "coveralls"
+end

metadata

@@ -0,0 +1,222 @@
+--- !ruby/object:Gem::Specification
+name: zola
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oduola Akeem
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  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
+  name: rspec-nc
+  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
+  name: guard
+  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
+  name: guard-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
+  name: pry
+  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
+  name: pry-remote
+  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
+  name: pry-nav
+  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
+  name: wdm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: 
+email:
+- akeem.oduola@andela.com
+executables:
+- crack
+- decrypt
+- encrypt
+extensions: []
+extra_rdoc_files: []
+files:
+- .codeclimate.yml
+- .coveralls.yml
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/crack
+- bin/decrypt
+- bin/encrypt
+- lib/crack.rb
+- lib/decrypt.rb
+- lib/encrypt.rb
+- lib/zola.rb
+- lib/zola/version.rb
+- zola.gemspec
+homepage: https://github.com/andela-aoduola/zola
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Zola is an encryption engine for encrypting, decrypting, and cracking messages.
+test_files: []
+has_rdoc: