afterpay-sdk 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d11a93da08d6aef6124413f47bbdadc7a16a8b7bb0eefdc432b7550b722d5275
+  data.tar.gz: f85183189810df17af941f776e2a900802cbf3f1df66d5e49d9b8b018dc2ed63
+SHA512:
+  metadata.gz: 33b5ada12c5ea764399ed5558329d0641daba8922e1636483fee3eb86ad315e8de013b3acfdd1427145a7e7f9f39b3333fd17e3afc4aa6dc58b4acb1587cfa68
+  data.tar.gz: d5277fc45fa4a21ecf3d686d5993cd3a035ebfb6bb1603ff99d58e1f10b08235e4626b5e8394e545700e015e7ace72604fac632ebd4400a10f730b30cd6c37dc

data/.env.sample

@@ -0,0 +1,2 @@
+APP_ID=
+SECRET=

data/.github/workflows/gempush.yml

@@ -0,0 +1,30 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - 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/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,33 @@
+AllCops:
+  Exclude:
+    - "afterpay-sdk.gemspec"
+    - "bin/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/Documentation:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+  Exclude:
+    - "spec/**/*"
+    - "Gemfile"
+    - "Rakefile"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
+Metrics/LineLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - "lib/afterpay-sdk.rb"
+Naming/VariableNumber:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+  - 2.6.1
+  - 2.5.1
+  - 2.3.3
+before_install: gem install bundler -v 2.0.1

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 iamchoonggg@gmail.com. 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,11 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in afterpay-sdk.gemspec
+gemspec
+
+group :test do
+  gem "coveralls", require: false
+  gem "simplecov", require: false
+  gem "vcr", "~> 4.0"
+  gem "webmock", "~> 3.5", ">= 3.5.1"
+end

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    afterpay-sdk (2.0.0)
+      faraday (>= 0.8, < 1.0)
+      faraday_middleware (~> 0.13.1)
+      money (>= 6.7.1, < 7.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.8)
+    coveralls (0.8.22)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    dotenv (2.7.2)
+    faraday (0.17.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    hashdiff (0.3.8)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    json (2.3.1)
+    method_source (0.9.2)
+    money (6.16.0)
+      i18n (>= 0.6.4, <= 2)
+    multipart-post (2.1.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rake (12.3.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.20.2)
+    vcr (4.0.0)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  afterpay-sdk!
+  bundler (~> 2.0)
+  coveralls
+  dotenv (~> 2.2, >= 2.2.1)
+  pry
+  rake (~> 12.3, >= 12.3.3)
+  rspec (~> 3.0)
+  simplecov
+  vcr (~> 4.0)
+  webmock (~> 3.5, >= 3.5.1)
+
+BUNDLED WITH
+   2.2.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Elijah Goh Chong Hui
+
+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,284 @@
+# Afterpay Ruby
+
+Based on the [API docs](https://developers.afterpay.com/afterpay-online/reference)
+
+Afterpay Ruby is a Ruby wrapper for Afterpay API. It provides simple DSL and serialization to Afterpay's API attribute. This version supports the v2 version of Afterpay API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'afterpay-sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install afterpay-sdk
+
+## Usage
+
+You need to configure Afterpay using your Merchant ID and secret.
+
+For Rails, put this in your initializer.
+
+```ruby
+Afterpay.configure do |config|
+  config.app_id = <app_id>
+  config.secret = <secret>
+
+  # Sets the environment for Afterpay
+  # defaults to sandbox
+  # config.env = "sandbox" # "live"
+
+  # Sets the user agent header for Afterpay requests
+  # Refer https://developers.afterpay.com/afterpay-online/reference#configuration
+  # config.user_agent_header = {pluginOrModuleOrClientLibrary}/{pluginVersion} ({platform}/{platformVersion}; Merchant/{merchantId}) { merchantUrl }
+  # Example
+  # config.user_agent_header = "Afterpay Module / 1.0.0 (rails/ 5.1.2; Merchant/#{ merchant_id }) #{ merchant_website_url }"
+
+end
+```
+
+### Creating an Order
+
+[api docs](https://YourMechanic/afterpay-sdk#create-checkout)
+
+Order accepts a [Consumer](YourMechanic/afterpay-sdk#consumer-object) and an array of [Item](YourMechanic/afterpay-sdk#item-object) object which are required.
+
+```ruby
+order = Afterpay::Order.create(
+  total: <Money>,
+  consumer: <Afterpay::Consumer>,
+  items: [<Afterpay::Item>],
+  success_url: <String>,
+  cancel_url: <String>,
+  reference: <String>,
+  tax: <Money>,
+  shipping: <Money | optional>,
+  discounts: [<Afterpay::Discount | optional>],
+  billing_address: <Afterpay::Address | optional>,
+  shipping_address: <Afterpay::Address | optional>,
+)
+
+# OR
+
+order = Afterpay::Order.new(
+  ...
+)
+order.create
+
+
+order.success?
+=> true
+order.token
+=> xxxxxxx
+
+# Error
+
+order.success?
+=> false
+order.error
+=> Afterpay::Error:0x00007f8a63953888
+  @id="48da0bce49d39625",
+  @code="invalid_object",
+  @message="merchant.redirectConfirmUrl must be a valid URL, merchant.redirectConfirmUrl may not be empty" >
+```
+
+### Executing Payment
+
+```ruby
+payment = Afterpay::Payment.execute(
+  token: token <String>,
+  reference: "checkout-1" <String>
+)
+=> <Afterpay::Payment ...>
+
+payment.success?
+=> true
+payment.order
+=> <Afterpay::Order ...>
+payment.status
+=> APPROVED
+```
+
+### Deferred Payment
+
+```ruby
+mony = Money.from_amount(1000, "USD")
+
+For Auth
+Afterpay::Payment.execute_auth(request_id: 'fjfwwwjfj090292920', token: '002.v4krg5qpii1tbp0kvr261rf3p1k5jfe2fin', merchant_reference: '100101382')
+
+For executing deferred payment
+Afterpay::Payment.execute_deferred_payment(request_id: 'ppjjjkjk', reference: '100101382', amount: mony, payment_event_merchant_reference: '', order_id: 100101524323)
+```
+
+### Void payment
+
+```ruby
+Afterpay::Payment.execute_void(request_id: 'ppjjjkjk', order_id: 'same_as_id_of_auth_output', amount: mony)
+```
+
+### Refund
+
+```ruby
+Afterpay::Refund.execute(request_id: 'unique_id', order_id: 'order_id', amount: mony, merchant_reference: '100101382', refund_merchant_reference: '100101111')
+```
+
+### Update Shipping Courier
+
+```ruby
+Afterpay::Payment.update_shipping_courier(order_id: valid_order_id,
+                                          shipped_at: DateTime.now.iso8601,
+                                          name: "Bludart",
+                                          tracking: "AWB129181",
+                                          priority: "EXPRESS")
+```
+
+### Get Payment By Order Id
+
+This endpoint retrieves an individual payment along with its order details.
+
+```ruby
+Afterpay::Payment.get_payment_by_order_id(order_id: valid_order_id)
+
+```
+
+### Get Payment By Token
+
+This endpoint retrieves an individual payment along with its order details.
+
+```ruby
+Afterpay::Payment.get_payment_by_token(token: valid_token)
+
+```
+
+### Update Payment by Order Id
+
+This end point is for merchants that creates merchant side's order id after
+AfterPay order id creation. The merchants should call immediately after the AfterPay order is
+in order to properly update with their order id that can be tracked.
+
+```ruby
+Afterpay::Payment.update_payment_by_order_id(order_id: valid_order_id,
+merchant_reference: "new_merchant_order_id_1234")
+```
+
+### reverse_payment_by_token
+
+This endpoint performs a reversal of the checkout that is used to initiate
+the Afterpay payment process. This will cancel the order asynchronously as
+soon as it is created without the need of an additional call to the void endpoint.
+In order for a payment to be eligible, the order must be in an Auth-Approved or
+Captured state and must be issued within 10 minutes of the order being created.
+token paramater is the token of the checkout to be reversed (voided).
+
+```ruby
+Afterpay::Payment.reverse_payment_by_token(token: valid_token)
+```
+
+### list_payments
+
+This endpoint retrieves a collection of payments along with their order details.
+
+```ruby
+Afterpay::Payment.list_payments(
+        to_created_date: nil,
+        from_created_date: nil, limit: 10, offset: 0,
+        tokens: [],
+        ids: ["100101533036"], merchant_ref: ["100101382"],
+        statuses: ["Approved"], order_by: "createdAt", asc: false
+      )
+```
+
+### Consumer Object
+
+[api docs](https://developers.afterpay.com/afterpay-online/reference#consumer-object)
+
+Consumer contains the details of the payee which will be serialized to API's format.
+
+```ruby
+Afterpay::Consumer.new(
+  email: <String>,
+  phone: <String>,
+  first_name: <String>,
+  last_name: <String>,
+)
+```
+
+### Item Object
+
+[api docs](https://developers.afterpay.com/afterpay-online/reference#item-object)
+
+Item holds the details of purchace per item.
+
+```ruby
+Afterpay::Item.new(
+  name: <String>,
+  price: <Money>,
+  sku: <String | optional>,
+  quantity: <Number | defaults to 1>,
+  page_url: <String | optional>,
+  image_url: <String | optional>,
+  categories: [][],
+  estimatedShipmentDate: <String | optional>
+)
+```
+
+### Discount Object
+
+[api docs](https://developers.afterpay.com/afterpay-online/reference#discount-object)
+
+Discount Applied to the Order
+
+```ruby
+Afterpay::Discount.new(
+  name: <String>,
+  amount: <Money>
+)
+```
+
+### Address Object
+
+[api docs](https://developers.afterpay.com/afterpay-online/reference#contact-object)
+
+Item holds the details of purchace per item.
+
+```ruby
+Afterpay::Address.new(
+  name: <String>,
+  line_1: <String>,
+  line_2: <String | optional>,
+  area_1: <String | required | Limited to 128 characters>,
+  area_2: <String | optional | Limited to 128 characters>,
+  region: <String | required | Limited to 128 characters>,
+  postcode: <String | Number>,
+  country: <String | optional>,
+  phone: <String>
+)
+```
+
+## 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/YourMechanic/afterpay-sdk. 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.
+
+You will need to copy `.env.sample` to `.env` for running Afterpay console. This will not be checked into git.
+
+## 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 Afterpay project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/afterpay-sdk/blob/master/CODE_OF_CONDUCT.md).