affirm-ruby-api 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0df8ada7075ef3babd97d1c61ab3995f4a0a3de3c4ac11d5829ed59d5881105
-  data.tar.gz: 8e1b68e21079f052125da6c5d668b06e8c616450181fb460990932fa60bab71a
+  metadata.gz: 76fe80cc1544c26c94e3bda13c840793345aff3bb26e59ab13c5d549a3fa45fa
+  data.tar.gz: 8510da3a8c4a55382d869486b976e2ea8a534a65052663427a00c6440d4473f2
 SHA512:
-  metadata.gz: dfa097ad10c557a8a32644d0364d7337a9db4e9713cc4acadc2b6354007f5db3d07b089f396f62442b95b28fd4b634bdcce7c14b1ff2b13e4a2832cf177b510a
-  data.tar.gz: 493edcb74fd37a736ec6ce4a9b4b1e392aa9191c6ca482735b8c64a94955613c0c9f810092b3dc0d0ae4756c535301450e4c5b48c031e3bca4b1555f46c45c2a
+  metadata.gz: 5cf6a35705ff3056ff2c1a17959be61c1052a50b2462183801ef09e1c35edb80617739b8ed717625e844e26eb4e105957f57e4dbea64eb425ba0a8ca572560a2
+  data.tar.gz: 7e2f0d5a70749accf09f4b38129515dfe48250f06e447739ab236c9de11e743c8d7db07e8433916d6fd0767dcc961782e34296dfb02dbace35ff027bd0a790d1

data/.gitbook.yaml

@@ -0,0 +1,5 @@
+root: ./docs/
+
+structure:
+  readme: README.md
+  summary: SUMMARY.md

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: peterberkenbosch

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,36 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+# Bug Report
+
+_Please help us help you by filling out any applicable information in this template and removing the rest!_
+
+## Describe the bug
+
+A clear and concise description of what the bug is.
+
+## To Reproduce
+
+Steps to reproduce the behavior
+
+## Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+## Screenshots or reproduction
+
+If applicable, add screenshots (errors, example of the behavior, etc.) to help explain your problem or post a link to a repository that replicates the issue.
+
+## Versions
+
+### Affirm
+
+- Gem: [e.g. 2.0.1]
+
+### External tools
+
+- Ruby: [e.g. 2.6.4]
+- Rails: [e.g. 6.0.0]
+- Integration platform (Solidus, Spree etc) [e.g. Solidus master]

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+---
+
+# Feature Request
+
+_Please help us help you by filling out any applicable information in this template and removing the rest!_
+
+## Is your feature request related to a problem?
+
+A clear and concise description of what the problem is. If this is a bug, please open a bug report instead of a feature request!
+
+## Describe the solution you'd like
+
+A clear and concise description of what you want to happen. Please also include alternative solutions or features you've considered.
+
+## Additional context
+
+Add any other context or screenshots about the feature request here.
+
+## PR link
+
+If you have opened a pull request to address the issue, please link it here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+# Type of PR (feature, enhancement, bug fix, etc.)
+
+## Description
+
+Please include a summary of the change and which issue is fixed.
+
+Fixes # (issue)
+
+## Why should this be added
+
+Explain value.
+
+## Checklist
+
+- [ ] My code follows the style guidelines of this project
+- [ ] Checks (StandardRB, RSpec) are passing

data/.github/workflows/changelog.yml

@@ -0,0 +1,37 @@
+name: Changelog
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 4
+    if: "!contains(github.event.head_commit.message, '[nodoc]')"
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: actions/cache@v1.1.2
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gem-
+    - name: Create local changes
+      run: |
+        gem install github_changelog_generator
+        github_changelog_generator -u peterberkenbosch -p affirm-ruby-api --token ${{ secrets.CHANGELOG_GITHUB_TOKEN }} --exclude-labels duplicate,question,invalid,wontfix,nodoc
+    - name: Commit files
+      run: |
+        git config --local user.email "github-actions@example.com"
+        git config --local user.name "GitHub Actions"
+        git commit -m "[nodoc] update changelog" -a
+    - name: Push changes
+      uses: ad-m/github-push-action@master
+      with:
+        github_token: ${{ secrets.CHANGELOG_GITHUB_TOKEN }}

data/.github/workflows/standardrb.yml

@@ -0,0 +1,33 @@
+name: StandardRB
+
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - master
+
+jobs:
+  standard:
+    name: StandardRB Check Action
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - name: Bundle install
+      run: |
+        gem install bundler
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+    - name: Run StandardRB
+      run: bundle exec standardrb --format progress

data/.github/workflows/test.yml

@@ -1,34 +1,33 @@
-name: Run Tests
+name: Tests
 
 on:
-  push:
-    branches: [ master ]
   pull_request:
-    branches: [ master ]
+    branches:
+      - '*'
+  push:
+    branches:
+      - master
 
 jobs:
-  build:
-
+  ruby_test:
+    name: Ruby Test Action
     runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@master
     - name: Set up Ruby 2.6
       uses: actions/setup-ruby@v1
       with:
         ruby-version: 2.6.x
-    - name: Build and test with Rake
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - name: Bundle install
       run: |
         gem install bundler
+        bundle config path vendor/bundle
         bundle install --jobs 4 --retry 3
-        bundle exec rake
-    - uses: devmasx/coverage-check-action@v1.1.0
-      with:
-        type: simplecov
-        result_path: coverage/.last_run.json
-        min_coverage: 100
-        token: ${{secrets.GITHUB_TOKEN}}
-    - name: StandardRB Linter
-      uses: andrewmcodes/standardrb-action@v0.0.2
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Run ruby tests
+      run: bundle exec rake

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/CHANGELOG.md

@@ -1,24 +1,44 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+## [Unreleased](https://github.com/peterberkenbosch/affirm-ruby-api/tree/HEAD)
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project
-adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+[Full Changelog](https://github.com/peterberkenbosch/affirm-ruby-api/compare/v1.0.2...HEAD)
 
-## [Unreleased]
+**Implemented enhancements:**
 
-## [1.0.2] - 2020-04-21
+- Use gitbook.io for official documentation [\#8](https://github.com/peterberkenbosch/affirm-ruby-api/pull/8) ([peterberkenbosch](https://github.com/peterberkenbosch))
 
-### Changed
-- Fix Gemfile.lock missing version bump
-- Support Ruby >= 2.5 (https://www.ruby-lang.org/en/news/2020/04/05/support-of-ruby-2-4-has-ended/)
+**Merged pull requests:**
 
-## [1.0.1] - 2020-04-13
+- Add provider to transaction [\#10](https://github.com/peterberkenbosch/affirm-ruby-api/pull/10) ([peterberkenbosch](https://github.com/peterberkenbosch))
+- Bump standard from 0.2.4 to 0.2.5 [\#7](https://github.com/peterberkenbosch/affirm-ruby-api/pull/7) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
 
-### Added
-- Introduce `TestingSupport::HttpResponses` for sharing the http and JSON fixtures
-so we can share these in environments that use this gem.
+## [v1.0.2](https://github.com/peterberkenbosch/affirm-ruby-api/tree/v1.0.2) (2020-04-21)
 
-## [1.0.0] - 2020-04-13
+[Full Changelog](https://github.com/peterberkenbosch/affirm-ruby-api/compare/v1.0.1...v1.0.2)
 
-Initial release.
+**Merged pull requests:**
+
+- Bump pry from 0.12.2 to 0.13.1 [\#6](https://github.com/peterberkenbosch/affirm-ruby-api/pull/6) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Bump rake from 12.3.3 to 13.0.1 [\#5](https://github.com/peterberkenbosch/affirm-ruby-api/pull/5) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Bump standard from 0.2.2 to 0.2.4 [\#4](https://github.com/peterberkenbosch/affirm-ruby-api/pull/4) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+
+## [v1.0.1](https://github.com/peterberkenbosch/affirm-ruby-api/tree/v1.0.1) (2020-04-13)
+
+[Full Changelog](https://github.com/peterberkenbosch/affirm-ruby-api/compare/v1.0.0...v1.0.1)
+
+**Merged pull requests:**
+
+- Add testing support for http and json stub [\#2](https://github.com/peterberkenbosch/affirm-ruby-api/pull/2) ([peterberkenbosch](https://github.com/peterberkenbosch))
+
+## [v1.0.0](https://github.com/peterberkenbosch/affirm-ruby-api/tree/v1.0.0) (2020-04-13)
+
+[Full Changelog](https://github.com/peterberkenbosch/affirm-ruby-api/compare/8d00e6ca963436d032e476614422cdd55790ef6a...v1.0.0)
+
+**Merged pull requests:**
+
+- add gem-release and config [\#1](https://github.com/peterberkenbosch/affirm-ruby-api/pull/1) ([peterberkenbosch](https://github.com/peterberkenbosch))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -1,12 +1,12 @@
 # Affirm Ruby API
 
-![Run Tests](https://github.com/peterberkenbosch/affirm-ruby-api/workflows/Run%20Tests/badge.svg)
-[![Gem Version](https://badge.fury.io/rb/affirm-ruby-api.svg)](https://badge.fury.io/rb/affirm-ruby-api)
-
 Clean, fast and pure Ruby implementation for the [Affirm API](https://docs.affirm.com/affirm-developers/reference)
 
-This is using the new Transaction API and is not compatible with the Charge API.
-Also see the [Affirm Changelog](https://docs.affirm.com/affirm-developers/changelog/transactions-api)
+This is using the new Transaction API and is not compatible with the Charge API. Also see the [Affirm Changelog](https://docs.affirm.com/affirm-developers/changelog/transactions-api)
+
+[![Gem Version](https://badge.fury.io/rb/affirm-ruby-api.svg)](https://badge.fury.io/rb/affirm-ruby-api)
+![Tests](https://github.com/peterberkenbosch/affirm-ruby-api/workflows/Tests/badge.svg)
+![StandardRB](https://github.com/peterberkenbosch/affirm-ruby-api/workflows/StandardRB/badge.svg)
 
 ## Installation
 
@@ -24,12 +24,9 @@ Or install it yourself as:
 
     $ gem install affirm-ruby-api
 
-## Usage
-
-
-## Sponsorship
+## Documentation
 
-If you use this extension and like to support this work, please consider [being a sponsor](https://github.com/sponsors/peterberkenbosch).
+* [Official documentation](https://peterberkenbosch.gitbook.io/affirm-ruby-api)
 
 ## Development
 

data/SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.0.x   | :white_check_mark: |
+| < 0.1   | :x:                |
+
+## Reporting a Vulnerability
+
+Please send an email to security@peterberkenbosch.nl with the vulnerability you have found so we can patch this library and send out a security advisory so people using this library have time to upgrade.
+
+Thanks!

data/docs/README.md

@@ -0,0 +1,33 @@
+---
+description: Affirm Ruby API for enabling Affirm Financing in your Ruby based projects.
+---
+
+# Welcome
+
+Clean, fast and pure Ruby implementation for the [Affirm API](https://docs.affirm.com/affirm-developers/reference)
+
+This is using the new Transaction API and is not compatible with the Charge API. Also see the [Affirm Changelog](https://docs.affirm.com/affirm-developers/changelog/transactions-api)
+
+[![Gem Version](https://badge.fury.io/rb/affirm-ruby-api.svg)](https://badge.fury.io/rb/affirm-ruby-api)
+![Tests](https://github.com/peterberkenbosch/affirm-ruby-api/workflows/Tests/badge.svg)
+![StandardRB](https://github.com/peterberkenbosch/affirm-ruby-api/workflows/StandardRB/badge.svg)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'affirm-ruby-api'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install affirm-ruby-api
+```

data/docs/SUMMARY.md

@@ -0,0 +1,3 @@
+# Table of contents
+
+* [Welcome](README.md)

data/lib/affirm/client.rb

@@ -82,7 +82,7 @@ module Affirm
     #
     # @param [String] transaction_id
     # @param [String] expand
-    # @return <Struct::Transaction::Event>
+    # @return <Struct::Transaction>
     #
     # @raise Affirm::RequestError
     def read_transaction(transaction_id, expand = nil)
@@ -168,7 +168,7 @@ module Affirm
       begin
         response = http.request(request)
       rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
-             Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+        Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
         raise RequestError, e.message
       end
 
@@ -187,7 +187,7 @@ module Affirm
         raise NotFoundError, response
       when 500, 502, 503, 504
         # 500, 502, 503, 504 - Server Errors
-        raise Error
+        raise Error, response
       end
     end
 

data/lib/affirm/structs/transaction.rb

@@ -12,6 +12,15 @@ module Affirm
       attr_accessor :order_id
       attr_accessor :provider_id
       attr_accessor :status
+
+      def provider
+        case provider_id
+        when 1
+          :affirm
+        when 2
+          :katapult
+        end
+      end
     end
   end
 end

data/lib/affirm/testing_support/http_responses.rb

@@ -1,3 +1,5 @@
+require_relative "../version"
+
 module Affirm
   module TestingSupport
     module HttpResponses

data/lib/affirm/version.rb

@@ -1,3 +1,3 @@
 module Affirm
-  VERSION = "1.0.2".freeze
+  VERSION = "1.0.3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: affirm-ruby-api
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Peter Berkenbosch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-21 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies: []
 description: Affirm Ruby API for enabling Affirm Financing in your Ruby based projects.
 email:
@@ -18,19 +18,28 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gem-release.yml"
+- ".gitbook.yaml"
+- ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/changelog.yml"
+- ".github/workflows/standardrb.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - affirm-ruby-api.gemspec
 - bin/console
 - bin/setup
+- docs/README.md
+- docs/SUMMARY.md
 - lib/affirm-ruby-api.rb
 - lib/affirm.rb
 - lib/affirm/client.rb

data/Gemfile.lock

@@ -1,83 +0,0 @@
-PATH
-  remote: .
-  specs:
-    affirm-ruby-api (1.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    coderay (1.1.2)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    gem-release (2.1.1)
-    hashdiff (1.0.1)
-    jaro_winkler (1.5.4)
-    method_source (1.0.0)
-    parallel (1.19.1)
-    parser (2.7.1.1)
-      ast (~> 2.4.0)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    public_suffix (4.0.3)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.80.1)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rexml
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
-    simplecov (0.18.5)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    standard (0.2.4)
-      rubocop (~> 0.80.1)
-      rubocop-performance (~> 1.5.2)
-    unicode-display_width (1.6.1)
-    webmock (3.8.3)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  affirm-ruby-api!
-  gem-release
-  pry
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  simplecov
-  standard
-  webmock (~> 3.8)
-
-BUNDLED WITH
-   2.1.4