caesar_code 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c07a4a5992a81276bc877035301819821ddb7036
+  data.tar.gz: cc44718b9caddea12c2bc53b64d26ba42454d8ce
+SHA512:
+  metadata.gz: 307ff2f894ca876a75f3c7d0486b8ad191c2edf00ca4c50c6e58390c8d1f9dfd7341133c300e6d27b2ab019a3d8438e2979739b4c010c87fe903f7cfe966ab0a
+  data.tar.gz: 79c6a003538cfcdb8e571169137dee8aca0b63c196c2efde3a39c269137429b790e3e74dce6843cd33adefe14f482b483c268fd891e36e4aefb0c150bda9ab01

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 otamm
+
+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,51 @@
+# CaesarCode
+
+A kinda simple gem that implements and breaks Caesar or Shift (basically Caesar cipher
+with a number of shifts not equivalent to 3) ciphers. Breaking a cipher relies on user input to
+confirm a message is readable and makes sense. The 15 most common words of the English language
+are loaded by default and the user is prompted a message asking whether or not the cipher was
+successfully broken based on this list of words; the list can be arbitrarily extended as an optional
+second parameter to the #decipher method.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'caesar_code'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install caesar
+
+## Usage
+
+Enciphering:
+```ruby
+CaesarCode.encipher("abcd")
+# => "DEFG"
+# By default, the encryption shifts each letter 3 times.
+CaesarCode.encipher("IBM",25)
+# => "HAL"
+# The encryption can also be made with an arbitrary number of shifts.
+```
+
+Deciphering:
+```ruby
+CaesarCode.decipher("cf")
+# Will prompt the user asking if the message "BE" makes any sense (as "BE" is one of the most common words in English)
+CaesarCode.decipher("ifmmp IBM", "HAL")
+# Will prompt the user on the message "HELLO HAL", as "HAL" was added to the list of words to search for in the text.
+```
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/caesar/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

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+
+Dir.glob('spec/tasks/**/*.rake').each(&method(:import))
+#run RSpec with 'bundle exec rake spec'

data/caesar_code.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'caesar_code/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "caesar_code"
+  spec.version       = CaesarCode::VERSION
+  spec.authors       = ["Otávio Monteagudo"]
+  spec.email         = ["oivatom@gmail.com"]
+  spec.summary       = %q{Implementation of encipher and decipher functions of the Caesar/Shift cipher.}
+  spec.description   = %q{Easily implement a function to encipher or decipher a given message encrypted with either Caesar or Shift cipher. Deciphering relies on user input and a list of common words.}
+  spec.homepage      = "https://github.com/otamm/caesar-code"
+  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"
+end

data/lib/caesar_code.rb

@@ -0,0 +1,105 @@
+require "caesar_code/version"
+
+module CaesarCode
+
+  @@alpha_nums =    {
+    "A"=>1,
+    "B"=>2,
+    "C"=>3,
+    "D"=>4,
+    "E"=>5,
+    "F"=>6,
+    "G"=>7,
+    "H"=>8,
+    "I"=>9,
+    "J"=>10,
+    "K"=>11,
+    "L"=>12,
+    "M"=>13,
+    "N"=>14,
+    "O"=>15,
+    "P"=>16,
+    "Q"=>17,
+    "R"=>18,
+    "S"=>19,
+    "T"=>20,
+    "U"=>21,
+    "V"=>22,
+    "W"=>23,
+    "X"=>24,
+    "Y"=>25,
+    "Z"=>0
+  }
+  # 'Z => 0' because of the "modulo 26" operation.
+
+  def self.encipher(message,key=3) #officially, Caesar cipher shifts 3 positions. the n position shift cipher is the "shift cipher".
+
+    if key.class == String
+      key = @@alpha_nums[key]
+    elsif key.class != Fixnum
+      raise "Key argument must be either a string or integer."
+    end
+
+    cipher = []
+    message = message.upcase.split("")
+    message.each do |char|
+      if @@alpha_nums[char] == nil
+        cipher.push(char)
+      else
+        cipher.push(@@alpha_nums.find { |k,val| @@alpha_nums[k] == ((@@alpha_nums[char] + key) % 26) }[0])
+      end
+    end
+    return cipher.join("")
+  end
+
+  def self.decipher(ciphered,words_to_search_for=false)
+    most_common_english_words = ["THE","BE","TO","OF","AND","A","IN","THAT","HAVE","I","IT","FOR","WITH","AS","IS"]
+
+    #checks for optional argument and adds it to words of interest.
+    if words_to_search_for
+      if words_to_search_for.class == Array
+        words_to_search_for.each { |word| word = word.upcase }
+        most_common_english_words = words_to_search_for + most_common_english_words
+      elsif words_to_search_for.class == String
+        words_to_search_for = words_to_search_for.upcase.split(/\s/)
+        most_common_english_words = words_to_search_for + most_common_english_words
+      end
+    end
+
+    # variables that need to be declared outside the function's main loop.
+    ciphered = ciphered.upcase
+    coded_words_chars = ciphered.split("")
+    all_messages = []
+    alphaposition = 0
+    #main loop; iterates over alphabet and shifts each character of the input cipher.
+    #(line 47 to 56) Asks user to confirm a possible match. Outputs all shifts if no confirmation is received.
+    while alphaposition <= 26
+      message = []
+      alphaposition += 1
+      coded_words_chars.each do |char|
+        if @@alpha_nums[char] == nil
+          message.push(char)
+        else
+          message.push(@@alpha_nums.find { |key,val| @@alpha_nums[key] == (@@alpha_nums[char] + alphaposition) % 26 }[0])
+        end
+      end
+      message = message.join("").split(/[^A-Z0-9]/) # the RegEx splits 'message' by each char that fits 'not an uppercase letter neither a digit'
+      most_common_english_words.each do |word|
+        if message.include?(word)
+          puts message.join(" ")
+          puts "Does this make any sense? (y/n)"
+          answer = gets.chomp
+          if answer == 'y' || answer == 'Y'
+            puts "Encrypted with #{ alphaposition } shift(s)"
+            return message.join(" ")
+          end
+        end
+      end
+      all_messages.push(message.join(" "))
+    end
+
+    #output in case of failure of match recognition by the user.
+    puts all_messages
+  end
+
+end

data/lib/caesar_code/version.rb

@@ -0,0 +1,10 @@
+module CaesarCode
+  VERSION = "0.0.1"
+end
+
+# Follow semver.org 's guidelines:
+
+# MAJOR version when you make incompatible API changes,
+# MINOR version when you add functionality in a backwards-compatible manner, and
+# PATCH version when you make backwards-compatible bug fixes.
+# Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

data/spec/caesar_code_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe CaesarCode do
+
+  describe '#encipher' do
+
+    it 'enciphers with 3 shits by default' do
+      output = CaesarCode.encipher("IBM")
+      expect(output).to eq "LEP"
+    end
+
+    it 'enciphers with an arbitrary number of shifts' do
+      output = CaesarCode.encipher("IBM",25)
+      expect(output).to eq "HAL"
+    end
+
+  end
+
+  #describe '#decipher with positives' do
+    #before do
+    #  $positive = StringIO.new("y\n")
+    #  $negative = StringIO.new("n\n")
+    #end
+
+    #after do
+    #  $positive = STDIN
+    #  $negative = STDIN
+    #end
+
+    #it 'asks user to confirm a deciphered message' do
+    #  positive = StringIO.new("y\n")
+    #  allow(Caesar.decipher("cf")).to receive(:answer) { positive }
+    #  expect(deciphered).to eq "BE"
+    #end
+  #end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'caesar_code'
+#require 'stringio'

data/spec/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: caesar_code
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Otávio Monteagudo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Easily implement a function to encipher or decipher a given message encrypted
+  with either Caesar or Shift cipher. Deciphering relies on user input and a list
+  of common words.
+email:
+- oivatom@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- caesar_code.gemspec
+- lib/caesar_code.rb
+- lib/caesar_code/version.rb
+- spec/caesar_code_spec.rb
+- spec/spec_helper.rb
+- spec/tasks/rspec.rake
+homepage: https://github.com/otamm/caesar-code
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Implementation of encipher and decipher functions of the Caesar/Shift cipher.
+test_files:
+- spec/caesar_code_spec.rb
+- spec/spec_helper.rb
+- spec/tasks/rspec.rake