cardconnect 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0d6ec54a93e96b0853646453b4279a2f4940f944
-  data.tar.gz: 4fdb897d65793526a08198bffd4f7b0e1533dbb6
+SHA256:
+  metadata.gz: 392819d44d5b57e895e919ff4d8f09be8b2a03301100f944fd79b3b5cb321a52
+  data.tar.gz: 5d972cde73c7482d8de49279a68fc00429058244f1a6b960e823a130c1b437db
 SHA512:
-  metadata.gz: 7c9363231dcd9e016e566bf9bee06c6d58f08c9bf17c8e5b873a5ccb6e5192b42859bfb5517b75c565b220ba7f62a5442251eaf317fb042d5ac9d343bb103d4c
-  data.tar.gz: ecc1e1b60110560499449a41b3f615d1506ec0ce2bde957a719ac95cf7d7ebedd243eb3d9da2431e51c237399fea5c7eb2ad6febef6145f76bfd7c82555804c4
+  metadata.gz: 48c09c70ca14beffd6bc7e4d8b6999b4ad9b20bc4b04c9137908c514af52950f717e9cd02021187bd79831594a449b01ea734db7b2f37e67e124e4f9a76eb6b7
+  data.tar.gz: 0c5ce20dccadabad622ade2c9b46911672187b0734292e9470fffd4ae427138bc4561521d9bfb41656581307164c6b34057b6232a77dc62ac0299841d3b8fd0d

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## v2.4.0
+
+* Upgrades `faraday` and `faraday_middleware` dependency versions to use ones that works with ruby 3.0.
+
+## v2.3.0
+
+* Added the following fields to response objects (@shivashankar-ror):
+  - CaptureResponse: `:respproc, :resptext, :commcard, :respstat, :respcode, :batchid, :token`
+  - InquireResponse: `:capturedate, :batchid, :token, :authdate, :lastfour, :name, :currency, :settledate`
+  - ProfileGetResponse: `:gsacard, :auoptout`
+
+* Added support for Bin Service (@shivashankar-ror)
+
 ## v2.2.0
 
 * Add `token` field to Profile Service for create/update responses since this field can potentially be included in the response if a token hadn't already been created for that particular profile. (@mauriciozaffari)

data/README.md

@@ -4,7 +4,6 @@ CardConnect API Ruby Client
 
 [![Gem Version](https://badge.fury.io/rb/cardconnect.svg)](http://badge.fury.io/rb/cardconnect)
 [![Code Climate](https://codeclimate.com/github/mobilecause/cardconnect/badges/gpa.svg)](https://codeclimate.com/github/mobilecause/cardconnect)
-[![Build Status](https://travis-ci.org/mobilecause/cardconnect.svg?branch=master)](https://travis-ci.org/mobilecause/cardconnect)
 
 ## Installation
 
@@ -133,10 +132,39 @@ service.build_request(params)
 response = service.submit
 ```
 
+### Bin Service
+
+CardConnect documentation for this service can be found here: https://developer.cardconnect.com/cardconnect-api#bin-service
+
+Example:
+
+```ruby
+service = CardConnect::Service::Bin.new
+service.build_request(params)
+response = service.submit
+```
+
 ### Response Codes
 
 http://developer.cardconnect.com/cardconnect-api/#response-codes
 
+## Run-time logins
+Typically, you want to use `config/initializers/cardconnect.rb` to set your API username and password details in a secure way, as detailed above. If you need to connect to multiple CardConnect accounts, you can specify the username/password immediately before processing a transaction.
+
+Example:
+```
+config = CardConnect::Configuration.new
+config.api_username = "username"
+config.api_password = "password123"
+config.endpoint = "https://url.com"
+
+connection = CardConnect::Connection.new(config).connection
+service = CardConnect::Service::Authorize.new(connection)
+service.build_request(params)
+response = service.submit
+```
+Username, password, and/or endpoint can be defined either in the CardConnect initializer or overridden at runtime.
+
 ## To Do:
 
 #### Authorization Service
@@ -165,10 +193,6 @@ http://developer.cardconnect.com/cardconnect-api/#response-codes
 
 * Close Batch Service needs to be implemented
 
-#### Bin Service
-
-* Bin Service needs to be implemented
-
 ## Contributing
 
 1. Fork it ( https://github.com/mobilecause/cardconnect/fork )

data/cardconnect.gemspec

@@ -18,8 +18,5 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.0'
-
-  spec.add_dependency 'faraday', '~> 0.12.1'
-  spec.add_dependency 'faraday_middleware', '~> 0.11.0.1'
+  spec.add_dependency 'faraday', '~> 2.7.4'
 end

data/lib/cardconnect/connection.rb

@@ -1,5 +1,4 @@
 require 'faraday'
-require 'faraday_middleware'
 
 module CardConnect
   class Connection
@@ -7,9 +6,10 @@ module CardConnect
       @config = config
     end
 
-    def connection
+    def connection(config = nil)
+      config ||= @config
       @connection ||= Faraday.new(faraday_options) do |f|
-        f.request :basic_auth, @config.api_username, @config.api_password
+        f.request :authorization, :basic, config.api_username, config.api_password
         f.request :json
 
         f.response :json, content_type: /\bjson$/

data/lib/cardconnect/services/authorization/authorization_response.rb

@@ -3,7 +3,7 @@ module CardConnect
     class AuthorizationResponse
       include Utils
 
-      FIELDS = [:respstat, :retref, :account, :token, :amount, :merchid, :respcode,
+      FIELDS = [:respstat, :retref, :account, :expiry, :token, :amount, :merchid, :respcode,
                 :resptext, :respproc, :avsresp, :cvvresp, :authcode, :commcard, :profileid, :acctid].freeze
 
       attr_accessor(*FIELDS)
@@ -24,11 +24,7 @@ module CardConnect
       end
 
       def body
-        body = {}
-        FIELDS.each do |attr|
-          body.merge!(attr => send(attr))
-        end
-        body
+        FIELDS.collect{|attr| {attr => send(attr)} }.reduce({}, :merge)
       end
 
       private

data/lib/cardconnect/services/bin/bin.rb

@@ -0,0 +1,15 @@
+module CardConnect
+  module Service
+    class Bin < ServiceEndpoint
+      # Initializes a Bin Service
+      #
+      # @param connection [CardConnect::Connection]
+      # @return CardConnect::Service::Bin
+      def initialize(connection = CardConnect.connection)
+        super(connection)
+        @resource_name = '/bin'
+        @rest_method = 'get'
+      end
+    end
+  end
+end

data/lib/cardconnect/services/bin/bin_request.rb

@@ -0,0 +1,43 @@
+module CardConnect
+  module Service
+    class BinRequest
+      include Utils
+
+      REQUIRED_FIELDS = [:token, :merchid].freeze
+
+      FIELDS = REQUIRED_FIELDS
+
+      attr_accessor(*FIELDS)
+      attr_reader :errors
+
+      # Initializes a new BinGetRequest
+      #
+      # @param attrs [Hash]
+      # @return CardConnect::BinGetRequest
+      def initialize(attrs = {})
+        @errors = []
+        set_attributes(attrs, FIELDS)
+        validate_required_fields
+      end
+
+      # Indicates that the request is valid once it is built.
+      def valid?
+        errors.empty?
+      end
+
+      # Builds the request payload
+      def payload
+        "/#{merchid}/#{token}"
+      end
+
+      private
+
+      def validate_required_fields
+        REQUIRED_FIELDS.each do |field|
+          value = send(field)
+          value.nil? || value.empty? ? errors.push("#{field.capitalize} is missing") : next
+        end
+      end
+    end
+  end
+end

data/lib/cardconnect/services/bin/bin_response.rb

@@ -0,0 +1,36 @@
+module CardConnect
+  module Service
+    class BinResponse
+      include Utils
+
+      FIELDS = [
+        :country, :cardusestring, :gsa, :product,
+        :corporate, :fsa, :subtype, :purchase, :prepaid, :binlo,
+        :issuer, :binhi
+      ].freeze
+
+      # Error messages
+      BIN_INFO_NOT_FOUND = 'No bin information found'
+      TOKEN_NOT_FOUND    = 'Token not found'
+      BIN_NOT_ENABLED    = 'Bin feature not enabled for merchant'
+
+      attr_accessor(*FIELDS)
+      attr_reader :errors
+
+      def initialize(response)
+
+        set_attributes(response, FIELDS)
+       # raise [response, self].inspect
+        @errors = []
+      end
+
+      def success?
+        @errors.empty?
+      end
+
+      def body
+        FIELDS.collect{|attr| {attr => send(attr)} }.reduce({}, :merge)
+      end
+    end
+  end
+end

data/lib/cardconnect/services/capture/capture_request.rb

@@ -29,11 +29,7 @@ module CardConnect
 
       # Builds the request payload
       def payload
-        payload = {}
-        FIELDS.each do |field|
-          payload.merge!(field => send(field))
-        end
-        payload
+        FIELDS.collect{|field| {field => send(field)} }.reduce({}, :merge)
       end
 
       private

data/lib/cardconnect/services/capture/capture_response.rb

@@ -3,15 +3,17 @@ module CardConnect
     class CaptureResponse
       include Utils
 
-      FIELDS = [:merchid, :account, :amount, :retref, :setlstat].freeze
+      FIELDS = [:merchid, :account, :amount, :retref, :setlstat, :respproc,
+                :resptext, :commcard, :respstat, :respcode,
+                :batchid, :token].freeze
 
       # Settlement Statuses
       TXN_NOT_FOUND = 'Txn not found' # The Retref was not found
-      AUTHORIZED = 'Authorized' # Auth only, not captured
-      QUEUED = 'Queued for Capture' # Queued for the Processor
-      ZERO_AMOUNT = 'Zero Amount' # Capture (and Auth) were Voided
-      ACCEPTED = 'Accepted' # Accepted by the Processor
-      REJECTED = 'Rejected' # Rejected by the Processor
+      AUTHORIZED    = 'Authorized' # Auth only, not captured
+      QUEUED        = 'Queued for Capture' # Queued for the Processor
+      ZERO_AMOUNT   = 'Zero Amount' # Capture (and Auth) were Voided
+      ACCEPTED      = 'Accepted' # Accepted by the Processor
+      REJECTED      = 'Rejected' # Rejected by the Processor
 
       attr_accessor(*FIELDS)
 
@@ -20,11 +22,7 @@ module CardConnect
       end
 
       def body
-        body = {}
-        FIELDS.each do |attr|
-          body.merge!(attr => send(attr))
-        end
-        body
+        FIELDS.collect{|attr| {attr => send(attr)} }.reduce({}, :merge)
       end
     end
   end

data/lib/cardconnect/services/inquire/inquire_response.rb

@@ -3,17 +3,20 @@ module CardConnect
     class InquireResponse
       include Utils
 
-      FIELDS = [:merchid, :account, :amount, :currency, :retref, :respcode,
-                :respproc, :respstat, :resptext, :setlstat].freeze
-                
+      FIELDS = [
+        :merchid, :account, :amount, :currency, :retref, :respcode,
+        :respproc, :respstat, :resptext, :setlstat, :capturedate, :batchid,
+        :token, :authdate, :lastfour, :name, :settledate, :expiry
+      ].freeze
+
       # Settlement Status
-      AUTHORIZED = 'Authorized' # Txn has not been Captured
-      QUEUED = 'Queued for Capture' # Txn is in flight to Clearing House
-      ACCEPTED = 'Accepted' # Txn was accepted for Settlement
-      REJECTED = 'Rejected' # Txn was not accepted
+      AUTHORIZED  = 'Authorized' # Txn has not been Captured
+      QUEUED      = 'Queued for Capture' # Txn is in flight to Clearing House
+      ACCEPTED    = 'Accepted' # Txn was accepted for Settlement
+      REJECTED    = 'Rejected' # Txn was not accepted
       ZERO_AMOUNT = 'Zero Amount' # Txn was $0
-      VOIDED = 'Voided' # Txn has been voided
-      DECLINED = 'Declined' # Txn had an error
+      VOIDED      = 'Voided' # Txn has been voided
+      DECLINED    = 'Declined' # Txn had an error
 
       attr_accessor(*FIELDS)
       attr_reader :errors
@@ -28,11 +31,7 @@ module CardConnect
       end
 
       def body
-        body = {}
-        FIELDS.each do |attr|
-          body.merge!(attr => send(attr))
-        end
-        body
+        FIELDS.collect{|attr| {attr => send(attr)} }.reduce({}, :merge)
       end
     end
   end

data/lib/cardconnect/services/profile/profile.rb

@@ -5,7 +5,7 @@ module CardConnect
       #
       # @param connection [CardConnect::Connection]
       # @return CardConnect::Service::Profile
-      def initialize(rest_method = nil, connection = CardConnect.connection)
+      def initialize(rest_method, connection = CardConnect.connection)
         super(connection)
         @resource_name = '/profile'
         @rest_method = rest_method

data/lib/cardconnect/services/profile/profile_delete_response.rb

@@ -22,11 +22,7 @@ module CardConnect
       end
 
       def body
-        body = {}
-        FIELDS.each do |attr|
-          body.merge!({attr => send(attr)})
-        end
-        body
+        FIELDS.collect{|attr| {attr => send(attr)} }.reduce({}, :merge)
       end
 
       private

data/lib/cardconnect/services/profile/profile_get_response.rb

@@ -3,13 +3,15 @@ module CardConnect
     class ProfileGetResponse
       include Utils
 
-      FIELDS = [:profileid, :acctid, :respstat, :account, :respcode, :resptext, :respproc, :accttype, :expiry,
-                :name, :address, :city, :region, :country, :phone, :postal, :ssnl4, :email, :defaultacct, :license, :token]
+      FIELDS = [:gsacard, :profileid, :acctid, :respstat, :account,
+        :respcode, :resptext, :respproc, :accttype, :expiry,
+        :name, :address, :city, :region, :country, :phone, :postal,
+        :ssnl4, :email, :defaultacct, :license, :token, :auoptout]
 
       attr_accessor(*FIELDS)
       attr_reader :errors
 
-      STATUS_APPROVED = 'A'
+      STATUS_APPROVED  = 'A'
       STATUS_NOT_FOUND = 'C'
 
       def initialize(response)
@@ -23,11 +25,7 @@ module CardConnect
       end
 
       def body
-        body = {}
-        FIELDS.each do |attr|
-          body.merge!({attr => send(attr)})
-        end
-        body
+        FIELDS.collect{|attr| {attr => send(attr)} }.reduce({}, :merge)
       end
 
       private

data/lib/cardconnect/services/profile/profile_put_response.rb

@@ -25,11 +25,7 @@ module CardConnect
       end
 
       def body
-        body = {}
-        FIELDS.each do |attr|
-          body.merge!({attr => send(attr)})
-        end
-        body
+        FIELDS.collect{|attr| {attr => send(attr)} }.reduce({}, :merge)
       end
 
       private

data/lib/cardconnect/services/refund/refund_response.rb

@@ -23,11 +23,7 @@ module CardConnect
       end
 
       def body
-        body = {}
-        FIELDS.each do |attr|
-          body.merge!(attr => send(attr))
-        end
-        body
+        FIELDS.collect{|attr| {attr => send(attr)} }.reduce({}, :merge)
       end
 
       private

data/lib/cardconnect/services/settlement_status/settlement_status_response.rb

@@ -20,11 +20,7 @@ module CardConnect
       end
 
       def body
-        body = {}
-        FIELDS.each do |attr|
-          body.merge!(attr => send(attr))
-        end
-        body
+        FIELDS.collect{|attr| {attr => send(attr)} }.reduce({}, :merge)
       end
 
       private

data/lib/cardconnect/services/void/void_response.rb

@@ -24,11 +24,7 @@ module CardConnect
       end
 
       def body
-        body = {}
-        FIELDS.each do |attr|
-          body.merge!(attr => send(attr))
-        end
-        body
+        FIELDS.collect{|attr| {attr => send(attr)} }.reduce({}, :merge)
       end
 
       private

data/lib/cardconnect/utils.rb

@@ -4,18 +4,15 @@ module CardConnect
       return if attributes.empty?
       attributes = attributes[0] if attributes.is_a? Array
       attributes = symbolize_keys(attributes)
+
       fields.each do |attr|
-        next unless attributes[attr]
+        next if attributes[attr].nil?
         send("#{attr}=", attributes[attr])
       end
     end
 
     def symbolize_keys(hash)
-      symbolized_hash = {}
-      hash.each do |k, v|
-        symbolized_hash[k.to_sym] = v
-      end
-      symbolized_hash
+      hash.collect{|key, value| {key.to_sym => value} }.reduce({}, :merge)
     end
   end
 end

data/lib/cardconnect/version.rb

@@ -1,3 +1,3 @@
 module CardConnect
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.4.0'.freeze
 end

data/lib/cardconnect.rb

@@ -23,6 +23,8 @@ require 'cardconnect/services/profile/profile_get_request'
 require 'cardconnect/services/profile/profile_get_response'
 require 'cardconnect/services/profile/profile_delete_request'
 require 'cardconnect/services/profile/profile_delete_response'
+require 'cardconnect/services/bin/bin_request'
+require 'cardconnect/services/bin/bin_response'
 
 require 'cardconnect/services/service_endpoint'
 require 'cardconnect/services/authorization/authorization'
@@ -32,6 +34,8 @@ require 'cardconnect/services/inquire/inquire'
 require 'cardconnect/services/refund/refund'
 require 'cardconnect/services/void/void'
 require 'cardconnect/services/profile/profile'
+require 'cardconnect/services/bin/bin'
+
 
 module CardConnect
   class << self
@@ -47,4 +51,4 @@ module CardConnect
       @connection ||= Connection.new.connection
     end
   end
-end
+end

data/test/api_request_stubs.rb

@@ -113,3 +113,10 @@ def valid_profile_put_request
     "profileupdate" => "Y"
   }
 end
+
+def valid_bin_request
+  {
+    'token' => '9477709629051443',
+    'merchid' => '000000927996'
+  }
+end

data/test/api_response_stubs.rb

@@ -13,6 +13,7 @@ def valid_auth_response # rubocop:disable Metrics/MethodLength
     'authcode' => '046221',
     'respproc' => 'FNOR',
     'commcard' => 'N',
+    'expiry' => '04/32',
     'profileid' => '12345678',
     'acctid' => nil
   }
@@ -24,22 +25,36 @@ def valid_capture_response
     'setlstat' => 'Pending',
     'retref' => '288002073633',
     'merchid' => '000000927996',
-    'account' => '41XXXXXXXXXX4113'
+    'account' => '41XXXXXXXXXX4113',
+    'respproc' => 'FNOR',
+    'resptext' => 'Approval',
+    'respstat' => 'A',
+    'respcode' => '00',
+    'batchid' => '1900941569',
+    'token' => '9418594164541111',
+    'commcard' => ' C '
   }
 end
-
 def valid_inquire_response # rubocop:disable Metrics/MethodLength
   {
     'amount' => '596.00',
     'resptext' => 'Approval',
-    'setlstat' => 'NOTCAPTURED',
+    'setlstat' => 'Accepted',
     'respcode' => '00',
     'retref' => '288015190411',
     'merchid' => '000000927996',
-    'account' => '41XXXXXXXXXX4113',
+    'account' => '9418594164541111',
     'respproc' => 'FNOR',
     'respstat' => 'A',
-    'currency' => 'USD'
+    'currency' => 'USD',
+    'token' => '9418594164541111',
+    'expiry' => '04/32',
+    'authdate' => '20180410',
+    'lastfour' => '1111',
+    'name' => 'TOM JONES',
+    'capturedate' => '20180326065748',
+    'batchid' => '1900941569',
+    'settledate' => '20180327143721'
   }
 end
 
@@ -108,7 +123,9 @@ def valid_profile_get_response #rubocop:disable Metrics/MethodLength
     "city" => "ANYTOWN",
     "expiry" => "0214",
     "profileid" => "12345678901234567890",
-    "acctid" => "1"
+    "acctid" => "1",
+    "gsacard" => "N",
+    "auoptout" => "N"
   }
 end
 
@@ -150,3 +167,20 @@ def valid_profile_put_response #rubocop:disable Metrics/MethodLength
     "gsacard" => "N"
   }
 end
+
+def valid_bin_response
+  {
+    "country" => "USA",
+    "product" => "V",
+    "cardusestring" => "True credit",
+    "gsa" => false,
+    "corporate" => true,
+    "fsa" => false,
+    "subtype" => "Visa Corporate T&E",
+    "purchase" => false,
+    "prepaid" => false,
+    "binlo" => "478823XXX",
+    "issuer" => "JPMorgan Chase Bank N.A. - Commercial",
+    "binhi" => "478825XXX"
+  }
+end

data/test/cardconnect/configuration_test.rb

@@ -10,22 +10,22 @@ describe CardConnect::Configuration do
   end
 
   it 'must respond to merchant id' do
-    @config.must_respond_to :merchant_id
+    _(@config).must_respond_to :merchant_id
   end
 
   it 'must respond to api username' do
-    @config.must_respond_to :api_username
+    _(@config).must_respond_to :api_username
   end
 
   it 'must respond to api password' do
-    @config.must_respond_to :api_password
+    _(@config).must_respond_to :api_password
   end
 
   it 'must respond to endpoint' do
-    @config.must_respond_to :endpoint
+    _(@config).must_respond_to :endpoint
   end
 
   it 'must respond to connection_options' do
-    @config.must_respond_to :connection_options
+    _(@config).must_respond_to :connection_options
   end
 end