luhn_credit_card_verificator 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65f02a3c0768469eddeda17b7c85d752718967d998c321b0bbc1adf468f122d9
-  data.tar.gz: 1f07606e94aa6a3df7f507b3f4088e5f7a5f01fd10d972f9373d881ada870005
+  metadata.gz: b989811ccdd8fa467ad84f4d2f87e0b3e5323f784f396118fc093143a42134f1
+  data.tar.gz: 6e9493d322d24163e1f3b496b050db8b13137d00adaebda70a552f27e91d8170
 SHA512:
-  metadata.gz: e5ab50944da354b8cbc7628382b512067e7612f1c6decd91c4b9b5074b1d30e86acdd7ade1baa0a85cee5620a9911dee967ec5e445e24e9e2301f2ca4d4da41f
-  data.tar.gz: 0fff276ac5f3e3e497ec5abca440651aab2f5413545b1735fe76b717f38eedb83fad1022e63b7de436bea319ae937f110849d27a6a4b49e2be6af2419b31e3de
+  metadata.gz: 42cc8d2f7aab7ea92236f2bbaaf4b5b45c8c7ef285c47a80d7fede19b9991c3d2953bff2dc5fba3a8c5595855239a148834197baa36a7084f51d36d53da02ffe
+  data.tar.gz: 7fa7991e97c1331f26031f54ffed7e204132fa289feb77b052d01af4e8abf318dffae09d50bc6a9c14db975a0a2fe51b729d48ee840f94ddd904299a33e1ee54

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-06-02
-
+## [1.0.0] - 2022-06-02
 - Initial release
+
+## [1.0.1] - 2022-06-02
+- Change the home page url 
+
+## [2.0.0] - 2022-06-02
+- Fix major bug to verify card numbers
+- add functionalities to get more information about the credit card

data/README.md

@@ -16,8 +16,16 @@ If bundler is not being used to manage dependencies, install the gem by executin
     $ gem install luhn_credit_card_verificator
 
 ## Usage
-Very easy to use with the method : is_verif_card(numbers_of_credit_cards) : return a boolean
 
+#### 3 functions you can use : 
+
+----
+
+#### 1) Verify if the numbers of the credit card are ok
+```
+is_verif_card(credit_card_number)
+```
+Example : 
 ```
 require 'luhn_credit_card_verificator';
 
@@ -27,6 +35,40 @@ puts result
 
 >>  return true or false
 ```
+---
+
+#### 2) Get the issuing bank information (AMEX, VISA or MASTERCARD)
+```
+get_issuing_bank(credit_card_number)
+```
+Example : 
+```
+require 'luhn_credit_card_verificator';
+
+card_number_from_user = 4556737586899855
+result = LuhnCreditCardVerificator.get_issuing_bank(card_number_from_user);
+puts result
+
+>>  return VISA 
+```
+
+---
+
+#### 2) Get the both (If credit card number are ok and issuing bank)
+
+```
+get_all_credit_card_information(credit_card_number);
+```
+Example :
+```
+require 'luhn_credit_card_verificator';
+
+card_number_from_user = 4556737586899855
+result = LuhnCreditCardVerificator.get_all_credit_card_information(card_number_from_user);
+puts result
+
+>>  return {valid => true, "bank" => VISA} 
+```
 
 __If result is `True` so the card is OK.__
 
@@ -45,7 +87,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/luhn_credit_card_verificator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/luhn_credit_card_verificator/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/SarahBourgeois/luhn_credit_card_verificator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/luhn_credit_card_verificator/blob/master/CODE_OF_CONDUCT.md).
 
 ## Code of Conduct
 

data/lib/enum.rb

@@ -0,0 +1,12 @@
+module BANK_TYPE
+  VISA = "VISA"
+  MASTERCARD = "MASTERCARD"
+  AMEX = "AMERICAN EXPRESS"
+  UNKNOWN = "UNKNOWN"
+end
+
+module BANK_NUMBER
+  VISA_NUMBER = "4";
+  AMEX_NUMBER = %w[34 37];
+  MASTERCARD_NUMBER = [51, 52, 53, 54, 55];
+end

data/lib/helper.rb

@@ -1,4 +1,5 @@
 class Helper
+
   def self.format_input(card)
     clean_card = card.gsub(/\s+/, "").split("");
     return clean_card.reverse!;
@@ -17,6 +18,4 @@ class Helper
     return sum % 10 == 0;
   end
 
-
-
 end

data/lib/luhn_credit_card_verificator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LuhnCreditCardVerificator
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

data/lib/luhn_credit_card_verificator.rb

@@ -2,37 +2,81 @@
 
 require_relative "luhn_credit_card_verificator/version"
 require "Helper"
+require "enum"
 
 module LuhnCreditCardVerificator
 
   class Error < StandardError; end
 
-    # verify is credit card numbers are ok
-    def self.is_card_valid(card_number)
-      card_array_pair = Array.new;
-      card_array_impair = Array.new;
-      i =0;
-
-      begin
-        format_card = format_input(card_number.to_s);
-        format_card.each { |item|
-          number_to_push = double_number(item);
-          if i%2 == 0
-            card_array_pair.push(item.to_i);
-          end
-          if i%2 != 0
-            card_array_impair.push(number_to_push)
-          end
-          i = i +1
-        }
-
-        card_sum = card_array_pair.sum;
-        card_sum2 = card_array_impair.sum;
-
-        result = check_card_validity(card_sum, card_sum2);
-        return result;
-      rescue
-        return false;
-      end
+
+  # Verify if numbers of a credit card are valid
+  #
+  # Example:
+  #   >> is_card_valid(4556737586899855)
+  #   >> is_card_valid("4556 7375 8689 9855")
+  #   => true
+  #
+  # Arguments:
+  #   credit_card_number: (String) or (Integer)
+  def self.is_card_valid(card_number)
+    card_array_pair = Array.new;
+    card_array_impair = Array.new;
+    i =0;
+
+    begin
+      format_card = Helper::format_input(card_number.to_s);
+      format_card.each { |item|
+        number_to_push = Helper::double_number(item);
+        card_array_pair.push(item.to_i) if i%2 == 0;
+        card_array_impair.push(number_to_push) if i%2 != 0;
+        i = i +1
+      }
+      sum_pair = card_array_pair.sum
+      sum_impair = card_array_impair.sum
+      result = Helper::check_card_validity(sum_pair, sum_impair);
+      return result;
+    rescue
+      return false;
     end
   end
+
+  # Get the issuing bank of a credit card
+  #
+  # Example:
+  #   >> get_issuing_bank(4556737586899855)
+  #   >> get_issuing_bank("4556 7375 8689 9855")
+  #   => VISA
+  #
+  # Arguments:
+  #   credit_card_number: (String) or (Integer)
+  def self.get_issuing_bank(credit_card_number)
+    card = credit_card_number.to_s
+    return BANK_TYPE::AMEX if card[0..1] == BANK_NUMBER::AMEX_NUMBER[0] or card[0..1] == BANK_NUMBER::AMEX_NUMBER[1];
+    return BANK_TYPE::VISA if card[0] == BANK_NUMBER::VISA_NUMBER;
+    return BANK_TYPE::MASTERCARD if card[0..1].to_i.between?(BANK_NUMBER::MASTERCARD_NUMBER[0], BANK_NUMBER::MASTERCARD_NUMBER[4]);
+    return BANK_TYPE::UNKNOWN;
+  end
+
+
+  # Verify if credit card numbers are valid and the issuing bank at the same time
+  #
+  # Example:
+  #   >> get_all_credit_card_information(4556737586899855)
+  #   >> get_all_credit_card_information("4556 7375 8689 9855")
+  #   => {valid => true, "bank" => VISA}
+  #
+  # Arguments:
+  #   credit_card_number: (String) or (Integer)
+  def self.get_all_credit_card_information(credit_card_number)
+    begin
+      is_valid = is_card_valid(credit_card_number);
+      issuing_bank = get_issuing_bank(credit_card_number);
+      return {"valid" => is_valid, "bank" => issuing_bank}
+    rescue => error
+      return {"response" => "an error occurs during the verification of the credit card numbers #{error.message}"}
+    end
+
+  end
+end
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: luhn_credit_card_verificator
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - SarahBourgeois
@@ -30,6 +30,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/enum.rb
 - lib/helper.rb
 - lib/luhn_credit_card_verificator.rb
 - lib/luhn_credit_card_verificator/version.rb