paypro 0.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c6bd8a3eec2325e4cac9984dea2799f476a239b8
-  data.tar.gz: 7daab9b2d8ae429bfcc575c288abc0cb87b57ef1
+SHA256:
+  metadata.gz: 1b607a221258fa5d8bfe0bda8f604acb345d0e89066f8f86089386932762b3ca
+  data.tar.gz: ebc0b753e9d234c911a34af6e95a7bf733c85b60ff1c2f316bb73e2e812f98ae
 SHA512:
-  metadata.gz: 46859aa059d6dd303bd030194ffba0b09860c5c483eb27881d1473c7f36d397682b787e5784f42159dffea47e94ce4c00bef223105c13e8f7779b2e831b390ae
-  data.tar.gz: 60058dc4571627502ffa2ede304885c303e94839b1f72967f82ea6c814beb616eeecd94af786eff20c051d9a417b067ad6131d7c57b7bea43c3583212ae1ad3b
+  metadata.gz: 0c481bd099168f64341e52b444ab2780737910d51932864912d57becb6ae8a618c2042b4046059d4a7ec8ad34d1a5189e15acca6e19c68487c494fde6083c2bf
+  data.tar.gz: 0aed28248485b406f8a3d15acc98acf8ec7932077f35f625c251f4df731fa4aae33fe34e640461fffd2501468b061450151e399ba7507f299bc42392fbead0c6

data/.github/workflows/build.yml

@@ -0,0 +1,54 @@
+name: build
+
+on:
+  push:
+    branches:
+      - 'master'
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  build:
+    name: Build
+    needs: test
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+    - name: Build
+      run: gem build paypro.gemspec
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+    - name: Lint
+      run: bundle install && bundle exec rubocop
+
+  test:
+    name: Test (${{ matrix.ruby-version }})
+    needs: lint
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0', 3.1, 3.2]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Test
+        run: bundle install && bundle exec rspec

data/.gitignore

@@ -1,50 +1,14 @@
-*.gem
-*.rbc
-/.config
+/.bundle/
+/.yardoc
+/_yardoc/
 /coverage/
-/InstalledFiles
+/doc/
 /pkg/
 /spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
 /tmp/
+*.DS_Store
 
-# Used by dotenv library to load environment variables.
-# .env
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
+.rspec_status
+.ruby-version
 
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
+Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -1,20 +1,39 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
 AllCops:
-  Exclude:
-    - "db/**/*"
-    - "tmp/**/*"
-    - "vendor/**/*"
-    - "bin/**/*"
-    - "log/**/*"
-    - "public/**/*"
-  TargetRubyVersion: 2.4
-Metrics/LineLength:
-  Enabled: true
-  Max: 120
-Style/FrozenStringLiteralComment:
-  Description: 'Ruby 3.0 transition for frozen string literals'
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.0
+
+# We disable this to allow automatic releases
+Gemspec/RequireMFA:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/ClassLength:
+  CountAsOne: ['array', 'hash', 'heredoc', 'method_call']
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 30
+
+RSpec/ExampleLength:
+  CountAsOne: ['array', 'hash', 'heredoc']
+  Max: 10
+
+RSpec/MultipleMemoizedHelpers:
   Enabled: false
-Style/BlockLength:
+
+RSpec/NestedGroups:
+  Max: 5
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
   Exclude:
-    - 'Rakefile'
-    - '**/*.rake'
-    - 'spec/**/*.rb'
+    - 'bin/**'

data/Gemfile

@@ -1,8 +1,20 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
+# Specify your gem's dependencies in paypro.gemspec
 gemspec
 
 group :development do
-  gem 'rspec_junit_formatter', '~> 0.3'
-  gem 'rubocop', '~> 0.39'
+  gem 'debug', '~> 1.8.0'
+  gem 'rake', '~> 12.0'
+  gem 'rspec', '~> 3.0'
+
+  gem 'rubocop', '~> 1.57'
+  gem 'rubocop-performance', '~> 1.19.0'
+  gem 'rubocop-rspec', '~> 2.25.0'
+
+  gem 'timecop', '~> 0.9.8'
+
+  gem 'webmock', '~> 3.19.0'
 end

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 PayPro
+Copyright (c) 2023 PayPro
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,36 +1,98 @@
-![PayPro](https://paypro.nl/images/logo-ie.png)
-# Ruby Client for PayPro API v1
+# PayPro Ruby Library
+
+[![build](https://github.com/paypronl/paypro-ruby/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/paypronl/paypro-ruby/actions/workflows/build.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
-This library provides a Ruby client to connect with the PayPro API.
+The PayPro Ruby library can be used to make integrating with the PayPro API easier when using Ruby.
+It provides easy to use classes to interact with all resources available through the API.
+
+It also provides the following:
+
+- Built-in pagination support
+- Easy configuration
+- Webhook request verification helpers
 
 ## Requirements
 
- - Ruby >= 2.0.0
+- Ruby >= 3.0.0
 
 ## Installation
 
-We provide an installation guide on https://paypro.nl/developers/api-clients/ruby.
+You can install the gem like this:
+
+```sh
+gem install paypro
+```
+
+If you'd rather install the gem through `bundler` you can put this in your Gemfile:
+
+```ruby
+source 'https://rubygems.org'
+
+gem 'paypro'
+
+```
 
 ## Getting started
 
-Example of creating a payment:
+In order to use the API you need to have a valid API key.
+You can find your API key in the [PayPro dashboard](https://app.paypro.nl/developers/api-keys)
+
+Example of using the API:
 
 ```ruby
 require 'paypro'
 
-client = PayPro::Client.new('YOUR_API_KEY')
-client.command = 'create_payment';
-client.params = { amount: 500, consumer_email: 'test@paypro.nl', pay_method: 'ideal/INGBNL2A' }
-client.execute
+client = PayPro::Client.new('pp_...')
+
+# Creating a payment
+payment = client.payments.create({ amount: 500, currency: 'EUR', description: 'Test Payment' })
+
+# Retrieving all subscriptions
+subscriptions = client.subscriptions.list
+
+# Retrieving a single customer
+customer = client.customers.get('CUSSDGDCJVZH5K')
+
 ```
 
-## Documentation
+## Per-request configuration
 
-For guides and code examples you can go to https://paypro.nl/developers/docs.
+When you have multiple API keys to use during a single request, you can specify these in all requests.
+
+```ruby
+require 'paypro'
+
+client = PayPro::Client.new('pp_...')
+
+# Creating a payment
+payment = client.payments.create({ amount: 500, currency: 'EUR', description: 'Test Payment' }, api_key: 'pp_...')
+
+# Retrieving five subscriptions
+subscriptions = client.subscriptions.list({ limit: 5 }, api_key: 'pp_...')
+
+# Retrieving a single customer
+customer = client.customers.get('CUSSDGDCJVZH5K', api_key: 'pp_...', api_url: 'https://api-test.paypro.nl')
+```
+
+## Development
 
-## Contributing
 If you want to contribute to this project you can fork the repository. Create a new branch, add your feature and create a pull request. We will look at your request and determine if we want to add it.
 
-## License
-[MIT](https://github.com/paypronl/paypro-ruby-v1/blob/master/LICENSE)
+To run all the tests:
+
+```sh
+bundle exec rspec
+```
+
+To run the linter:
+
+```sh
+bundle exec rubocop
+```
+
+To run an `irb` with the gem already required you can use:
+
+```sh
+bin/console
+```

data/Rakefile

@@ -1,2 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-Rspec::Core::RakeTask.new('spec')
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pay_pro'
+require 'debug'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here