justifi 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c34231d16ea73027351523d6309369021705f687926de6467fd4e81d1ff122f
+  data.tar.gz: 8c0009bd8453cf885113b081c3527ce6f074c08b0ba7086ba82348d89f8ce09e
+SHA512:
+  metadata.gz: ce6dc69cbc087eaa57536791686380791ba816ef7acebad501ad5f6133567dd37c1475ef0ada32d666282f1d556dae668950fd3806297392b95e42703d6d1c61
+  data.tar.gz: fff1e3c1f3d49da9dd15a248f43ee1f2330860a7ab0d492bdfd223f1ce80d77c1ea4088511bc577f7ca761c99aeaafd60377ee19bdcb9e97c71716cf2ca76d4c

data/.env.template

@@ -0,0 +1,2 @@
+CLIENT_ID=some_client
+CLIENT_SECRET=some_client_secret

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,48 @@
+<!--
+Describe the rationale and use case for this pull request.  Provide any
+background, examples, and images that provide further information to accurately
+describe what it is that you are adding to the repo.  Add subsections as
+necessary to organize and feel free to link and reference other PRs as
+necessary, but also include them in the links section below as a quick
+reference.
+
+**Guidelines:**
+
+* Keep Pull Request titles short and to the point, ideally under 72 characters
+* Provide as much context/info in the description as necessary to get the
+  reviewer up to the same domain knowledge level as yourself
+* Keep code changes as short as possible and implementing a single
+  feature/fix/refactoring, when possible
+-->
+
+Type of Change
+--------------
+
+* [ ] Bug fix (non-breaking change which fixes an issue)
+* [ ] New feature (non-breaking change which adds functionality)
+* [ ] Breaking change (would cause existing functionality to not work as expected)
+* [ ] This change requires a documentation update
+* [ ] This change is in scope for PCI
+* [ ] This requires approval from UX
+* [ ] This requires approval from Marketing
+
+
+Links
+-----
+
+<!--
+**Examples** 
+
+* http://documentation.for/library/that/I/am/adding
+* [relevant issue or pull_request](#123)
+-->
+
+
+Steps for Testing/QA
+--------------------
+
+<!--
+If there are any manual steps that you would like the reviewer(s) to take to
+verify your changes, please describe in detail the steps to reproduce the
+features added by the pull request, or the bug before and after the change.
+-->

data/.github/workflows/build_and_release.yml

@@ -0,0 +1,92 @@
+name: 📦 Build and Release
+
+on:
+  push:
+    paths:
+      - lib/justifi/version.rb
+  workflow_dispatch:
+
+jobs:
+  run_tests:
+    name: 📋 Verify
+    uses: justifi-tech/justifi-ruby/.github/workflows/verify.yml@main
+    if: github.ref == 'refs/heads/main'
+    secrets:
+      CLIENT_STAGING_ID: ${{secrets.CLIENT_STAGING_ID }}
+      CLIENT_SECRET_STAGING: ${{secrets.CLIENT_SECRET_STAGING }}
+      API_STAGING_BASE_URL: ${{secrets.API_STAGING_BASE_URL}}
+      ENVIRONMENT: ${{secrets.ENVIRONMENT}}
+
+  build_and_release:
+    strategy:
+      matrix:
+        include:
+          - api_key: JUSTIFI_MACHINA_RUBYGEMS_API_KEY
+            bearer: false
+            gem_host: https://rubygems.org
+            pkg_host_name: rubygems.org
+          - api_key: JUSTIFI_MACHINA_GITHUB_TOKEN
+            bearer: true
+            gem_host: https://rubygems.pkg.github.com/${{ github.repository_owner }}
+            pkg_host_name: pkg.github.com
+
+    name: 📦 Package and Release on ${{ matrix.pkg_host_name }}
+    needs: run_tests
+    if: github.ref == 'refs/heads/main'
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Build API_KEY value
+        id: api_key
+        run: |
+          echo "::set-output name=value::${{ matrix.bearer && 'Bearer ' || '' }}${{ secrets[matrix.api_key] }}"
+
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Ruby and install gems
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 2.6
+          rubygems: 3.2.32 # Required for GEM_HOST_API_KEY to work (delete if we use Ruby 3)
+
+      # The `computed` value here is to solve for `-pre` style tags.
+      # `raw_value` is what comes directly from the VERSION value, and
+      # `computed` is what `Gem::Version` will output
+      - name: Fetch Gem Version
+        id: gem_version
+        run: |
+          ruby -r ./lib/justifi/version.rb -e '
+            puts "::set-output name=raw_value::#{Justifi::VERSION}"
+            puts "::set-output name=computed::#{Gem::Version.new(Justifi::VERSION)}"
+          '
+
+      # Combination of bundler's release steps and the steps here:
+      #
+      #   https://github.com/rickstaa/action-create-tag/blob/main/entrypoint.sh
+      #
+      - name: Tag Release
+        id: git_tag
+        if: matrix.gem_host == 'https://rubygems.org' # only do this step 1 time
+        env:
+          TAG: v${{ steps.gem_version.outputs.raw_value }}
+          VERSION: ${{ steps.gem_version.outputs.raw_value }}
+        run: |
+          git config user.name "JustiFi Machina"
+          git config user.email "justifi.machina@justifi.ai"
+          git tag -a "${TAG}" -m "Version ${VERSION}" "${GITHUB_SHA}"
+          git remote set-url origin "https://justifi-machina:${{ secrets.JUSTIFI_MACHINA_GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git"
+          git push origin refs/tags/${TAG}
+
+      - name: Build gem
+        run: gem build justifi.gemspec
+
+      - name: Publish gem to GitHub packages
+        env:
+          GEM_HOST_API_KEY: ${{ steps.api_key.outputs.value }}
+          RUBYGEMS_HOST: ${{ matrix.gem_host }}
+          VERSION: ${{ steps.gem_version.outputs.computed }}
+        run: |
+          gem push --host ${RUBYGEMS_HOST} justifi-${VERSION}.gem

data/.github/workflows/publish_coverage.yml

@@ -0,0 +1,46 @@
+name: Generate Coverage
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  generate_coverage:
+    name: Generate Coverage
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby and install gems
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 2.6
+
+      - name: Run tests
+        env:
+          CLIENT_ID: ${{secrets.CLIENT_STAGING_ID }}
+          CLIENT_SECRET: ${{secrets.CLIENT_SECRET_STAGING }}
+          API_STAGING_BASE_URL: ${{secrets.API_STAGING_BASE_URL}}
+          ENVIRONMENT: ${{secrets.ENVIRONMENT}}
+        run: bundle exec rspec
+
+      - name: Deploy coverage to S3
+        uses: zdurham/s3-upload-github-action@master
+        with:
+          args: --acl public-read
+        env:
+          FILE: "coverage/coverage_badge_total.svg"
+          S3_BUCKET: ${{ secrets.AWS_STAGING_BUCKET_NAME }}
+          S3_KEY: "coverage_badge_total.svg"
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID_STAGING }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY_STAGING }}
+          AWS_REGION: "us-east-1"
+
+      - name: Change coverage_badge_total.svg Cache-Control
+        run: |
+          aws configure set aws_access_key_id ${{ secrets.AWS_ACCESS_KEY_ID_STAGING }}
+          aws configure set aws_secret_access_key ${{ secrets.AWS_SECRET_ACCESS_KEY_STAGING }}
+          aws configure set default.region "us-east-1"
+          aws s3 cp s3://${{ secrets.AWS_STAGING_BUCKET_NAME }}/coverage_badge_total.svg s3://${{ secrets.AWS_STAGING_BUCKET_NAME }}/coverage_badge_total.svg --metadata-directive REPLACE --cache-control "max-age=0" --acl public-read --content-type "image/svg+xml"

data/.github/workflows/verify.yml

@@ -0,0 +1,51 @@
+name: verify
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    branches:
+    - main
+  workflow_call:
+    secrets:
+      CLIENT_STAGING_ID:     {required: true}
+      CLIENT_SECRET_STAGING: {required: true}
+      API_STAGING_BASE_URL:  {required: true}
+      ENVIRONMENT:           {required: true}
+
+jobs:
+  linters:
+    name: Linters
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup Ruby and install gems
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 2.6
+      - name: Run linters
+        run: |
+           bundle exec rubocop
+
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby and install gems
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 2.6
+
+      - name: Run tests
+        env:
+          CLIENT_ID: ${{secrets.CLIENT_STAGING_ID }}
+          CLIENT_SECRET: ${{secrets.CLIENT_SECRET_STAGING }}
+          API_STAGING_BASE_URL: ${{secrets.API_STAGING_BASE_URL}}
+          ENVIRONMENT: ${{secrets.ENVIRONMENT}}
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+examples/
+
+# rspec failure tracking
+.rspec_status
+.env
+.byebug_history
+.DS_STORE

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,12 @@
+require: standard
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+    - "bin/*"
+    - "db/schema.rb"
+    - "tmp/**/*"
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at jmatheus.vaz@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    justifi (0.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    dotenv (2.7.6)
+    hashdiff (1.0.1)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.3.0)
+    repo-small-badge (0.2.7)
+      victor (~> 0.2.8)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.27.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-small-badge (0.2.4)
+      repo-small-badge (~> 0.2.7)
+      simplecov (~> 0.17)
+    simplecov_json_formatter (0.1.4)
+    standard (1.10.0)
+      rubocop (= 1.27.0)
+      rubocop-performance (= 1.13.3)
+    unicode-display_width (2.1.0)
+    victor (0.2.8)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  dotenv
+  justifi!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+  simplecov
+  simplecov-small-badge
+  standard
+  webmock (>= 3.8.0)
+
+BUNDLED WITH
+   2.2.3

data/README.md

@@ -0,0 +1,227 @@
+# JustiFi Ruby ![Coverage](https://justifi-gem-assets.s3.us-east-2.amazonaws.com/coverage_badge_total.svg)
+
+The JustiFi gem provides a simple way to access JustiFi API for apps written in Ruby language. 
+It includes a pre-defined set of modules and classes that are essentially wrapped versions of our API resources.
+
+## Installation
+
+From the command line:
+```bash
+gem install justifi --version "0.4.0" --source "https://rubygems.pkg.github.com/justifi-tech"
+```
+OR
+
+Add these lines to your application's Gemfile:
+
+```ruby
+source "https://rubygems.pkg.github.com/justifi-tech" do
+  gem "justifi", "0.4.0"
+end
+```
+And then execute:
+
+    $ bundle install
+
+
+## Setup
+
+The gem needs to be configured with your `client_id` and `client_secret` in order to access JustiFi API resources.
+
+Set `Justifi.client_id` and `Justifi.client_secret`:
+
+```ruby
+require 'justifi'
+
+Justifi.client_id = 'live_13...'
+Justifi.client_secret = 'live_TDYj_wdd...'
+```
+
+OR just use the `Justifi.setup` method to set all at once:
+
+
+```ruby
+require 'justifi'
+
+# setup
+Justifi.setup(client_id:     ENV["JUSTIFI_CLIENT_ID"],
+              client_secret: ENV["JUSTIFI_CLIENT_SECRET"])
+```
+
+
+## Create Payment
+
+There are two ways to create a payment:
+
+1. Create with tokenized payment method:
+
+```ruby
+payment_params = {
+  amount: 1000,
+  currency: "usd",
+  capture_strategy: "automatic",
+  email: "example@example.com",
+  description: "Charging $10 on Example.com",
+  payment_method: {
+    token: "#{tokenized_payment_method_id}"
+  }
+}
+
+Justifi::Payment.create(params: payment_params)
+```
+
+2. Create with full payment params:
+
+```ruby
+payment_params = {
+  amount: 1000,
+  currency: "usd",
+  capture_strategy: "automatic",
+  email: "example@example.com",
+  description: "Charging $10 on Example.com",
+  payment_method: {
+    card: {
+      name: "JustiFi Tester",
+      number: "4242424242424242",
+      verification: "123",
+      month: "3",
+      year: "2040",
+      address_postal_code: "55555"
+    }
+  }
+}
+
+Justifi::Payment.create(params: payment_params)
+```
+
+## Idempotency Key
+
+You can use your own idempotency-key when creating payments.
+
+```ruby
+payment_params = {
+  amount: 1000,
+  currency: "usd",
+  capture_strategy: "automatic",
+  email: "example@example.com",
+  description: "Charging $10 on Example.com",
+  payment_method: {
+    card: {
+      name: "JustiFi Tester",
+      number: "4242424242424242",
+      verification: "123",
+      month: "3",
+      year: "2040",
+      address_postal_code: "55555"
+    }
+  }
+}
+
+Justifi::Payment.create(params: payment_params, idempotency_key: "my_idempotency_key")
+```
+
+IMPORTANT: The gem will generate an idempotency key in case you don't want to use your own.
+
+## Create Payment Refund
+
+In order to create a refund, you will need an amount, a payment_id ( `py_2aBBouk...` ).
+
+```ruby
+payment_params = {
+  amount: 1000,
+  currency: "usd",
+  capture_strategy: "automatic",
+  email: "example@example.com",
+  description: "Charging $10 on Example.com",
+  payment_method: {
+    card: {
+      name: "JustiFi Tester",
+      number: "4242424242424242",
+      verification: "123",
+      month: "3",
+      year: "2040",
+      address_postal_code: "55555"
+    }
+  }
+}
+
+payment_id = Justifi::Payment.create(params: payment_params).data[:id] # get the payment id
+reason     = ['duplicate', 'fraudulent', 'customer_request'] # optional: one of these
+amount     = 1000
+
+Justifi::Payment.create_refund( amount: 1000, reason: reason, payment_id: payment_id )
+```
+
+## Listing Resources
+
+All top-level API resources have support for bulk fetches via `array` API methods.
+JustiFi uses cursor based pagination which supports `limit`, `before_cursor` and `after_cursor`.
+Each response will have a `page_info` object that contains the `has_next` and `has_previous` fields,
+you can find more information about this on [JustiFi's Developer Portal](https://developer.justifi.ai/#section/Pagination).
+
+### List Payments
+
+```ruby
+payments = Justifi::Payment.list
+
+# pagination with end_cursor
+
+query_params = {
+  limit: 15,
+  after_cursor: payments.data[:page_info][:end_cursor],
+}
+
+payments = Justifi::Payment.list(params: query_params)
+```
+
+
+### List Refunds
+
+```ruby
+refunds = Justifi::Refund.list
+
+# pagination
+refunds = refunds.next_page
+refunds = refunds.previous_page
+```
+
+
+## Get resource by id
+
+```ruby
+payment = Justifi::Payment.get(payment_id: 'py_xyz')
+refund = Justifi::Refund.get(refund_id: 're_xyz')
+```
+
+## Seller Account
+
+You can make requests using the `Seller-Account` header in order to process resources as a seller-account.
+
+```ruby
+seller_account_id = "acc_xyzs"
+Justifi::PaymentIntent.create(params: payment_intent_params, seller_account_id: seller_account_id)
+```
+
+Any API resource using the `seller_account_id` variable will include the `Seller-Account` header and be
+processed as the seller account.
+
+## Contributing
+
+### Release a new version of the gem
+
+Follow the steps below to make a release:
+
+1. Increment the version number in `lib/justifi/version.rb`
+2. Run `bundle`
+3. Commit the following file changes to your branch
+  - `Gemfile.lock`
+  - `lib/justifi/version.rb`
+4. Create and Merge your PR to `main`
+
+After this, the `.github/workflows/build_and_release.yml` will tag and release
+the gem to github packages.
+
+
+## Code of Conduct
+
+Everyone interacting in the JustApi project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of conduct][].