kiq 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8738b2a749f8c6959b25142fd004b6b4afd9a22d
+  data.tar.gz: b294d68b568e765289461654a299ea702fc6d8ee
+SHA512:
+  metadata.gz: c1a743f005a75273f63e9547b7425a5db88984ec7ce0d75fe422de321ccda91cbe27ce20e817aebd0cb12ef67468dcc04e62c44ad44fb84f32c179271a758c91
+  data.tar.gz: 71c3e03e2c1ecf0d8386d828044b481d25aa7c65436f92b73547169b3cc1ecc7394d490036e7d97782e8cc584b7cf8a72ab73184d1e441338996fa88bab0aa20

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Gem's dependencies specified in kiq.gemspec
+gemspec

data/README.md

@@ -0,0 +1,73 @@
+
+Kiq [![Build Status](https://travis-ci.org/loganmeetsworld/kiq.svg?branch=master)](https://travis-ci.org/loganmeetsworld/kiq) [![Gem Version](https://badge.fury.io/rb/kiq.svg)](https://badge.fury.io/rb/kiq) [![Inline docs](http://inch-ci.org/github/loganmeetsworld/kiq.svg?branch=master)](http://inch-ci.org/github/loganmeetsworld/kiq) [![Code Climate](https://codeclimate.com/github/loganmeetsworld/kiq/badges/gpa.svg)](https://codeclimate.com/github/loganmeetsworld/kiq)
+=========
+
+## Summary
+kiq is a crowd funding application that can be run from your command line. This project was a learning experience. Key learning points for me were:
+* Building a Ruby gem.
+* Struggling with deciding if I should use other gems and build in dependencies.
+* Testing Ruby and making code more modular.
+* Getting over my Rails addiction to lovely built in libraries and methods.
+
+## Installation
+This is a Ruby Gem! It can be found on the rubygems site [here](https://rubygems.org/gems/kiq) and easily implemented on any operating system that has Ruby installed with the command `gem install kiq`.  
+
+I tested this gem out on OSX El Capitan, Yosemite, Microsoft 10, and Linux. Just make sure you have [https://www.ruby-lang.org/en/documentation/installation/](Ruby installed on your OS). RubyGems comes with a Ruby installation.  
+
+This gem uses serialization to store the projects in a `.kiq` yml file. If you don't want this file in whatever folder you are currently in, I would suggest creating a new folder to use the gem:  
+`cd projects`  
+`mkdir kiq`  
+`gem install kiq`  
+And then you're off! If you ever want to remove the `.kiq` yaml file, delete it from the folder with:  
+`rm .kiq`  
+
+If you're interesting in developing with the code, use git to clone this repo:  
+`git clone https://github.com/loganmeetsworld/kiq.git`
+
+## Sample Input and Output
+```
+> kiq project Awesome_Sauce 500  
+Added Project: Awesome_Sauce!  
+> kiq back John Awesome_Sauce 4111111111111111 50  
+John backed Awesome_Sauce for $50.  
+> kiq back Sally Awesome_Sauce 1234567890123456 10  
+ERROR: That card fails Luhn-10!  
+> kiq back Jane Awesome_Sauce 4111111111111111 50  
+ERROR: That card has already been added by another user!  
+> kiq back Jane Awesome_Sauce 5555555555554444 50  
+Jane backed Awesome_Sauce for $50.  
+> kiq list Awesome_Sauce  
+Project Name: Awesome_Sauce  
+Amount Remaining: $400.0  
+BACKERS:  
+Backer John, Amount: $50  
+Backer Jane, Amount: $50  
+> kiq back Mary Awesome_Sauce 5474942730093167 400  
+Reached goal!  
+Mary backed Awesome_Sauce for $400.  
+> kiq list Awesome_Sauce  
+Project Name: Awesome_Sauce  
+Amount Remaining: $0.0  
+Reached goal!  
+BACKERS:  
+Backer John, Amount: $50  
+Backer Jane, Amount: $50  
+Backer Mary, Amount: $400  
+> kiq backer John  
+Backed Awesome_Sauce for $50 dollars.  
+```
+
+## Technology/Dependencies
+### Let's talk about assumptions
+* I want to recognize that I made a couple of assumptions in this process. The first assumption was that a user downloading the gem was using a Mac. 
+
+### Why ruby, why a gem (and the downsides to those choices)
+### To depend, or not to depend? That is the question.
+### Serialization For Storage
+### Hash Useage
+
+## To Do (if only there was more time)
+A lot of things.
+* Make it look prettier, research UI gems like `highline` and `colorize` and look for ways to implement them.
+* Refactor the specs. There's a lot of repetition there.
+* Add specs for handling user input.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w(--color)
+end

data/bin/kiq

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# Loads the library path and all files in it
+# requires the run file to start program
+# calls the perform method in run
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'kiq/run'
+
+Kiq::CLI::Run.new.perform

data/kiq.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kiq/helpers/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'kiq'
+  gem.version       = Kiq::VERSION
+  gem.authors       = ['Logan McDonald']
+  gem.email         = ['logan@logancodes.it']
+  gem.description   = %q{Use this command line tool to back Kickstarter campaigns.}
+  gem.summary       = %q{Mini Kickstarter Command Line Interface}
+  gem.homepage      = 'https://github.com/loganmeetsworld/kiq'
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.files         -= gem.files.grep(%r{^\.})
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rspec', '~> 2.14'
+  gem.add_development_dependency 'rake', '~> 10.1'
+  gem.add_development_dependency 'simplecov', '~> 0.12'
+end

data/lib/kiq.rb

@@ -0,0 +1,8 @@
+require 'kiq/run'
+require 'kiq/project'
+require 'kiq/backer'
+require 'kiq/helpers/constants'
+require 'kiq/helpers/display'
+
+module Kiq
+end

data/lib/kiq/backer.rb

@@ -0,0 +1,157 @@
+module Kiq
+  module CLI
+    # Hosts logic for the backer object
+    class Backer
+      @@instance_collector = []
+      # Allows access to name, credit_card, and amount
+      attr_accessor :name, :credit_card, :amount
+
+      # @param name [String]
+      # @param amount [String]
+      # @credit_card [String]
+      # Initalizes a new Backer object
+      def initialize(name, credit_card, amount)
+        @name = name
+        @amount = amount
+        @credit_card = credit_card
+      end
+
+      # @param project [Project]
+      # Check if project exists
+      # @return [Boolean] warning if false
+      def self.validate_project_exists(project)
+        if !project.nil?
+          return true
+        else
+          puts "ERROR: Project doesn't exist."
+          return false
+        end
+      end
+
+      # @param project [Project]
+      # Checks all validation methods for a credit card
+      # @return [Boolean] warning if false
+      def self.validate_card(project, credit_card)
+        return self.check_card_uniqueness(project, credit_card) && self.check_card_luhn_10(credit_card) && self.check_card_length(credit_card) && self.check_card_numeric(credit_card) && self.check_name_length(name)
+      end
+
+      # @param backer_name [String]
+      # Checks all validation methods for a Backer's name
+      # @return [Boolean] warning if false
+      def self.validate_backer_name(backer_name)
+        return self.check_name_characters(backer_name) && self.check_name_length(backer_name)
+      end
+
+      # @param amount [String]
+      # Checks if the amount includes dollar signs
+      # @return [Boolean] warning if false
+      def self.check_amount_dollar_sign(amount)
+        if !amount.include?('$')
+          return true
+        else
+          puts "ERROR: Backing amount must not contain the '$' character or any other alphanumeric characters. Numbers only."
+          return false
+        end
+      end
+
+      # @param name [String]
+      # Checks if the name has non-alphanumeric characters besides underscores and dashes
+      # @return [Boolean] warning if false
+      def self.check_name_characters(name)
+        if name.scan(/[^\w-]/).empty?
+          return true
+        else
+          puts "ERROR: Backer name may only use alphanumeric characters, underscores, and dashes."
+          return false
+        end
+      end
+
+      # @param name [String]
+      # Checks if the string is between 4 and 20 characters
+      # @return [Boolean] warning if false
+      def self.check_name_length(name)
+        if name.length >= 4 && name.length <= 20
+          return true
+        else
+          puts "ERROR: Backer name must be between 4 and 20 characters."
+          return false
+        end
+      end
+
+      # @param project [Project]
+      # @param credit_card [String]
+      # Checks if the credit card is unique, no other Backer exists with that card
+      # @return [Boolean] warning if false
+      def self.check_card_uniqueness(project, credit_card)
+        if project.backers[credit_card].nil?
+          return true
+        else
+          puts "ERROR: That card has already been added by another user!"
+          return false
+        end
+      end
+
+      # @param credit_card [String]
+      # Checks if the credit card passes the Luhn-10 algorithm
+      # @return [Boolean] warning if false
+      def self.check_card_luhn_10(credit_card)
+        if self.luhn_valid?(credit_card)
+          return true
+        else
+          puts "ERROR: That card fails Luhn-10!"
+          return false
+        end
+      end
+
+      # @param credit_card [String]
+      # Checks if the credit card is under 19 numbers long
+      # @return [Boolean] warning if false
+      def self.check_card_length(credit_card)
+        if credit_card.length <= 19
+          return true
+        else
+          puts "ERROR: That card isn't less than or equal to 19 numbers!"
+          return false
+        end
+      end
+
+      # @param credit_card [String]
+      # Checks if the credit card only contains numbers
+      # @return [Boolean] warning if false
+      def self.check_card_numeric(credit_card)
+        if credit_card.match(/^\d+$/)
+          return true
+        else
+          puts "ERROR: That card isn't purely numeric!"
+          return false
+        end
+      end
+
+      # @param credit_card [String]
+      # Computes Luhn-10 algorithm
+      # @return [Boolean]
+      def self.luhn_valid?(credit_card)
+        number = credit_card.reverse
+        sum = 0
+        count = 0
+
+        number.each_char do |char|
+          n = char.to_i
+          if count.odd?
+            n *= 2
+          end
+
+          if n >= 10
+            n = 1 + (n - 10)
+          end
+
+          sum += n
+          count += 1
+        end
+
+        (sum % 10) == 0
+      end
+
+    end
+  end
+end

data/lib/kiq/helpers/constants.rb

@@ -0,0 +1,20 @@
+require 'kiq/helpers/version'
+
+# Contains all relevant constants for displaying information
+module Kiq
+  TITLE_HASH = {
+    'NAME' => "kiq: a command line interface for backing Kickstarter projects.\n\n",
+    'SYNOPSIS' => "kiq [command] [arguments...]\n\n",
+    'VERSION' => "#{Kiq::VERSION}\n\n"
+  }
+  COMMAND_HASH = {
+    'list' => ['     - Display a project including backers and backed amounts', '[project name]'],
+    'project' => ['  - Create a new project', '[project name] [amount]'],
+    'back' => ['     - Back a project', '[backer name] [project name] [credit card number] [backing amount]'],
+    'backers' => ['  - Display a list of projects that a backer has backed and amounts backed', '[backer name]']
+  }
+
+  SPACES = '    '
+
+  GLOBAL_COMMAND = "--help   - Get help for a command\n\n"
+end

data/lib/kiq/helpers/display.rb

@@ -0,0 +1,32 @@
+module Kiq
+  # Displays help to the user
+  class Display
+    # Returns the full help center
+    # @return [String]
+    def self.help
+      Kiq::TITLE_HASH.keys.each do |key|
+        puts key
+        puts Kiq::SPACES + Kiq::TITLE_HASH[key]
+      end
+
+      puts 'GLOBAL OPTIONS'
+      puts Kiq::SPACES + Kiq::GLOBAL_COMMAND
+
+      puts "COMMANDS"
+      Kiq::COMMAND_HASH.keys.each do |key|
+        puts Kiq::SPACES + key + Kiq::COMMAND_HASH[key][0]
+      end
+      puts "\n"
+    end
+
+    # @param command [String]
+    # Returns the command help center
+    # @return [String]
+    def self.command_help(command)
+      puts 'NAME'
+      puts Kiq::SPACES + Kiq::TITLE_HASH['NAME']
+      puts 'SYNOPSIS'
+      puts Kiq::SPACES + command + Kiq::SPACES + Kiq::COMMAND_HASH[command][1]
+    end
+  end
+end

data/lib/kiq/helpers/version.rb

@@ -0,0 +1,4 @@
+# Current version of Kiq gem
+module Kiq
+  VERSION = "0.1.6"
+end

data/lib/kiq/project.rb

@@ -0,0 +1,100 @@
+module Kiq
+  module CLI
+    # Hosts logic for the backer object
+    class Project
+      @@instance_collector = []
+      # Allows access to name, amount, and backers
+      attr_accessor :name, :amount, :backers
+
+      # @param name [String]
+      # @param amount [String]
+      # @param backers [Hash]
+      # @instance_collector [Array]
+      # Initialize a project object with name and amount
+      def initialize(name, amount, backers={})
+        @name = name
+        @amount = amount
+        @backers = backers
+        @@instance_collector << self
+      end
+
+      # Sets up easy was to call all instances of an object
+      # @return instances
+      def self.all_offspring
+        @@instance_collector
+      end
+
+      # @param project [Array] the user input for project
+      # @param projects [Array] all instances of Project
+      # Calls all validation methods for a given project
+      # @return [Boolean]
+      def self.validate_project(project, projects)
+        name = project[1]
+        amount = project[2]
+
+        return self.check_input_length(project) && self.project_does_not_exist?(project, projects) && self.check_amount_dollar_sign(amount) && self.check_name_characters(name) && self.check_name_length(name)
+      end
+
+      # @param project [Array] the user input for project
+      # @param projects [Array] all instances of Project
+      # Checks if project already exists
+      # @return [Boolean] warning if false
+      def self.project_does_not_exist?(project, projects)
+        if projects[project[1]].nil?
+          return true
+        else
+          puts "ERROR: Project already exists."
+          return false
+        end
+      end
+
+      # @param amount [String]
+      # Checks if the amount includes dollar signs
+      # @return [Boolean] warning if false
+      def self.check_amount_dollar_sign(amount)
+        if !amount.include?('$')
+          return true
+        else
+          puts "ERROR: Project amount must not contain the '$' character or any other alphanumeric characters. Numbers only."
+          return false
+        end
+      end
+
+      # @param input [Array] full user input
+      # Checks if the array is the correct length for project input
+      # @return [Boolean] warning if false
+      def self.check_input_length(input)
+        if input.length == 3
+          return true
+        else
+          puts "ERROR: A project must have two arguments."
+          return false
+        end
+      end
+
+      # @param name [String]
+      # Checks if the name has non-alphanumeric characters besides underscores and dashes
+      # @return [Boolean] warning if false
+      def self.check_name_characters(name)
+        if name.scan(/[^\w-]/).empty?
+          return true
+        else
+          puts "ERROR: Project name may only use alphanumeric characters, underscores, and dashes."
+          return false
+        end
+      end
+
+      # @param name [String]
+      # Checks if the string is between 4 and 20 characters
+      # @return [Boolean] warning if false
+      def self.check_name_length(name)
+        if name.length >= 4 && name.length <= 20
+          return true
+        else
+          puts "ERROR: Project name must be between 4 and 20 characters."
+          return false
+        end
+      end
+    end
+  end
+end

data/lib/kiq/run.rb

@@ -0,0 +1,176 @@
+require 'yaml'
+require 'kiq/project'
+require 'kiq/backer'
+require 'kiq/helpers/constants'
+require 'kiq/helpers/display'
+
+module Kiq
+  FILE = File.expand_path('.kiq')
+  module CLI
+    # Runs the program when the user types 'kiq'
+    class Run
+      # Initialize the Run with a projects hash and load the file
+      def initialize
+        @projects = {}
+        load_file
+        load_projects
+      end
+
+      # Uses user input
+      # @return [String] help documentation or handles valid input
+      def perform
+        user_input      = ARGV
+        primary_command = user_input[0]
+        valid_commands  = ['project', 'list', 'back', 'backer']
+
+        case primary_command
+        when *valid_commands
+          handle(user_input)
+        when '-v'
+          puts Kiq::VERSION
+        when nil
+          Display.help
+        when '--help'
+          Display.help
+        else
+          puts "Unknown command: '#{user_input}'." unless user_input == '-h'
+          Display.help
+        end
+      end
+
+      # Handles valid input
+      # Runs relevant method for command
+      # Returns help if user input indicates help is needed
+      def handle(input)
+        if input[-1] == '--help'
+          return Display.command_help(input[0])
+        end
+
+        case input[0]
+        when "project"
+          add(input)
+        when "back"
+          back(input[0], input[1], input[2], input[3], input[4])
+        when "list"
+          list(input[1])
+        when "backer"
+          backer(input[1])
+        end
+      end
+
+      # @param project [Array]
+      # Returns successful message if project added
+      # Returns help if add is unsuccessful
+      def add(project)
+        type = project[0]
+        name = project[1]
+        amount = project[2]
+
+        if Project.validate_project(project, @projects)
+          @projects[name] = Project.new(name, amount)
+          save
+          puts "Added Project: #{name}!"
+        else
+          Display.command_help(type)
+        end
+      end
+
+      # @param type [String]
+      # @param backer_name [String]
+      # @param project_name [String]
+      # @param credit_card [String]
+      # @param amount [String]
+      # @return [String] successful message if user input is valid, help if back is unsuccessful
+      def back(type, backer_name, project_name, credit_card, amount)
+        project = @projects[project_name]
+        if Backer.validate_project_exists(project) && Backer.validate_card(project, credit_card) && Backer.validate_backer_name(backer_name) && Backer.check_amount_dollar_sign(amount)
+          backer = Backer.new(backer_name, credit_card, amount)
+          project.backers[credit_card] = backer
+          update_goal(project, amount)
+          save
+          puts "#{backer.name.capitalize} backed #{project_name} for $#{backer.amount}."
+        else
+          Display.command_help(type)
+        end
+      end
+
+      # @param project_name [String]
+      # If Project instance exists, lists all backers for a certain project
+      # @return [String] of backers, or error and help if project does not exist
+      def list(project_name)
+        if !Project.project_does_not_ exist?(['project', project_name], @projects)
+          project = Project.all_offspring.find { |p| p.name == project_name }
+          puts "Project Name: #{project.name}"
+          puts "Amount Remaining: $#{project.amount}"
+          check_goal(project)
+          puts "BACKERS:"
+          project.backers.each do |backer|
+            puts "Backer #{backer[1].name}, Amount: $#{backer[1].amount}"
+          end
+        else
+          puts "ERROR: Project does not exist.\n\n"
+          Display.help
+        end
+      end
+
+      # @param backer_name [String]
+      # Lists projects backed by a certain backer
+      # @return [String] of projects, or nothing if none exist
+      def backer(backer_name)
+        @projects.each do |project|
+          project[1].backers.each do |backer|
+            if backer[1].name == backer_name
+              puts "Backed #{project[1].name} for $#{backer[1].amount} dollars"
+            end
+          end
+        end
+      end
+
+      private
+
+      # Accessor for the project list file
+      # Returns the file path
+      def file
+        @file ||= File.exist?(FILE) ? FILE : '.kiq'
+      end
+
+      # Creates a new project file if none exists
+      # Returns nothing
+      def load_file
+        File.exist?(file) ? return : save
+      end
+
+      # Loads the yaml projects file and creates a projects hash
+      # Returns nothing
+      def load_projects
+        unless File.zero?(@file)
+          contents = YAML.load_file(@file)
+          contents.keys.each do |d|
+            @projects[d] = Project.new(contents[d].name, contents[d].amount, contents[d].backers)
+          end
+        end
+      end
+
+      # Saves the current list of projects to the yaml file (serialization)
+      # Returns nothing
+      def save
+        File.open(file, "w") {|f| f.write(@projects.to_yaml) }
+      end
+
+      # Updates project goal
+      # Returns check_goal if goal is met
+      def update_goal(project, amount)
+        project.amount = project.amount.to_f - amount.to_f
+        check_goal(project)
+      end
+
+      # Checks if project amount has met the goal
+      # @return [String] success message if goal met, else returns nothing
+      def check_goal(project)
+        if project.amount.to_i <= 0
+          puts "Reached goal!"
+        end
+      end
+    end
+  end
+end

data/spec/kiq.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe 'Kiq::CLI::Run' do
+end

data/spec/kiq/backer_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+RSpec.describe Kiq::CLI::Backer do
+  let(:backer) { Kiq::CLI::Backer }
+  context 'validate a project' do
+    describe '#self.validate_project_exists(project)' do
+      project =  Kiq::CLI::Project.new('Test', '300', {})
+      non_existant_project = nil
+      it 'returns true if a project exists' do
+        expect(backer.validate_project_exists(project)).to eq true
+      end
+      it 'returns false if a project does not exist' do
+        expect(backer.validate_project_exists(non_existant_project)).to eq false
+      end
+    end
+  end
+
+  context 'validate a card' do
+    describe 'self.check_card_uniqueness(project, credit_card)' do
+      project =  Kiq::CLI::Project.new('Test', '300', {})
+      project_backer = Kiq::CLI::Backer.new('Jane', '4000', '5555555555554444')
+      project.backers = {"5555555555554444"=> project_backer}
+      credit_card = "5555555555554444"
+
+      it 'returns false if the card is not new' do
+        expect(backer.check_card_uniqueness(project, credit_card)).to eq false
+      end
+    end
+
+    describe 'self.self.check_card_luhn_10(credit_card)' do
+      valid_cards = ['4111111111111111', '378282246310005', '371449635398431', '5610591081018250']
+      invalid_cards = ['1234567890123456', ]
+
+      it 'returns true if the card is valid' do
+        valid_cards.each do |card|
+          expect(backer.check_card_luhn_10(card)).to eq true
+        end
+      end
+
+      it 'returns false if the card is not valid' do
+        invalid_cards.each do |card|
+          expect(backer.check_card_luhn_10(card)).to eq false
+        end
+      end
+    end
+
+    describe 'self.check_card_length(credit_card)' do
+      valid_card = '123456789'
+      invalid_card = '123456789098765432123456'
+      it 'returns true if the card is under 19 characters' do
+        expect(backer.check_card_length(valid_card)).to eq true
+      end
+
+      it 'returns false if the card is not under 19 characters' do
+        expect(backer.check_card_length(invalid_card)).to eq false
+      end
+    end
+
+    describe 'self.check_card_numeric(credit_card)' do
+      valid_card = '123456789'
+      invalid_cards = ['123fds45678', '3948-3929-34', '_394_']
+      it 'returns true if the card is under 19 characters' do
+        expect(backer.check_card_numeric(valid_card)).to eq true
+      end
+
+      it 'returns false if the card is not under 19 characters' do
+        invalid_cards.each do |card|
+          expect(backer.check_card_numeric(card)).to eq false
+        end
+      end
+    end
+  end
+
+  context 'validate a backer name' do
+    describe 'self.check_name_characters(name)' do
+      good_name = 'good_name-'
+      bad_name = 'bad name'
+      it 'returns true if name has correct chacters' do
+        expect(backer.check_name_characters(good_name)).to eq true
+      end
+
+      it 'returns false if name does not have correct chacters' do
+        expect(backer.check_name_characters(bad_name)).to eq false
+      end
+    end
+
+    describe 'self.check_name_length(name)' do
+      long_name = 'abcdefghijklmnopqrstuvwxyz'
+      short_name = 'abc'
+      good_name = 'justright'
+
+      it 'returns true if name is between 4 and 20 characters long' do
+        expect(backer.check_name_length(good_name)).to eq true
+      end
+
+      it 'returns false if name is not between 4 and 20 characters long' do
+        expect(backer.check_name_length(short_name)).to eq false
+        expect(backer.check_name_length(long_name)).to eq false
+      end
+    end
+  end
+
+  context 'validate an amount' do
+    describe 'self.check_amount_dollar_sign(amount)' do
+      good_amount = '400'
+      bad_amount = '$400'
+      it 'returns true if amount has no dollar sign' do
+        expect(backer.check_amount_dollar_sign(good_amount)).to eq true
+      end
+
+      it 'returns false if amount has dollar sign' do
+        expect(backer.check_amount_dollar_sign(bad_amount)).to eq false
+      end
+    end
+  end
+end

data/spec/kiq/project_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+RSpec.describe Kiq::CLI::Project do
+
+  describe '#self.all_offspring' do
+    it 'returns all the instances of project class' do
+      Kiq::CLI::Project.new('Test', '300', {})
+      expect(Kiq::CLI::Project.all_offspring.length).to_not eq 0
+    end
+  end
+
+  context 'validating a project' do
+    describe 'self.project_does_not_exist?(project, projects)' do
+      Kiq::CLI::Project.new('Test', '300', {})
+      projects = {'Test' => Kiq::CLI::Project.all_offspring.first}
+      good_project = ['project', 'NotTest']
+      bad_project = ['project', 'Test']
+
+      it 'returns true if a project does not exist' do
+        expect(Kiq::CLI::Project.project_does_not_exist?(good_project, projects)).to eq true
+      end
+
+      it 'returns false if a project does not exist' do
+        expect(Kiq::CLI::Project.project_does_not_exist?(bad_project, projects)).to eq false
+      end
+    end
+
+    describe 'self.check_amount_dollar_sign(amount)' do
+      good_amount = '400'
+      bad_amount = '$400'
+      it 'returns true if amount has no dollar sign' do
+        expect(Kiq::CLI::Project.check_amount_dollar_sign(good_amount)).to eq true
+      end
+
+      it 'returns false if amount has dollar sign' do
+        expect(Kiq::CLI::Project.check_amount_dollar_sign(bad_amount)).to eq false
+      end
+    end
+
+    describe 'self.check_input_length(input)' do
+      short_input = ['Test', 'One']
+      long_input = ['Test', 'One', 'Two', 'Three']
+      good_input = ['Test', 'One', 'Two']
+
+      it 'returns true if correct number of args' do
+        expect(Kiq::CLI::Project.check_input_length(good_input)).to eq true
+      end
+
+      it 'returns false if incorrect number of args' do
+        expect(Kiq::CLI::Project.check_input_length(short_input)).to eq false
+        expect(Kiq::CLI::Project.check_input_length(long_input)).to eq false
+      end
+    end
+
+    describe 'self.check_name_characters(name)' do
+      good_name = 'good_name-'
+      bad_name = 'bad name'
+      it 'returns true if name has correct chacters' do
+        expect(Kiq::CLI::Project.check_name_characters(good_name)).to eq true
+      end
+
+      it 'returns false if name does not have correct chacters' do
+        expect(Kiq::CLI::Project.check_name_characters(bad_name)).to eq false
+      end
+    end
+
+    describe 'self.check_name_length(name)' do
+      long_name = 'abcdefghijklmnopqrstuvwxyz'
+      short_name = 'abc'
+      good_name = 'justright'
+
+      it 'returns true if name is between 4 and 20 characters long' do
+        expect(Kiq::CLI::Project.check_name_length(good_name)).to eq true
+      end
+
+      it 'returns false if name is not between 4 and 20 characters long' do
+        expect(Kiq::CLI::Project.check_name_length(short_name)).to eq false
+        expect(Kiq::CLI::Project.check_name_length(long_name)).to eq false
+      end
+    end
+  end
+end

data/spec/kiq/run_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe Kiq::CLI::Run do
+  it 'can initialize a run' do
+    expect( Kiq::CLI::Run.new).to_not eq nil
+  end
+
+  describe '#add(project)' do
+    project = ['project', 'RandomProject', '300']
+    Kiq::CLI::Run.new.add(project)
+    projects = { 'RandomProject' => Kiq::CLI::Project.all_offspring.first }
+
+    it 'adds a project' do
+      expect(Kiq::CLI::Project.project_does_not_exist?('RandomProject', projects)).to eq true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'kiq'
+
+require 'simplecov'
+SimpleCov.start
+
+RSpec.configure do |config|
+  original_stderr = $stderr
+  original_stdout = $stdout
+  config.before(:all) do
+    # Redirect stderr and stdout
+    $stderr = File.open(File::NULL, "w")
+    $stdout = File.open(File::NULL, "w")
+  end
+  config.after(:all) do
+    $stderr = original_stderr
+    $stdout = original_stdout
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: kiq
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Logan McDonald
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: Use this command line tool to back Kickstarter campaigns.
+email:
+- logan@logancodes.it
+executables:
+- kiq
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- bin/kiq
+- kiq.gemspec
+- lib/kiq.rb
+- lib/kiq/backer.rb
+- lib/kiq/helpers/constants.rb
+- lib/kiq/helpers/display.rb
+- lib/kiq/helpers/version.rb
+- lib/kiq/project.rb
+- lib/kiq/run.rb
+- spec/kiq.rb
+- spec/kiq/backer_spec.rb
+- spec/kiq/project_spec.rb
+- spec/kiq/run_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/loganmeetsworld/kiq
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Mini Kickstarter Command Line Interface
+test_files:
+- spec/kiq.rb
+- spec/kiq/backer_spec.rb
+- spec/kiq/project_spec.rb
+- spec/kiq/run_spec.rb
+- spec/spec_helper.rb