gravity_falls_message 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51e68853e44988a10e325f0dbcae25d8af1d0cac
+  data.tar.gz: 609060a40297ae2f77602857f988e3924ad3c2b1
+SHA512:
+  metadata.gz: 6f6bad51562f6e710e850380b21747f267b31e93fea56e27f5d591f3e24689b6c3a107fa62ef4e4a0a355436a2db3cbb4687036ab42ff676ca199745b1ee9f79
+  data.tar.gz: 9fc5a8aaaf6f7ad5914745a374e38b9b4cf96ca9386968c545ae321e8dcb9149b73ccf7eb45fd26e1f0fa3aa0b3c0d654cf61da644a014273b945dc7c64c71cb

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian Hall
+
+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,123 @@
+# Gravity Falls Message
+
+A gem to encode and decode messages using the ciphers as presented on Disney XD's show Gravity Falls. For more detailed information about the ciphers and how they are used, visit [the Gravity Falls Wiki cryptograms page](http://gravityfalls.wikia.com/wiki/List_of_cryptograms "Gravity Falls Wiki - List of cryptograms")
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gravity_falls'
+```
+
+Run the following command to install it:
+
+```console
+bundle install
+```
+
+## Supported Ciphers
+
+This gem currently supports the following ciphers:
+
+- A1Z26
+- atbash
+- binary
+- caesar
+- vigenere
+
+## Usage
+
+**Gravity Falls Message** has two methods, `decode` and `encode`. `GravityFallsMessage::Cipher` is where the work gets done, and defaults to decoding.
+
+The `decode` and `encode` methods take the `message` to be decoded or encoded as the first argument, followed by the `cipher` to be used, and finally an `options` hash.
+
+The `options` hash is only used for the Caesar and Vigenère ciphers. Since a Vigenère cipher is just a Caesar cipher whose shift is calculated from a key, the Vigenère cipher calls the Caesar cipher, passing in its `options` hash.
+
+The A1Z26 cipher expects encoded messages to have the integer representation for each letter delimited by a `-` character, i.e. `14-5-24-20 21-16` is the representation of `NEXT UP`, where `N = 14`, `5 = E`, `24 = X`, etc.
+
+### Valid Options for Caesar and Vigenère Ciphers
+
+Options other than those listed here are ignored.
+
+**Valid Options:**
+
+- `encode:` When present or `true`, switches the Cipher so it encodes the message rather than decoding it.
+- `key:` A `String`. Characters other than `/[a-zA-z]/` are ignored.
+- `shift:` An `Integer` representing the number of characters to shift. Defaults to 3. Must be positive (for now). 
+
+### Decoding Messages
+
+```console
+# decode a message using the A1Z26 cipher
+> message = "20-15 2-5 3-15-14-20-9-14-21-5-4..."
+=> "20-15 2-5 3-15-14-20-9-14-21-5-4..."
+> GravityFallsMessage.decode(message, 'a1z26')
+=> "TO BE CONTINUED..."
+
+# decode a message using the atbash cipher
+> message = "MLG S.T. DVOOH ZKKILEVW."
+=> "MLG S.T. DVOOH ZKKILEVW."
+> GravityFallsMessage.decode(message, 'atbash')
+=> "NOT H.G. WELLS APPROVED."
+
+# decode a message using binary
+> message = "0101001101001000010011110101001001010100"
+=> "0101001101001000010011110101001001010100"
+> GravityFallsMessage.decode(message, 'binary')
+=> "SHORT"
+
+# decode a message using the caesar cipher
+> message = "ZHOFRPH WR JUDYLWB IDOOV."
+=> "ZHOFRPH WR JUDYLWB IDOOV."
+> GravityFallsMessage.decode(message, 'caesar')
+=> "WELCOME TO GRAVITY FALLS."
+
+# decode a message using the vigenere cipher
+> message = "NLMXQWWN IIZ LZFNF"
+=> "NLMXQWWN IIZ LZFNF"
+> GravityFallsMessage.decode(message, 'vigenere', key: 'WHATEVS')
+=> "REMEMBER BIG HENRY"
+```
+
+### Encoding Messages
+
+```console
+# encode a message using the A1Z26 cipher
+> message = "TO BE CONTINUED..."
+=> "TO BE CONTINUED..."
+> GravityFallsMessage.encode(message, 'a1z26')
+=> "20-15 2-5 3-15-14-20-9-14-21-5-4..."
+
+# encode a message using the atbash cipher
+> message = "NOT H.G. WELLS APPROVED."
+=> "NOT H.G. WELLS APPROVED."
+> GravityFallsMessage.encode(message, 'atbash')
+=> "MLG S.T. DVOOH ZKKILEVW."
+
+# encode a message using binary
+> message = "SHORT"
+=> "SHORT"
+> GravityFallsMessage.encode(message, 'binary')
+=> "0101001101001000010011110101001001010100"
+
+# encode a message using the caesar cipher
+> message = "WELCOME TO GRAVITY FALLS."
+=> "WELCOME TO GRAVITY FALLS."
+> GravityFallsMessage.encode(message, 'caesar')
+=> "ZHOFRPH WR JUDYLWB IDOOV."
+
+# encode a message using the vigenere cipher
+> message = "REMEMBER BIG HENRY"
+=> "REMEMBER BIG HENRY"
+> GravityFallsMessage.encode(message, 'vigenere', key: 'WHATEVS')
+=> "NLMXQWWN IIZ LZFNF"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/gravity_falls_message/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,10 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs = ['lib', 'test']
+  t.test_files = FileList['test/test_helper.rb', 'test/*_test.rb']
+end
+
+task default: :test

data/gravity_falls_message.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gravity_falls_message/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gravity_falls_message"
+  spec.version       = GravityFallsMessage::VERSION
+  spec.authors       = ["Brian Hall"]
+  spec.email         = ["brian@brianhalldeveloper.com"]
+  spec.summary       = %q{A gem to encode and decode messages using the ciphers as presented on Disney XD's show Gravity Falls.}
+  spec.description   = %q{}
+  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.required_ruby_version = '~> 2.1.2'
+  spec.test_files = Dir.glob("test/**/*")
+  
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'minitest-reporters', '~> 1.0.6'
+  spec.add_development_dependency 'shoulda', '~> 3.5.0'
+  spec.add_development_dependency 'pry'
+end

data/lib/gravity_falls_message.rb

@@ -0,0 +1,32 @@
+require "gravity_falls_message/version"
+require 'gravity_falls_message/cipher'
+
+module GravityFallsMessage
+  
+  def self.decode message, cipher, options={}
+    if  cipher != 'binary'
+      message = cipher == 'a1z26' ? message.split(/( |\W)/) : message.split('')
+    end
+    # raise something if cipher == 'vigenere' && options[:key].nil?
+    case cipher
+    when 'a1z26' then Cipher.a1z26(message)
+    when 'atbash' then Cipher.atbash(message)
+    when 'binary' then Cipher.binary(message)
+    when 'caesar' then Cipher.caesar(message, options)
+    when 'vigenere' then Cipher.vigenere(message, options)
+    end
+  end
+  
+  def self.encode message, cipher, options={}
+    message = message.split(//) if cipher != 'binary'
+
+    case cipher
+    when 'a1z26' then Cipher.a1z26(message, true)
+    when 'atbash' then Cipher.atbash(message, true)
+    when 'binary' then Cipher.binary(message, true)
+    when 'caesar' then Cipher.caesar(message, options.merge(encode: true))
+    when 'vigenere' then Cipher.vigenere(message, options.merge(encode: true))
+    end
+  end
+  
+end

data/lib/gravity_falls_message/cipher.rb

@@ -0,0 +1,66 @@
+module GravityFallsMessage
+  class Cipher
+    
+    def self.alphabet
+      ('A'..'Z').to_a
+    end
+  
+    def self.a1z26 arr, encode=false
+      answer = arr.collect do |c|
+        if /-/ === c
+          ''
+        elsif /\W/ === c
+          c
+        elsif c != ''
+          encode ? alphabet.index(c.upcase) + 1 : alphabet[c.to_i - 1]
+        end
+      end
+      encode ? answer.join('-').gsub(/-?(\s|")-/, '\1').gsub(/-(\W)-?/,'\1') : answer.join('')
+    end
+    
+    def self.atbash arr, encode=false
+      answer = arr.collect do |c|
+        if /\W/ === c
+          c
+        else
+          encode ? alphabet[alphabet.reverse.index(c.upcase)] : alphabet.reverse[alphabet.index(c.upcase)]
+        end
+      end
+      answer.join('')
+    end
+    
+    def self.binary input, encode=false
+      if encode
+        answer = input.unpack('B*')[0]
+      else
+        answer = ''
+        (0..input.length).step(8).each {|i| answer << input[i,8].to_i(2).chr}
+      end
+      answer.delete("\0")
+    end
+    
+    def self.caesar arr, options={}
+      encode = options[:encode]
+      default_shift = options[:shift] || 3
+      key = options[:key].gsub(/[^A-Z]/i,'').upcase.split(//) if options[:key]
+      answer = arr.collect do |c|
+        val = key ? alphabet.index(key[0]) : default_shift
+        shift_value = encode ? val : (val * -1)
+        if /\W/ === c
+          c
+        else
+          ind = alphabet.index(c.upcase) + shift_value
+          ind = ind >= 26 ? ind - 26 : ind
+          key.rotate! if key
+          alphabet[ind]
+        end
+      end
+      answer.join('').upcase
+    end
+  
+    def self.vigenere arr, options={}
+      caesar(arr, options)
+    end
+    
+  end
+end

data/lib/gravity_falls_message/version.rb

@@ -0,0 +1,3 @@
+module GravityFallsMessage
+  VERSION = "0.0.1"
+end

data/test/gravity_falls_message_test.rb

@@ -0,0 +1,102 @@
+class GravityFallsMessageTest < Minitest::Test
+  
+  def setup
+    @a1z26_crypts = {
+      "14-5-24-20 21-16: \"6-15-15-20-2-15-20 20-23-15: 7-18-21-14-11-12-5'19 7-18-5-22-5-14-7-5.\"" => "NEXT UP: \"FOOTBOT TWO: GRUNKLE'S GREVENGE.\"",
+      "18-5-22-5-18-19-5 20-8-5 3-9-16-8-5-18-19" => "REVERSE THE CIPHERS",
+      "8-1-16-16-25 14-15-23, 1-18-9-5-12?" => "HAPPY NOW, ARIEL?"
+    }
+    
+    @atbash_crypts = {
+      "MLG S.T. DVOOH ZKKILEVW." => "NOT H.G. WELLS APPROVED.",
+      "KFIV VMVITB, MLG HPRM ZMW YLMV" => "PURE ENERGY, NOT SKIN AND BONE",
+      "IRHRMT ORPV GSV HSVKZIW GLMV" => "RISING LIKE THE SHEPARD TONE"
+    }
+    
+    @binary_crypts = {
+      "0101000001010101" => "PU", "01010000010101010101010000100000010000010100110001001100001000000101001101001001010110000010000001010000010010010100010101000011010001010101001100100000010101000100111101000111010001010101010001001000010001010101001000100001" => "PUT ALL SIX PIECES TOGETHER!"
+    }
+        
+    @caesar_crypts = {
+      'ZLGGOH' => 'WIDDLE',
+      'VKLIWHU' => 'SHIFTER',
+      'ZKDWHYV' => 'WHATEVS',
+      'EHDUR' => 'BEARO'
+    }
+    
+    @vigenere_crypts = [
+      {
+        key: 'SHIFTER',
+        cryptogram: 'OOIY DMEV VN IBWRKAMW BRUWLL',
+        solution: 'WHAT KIND OF DISASTER INDEED'
+      },
+      {
+        key: 'BEARO',
+        cryptogram: 'BRTYMEMNX QBR HRRQPEE',
+        solution: 'ANTHYDING CAN HADPLEN'
+      }
+    ]
+  end
+  
+  should "decode a message using the a1z26 cipher" do
+    @a1z26_crypts.each_pair do |cryptogram, solution|
+      assert_equal solution, GravityFallsMessage.decode(cryptogram, 'a1z26')
+    end
+  end
+
+  should "decode a message using the atbash cipher" do
+    @atbash_crypts.each_pair do |cryptogram, solution|
+      assert_equal solution, GravityFallsMessage.decode(cryptogram, 'atbash')
+    end
+  end
+
+  should "decode a message using binary" do
+    @binary_crypts.each_pair do |cryptogram, solution|
+      assert_equal solution, GravityFallsMessage.decode(cryptogram, 'binary')
+    end
+  end
+
+  should "decode a message using the caesar cipher" do
+    @caesar_crypts.each_pair do |cryptogram, solution|
+      assert_equal solution, GravityFallsMessage.decode(cryptogram, 'caesar')
+    end
+  end
+
+  should "decode a message using the vigenere cipher" do
+    @vigenere_crypts.each do |crypt|
+      assert_equal crypt[:solution], GravityFallsMessage.decode(crypt[:cryptogram], 'vigenere', {key: crypt[:key]})
+    end
+  end
+
+
+  should "encode a message using the a1z26 cipher" do
+    @a1z26_crypts.each_pair do |cryptogram, solution|
+      assert_equal cryptogram, GravityFallsMessage.encode(solution, 'a1z26')
+    end
+  end
+
+  should "encode a message using the atbash cipher" do
+    @atbash_crypts.each_pair do |cryptogram, solution|
+      assert_equal cryptogram, GravityFallsMessage.encode(solution, 'atbash')
+    end
+  end
+
+  should "encode a message using binary" do
+    @binary_crypts.each_pair do |cryptogram, solution|
+      assert_equal cryptogram, GravityFallsMessage.encode(solution, 'binary')
+    end
+  end
+
+  should "encode a message using the caesar cipher" do
+    @caesar_crypts.each_pair do |cryptogram, solution|
+      assert_equal cryptogram, GravityFallsMessage.encode(solution, 'caesar')
+    end
+  end
+
+  should "encode a message using the vigenere cipher" do
+    @vigenere_crypts.each do |crypt|
+      assert_equal crypt[:cryptogram], GravityFallsMessage.encode(crypt[:solution], 'vigenere', {key: crypt[:key]})
+    end
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'shoulda/context'
+require 'shoulda/matchers'
+require 'pry'
+
+require 'gravity_falls_message'
+
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new 

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: gravity_falls_message
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Hall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-25 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: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.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'
+description: ''
+email:
+- brian@brianhalldeveloper.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gravity_falls_message.gemspec
+- lib/gravity_falls_message.rb
+- lib/gravity_falls_message/cipher.rb
+- lib/gravity_falls_message/version.rb
+- test/gravity_falls_message_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 2.1.2
+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: A gem to encode and decode messages using the ciphers as presented on Disney
+  XD's show Gravity Falls.
+test_files:
+- test/gravity_falls_message_test.rb
+- test/test_helper.rb