bambora-client 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8f50aad228da33d3dedb136373039a3a309f8b12a960f1085dced94cc54b65d
-  data.tar.gz: ec781f04b770e5847ac525386fc451e8bbf3d1c8656ba5481f06f172d21acd7d
+  metadata.gz: cfbb5f16d08f5d325effaf6e1f63c6b685f994d24205a8dccf7bcc53da3d2cbd
+  data.tar.gz: 8c29fc34d18356b8f0890a65976e0351ba2686d64181464729753087d85bd892
 SHA512:
-  metadata.gz: b256bf3dcdf58dea2b02a5c8b79b56c166070e591f267e21c16b16ee22afb2508aa5d3773abd000f2ff84c0a0f15196eda62ed139be8616d6d3ad686d4f28cd6
-  data.tar.gz: b0b6d9fa8808ba07c1a5d0daf4fcb6420157d554614e1a7f666940cff2d88050d64c1e4438abbd1dd27222daf88f43166ded3696bcabe3616b2a4a15eeb342ef
+  metadata.gz: 7fd38771757b08b4c5effbbf9c43b3dbdc894478b76f3c8f896d2e4b6152a28045eb32d9641218d33add77ba29d4be81c38bf381c64d088c33cd69c96c9f990b
+  data.tar.gz: cd04925aa02ec74f09ac4e50b13ba718b8a5ad1d746914b96c8a18d276985233e8ab791361927eeb4e9eeac9fe89ed9bb624b5a7ca0bfcced090392c072dfaef

data/.github/workflows/gempush.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags:
+      - v* # Only run when we carve a new tag
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
+
+

data/.github/workflows/linter.yml

@@ -7,7 +7,20 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+      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: ruby/setup-ruby@v1
+    - run: |
+        gem install bundler
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
     - name: Rubocop checks
-      uses: gimenete/rubocop-action@1.0
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: bundle exec rubocop

data/.github/workflows/ruby.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [ '2.4.x', '2.5.x', '2.6.x']
+        ruby: ['2.4', '2.5', '2.6']
     name: Ruby ${{ matrix.ruby }} Test
     steps:
       - uses: actions/checkout@master
@@ -22,7 +22,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-gem-
       - name: Setup ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
       - run: |

data/.gitignore

@@ -9,3 +9,7 @@
 
 # rspec failure tracking
 .rspec_status
+bambora-client-*.gem
+
+# Ruby-specific files
+Gemfile.lock

data/.rubocop.yml

@@ -40,9 +40,6 @@ Style/TrailingCommaInHashLiteral:
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: comma
 
-Layout/ParameterAlignment:
-  EnforcedStyle: with_fixed_indentation
-
 Layout/EmptyLineAfterMagicComment:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 0.4.0 (2021-05-31)
+
+- Add `Bambora::V1::PaymentResource#get` method
+
+## 0.3.0 (2020-05-27)
+
+- Add `Bambora::V1::ProfileResource#update` method
+
+## 0.2.0 (2020-05-11)
+
+- Add `Bambora::V1::ProfileResource#get` method
+
+## 0.1.3 (2020-04-30)
+
+- Ensure Batch Report returns empty array `:record` in response at the very least
+
+## 0.1.2 (2020-04-14)
+
+- Fix nil record with Bank Batch Report returns
+
 ## 0.1.1 (2020-03-04)
 
 - Upgrade `rake` to `13.0.1`

data/README.md

@@ -92,6 +92,31 @@ profiles.delete(customer_code: '02355E2e58Bf488EAB4EaFAD7083dB6A')
 #    }
 ```
 
+### Update a Profile
+
+```ruby
+profiles.update(
+  customer_code: '02355E2e58Bf488EAB4EaFAD7083dB6A',
+  payment_profile_data: {
+    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",
+#    }
+```
+
 ### Payments
 
 *Summary*: Process payments using Credit Card, Payment Profile, Legato Token, Cash, Cheque, Interac, Apple Pay, or

data/lib/bambora/bank/batch_report_resource.rb

@@ -53,17 +53,28 @@ module Bambora
       #
       #  @params profile_data [Hash] with values as noted in the example.
       def show(report_data)
-        add_messages_to_response(
-          client.post(path: sub_path, body: batch_report_body(report_data)),
-        )
+        response = client.post(path: sub_path, body: batch_report_body(report_data))
+
+        response = ensure_record_key_exists(response)
+        response = add_messages_to_response(response)
+
+        response
       end
 
       private
 
+      def ensure_record_key_exists(response)
+        # bambora can return null or empty record results, fill it in for consistency
+        response.dig(:response)[:record] = [] if response.dig(:response, :record).nil?
+
+        response
+      end
+
       def add_messages_to_response(response)
         response.dig(:response, :record).map! do |record|
           record.merge!(messages: record[:messageId].split(',').map { |id| MESSAGES[id] })
         end
+
         response
       end
 

data/lib/bambora/client/version.rb

@@ -2,6 +2,6 @@
 
 module Bambora
   class Client
-    VERSION = '0.1.1'
+    VERSION = '0.4.0'
   end
 end

data/lib/bambora/rest/client.rb

@@ -38,6 +38,10 @@ module Bambora
         end
       end
 
+      def put(path:, body:, headers:)
+        connection.put(path, body, headers)
+      end
+
       def connection
         @connection ||= Faraday.new(url: base_url) do |faraday|
           faraday.request :multipart

data/lib/bambora/rest/json_client.rb

@@ -99,6 +99,55 @@ module Bambora
         ).to_h
       end
 
+      # Make a PUT Request.
+      #
+      # @example
+      #
+      #   client = Bambora::Rest::JSONClient(base_url: '...', merchant_id: '...')
+      #
+      #   data = {
+      #     billing: {
+      #        name: "joh doe",
+      #        address_line1: "123 main st",
+      #        address_line2: "111",
+      #        city: "victoria",
+      #        province: "bc",
+      #        country: "ca",
+      #        postal_code: "V8T4M3",
+      #        phone_number: "25012312345",
+      #        email_address: "bill@smith.com"
+      #     },
+      #     card: {
+      #       name: 'Hup Podling',
+      #       number: '4030000010001234',
+      #       expiry_month: '12',
+      #       expiry_year: '23',
+      #       cvd: '123',
+      #     },
+      #   }
+      #
+      #   client.put(
+      #     path: 'v1/profiles',
+      #     body: data,
+      #     api_key: '...'
+      #   )
+      #   # => {
+      #   #      :code => 1,
+      #   #      :message => "Operation Successful",
+      #   #      :customer_code => "02355E2e58Bf488EAB4EaFAD7083dB6A",
+      #   #    }
+      #
+      # @param path [String] Indicating request path.
+      # @param body [Hash] Data to be sent in the body of the request.
+      # @param api_key [String] Indicating the API Key to be used with the request.
+      #
+      # @return [Hash] Indicating success or failure of the operation.
+      def put(path:, body:, api_key:)
+        parse_response_body(
+          super(path: path, body: body.to_json.to_s, headers: build_headers(api_key: api_key)),
+        ).to_h
+      end
+
       private
 
       def build_headers(api_key:)

data/lib/bambora/v1/payment_resource.rb

@@ -77,6 +77,22 @@ module Bambora
       end
 
       alias make_payment_with_payment_profile create_with_payment_profile
+
+      # Retrieve the details of a previously attempted payment.
+      #
+      #
+      # @example
+      #
+      #   client = Bambora::Rest::JSONClient(base_url: '...', api_key: '...', merchant_id: '...')
+      #   payments = Bambora::V1::PaymentResource(client: client)
+      #   payments.get(transaction_id: 1000341)
+      #
+      # @param transaction_id [Integer] An integer identifier for the associated transaction.
+      #
+      # @return [Hash] Transaction details.
+      def get(transaction_id:)
+        client.get(path: "#{sub_path}/#{transaction_id}", api_key: api_key)
+      end
     end
   end
 end

data/lib/bambora/v1/profile_resource.rb

@@ -54,8 +54,94 @@ module Bambora
       # @see https://dev.na.bambora.com/docs/guides/payment_profiles
       #
       # @return [Hash] Indicating success or failure of the operation.
-      def create(card_data)
-        client.post(path: sub_path, body: card_data, api_key: api_key)
+      def create(payment_profile_data)
+        client.post(path: sub_path, body: payment_profile_data, api_key: api_key)
+      end
+
+      ##
+      # Get a Bambora payment profile given a customer code.
+      #
+      # @example
+      #
+      #   client = Bambora::Rest::JSONClient(base_url: '...', api_key: '...', merchant_id: '...')
+      #   profiles = Bambora::V1::ProfileResource(client: client)
+      #   customer_code = '02355E2e58Bf488EAB4EaFAD7083dB6A'
+      #
+      #   profiles.get(customer_code: customer_code)
+      #   # => {
+      #   #      :code => 1,
+      #   #      :message => "Operation Successful",
+      #   #      :customer_code => "02355E2e58Bf488EAB4EaFAD7083dB6A",
+      #   #      :status => "A",
+      #   #      :last_transaction => "1900-01-01T00:00:00",
+      #   #      :modified_date => "1900-01-01T00:00:00",
+      #   #      :card => { :name => "", :number => "", :card_type => "" },
+      #   #      :language => "en",
+      #   #      :velocity_group => "",
+      #   #      :profile_group => "",
+      #   #      :account_ref => "",
+      #   #      :billing =>
+      #   #        {
+      #   #          :name => "Harry Lewis",
+      #   #          :address_line1 => "",
+      #   #          :address_line2 => "",
+      #   #          :city => "",
+      #   #          :province => "",
+      #   #          :country => "",
+      #   #          :postal_code => "",
+      #   #          :phone_number => "",
+      #   #          :email_address => ""},
+      #   #      :custom => { :ref1 => "", :ref2 => "", :ref3 => "", :ref4 => "", :ref5 => "" }}
+      #
+      # @param customer_code [String] A unique identifier for the associated payment profile.
+      #
+      # @return [Hash] Payment profile details.
+      def get(customer_code:)
+        client.get(path: "#{sub_path}/#{customer_code}", api_key: api_key)
+      end
+
+      # Make a PUT Request.
+      #
+      # @example
+      #
+      #   client = Bambora::Rest::JSONClient(base_url: '...', api_key: '...', merchant_id: '...')
+      #   profiles = Bambora::V1::ProfileResource(client: client)
+      #   customer_code = '02355E2e58Bf488EAB4EaFAD7083dB6A'
+      #
+      #   data = {
+      #     billing: {
+      #        name: "joh doe",
+      #        address_line1: "123 main st",
+      #        address_line2: "111",
+      #        city: "victoria",
+      #        province: "bc",
+      #        country: "ca",
+      #        postal_code: "V8T4M3",
+      #        phone_number: "25012312345",
+      #        email_address: "bill@smith.com"
+      #     },
+      #     card: {
+      #       name: 'Hup Podling',
+      #       number: '4030000010001234',
+      #       expiry_month: '12',
+      #       expiry_year: '23',
+      #       cvd: '123',
+      #     },
+      #   }
+      #
+      #   profiles.update(customer_code: customer_code, payment_profile_data: data)
+      #   # => {
+      #   #      :code => 1,
+      #   #      :message => "Operation Successful",
+      #   #      :customer_code => "02355E2e58Bf488EAB4EaFAD7083dB6A",
+      #   #    }
+      #
+      # @param customer_code [String] A unique identifier for the associated payment profile.
+      # @param data [Hash] Payment profile data to be sent in the body of the request.
+      #
+      # @return [Hash] Indicating success or failure of the operation.
+      def update(customer_code:, payment_profile_data:)
+        client.put(path: "#{@sub_path}/#{customer_code}", body: payment_profile_data, api_key: api_key)
       end
 
       ##

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bambora-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Cassidy K
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2021-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -187,6 +187,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gempush.yml"
 - ".github/workflows/linter.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
@@ -196,7 +197,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -250,8 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A thread-safe client for the Bambora/Beanstream API.

data/Gemfile.lock

@@ -1,93 +0,0 @@
-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 (13.0.1)
-    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 (~> 13.0)
-  rspec (~> 3.0)
-  rspec_junit_formatter (~> 0.4.1)
-  rubocop (~> 0.74.0)
-  webmock (~> 3.7)
-
-BUNDLED WITH
-   2.1.0