afterpay-sdk 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d11a93da08d6aef6124413f47bbdadc7a16a8b7bb0eefdc432b7550b722d5275
-  data.tar.gz: f85183189810df17af941f776e2a900802cbf3f1df66d5e49d9b8b018dc2ed63
+  metadata.gz: 6394dc3cf60aa29c10d0ad90f48515bfb680ce0fe98d835ccd681e72e78df967
+  data.tar.gz: 4f52e6c827219307155e2fe098e339e9b3b6406b357d951ff4aa531e16142727
 SHA512:
-  metadata.gz: 33b5ada12c5ea764399ed5558329d0641daba8922e1636483fee3eb86ad315e8de013b3acfdd1427145a7e7f9f39b3333fd17e3afc4aa6dc58b4acb1587cfa68
-  data.tar.gz: d5277fc45fa4a21ecf3d686d5993cd3a035ebfb6bb1603ff99d58e1f10b08235e4626b5e8394e545700e015e7ace72604fac632ebd4400a10f730b30cd6c37dc
+  metadata.gz: b0b586120bd8bdd18b4237ca64d16f95a86f6b33b0e7a7f5c0a1d0af417adb1ca35cb68e3ead7e550303ac0aafe16fc355243c08c6eceb4e9e40de1d00f0d54a
+  data.tar.gz: d09988e100a89972b89344bb3f0fd1824e02974495117b5130d542799d75ecb39fe0540635049aae02dac06305ba9d9abff0b8bf1faa51cf5183c54ba3a4d5a7

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## [Unreleased]
+
+## [2.0.0] - 2021-06-02
+
+- Initial release
+
+### 2.0.1 - 2021-07-05
+
+* bug fixes
+  * Correct the from_response method by not directly calling new with response but formatting the amount and then calling new with the attributes. The afterpay-sdk gem follows the Data Models attibutes data types as in v2 doc. As per the doc amount attibute of Refund or PaymentEvent object is a Money object so when the developer calls new he need to supply the money object however we use from_response method where we convert amount in response to money object using utils. (by @sachinsaxena1996)
+  * Fix refund objects attributes. add sucess? to refund model. Fix id be string in PaymentEvent. (by @sachinsaxena1996)
+  * Do not directly call new with response.body use from_response instead. Change done as attribute were blank in Refund.execute. (by @sachinsaxena1996)
+  * Fixed issue with error object of Refund object (by @sachinsaxena1996)
+* enhancement
+  * respond with objects array in payment response objects for events and refunds attributes. (by @sachinsaxena1996)
+  * Added rspec for data models (by @sachinsaxena1996)
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    afterpay-sdk (2.0.0)
+    afterpay-sdk (2.0.1)
       faraday (>= 0.8, < 1.0)
       faraday_middleware (~> 0.13.1)
       money (>= 6.7.1, < 7.0.0)
@@ -12,7 +12,7 @@ GEM
     addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
     coderay (1.1.2)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     coveralls (0.8.22)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)

data/README.md

@@ -46,9 +46,9 @@ end
 
 ### Creating an Order
 
-[api docs](https://YourMechanic/afterpay-sdk#create-checkout)
+[api docs](https://developers.afterpay.com/afterpay-online/reference#checkouts)
 
-Order accepts a [Consumer](YourMechanic/afterpay-sdk#consumer-object) and an array of [Item](YourMechanic/afterpay-sdk#item-object) object which are required.
+Order accepts a [Consumer](https://github.com/YourMechanic/afterpay-sdk#consumer-object) and an array of [Item](https://github.com/YourMechanic/afterpay-sdk#item-object) object which are required.
 
 ```ruby
 order = Afterpay::Order.create(
@@ -57,7 +57,7 @@ order = Afterpay::Order.create(
   items: [<Afterpay::Item>],
   success_url: <String>,
   cancel_url: <String>,
-  reference: <String>,
+  merchant_reference: <String>,
   tax: <Money>,
   shipping: <Money | optional>,
   discounts: [<Afterpay::Discount | optional>],
@@ -94,7 +94,7 @@ order.error
 ```ruby
 payment = Afterpay::Payment.execute(
   token: token <String>,
-  reference: "checkout-1" <String>
+  merchant_reference: "checkout-1" <String>
 )
 => <Afterpay::Payment ...>
 
@@ -115,7 +115,7 @@ 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)
+Afterpay::Payment.execute_deferred_payment(request_id: 'ppjjjkjk', merchant_reference: '100101382', amount: mony, payment_event_merchant_reference: '', order_id: 100101524323)
 ```
 
 ### Void payment

data/lib/afterpay/consumer.rb

@@ -4,11 +4,11 @@ module Afterpay
   class Consumer
     attr_accessor :email, :phone, :first_name, :last_name
 
-    def initialize(email:, phone:, first_name:, last_name:)
-      @email = email
-      @phone = phone
-      @first_name = first_name
-      @last_name = last_name
+    def initialize(attributes = {})
+      @email = attributes[:email]
+      @phone = attributes[:phone] || ""
+      @first_name = attributes[:first_name] || ""
+      @last_name = attributes[:last_name] || ""
     end
 
     def to_hash

data/lib/afterpay/discount.rb

@@ -20,7 +20,7 @@ module Afterpay
       return nil if response.nil?
 
       new(
-        name: response[:display_name],
+        name: response[:displayName],
         amount: Utils::Money.from_response(response[:amount])
       )
     end

data/lib/afterpay/item.rb

@@ -6,18 +6,16 @@ module Afterpay
   class Item
     attr_accessor :name, :sku, :quantity, :page_url, :image_url, :price, :categories, :estimated_shipment_date
 
-    # rubocop:disable Metrics/ParameterLists
-    def initialize(name:, price:, page_url:, image_url:, categories:, estimated_shipment_date:, sku: nil, quantity: 1)
-      @name = name
-      @sku = sku
-      @quantity = quantity
-      @price = price
-      @page_url = page_url
-      @image_url = image_url
-      @categories = categories
-      @estimated_shipment_date = estimated_shipment_date
+    def initialize(attributes = {})
+      @name = attributes[:name]
+      @sku = attributes[:sku] || ""
+      @quantity = attributes[:quantity]
+      @price = attributes[:price]
+      @page_url = attributes[:page_url] || ""
+      @image_url = attributes[:image_url] || ""
+      @categories = attributes[:categories] || []
+      @estimated_shipment_date = attributes[:estimated_shipment_date] || ""
     end
-    # rubocop:enable Metrics/ParameterLists
 
     def to_hash
       {

data/lib/afterpay/order.rb

@@ -4,7 +4,7 @@ module Afterpay
   # The Order object for creating an order to `/v2/checkouts`
   class Order
     attr_accessor :total, :consumer, :items, :shipping, :tax, :discounts,
-                  :billing, :shipping_address, :billing_address, :reference,
+                  :billing, :shipping_address, :billing_address, :merchant_reference,
                   :payment_type, :success_url, :cancel_url, :redirect_checkout_url
 
     attr_reader :expiry, :token, :error
@@ -77,11 +77,11 @@ module Afterpay
           redirectConfirmUrl: success_url,
           redirectCancelUrl: cancel_url
         },
-        merchantReference: reference,
+        merchantReference: merchant_reference,
         taxAmount: tax,
         paymentType: payment_type
       }
-      data[items] = items.map(&:to_hash) if items
+      data[:items] = items.map(&:to_hash) if items
       data[:taxAmount] = Utils::Money.api_hash(tax) if tax
       data[:shippingAmount] = Utils::Money.api_hash(shipping) if shipping
       data[:discounts] = discounts.map(&:to_hash) if discounts

data/lib/afterpay/payment.rb

@@ -8,22 +8,28 @@ module Afterpay
     attr_accessor :id, :token, :status, :created, :original_amount, :open_to_capture_amount,
                   :payment_state, :merchant_reference, :refunds, :order, :events, :error
 
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
+
     # Initialize Payment from response
-    def initialize(attributes)
-      @id = attributes[:id].to_i
-      @token = attributes[:token]
-      @status = attributes[:status]
-      @created = attributes[:created]
-      @original_amount = Utils::Money.from_response(attributes[:originalAmount])
-      @open_to_capture_amount = Utils::Money.from_response(attributes[:openToCaptureAmount])
-      @payment_state = attributes[:paymentState]
-      @merchant_reference = attributes[:merchantReference]
-      @refunds = attributes[:refunds]
-      @order = Order.from_response(attributes[:orderDetails])
-      @events = attributes[:events]
+    def initialize(attributes = {})
+      @id = attributes[:id] || ""
+      @token = attributes[:token] || ""
+      @status = attributes[:status] || ""
+      @created = attributes[:created] || ""
+      @original_amount = Utils::Money.from_response(attributes[:originalAmount]) || Money.from_amount(0)
+      @open_to_capture_amount = Utils::Money.from_response(attributes[:openToCaptureAmount]) || Money.from_amount(0)
+      @payment_state = attributes[:paymentState] || ""
+      @merchant_reference = attributes[:merchantReference] || ""
+      @refunds = attributes[:refunds].map { |refund| Refund.from_response(refund) } || [] unless attributes[:refunds].nil?
+      @order = Order.from_response(attributes[:orderDetails]) || Afterpay::Order.new
+      @events = attributes[:events].map { |event| PaymentEvent.from_response(event) } || [] unless attributes[:events].nil?
       @error = Error.new(attributes) if attributes[:errorId]
     end
 
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
+
     def success?
       @status == "APPROVED"
     end
@@ -31,19 +37,19 @@ module Afterpay
     # Executes the Payment
     #
     # @param token [String] the Order token
-    # @param reference [String] the reference for payment
+    # @param merchant_reference [String] the merchant_reference for payment
     # @return [Payment] the Payment object
-    def self.execute(token:, reference:)
+    def self.execute(token:, merchant_reference: nil)
       request = Afterpay.client.post("/v2/payments/capture") do |req|
         req.body = {
           token: token,
-          merchantRefernce: reference
+          merchantReference: merchant_reference
         }
       end
       new(request.body)
     end
 
-    def self.execute_auth(request_id:, token:, merchant_reference:)
+    def self.execute_auth(token:, request_id: nil, merchant_reference: nil)
       request = Afterpay.client.post("/v2/payments/auth") do |req|
         req.body = {
           requestId: request_id,
@@ -54,12 +60,12 @@ module Afterpay
       new(request.body)
     end
 
-    def self.execute_deferred_payment(request_id:, reference:, amount:,
-                                      payment_event_merchant_reference:, order_id:)
+    def self.execute_deferred_payment(amount:, order_id:, request_id: nil, merchant_reference: nil,
+                                      payment_event_merchant_reference: nil)
       request = Afterpay.client.post("/v2/payments/#{order_id}/capture") do |req|
         req.body = {
           requestId: request_id,
-          merchantRefernce: reference,
+          merchantReference: merchant_reference,
           amount: Utils::Money.api_hash(amount),
           paymentEventMerchantReference: payment_event_merchant_reference
         }
@@ -67,7 +73,7 @@ module Afterpay
       new(request.body)
     end
 
-    def self.execute_void(request_id:, order_id:, amount:)
+    def self.execute_void(order_id:, amount:, request_id: nil)
       request = Afterpay.client.post("/v2/payments/#{order_id}/void") do |req|
         req.body = {
           requestId: request_id,
@@ -77,7 +83,7 @@ module Afterpay
       new(request.body)
     end
 
-    def self.update_shipping_courier(order_id:, shipped_at:, name:, tracking:, priority:)
+    def self.update_shipping_courier(order_id:, shipped_at: nil, name: nil, tracking: nil, priority: nil)
       request = Afterpay.client.put("/v2/payments/#{order_id}/courier") do |req|
         req.body = {
           shippedAt: shipped_at,
@@ -140,8 +146,7 @@ module Afterpay
     # rubocop:disable Metrics/ParameterLists
 
     # This endpoint retrieves a collection of payments along with their order details.
-    def self.list_payments(to_created_date:, from_created_date:, limit:, offset:, tokens:, ids:,
-                           merchant_ref:, statuses:, order_by:, asc:)
+    def self.list_payments(tokens:, ids:, merchant_ref:, statuses:, to_created_date: nil, from_created_date: nil, limit: nil, offset: nil, order_by: nil, asc: nil)
       url = "/v2/payments?"
       url += "toCreatedDate=#{to_created_date.gsub('+', '%2b')}" if to_created_date
       url += "&fromCreatedDate=#{from_created_date.gsub('+', '%2b')}" if from_created_date

data/lib/afterpay/payment_event.rb

@@ -4,13 +4,27 @@ module Afterpay
   class PaymentEvent
     attr_accessor :id, :created, :expires, :type, :amount, :payment_event_merchant_reference
 
-    def initialize(attributes)
-      @id = attributes[:id]
-      @created = attributes[:created]
-      @expires = attributes[:expires]
-      @type = attributes[:expires]
-      @amount = Utils::Money.from_response(attributes[:amount])
-      @payment_event_merchant_reference = attributes[:paymentEventMerchantReference]
+    def initialize(attributes = {})
+      @id = attributes[:id] || ""
+      @created = attributes[:created] || ""
+      @expires = attributes[:expires] || ""
+      @type = attributes[:type] || ""
+      @amount = attributes[:amount] || Money.from_amount(0)
+      @payment_event_merchant_reference = attributes[:payment_event_merchant_reference] || ""
+    end
+
+    # Builds PaymentEvent from response
+    def self.from_response(response)
+      return nil if response.nil?
+
+      new(
+        id: response[:id],
+        created: response[:created],
+        expires: response[:expires],
+        type: response[:type],
+        amount: Utils::Money.from_response(response[:amount]),
+        payment_event_merchant_reference: response[:paymentEventMerchantReference]
+      )
     end
   end
 end

data/lib/afterpay/refund.rb

@@ -5,18 +5,24 @@ module Afterpay
     attr_accessor :request_id, :amount, :merchant_reference, :refund_id, :refunded_at,
                   :refund_merchant_reference, :error
 
-    def initialize(attributes)
-      @request_id = attributes[:requestId]
-      @amount = attributes[:amount]
-      @merchant_reference = attributes[:merchantReference]
-      @refund_id = attributes[:refundId]
-      @refunded_at = attributes[:refundAt]
-      @refund_merchant_reference = attributes[:refundMerchantReference]
-      @error = Error.new(attributes) if attributes[:errorId]
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
+
+    def initialize(attributes = {})
+      @request_id = attributes[:request_id] || ""
+      @amount = attributes[:amount] || Money.from_amount(0)
+      @merchant_reference = attributes[:merchant_reference] || ""
+      @refund_id = attributes[:refund_id] || ""
+      @refunded_at = attributes[:refunded_at] || ""
+      @refund_merchant_reference = attributes[:refund_merchant_reference] || ""
+      @error = Error.new(attributes[:error]) if attributes[:error] && attributes[:error][:errorId]
     end
 
-    def self.execute(request_id:, order_id:, amount:, merchant_reference:,
-                     refund_merchant_reference:)
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
+
+    def self.execute(order_id:, amount:, request_id: nil, merchant_reference: nil,
+                     refund_merchant_reference: nil)
       request = Afterpay.client.post("/v2/payments/#{order_id}/refund") do |req|
         req.body = {
           requestId: request_id,
@@ -25,7 +31,26 @@ module Afterpay
           refundMerchantReference: refund_merchant_reference
         }
       end
-      new(request.body)
+      from_response(request.body)
+    end
+
+    def success?
+      @error.nil?
+    end
+
+    # Builds Refund from response
+    def self.from_response(response)
+      return nil if response.nil?
+
+      new(
+        request_id: response[:requestId],
+        amount: Utils::Money.from_response(response[:amount]),
+        merchant_reference: response[:merchantReference],
+        refund_id: response[:refundId],
+        refunded_at: response[:refundedAt],
+        refund_merchant_reference: response[:refundMerchantReference],
+        error: response
+      )
     end
   end
 end

data/lib/afterpay/shipping_courier.rb

@@ -4,11 +4,24 @@ module Afterpay
   class ShippingCourier
     attr_accessor :shipped_at, :name, :tracking, :priority
 
-    def initialize(shipped_at:, name:, tracking:, priority:)
-      @shipped_at = shipped_at
-      @name = name
-      @tracking = tracking
-      @priority = priority
+    def initialize(attributes = {})
+      @shipped_at = attributes[:shipped_at] || ""
+      @name = attributes[:name] || ""
+      @tracking = attributes[:tracking] || ""
+      @priority = attributes[:priority] || ""
+    end
+
+    # Builds ShippingCourier from response
+    def self.from_response(response)
+      return nil if response.nil?
+
+      new(
+        shipped_at: response[:shippedAt],
+        name: response[:name],
+        tracking: response[:tracking],
+        priority: response[:priority],
+        error: Error.new(response)
+      )
     end
   end
 end

data/lib/afterpay/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Afterpay
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: afterpay-sdk
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Sachin Saxena
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-04 00:00:00.000000000 Z
+date: 2021-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -159,6 +159,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -208,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.8
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Afterpay ruby wrapper