credit_card_processor 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjdmNTZmYmYzODhhMDZlYmIwZTg3NGIyMTZiN2NkZDI3NmQzM2VjYg==
+  data.tar.gz: !binary |-
+    ZTM4OWYyYTlkMmMxNzg5NmY3MTcxYTUwNmUwNTc4MDc2ZDUzNzNiYw==
+SHA512:
+  metadata.gz: !binary |-
+    OTE5MjQ2OWIzN2VhMzNkNTBlNDFiMjNjZjgwYTExOTMxNjY0MWNjZWRhNjYw
+    NTJiY2ViZTkyODhlYzBiNjZlZGMxM2IzOThhMjhhNGJkYmNhNzBiYTVmODcx
+    ZmZhOWUwNGIxMDY0OGJkM2YwYjg0OTY4ZmU0MjQ5N2Y0ZDA3MTU=
+  data.tar.gz: !binary |-
+    ZTg0ZTA5OTdkM2FkMGMzNjNjMTQyODIwYjkwMWI2ZThjY2Y5MmEwNDkyMzQy
+    MTBlYjYwNjM5ZWQwYmZhNjBhYTAyOTNiOGNlOTAxMzYyNDQyYTgyOGNlYzY5
+    MDIxM2RhMTZlMDg1OWFjMDI5MjkxM2IyMWVlZDU0YTY0YzgyY2Y=

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 credit_card_processor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 TODO: Write your name
+
+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,32 @@
+# CreditCardProcessor
+
+Program to add new credit card accounts, process charges and credits against them, and display summary information.
+
+## Usage
+In the credit_card_processor repository run:
+
+```
+bundle install
+```
+
+to get dependencies.
+
+Then run the executable from bin:
+
+```
+./bin/credit_card_processor -f path_to_myfile.txt
+```
+
+## Design Decisions
+
+This was written in ruby 1.9.3.  I decided to use sqlite with sequel in order to load the accounts into a database structure for processing.  This can be easily transitioned from a sqlite db to a real db if needed.  Although it's outside the scope of this assignment it would probably be useful to store all charges and credits in a ledger table, along with the transaction date and time.  This is money so it's good to have a paper trail.
+
+I'm using trollop as a command line parser here, which may be overkill considering there is only one option.  But it's easy to implement and includes a nice help screen.  
+
+The code first creates a table called accounts.  It then parses an input file and takes any "Add" lines and inserts them into the account table along with the credit limit (called credit_available) and a balance of $0.  It strips the dollar signs for integer processing and later math.  If the credit card number does not pass luhn validation, it is inserted as "error".  I used an existing gem for luhn validation rather than write one myself.  
+
+When it encounters a "Charge" line, it first checks that it does not exceed the credit available for that name.  If not, it increases the balance and decreases the credit available. A charge is not subject to credit available check, but when processed increases the credit available and decreases the balance.  Both charge and credit lines only processed if the name listed exists in the accounts table.
+
+After processing all lines, it outputs either "name: $balance" or "name: error" depending on whether or not the credit card number can be validated.  This does not prevent charge/credit processing; it just displays the error at the end.   
+ 
+Finally I didn't push this to rubygems because I wasn't sure Braintree wanted this code out in the wild.  Therefore it cannot be installed as a gem, although bundle install can be used to get dependencies.  

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/credit_card_processor.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'credit_card_processor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'credit_card_processor'
+  spec.version       = CreditCardProcessor::VERSION
+  spec.authors       = ['meggiebonner']
+  spec.email         = ['meggie.bonner@gmail.com']
+  spec.summary       = 'Gem for credit card processing.'
+
+  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.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_runtime_dependency 'sequel', '~> 4.1'
+  spec.add_runtime_dependency 'trollop'
+  spec.add_runtime_dependency 'sqlite3'
+  spec.add_runtime_dependency 'luhn-ruby'
+end

data/lib/credit_card_processor/version.rb

@@ -0,0 +1,3 @@
+module CreditCardProcessor
+  VERSION = '0.0.1'
+end

data/lib/credit_card_processor.rb

@@ -0,0 +1,101 @@
+require 'credit_card_processor/version'
+require 'trollop'
+require 'sequel'
+require 'luhn'
+
+DB = Sequel.sqlite
+
+module CreditCardProcessor
+  class CCProcessor
+    def initialize(argv = ARGV)
+      @parser = Trollop::Parser.new
+      Trollop.with_standard_exception_handling(@parser) do
+        define_options(argv)
+        @options = @parser.parse(argv.clone)
+      end
+    end
+
+    def define_options(_argv)
+      @parser.banner <<-EOS.gsub(/^ {8}/, '')
+        Processes credit card info from an input file
+        Options:
+      EOS
+      @parser.opt :file, 'Full path to input file', type: :string, short: 'f', required: true
+    end
+
+    def create_table
+      DB.create_table? :accounts do
+        primary_key :id
+        String :name
+        String :cc_number
+        Integer :credit_available
+        Integer :balance
+      end
+    end
+
+    def cc_valid?(cc_number)
+      Luhn.valid? cc_number
+    end
+
+    def add_account(name, cc_number, credit_available)
+      if cc_valid?(cc_number)
+        DB[:accounts].insert(name: name, cc_number: cc_number, credit_available: credit_available, balance: 0)
+      else
+        DB[:accounts].insert(name: name, cc_number: 'error', credit_available: credit_available, balance: 0)
+      end
+    end
+
+    def name_exists?(name)
+      DB[:accounts].where(name: name)
+    end
+
+    def charge(name, charge)
+      credit_available = DB[:accounts].select(:credit_available).where(name: name).first
+      if charge.to_i <= credit_available[:credit_available].to_i && name_exists?(name)
+        DB[:accounts].where(name: name).update(balance: Sequel.expr(:balance) + charge.to_i)
+        DB[:accounts].where(name: name).update(credit_available: Sequel.expr(:credit_available) - charge.to_i)
+      end
+    end
+
+    def credit(name, credit)
+      if name_exists?(name)
+        DB[:accounts].where(name: name).update(balance: Sequel.expr(:balance) - credit.to_i)
+        DB[:accounts].where(name: name).update(credit_available: Sequel.expr(:credit_available) + credit.to_i)
+      end
+    end
+
+    def parse(input_file)
+      File.open(input_file).each do |line|
+        line = line.split(' ')
+        function = line[0]
+        if function == 'Add'
+          add_account(line[1], line[2], line[3].split('$').last.to_i)
+        elsif function == 'Charge'
+          charge(line[1], line[2].split('$').last.to_i)
+        elsif function == 'Credit'
+          credit(line[1], line[2].split('$').last.to_i)
+        else
+          puts 'Function is not valid'
+        end
+      end
+    end
+
+    def output
+      output_hash = DB[:accounts].select(:name, :cc_number, :balance).all
+      output_hash.sort_by { |output_hash| output_hash[:name] }.each do |output_hash|
+        if output_hash[:cc_number] == 'error'
+          puts "#{output_hash[:name]}: error"
+        else
+          puts "#{output_hash[:name]}: $#{output_hash[:balance]}"
+        end
+      end
+    end
+
+    def main
+      input_file = @options[:file]
+      create_table
+      parse(input_file)
+      output
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: credit_card_processor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- meggiebonner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+  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: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: luhn-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- meggie.bonner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- credit_card_processor.gemspec
+- lib/credit_card_processor.rb
+- lib/credit_card_processor/version.rb
+homepage: 
+licenses: []
+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: Gem for credit card processing.
+test_files: []
+has_rdoc: