bambora-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60f0ed5088f0e4f5b63e9335431dffc7562d2239d237a08ac45cbc116f118fce
+  data.tar.gz: 59bd1a213dde32eb67be6802e5621cf527c64e9b50a835fe754ecb663588a8fd
+SHA512:
+  metadata.gz: 4bdbdf83b22c92b96bb6c04f71cfbfaaa2f5679e94cb2b00b431398cf09624f34e334201bcbe1e4efd2b4bd4bfb4a17c87058dfec438bff0c913075060a04411
+  data.tar.gz: 194b507146db394ceee4d59848a2126422224752d68f391fd8f866db5a9d0fc5785e4b22b2de4b94d9710d7bf0a58e0687d8e69053bb7819d1be7254ea1ca853

data/.github/workflows/linter.yml

@@ -0,0 +1,13 @@
+name: Linters
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Rubocop checks
+      uses: gimenete/rubocop-action@1.0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.4.x', '2.5.x', '2.6.x']
+    name: Ruby ${{ matrix.ruby }} Test
+    steps:
+      - uses: actions/checkout@master
+        with:
+          ref: ${{ github.ref }}
+      - name: Cache Gems
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gem-
+      - name: Setup ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Run Tests
+        run: |
+          bundle exec rake spec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,108 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/MissingCopEnableDirective:
+  Enabled: false
+
+Style/ParenthesesAroundCondition:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+  Severity: 'warning'
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 100
+
+Metrics/ModuleLength:
+  # These use file-spanning module blocks, making this cop useless
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/PerceivedComplexity:
+  Max: 50
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: true
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+  SupportedStyles:
+    - nested
+    - compact
+  Enabled: false
+
+Style/TernaryParentheses:
+  Enabled: true
+  EnforcedStyle: require_parentheses
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/*/**/*_spec.rb'
+
+Style/SingleLineBlockParams:
+  Description: 'Enforces the names of some block params.'
+  Enabled: false
+
+# Disabled since it catches strftime incorrectly
+# See https://github.com/bbatsov/rubocop/issues/5245
+Style/FormatStringToken:
+  Enabled: false
+
+# safe_load is too restrictive, since we need ERB
+Security/YAMLLoad:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.5.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hello@cassidy.codes. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bambora-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    bambora-client (0.1.0)
+      excon (< 1.0)
+      faraday (< 1.0)
+      gyoku (~> 1.0)
+      multiparty (~> 0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    builder (3.2.4)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    excon (0.71.0)
+    faraday (0.17.1)
+      multipart-post (>= 1.2, < 3)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    hashdiff (1.0.0)
+    jaro_winkler (1.5.3)
+    method_source (0.9.2)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    multipart-post (2.1.1)
+    multiparty (0.2.0)
+      mime-types
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    public_suffix (4.0.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    unicode-display_width (1.6.0)
+    webmock (3.7.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bambora-client!
+  bundler (~> 2)
+  pry (~> 0.12.0)
+  pry-byebug (~> 3.7)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.4.1)
+  rubocop (~> 0.74.0)
+  webmock (~> 3.7)
+
+BUNDLED WITH
+   2.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Cassidy K
+
+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,198 @@
+# Bambora
+
+![](https://github.com/HiMamaInc/bambora-client/workflows/Tests/badge.svg)
+
+The official Bambora Ruby library is not thread-safe. This means you will run into errors when using it with Sidekiq or
+Puma. This gem is a thread-safe client for the Bambora and Beanstream APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bambora-client'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install bambora-client
+```
+
+## Usage
+
+You can initilize the client by passing a hash to it, or by passing a block.
+
+All `*_api_key` arguments are optional. If you do not pass these API keys in on initialization, you can pass them into their respective method calls.
+
+```ruby
+client = Bambora::Client.new(
+  base_url: ENV.fetch('BAMBORA_BASE_URL'),
+  merchant_id: ENV.fetch('BAMBORA_MERCHANT_ID'),
+  sub_merchant_id: ENV.fetch('BAMBORA_SUB_MERCHANT_ID'),
+)
+```
+
+The `client` can now initialize new classes for making requests to `/profiles`, `/payments`, etc.
+
+```ruby
+profiles = client.profiles(api_key: ENV.fetch('BAMBORA_PROFILES_API_KEY'))
+profiles.delete(customer_code: '02355E2e58Bf488EAB4EaFAD7083dB6A')
+```
+
+### Profiles
+
+*Summary*: Payment profiles store confidential payment information. Transactions can be processed against profiles.
+*Bambora Docs*: <https://dev.na.bambora.com/docs/guides/payment_profiles/>
+
+```ruby
+client = Bambora::Client.new(...)
+profiles = client.profiles(api_key: ENV.fetch('BAMBORA_PROFILES_API_KEY'))
+```
+
+Once the resource instance has been instantiated, actions can be made against the API.
+
+#### Create a Profile
+
+```ruby
+profiles.create(
+  {
+    language: 'en',
+    comments: 'hello',
+    card: {
+      name: 'Hup Podling',
+      number: '4030000010001234',
+      expiry_month: '12',
+      expiry_year: '23',
+      cvd: '123',
+    },
+  },
+)
+# => {
+#      :code => 1,
+#      :message => "Operation Successful",
+#      :customer_code => "02355E2e58Bf488EAB4EaFAD7083dB6A",
+#    }
+```
+
+#### Delete a Profile
+
+```ruby
+profiles.delete(customer_code: '02355E2e58Bf488EAB4EaFAD7083dB6A')
+# => {
+#      :code => 1,
+#      :message => "Operation Successful",
+#      :customer_code => "02355E2e58Bf488EAB4EaFAD7083dB6A",
+#    }
+```
+
+### Payments
+
+*Summary*: Process payments using Credit Card, Payment Profile, Legato Token, Cash, Cheque, Interac, Apple Pay, or
+Android Pay.
+*Bambora Docs*: <https://dev.na.bambora.com/docs/references/payment_APIs/>
+
+```ruby
+client = Bambora::Client.new(...)
+payments = client.payments
+```
+
+#### Make A Payment
+
+This is a lower level method that can be used to make a payment using any method. Below are some more specific and
+high level convenience methods.
+
+`create` is aliased as `make_payment` if you prefer syntax that reads more like a sentence.
+
+```ruby
+payments.create(
+  {
+    amount: 50,
+    payment_method: 'card',
+    card: {
+      name: 'Hup Podling',
+      number: '4504481742333',
+      expiry_month: '12',
+      expiry_year: '20',
+      cvd: '123',
+    },
+  },
+)
+# => {
+#      :id => "10000000",
+#      :authorizing_merchant_id => 300000000,
+#      :approved => "1",
+#      :message_id => "1",
+#      :message => "Approved",
+#      :auth_code => "TEST",
+#      :created => "2019-10-28T07:12:11",
+#      :order_number => "10000000",
+#      :type => "P",
+#      :payment_method => "CC",
+#      :risk_score => 0.0,
+#      :amount => 50.0,
+#      :custom => { :ref1 => "", :ref2 => "", :ref3 => "", :ref4 => "", :ref5 => "" },
+#      :card =>
+#        {
+#          :card_type => "VI",
+#          :last_fouri => "2333",
+#          :address_match => 0,
+#          :postal_result => 0,
+#          :avs_result => "0",
+#          :cvd_result => "1",
+#          :avs => { :id => "U", :message => "Address information is unavailable.", :processed => false }
+#        },
+#      :links =>
+#        [
+#          { :rel => "void", :href => "https://api.na.bambora.com/v1/payments/10000000/void", :method => "POST" },
+#          { :rel => "return", :href => "https://api.na.bambora.com/v1/payments/10000000/returns", :method => "POST" }
+#        ]
+#    }
+```
+
+##### Make A Payment With A Payment Profile
+
+`create_with_payment_profile` is aliased as `make_payment_with_payment_profile` if you prefer syntax that reads more
+like a sentence.
+
+```ruby
+payments.create_with_payment_profile(customer_code: '02355E2e58Bf488EAB4EaFAD7083dB6A', amount: 50)
+# => {
+#      :id => "10000000",
+#      :authorizing_merchant_id => 300000000,
+#      :approved => "1",
+#      :message_id => "1",
+#      :message => "Approved",
+#      ...
+#    }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can
+also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/HiMamaInc/bambora-client>. This project is
+intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Bambora project’s codebases, issue trackers, chat rooms and mailing lists is expected to
+follow the [code of conduct](https://github.com/HiMamaInc/bambora/blob/master/CODE_OF_CONDUCT.md).