shift_cipher 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abdd06cc35ae61955bdefcf9f9792c9c7b13bdd8
-  data.tar.gz: 66e3503497f4dc3e349f62804fc7c5f24614698e
+  metadata.gz: 62a19e3156396b6ae9b8e03e92147b6afa6939eb
+  data.tar.gz: 0a127d219db38403c298c6a6ec059c7db5fca804
 SHA512:
-  metadata.gz: a7fbc28663808cce272ed4ab46f5bcfc509e5b47fafaf0e8408840e3f23a9c3cbae531da33dd460fc23344418f6d7e275888cc64523d6a3b3d84cd685cd25d79
-  data.tar.gz: 36817906f3b14ae747319c7792688d82b559975c04f7f77a60bb30086070afa50d3ecd8fcb586ba3f5747bc9fbb0995712930721eae45803c914bf847ada1d71
+  metadata.gz: 6afa30e0afb2236a92659fa775b6bede6652d6d668628e0e05b0fbc55aa6f9342d18fac8611033a94297a8d81d6bb9422b0be759ef66d233677d3e63beb8f6c0
+  data.tar.gz: 726d3a52c26e4fb3dffbb1ecef70110ec70e38c11bccb33109daa69f5db79c08fe683cbf91fc8e6e874829ca5596e93affb5b3696a110894215d023a8d9c18dc

data/README.md

@@ -1,12 +1,12 @@
 # ShiftCipher
 
-A simple shift cipher, also known as a caeser ciipher
+A simple shift cipher, also known as a Caesar cipher
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
+```
 gem 'shift_cipher'
 ```
 
@@ -20,28 +20,52 @@ Or install it yourself as:
 
 ## Usage
 
-Initialise the Caeser cipher
+Initialise the Caesar cipher
 
-```ruby
-  cipher = ShiftCipher::Caeser.new(3) # initialised with an offset of 3 ('a' = 'd')
 ```
+  cipher = ShiftCipher::Caesar.new(3) # initialised with an offset of 3 ('a' = 'd')
+```
+
 or
-```ruby
-  cipher = ShiftCipher::Caeser.new('d') # initialised with an offset of 3 ('a' = 'd')
+
+```
+  cipher = ShiftCipher::Caesar.new(-3) # initialised with a negative offset of 3 ('a' = 'x')
+```
+
+or
+
+
+```
+  cipher = ShiftCipher::Caesar.new('d') # initialised with an offset of 3 ('a' = 'd')
 ```
 
 Encrypt a message:
-```ruby
+
+```
   encrypted_message = cipher.encrypt('hello world') 
   p encrypted_message # => "khoor zruog"
 ```
 
 Decrypt a message:
-```ruby
+
+```
   decrypted_message = cipher.decrypt('khoor zruog') 
   p decrypted_message # => "hello world"
 ```
 
+### Using the CLI tool:
+
+````
+  shift_cipher [options] text
+````
+
+#### Options
+   ```-h, --help```                Displays help message
+   ```-o, --offset OFFSET```       Sets the alphabet offset
+   ```-s, --start START```         Sets the starting letter of the shifted alphabet
+   ```-d, --decrypt```             Decrypts the given message    Decrypt
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/shift_cipher

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+# == Synopsis 
+#   This is a simple shift (Caesar) cipher for Ruby
+#
+# == Examples
+#   Encode text 
+#     shift_cipher -o 4 "hello world"  =>  "khoor zruog"
+#   Decode text
+#     shift_cipher -o 4 -d "khoor zruog"  =>  "hello world"
+#
+#   Other examples:
+#     We can set the starting letter of the shifted alphabet rather than the offset. The following is 
+#     equivalent to shift_cipher -o 3 "hello world"
+#       shift_cipher -s "c" "hello world"  =>  "jgnnq yqtnf"
+#
+# == Usage 
+#   shift_cipher [options] text
+#
+#   For help use: shift_cipher -h
+#
+# == Options
+#   -h, --help                Displays help message
+#   -o, --offset OFFSET       Sets the alphabet offset
+#   -s, --start START         Sets the starting letter of the shifted alphabet
+#   -d, --decrypt             Decrypts the given message    Decrypt
+#
+# == Author
+#   elsapet
+#
+# == Copyright
+#   Copyright (c) 2015 elsapet
+#   Licensed under the MIT License: http://www.opensource.org/licenses/mit-license.php
+
+
+require 'shift_cipher'
+require 'optparse'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.on("-o [OFFSET]", "--offset [OFFSET]", "-s [OFFSET]", "--start [OFFSET]") do |o|
+    options[:offset] = o
+  end
+  opts.on("-d", "--decrypt", "Decrypt") do
+    options[:decrypt] = true
+  end
+end.parse!
+
+cipher = options[:offset] ? ShiftCipher::Caesar.new(options[:offset]) : ShiftCipher::Caesar.new
+
+if options[:decrypt]
+  p cipher.decrypt(ARGV.last)
+else
+  p cipher.encrypt(ARGV.last)
+end

data/lib/shift_cipher/caesar.rb

@@ -0,0 +1,80 @@
+module ShiftCipher
+  class Caesar
+    attr_accessor :offset
+
+    def initialize(start = 0)
+
+      # set default
+      @offset = 0
+
+      # have we got a string?
+      if start.respond_to?(:ord)
+
+        # is it alphabetic?
+        if ('A'..'Z').include?(start)
+          @offset = start.downcase.ord - 97
+        elsif ('a'..'z').include?(start)
+          @offset = start.ord - 97
+
+        # is it numeric & in range?
+        elsif (1..26).include?(start.to_i.abs)
+          @offset = start.to_i
+        end
+
+      # have we got a number
+      elsif start.respond_to?(:to_i)
+        # is it in range?
+        if (1..26).include?(start.to_i)
+          @offset = start.to_i
+        end
+      end
+
+      # raise an error ... 
+      # what about case when start set to 0?
+    end
+
+    def encrypt(message)
+      shift(message, @offset)
+    end
+
+    def decrypt(message)
+      shift(message, - @offset)
+    end
+
+    private
+    def shift(message, directional_offset)
+      shifted_message = ""
+      message.downcase.split("").each do |character|
+        if is_alpha?(character)
+          shifted_character = shift_character(character, directional_offset)
+          shifted_message += shifted_character
+        elsif is_numeric?(character) #or is_whitespace?(character)
+          shifted_message += character
+        end
+      end if message
+      shifted_message.squeeze(' ')
+    end
+
+    def is_alpha?(character)
+      character.match(/^[[:alpha:]]$/)
+    end
+
+    def is_numeric?(character)
+      character.match(/^[[:digit:]]$/)
+    end
+
+    def is_whitespace?(character)
+      character.match(/^\s$/)
+    end
+
+    def shift_character(character, offset)
+      shifted_ord = character.ord + offset
+      if shifted_ord < 97
+        shifted_ord = 123 - (97 - shifted_ord)
+      elsif shifted_ord > 122
+        shifted_ord = 97 + (shifted_ord - 123)
+      end
+      shifted_ord.chr
+    end
+  end
+end

data/lib/shift_cipher/version.rb

@@ -1,3 +1,3 @@
 module ShiftCipher
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/lib/shift_cipher.rb

@@ -1,5 +1,5 @@
 require "shift_cipher/version"
-require "shift_cipher/caeser"
+require "shift_cipher/caesar"
 
 module ShiftCipher
 end

data/shift_cipher.gemspec

@@ -7,16 +7,14 @@ Gem::Specification.new do |spec|
   spec.name          = "shift_cipher"
   spec.version       = ShiftCipher::VERSION
   spec.authors       = ["elsapet"]
-  spec.email         = ["ebraae@gmail.com"]
 
   spec.summary       = "encrypt and de-crypt messages"
-  spec.description   = "encrypt and de-crypt messages using a simple caeser cipher, given an offset"
+  spec.description   = "encrypt and de-crypt messages using a simple Caesar cipher, given an offset"
   spec.homepage      = "https://github.com/elsapet/shift_cipher"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = ["shift_cipher"]
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.9"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shift_cipher
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - elsapet
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,11 +72,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
-description: encrypt and de-crypt messages using a simple caeser cipher, given an
+description: encrypt and de-crypt messages using a simple Caesar cipher, given an
   offset
-email:
-- ebraae@gmail.com
-executables: []
+email: 
+executables:
+- shift_cipher
 extensions: []
 extra_rdoc_files: []
 files:
@@ -89,7 +89,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bin/shift_cipher
 - lib/shift_cipher.rb
+- lib/shift_cipher/caesar.rb
 - lib/shift_cipher/caeser.rb
 - lib/shift_cipher/version.rb
 - shift_cipher.gemspec
@@ -113,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: encrypt and de-crypt messages