basecomm_sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57612b710ed2938369cf6b2def054be9b99bbf6b
+  data.tar.gz: 4b2662337f31a3d61f5d705ef8539c2fc6d206b4
+SHA512:
+  metadata.gz: 7acdd36efda79ca4cacf833efce4c508efd4e5026e7c67bccf5db556fcebe2bd402ebe5e7e0e6814bd19d795baba37b02b2c114545235334b77e1f4452a166f2
+  data.tar.gz: a2152e94cbaa08a116d714dd099b31f7e0172a053e3e3b0d64501519258d0cf9593f550f528c2e33a85c00278a66401d1dcf26b26158dd87b6301a3af34dbeab

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format doc

data/.rubocop.yml

@@ -0,0 +1,94 @@
+Style/Documentation:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Metrics/MethodLength:
+  CountComments: false # count full line comments?
+  Max: 16
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+# MethodLength:
+#   CountComments: false
+#   Max: 30
+
+#AlignHash:
+#  EnforcedColonStyle: table
+#  EnforcedHashRocketStyle: table
+
+HashSyntax:
+  Enabled: true
+
+Lambda:
+  Description: 'Use the new lambda literal syntax for single-line blocks.'
+  Enabled: true
+
+LambdaCall:
+  Description: 'Use lambda.call(...) instead of lambda.(...).'
+  Enabled: true
+
+LineLength:
+  Max: 90
+
+AlignParameters:
+  Description: >
+                 Align the parameters of a method call if they span more
+                 than one line.
+  Enabled: false
+
+# Checks formatting of special comments
+CommentAnnotation:
+  Keywords:
+    - TODO
+    - FIXME
+    - OPTIMIZE
+    - HACK
+    - REVIEW
+
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - '**/*.gemspec'
+    - '**/*.podspec'
+    - '**/*.jbuilder'
+    - '**/*.rake'
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Capfile'
+    - '**/Guardfile'
+    - '**/Podfile'
+    - '**/Thorfile'
+    - '**/Vagrantfile'
+  Exclude:
+    - 'vendor/**/*'
+    - 'stubs/**/*'
+
+Lint/Eval:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 110
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 120
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/PredicateName:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false

data/CHANGELOG

@@ -0,0 +1,3 @@
+*0.0.1* (January 07, 2015)
+
+* Initial

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,26 @@
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+CLI = 'bundle exec rspec --format doc --color'
+
+def rspec_watchers
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/.+/base\.rb$})        { 'spec' }
+  watch(%r{^providers/(.+)\.rb$})     { |m| "spec/providers/#{m[1]}_spec.rb" }
+  watch(%r{^spec/support/(.+)\.rb$})  { 'spec' }
+  watch('spec/spec_helper.rb')        { 'spec' }
+end
+
+group :default do
+  # guard :rubocop, cli: ['-D'] do
+  #   watch(%r{.+\.rb$})
+  #   watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  # end
+
+  guard :rspec, cmd: CLI do
+    rspec_watchers
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chris Blackburn
+
+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,102 @@
+# Base Commerce SDK
+
+**Version: 0.0.1**
+
+A gem for interfacing with the [Base Commerce](http://www.basecommerce.com/) API. This gem was developed with their help and serves to provide a Gem wrapper around their own Ruby SDK. Please contact them for more information about the Ruby SDK.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'basecomm_sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install basecomm_sdk
+
+## Usage
+
+First, you will need to setup an account with [Base Commerce](http://www.basecommerce.com/). Use their sandbox for testing, and please read their documentation before you begin.
+
+Read the RSpec examples in the './spec' directory for detailed usage of this gem.
+
+### Basics
+
+Include the module.
+
+    require 'basecomm_sdk'
+
+### Insantiate the Client
+
+```ruby
+# Get your sandbox credentials from Base Commerce
+config = {
+  gateway_username: ENV['BASECOMM_UID'],
+  gateway_password: ENV['BASECOMM_PWD'],
+  key: ENV['BASECOMM_KEY'],
+  sandbox: true # For production set this to false or not at all
+}
+client = Client.new(config)
+```
+
+### Add Bank Account
+
+```ruby
+bank_account = BankAccount.new(...)
+returned_bank_account = client.add_bank_account(bank_account)
+```
+
+### Add Bank Card
+
+```ruby
+bank_card = BankCard.new(...)
+returned_bank_card = client.add_bank_card(bank_card)
+```
+
+### Get Bank Account Transaction
+
+```ruby
+bat = client.get_bank_account_transaction(id) # id of the transaction you want
+```
+
+### Get Bank Card Transaction
+
+```ruby
+bct = client.get_bank_card_transaction(id)
+```
+
+### Process Bank Account Transaction (ACH)
+
+```ruby
+bat = BankAccountTransaction.new(...)
+returned_bat = client.process_bank_account_transaction(bat)
+```
+
+### Process Bank Card Transaction
+
+```ruby
+bct = BankCardTransaction.new(...)
+returned_bct = client.process_bank_card_transaction(bct)
+```
+
+## Errata
+
+* We have not used or tested Push Notifications or Settlement Batch APIs.
+
+## Updates
+
+We plan to keep this code updated and in sync with any changes in the Base Commerce API. However, for the latest code see the Base Commerce Ruby SDK.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/basecomm_sdk/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,14 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'midwire_common/rake_tasks'
+rescue StandardError => e
+  puts ">>> Could not load 'midwire_common/rake_tasks': #{e}"
+  exit
+end
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/basecomm_sdk.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'basecomm_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'basecomm_sdk'
+  spec.version       = BasecommSdk::VERSION
+  spec.authors       = ['Chris Blackburn', 'Jason Cartwright']
+  spec.email         = ['chris@gosimplefin.com', 'jasonc@gosimplefin.com']
+  spec.summary       = 'Ruby client gem for Base Commerce ACH provider'
+  spec.description   = spec.summary
+  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.add_runtime_dependency 'dotenv', '~> 1.0'
+  spec.add_runtime_dependency 'json', '~> 1.8'
+  spec.add_runtime_dependency 'faraday', '~> 0.9'
+  spec.add_runtime_dependency 'excon', '~> 0.42'
+  spec.add_runtime_dependency 'midwire_common', '>= 0.1.12'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'factory_girl', '~> 4.5'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-bundler'
+  spec.add_development_dependency 'guard-rubocop'
+end

data/lib/basecomm_sdk/address.rb

@@ -0,0 +1,25 @@
+module BasecommSdk
+  class Address < Base
+    NAME = {
+      xs_address_name_home:     'HOME',
+      xs_address_name_work:     'WORK',
+      xs_address_name_mailing:  'MAILING',
+      xs_address_name_shipping: 'SHIPPING',
+      xs_address_name_billing:  'BILLING',
+      xs_address_name_dba:      'DBA',
+      xs_address_name_legal:    'LEGAL'
+    }
+
+    attr_accessor :name, :line1, :line2, :line3, :city, :state, :zipcode,
+      :country
+
+    def self.build_from_json(json)
+      Address.new(JSON.parse(json).recursively_symbolize_keys!)
+    end
+    singleton_class.send(:alias_method, :from_json, :build_from_json)
+
+    def json_prefix
+      :address
+    end
+  end
+end

data/lib/basecomm_sdk/bank_account.rb

@@ -0,0 +1,29 @@
+module BasecommSdk
+  class BankAccount < Base
+    TYPE = {
+      xs_ba_type_checking: 'CHECKING',
+      xs_ba_type_savings:  'SAVINGS'
+    }
+    ENTITY = {
+      xs_ba_entity_individual:   'INDIVIDUAL',
+      xs_ba_entity_organization: 'ORGANIZATION'
+    }
+    STATUS = {
+      xs_ba_status_active:  'ACTIVE',
+      xs_ba_status_deleted: 'DELETED',
+      xs_ba_status_failed:  'FAILED'
+    }
+
+    attr_accessor :name, :alias, :account_number, :routing_number, :token,
+      :status, :type
+
+    def self.build_from_json(json)
+      BankAccount.new(JSON.parse(json).recursively_symbolize_keys!)
+    end
+    singleton_class.send(:alias_method, :from_json, :build_from_json)
+
+    def json_prefix
+      :bank_account
+    end
+  end
+end

data/lib/basecomm_sdk/bank_account_transaction.rb

@@ -0,0 +1,48 @@
+module BasecommSdk
+  class BankAccountTransaction < Base
+    ACCOUNT_TYPE = {
+      xs_bat_account_type_checking: 'CHECKING',
+      xs_bat_account_type_savings:  'SAVINGS'
+    }
+    TYPE = {
+      xs_bat_type_credit:   'CREDIT',
+      xs_bat_type_debit:    'DEBIT',
+      xs_bat_type_reversal: 'REVERSAL',
+      xs_bat_type_cancel:   'CANCEL'
+    }
+    STATUS = {
+      xs_bat_status_created:   'CREATED',
+      xs_bat_status_initiated: 'INITIATED',
+      xs_bat_status_settled:   'SETTLED',
+      xs_bat_status_returned:  'RETURNED',
+      xs_bat_status_canceled:  'CANCELED',
+      xs_bat_status_failed:    'FAILED',
+      xs_bat_status_rejected:  'REJECTED'
+    }
+    METHOD = {
+      xs_bat_method_ccd: 'CCD',
+      xs_bat_method_ppd: 'PPD',
+      xs_bat_method_tel: 'TEL',
+      xs_bat_method_web: 'WEB'
+    }
+
+    attr_accessor :id, :type, :status, :method,
+      :account_type, :routing_number, :account_number, :account_name,
+      :return_code, :trace, :merchant_transaction_id, :bank_account_token,
+      :micr_data, :amount, :effective_date, :settlement_date, :return_date,
+      :recurring_indicator
+
+    attr_accessor :custom_field1, :custom_field2, :custom_field3,
+      :custom_field4, :custom_field5, :custom_field6, :custom_field7,
+      :custom_field8, :custom_field9, :custom_field10
+
+    def self.build_from_json(json)
+      BankAccountTransaction.new(JSON.parse(json).recursively_symbolize_keys!)
+    end
+    singleton_class.send(:alias_method, :from_json, :build_from_json)
+
+    def json_prefix
+      :bank_account_transaction
+    end
+  end
+end

data/lib/basecomm_sdk/bank_card.rb

@@ -0,0 +1,26 @@
+module BasecommSdk
+  class BankCard < Base
+    STATUS = {
+      xs_bc_status_active:  'ACTIVE',
+      xs_bc_status_deleted: 'DELETED',
+      xs_bc_status_failed:  'FAILED'
+    }
+
+    attr_accessor :name, :number, :alias, :expiration_month, :expiration_year,
+      :status, :billing_address, :token, :creation_date, :last_used_date
+
+    def self.build_from_json(json)
+      BankCard.new(JSON.parse(json).recursively_symbolize_keys!)
+    end
+    singleton_class.send(:alias_method, :from_json, :build_from_json)
+
+    def initialize(options = {})
+      super
+      @billing_address = Address.new
+    end
+
+    def json_prefix
+      :bank_card
+    end
+  end
+end

data/lib/basecomm_sdk/bank_card_transaction.rb

@@ -0,0 +1,52 @@
+module BasecommSdk
+  class BankCardTransaction < Base
+    TYPE = {
+      xs_bct_type_auth:     'AUTH',
+      xs_bct_type_sale:     'SALE',
+      xs_bct_type_void:     'VOID',
+      xs_bct_type_capture:  'CAPTURE',
+      xs_bct_type_refund:   'REFUND',
+      xs_bct_type_credit:   'CREDIT'
+    }
+
+    STATUS = {
+      xs_bct_status_created: 'CREATED',
+      xs_bct_status_authorized: 'AUTHORIZED',
+      xs_bct_status_captured: 'CAPTURED',
+      xs_bct_status_settled: 'SETTLED',
+      xs_bct_status_voided: 'VOIDED',
+      xs_bct_status_declined: 'DECLINED',
+      xs_bct_status_failed: 'FAILED',
+      xs_bct_status_3dsecure: '3DSECURE',
+      xs_bct_status_verified: 'VERIFIED'
+    }
+
+    attr_accessor :billing_address, :type, :card_number, :card_name,
+      :expiration_month, :expiration_year, :card_cvv2,
+      :card_track1_data, :card_track2_data, :ip_address, :po_number,
+      :authorization_code,
+      :response_code, :status, :response_message, :cvv_response_code,
+      :avs_response_code, :encrypted_track_data, :merchant_transaction_id,
+      :verify_complete_url, :verify_url, :amount, :tax_amount, :tip_amount,
+      :id, :settlement_batch_id, :check_secure_code, :recurring_indicator,
+      :token, :settlement_date, :creation_date
+
+    attr_accessor :custom_field1, :custom_field2, :custom_field3,
+      :custom_field4, :custom_field5, :custom_field6, :custom_field7,
+      :custom_field8, :custom_field9, :custom_field10
+
+    def self.build_from_json(json)
+      BankCardTransaction.new(JSON.parse(json).recursively_symbolize_keys!)
+    end
+    singleton_class.send(:alias_method, :from_json, :build_from_json)
+
+    def initialize(options = {})
+      super
+      @billing_address = Address.new
+    end
+
+    def json_prefix
+      :bank_card_transaction
+    end
+  end
+end

data/lib/basecomm_sdk/base.rb

@@ -0,0 +1,91 @@
+# rubocop:disable Style/TrivialAccessors
+module BasecommSdk
+  class Base
+    def self.attr_accessor(*vars)
+      @attributes ||= []
+      @attributes.concat(vars)
+      super(*vars)
+    end
+
+    def self.attributes
+      @attributes
+    end
+
+    # Accepts prefixed attribute keys as well as non-prefixed
+    def initialize(options = {})
+      @messages = []
+      instance_hash = options.fetch(json_prefix, options)
+      attributes.each do |atr|
+        instance_variable_set(
+          "@#{atr}",
+          instance_hash.fetch(
+            "#{json_prefix}_#{atr}".to_sym,
+            instance_hash.fetch(
+              "#{atr}".to_sym,
+              nil
+            )
+          )
+        )
+      end
+      # Populate messages with exceptions
+      if options[:exception]
+        options[:exception].each_pair do |k, v|
+          messages << {k => v}
+        end
+      end
+    end
+
+    def messages
+      @messages
+    end
+
+    def attributes
+      self.class.attributes
+    end
+
+    def qualified_attributes
+      array = []
+      attributes.each do |atr|
+        array << qualified_key(atr)
+      end
+      array
+    end
+
+    def to_json(_options = {})
+      hash = {}
+      instance_variables.each do |iv|
+        var_name = iv.to_s[1..-1]
+        next if var_name.match(/messages$/)
+        var = instance_variable_get(iv)
+        hash[qualified_key(var_name)] = format(var) unless var.nil?
+      end
+      hash.to_json
+    end
+
+    def self.json_prefix
+      new.json_prefix
+    end
+
+    def qualified_key(key)
+      "#{json_prefix}_#{key}".to_sym
+    end
+
+    def format(instance_var)
+      case instance_var.class.name
+      when 'Date', 'Time', 'DateTime'
+        instance_var.strftime('%m/%d/%Y %H:%M:%S')
+      else
+        instance_var
+      end
+    end
+
+    def status_name
+      status["#{qualified_key('status')}_name".to_sym]
+    end
+
+    def status_description
+      status["#{qualified_key('status')}_description".to_sym]
+    end
+  end
+end
+# rubocop:enable Style/TrivialAccessors