mollie-api-ruby 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc0a692631f366a82801cfacbddd3a374feb23c4246cad015f5d5d28442bbe6f
-  data.tar.gz: 13bab05f6eee4826daaf8147e696fc1c5b8fd828a35e3dd56697ef756e97ac77
+  metadata.gz: f94d074aceda8fa4e7e541274aa0310d6dd414e80764f57bae3a2eaa604cc3dc
+  data.tar.gz: 74c99d214bd5f014134fc667e4aeff19cfec559b3d748dc64bfa7fac1b375fd4
 SHA512:
-  metadata.gz: 0eca2506d8f26e6de42661531956513f04292d59f87711ac8b26e584b9fd61d8c905bfaa68da20c96a7b2d08eedf8edfc955f7b9cc4658cbe3e663611f66bfde
-  data.tar.gz: 2d9c0f92e0349014398dae906afe85cc32ecf32d8a8c2fe739bbbae2d0ad85f8563bdc0b56f357e1f238cf1f0f4424f0d95c5110555d67f3d0b20e3b816b945d
+  metadata.gz: 1fc8639da1239db004daa99c723193cf0f56e8c82790267698d61d5597d49d8ec03a7bd338033be98644459d27cb8512810f47eac83ec205d000a34266bc7cbe
+  data.tar.gz: 4c13bc4d8756cd9a4c2701b4a04a037865fca7a8458865897f177af16a57ea97a4e883ca9c1096867646b501dbfbb9ecc83052431b7a53535f1dc38111aefee1

data/.rubocop_todo.yml

@@ -23,6 +23,10 @@ Lint/DuplicateMethods:
     - 'lib/mollie/customer/mandate.rb'
     - 'lib/mollie/customer/subscription.rb'
     - 'lib/mollie/invoice.rb'
+    - 'lib/mollie/order.rb'
+    - 'lib/mollie/order/line.rb'
+    - 'lib/mollie/order/shipment.rb'
+    - 'lib/mollie/payment/capture.rb'
     - 'lib/mollie/organization.rb'
     - 'lib/mollie/payment.rb'
     - 'lib/mollie/profile.rb'
@@ -37,6 +41,8 @@ Metrics/AbcSize:
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
   Max: 295
+  Exclude:
+    - 'test/**/*'
 
 # Offense count: 1
 Metrics/CyclomaticComplexity:

data/examples/captures/get-payment.rb

@@ -0,0 +1,2 @@
+capture = Mollie::Payment::Capture.get('cpt_4qqhO89gsT', payment_id: 'tr_WDqYK6vllg')
+payment = capture.payment

data/examples/captures/get-settlement.rb

@@ -0,0 +1,2 @@
+capture = Mollie::Payment::Capture.get('cpt_4qqhO89gsT', payment_id: 'tr_WDqYK6vllg')
+settlement = capture.settlement

data/examples/captures/get-shipment.rb

@@ -0,0 +1,2 @@
+capture  = Mollie::Payment::Capture.get('cpt_4qqhO89gsT', payment_id: 'tr_WDqYK6vllg')
+shipment = capture.shipment

data/examples/captures/get.rb

@@ -0,0 +1,4 @@
+capture = Mollie::Payment::Capture.get(
+  'cpt_4qqhO89gsT',
+  payment_id: 'tr_WDqYK6vllg'
+)

data/examples/captures/list.rb

@@ -0,0 +1 @@
+capture = Mollie::Payment::Capture.all(payment_id: 'tr_WDqYK6vllg')

data/examples/orders/cancel-lines.rb

@@ -0,0 +1,2 @@
+order = Mollie::Order.get('ord_kEn1PlbGa')
+order.lines[0].cancel

data/examples/orders/cancel.rb

@@ -0,0 +1,5 @@
+Mollie::Order.cancel('ord_kEn1PlbGa')
+
+# Cancel an order instance
+order = Mollie::Order.get('ord_kEn1PlbGa')
+order.cancel

data/examples/orders/create-refund.rb

@@ -0,0 +1,15 @@
+# Refund all order lines
+order  = Mollie::Order.get('ord_kEn1PlbGa')
+refund = order.refund!
+
+# Refund a specific order line
+order  = Mollie::Order.get('ord_kEn1PlbGa')
+refund = order.refund!(
+  lines: [
+    {
+      id: 'odl_dgtxyl',
+      quantity: 1
+    }
+  ],
+  description: 'Required quantity not in stock, refunding one photo book.'
+)

data/examples/orders/create.rb

@@ -0,0 +1,88 @@
+order = Mollie::Order.create(
+  amount: {
+    value: '1027.99',
+    currency: 'EUR'
+  },
+  billingAddress: {
+    streetAndNumber: 'Keizersgracht 313',
+    city: 'Amsterdam',
+    region: 'Noord-Holland',
+    postalCode: '1234AB',
+    country: 'NL',
+    title: 'Dhr',
+    givenName: 'Piet',
+    familyName: 'Mondriaan',
+    email: 'piet@mondriaan.com',
+    phone: '+31208202070'
+  },
+  shippingAddress: {
+    streetAndNumber: 'Prinsengracht 313',
+    streetAdditional: '4th floor',
+    city: 'Haarlem',
+    region: 'Noord-Holland',
+    postalCode: '5678AB',
+    country: 'NL',
+    title: 'Mr',
+    givenName: 'Chuck',
+    familyName: 'Norris',
+    email: 'norris@chucknorrisfacts.net'
+  },
+  metadata: {
+    order_id: '1337',
+    description: 'Lego cars'
+  },
+  consumerDateOfBirth: '1958-01-31',
+  locale: 'nl_NL',
+  orderNumber: '1337',
+  redirectUrl: 'https://example.org/redirect',
+  webhookUrl: 'https://example.org/webhook',
+  method: 'klarnapaylater',
+  lines: [
+    {
+      type: 'physical',
+      sku: '5702016116977',
+      name: 'LEGO 42083 Bugatti Chiron',
+      productUrl: 'https://shop.lego.com/nl-NL/Bugatti-Chiron-42083',
+      imageUrl: 'https://sh-s7-live-s.legocdn.com/is/image//LEGO/42083_alt1?$main$',
+      quantity: 2,
+      vatRate: '21.00',
+      unitPrice: {
+        "currency": 'EUR',
+        "value": '399.00'
+      },
+      totalAmount: {
+        "currency": 'EUR',
+        "value": '698.00'
+      },
+      discountAmount: {
+        "currency": 'EUR',
+        "value": '100.00'
+      },
+      vatAmount: {
+        "currency": 'EUR',
+        "value": '121.14'
+      }
+    },
+    {
+      type: 'physical',
+      sku: '5702015594028',
+      name: 'LEGO 42056 Porsche 911 GT3 RS',
+      productUrl: 'https://shop.lego.com/nl-NL/Porsche-911-GT3-RS-42056',
+      imageUrl: 'https://sh-s7-live-s.legocdn.com/is/image/LEGO/42056?$PDPDefault$',
+      quantity: 1,
+      vatRate: '21.00',
+      unitPrice: {
+        currency: 'EUR',
+        value: '329.99'
+      },
+      totalAmount: {
+        currency: 'EUR',
+        value: '329.99'
+      },
+      vatAmount: {
+        currency: 'EUR',
+        value: '57.27'
+      }
+    }
+  ]
+)

data/examples/orders/get.rb

@@ -0,0 +1 @@
+order = Mollie::Order.get('ord_kEn1PlbGa')

data/examples/orders/list-refunds.rb

@@ -0,0 +1 @@
+refunds = Order::Refund.all(order_id: 'ord_kEn1PlbGa')

data/examples/orders/list.rb

@@ -0,0 +1 @@
+orders = Mollie::Order.all

data/examples/orders/update.rb

@@ -0,0 +1,15 @@
+order = Mollie::Order.update(
+  'ord_kEn1PlbGa',
+  billingAddress: {
+    city: 'Amsterdam',
+    country: 'NL',
+    email: 'piet@mondriaan.com',
+    familyName: 'Mondriaan',
+    givenName: 'Piet',
+    phone: '+31208202070',
+    postalCode: '1234AB',
+    region: 'Noord-Holland',
+    streetAndNumber: 'Keizersgracht 313',
+    title: 'Dhr'
+  }
+)

data/examples/payments/get-order.rb

@@ -0,0 +1,2 @@
+payment = Mollie::Payment.get('tr_7UhSN1zuXS')
+order = payment.order

data/examples/refunds/get-order.rb

@@ -0,0 +1,2 @@
+refund = Mollie::Payment::Refund.get('re_4qqhO89gsT', payment_id: 'tr_WDqYK6vllg')
+order = refund.order

data/examples/shipments/create.rb

@@ -0,0 +1,17 @@
+shipment = Mollie::Order::Shipment.create(
+  order_id: 'ord_kEn1PlbGa',
+  lines: [
+    {
+      id: 'odl_dgtxyl',
+      quantity: 1
+    },
+    {
+      id: 'odl_jp31jz'
+    }
+  ],
+  tracking: {
+    carrier: 'PostNL',
+    code: '3SKABA000000000',
+    url: 'http://postnl.nl/tracktrace/?B=3SKABA000000000&P=1016EE&D=NL&T=C'
+  }
+)

data/examples/shipments/get-order.rb

@@ -0,0 +1,2 @@
+shipment = Mollie::Order::Shipment.get('shp_3wmsgCJN4U', order_id: 'ord_kEn1PlbGa')
+order = shipment.order

data/examples/shipments/get.rb

@@ -0,0 +1,4 @@
+shipment = Mollie::Order::Shipment.get(
+  'shp_3wmsgCJN4U',
+  order_id: 'ord_kEn1PlbGa'
+)

data/examples/shipments/list.rb

@@ -0,0 +1 @@
+shipments = Mollie::Order::Shipment.all(order_id: 'ord_kEn1PlbGa')

data/examples/shipments/update.rb

@@ -0,0 +1,9 @@
+shipment = Mollie::Order::Shipment.update(
+  'shp_3wmsgCJN4U',
+  order_id: 'ord_kEn1PlbGa',
+  tracking: {
+    carrier: 'PostNL',
+    code: '3SKABA000000000',
+    url: 'http://postnl.nl/tracktrace/?B=3SKABA000000000&P=1016EE&D=NL&T=C'
+  }
+)

data/lib/mollie.rb

@@ -21,6 +21,7 @@ require 'mollie/customer/subscription'
 require 'mollie/invoice'
 require 'mollie/list'
 require 'mollie/method'
+require 'mollie/order'
 require 'mollie/organization'
 require 'mollie/payment'
 require 'mollie/permission'
@@ -29,6 +30,10 @@ require 'mollie/refund'
 require 'mollie/settlement'
 
 require 'mollie/customer/payment'
+require 'mollie/order/line'
+require 'mollie/order/refund'
+require 'mollie/order/shipment'
+require 'mollie/payment/capture'
 require 'mollie/payment/chargeback'
 require 'mollie/payment/refund'
 require 'mollie/settlement/chargeback'

data/lib/mollie/base.rb

@@ -44,6 +44,7 @@ module Mollie
       def delete(id, options = {})
         request('DELETE', id, options)
       end
+      alias cancel delete
 
       def request(method, id = 0, data = {}, options = {})
         parent_id = options.delete(self.parent_id) || data.delete(self.parent_id)
@@ -88,5 +89,6 @@ module Mollie
       end
       self.class.delete(id, options)
     end
+    alias cancel delete
   end
 end

data/lib/mollie/exception.rb

@@ -2,7 +2,7 @@ module Mollie
   class Exception < StandardError
   end
 
-  class RequestError < RuntimeError
+  class RequestError < Mollie::Exception
     attr_accessor :status, :title, :detail, :field, :links
 
     def initialize(error)

data/lib/mollie/list.rb

@@ -20,6 +20,14 @@ module Mollie
       end
     end
 
+    def [](index)
+      @items[index]
+    end
+
+    def size
+      @items.size
+    end
+
     def each(&block)
       @items.each(&block)
     end

data/lib/mollie/order.rb

@@ -0,0 +1,142 @@
+module Mollie
+  class Order < Base
+    STATUS_PENDING    = 'pending'.freeze
+    STATUS_AUTHORIZED = 'authorized'.freeze
+    STATUS_PAID       = 'paid'.freeze
+    STATUS_SHIPPING   = 'shipping'.freeze
+    STATUS_EXPIRED    = 'expired'.freeze
+    STATUS_CANCELED   = 'canceled'.freeze
+    STATUS_COMPLETED  = 'completed'.freeze
+
+    attr_accessor :id,
+                  :profile_id,
+                  :method,
+                  :mode,
+                  :amount,
+                  :amount_captured,
+                  :amount_refunded,
+                  :status,
+                  :is_cancelable,
+                  :billing_address,
+                  :consumer_date_of_birth,
+                  :order_number,
+                  :shipping_address,
+                  :locale,
+                  :metadata,
+                  :redirect_url,
+                  :webhook_url,
+                  :created_at,
+                  :expires_at,
+                  :expired_at,
+                  :paid_at,
+                  :authorized_at,
+                  :canceled_at,
+                  :completed_at,
+                  :lines,
+                  :_links
+
+    alias links _links
+
+    def pending?
+      status == STATUS_PENDING
+    end
+
+    def authorized?
+      status == STATUS_AUTHORIZED
+    end
+
+    def paid?
+      status == STATUS_PAID
+    end
+
+    def shipping?
+      status == STATUS_SHIPPING
+    end
+
+    def expired?
+      status == STATUS_EXPIRED
+    end
+
+    def canceled?
+      status == STATUS_CANCELED
+    end
+
+    def completed?
+      status == STATUS_COMPLETED
+    end
+
+    def cancelable?
+      is_cancelable
+    end
+
+    def checkout_url
+      Util.extract_url(links, 'checkout')
+    end
+
+    def lines=(lines)
+      @lines = lines.map { |line| Order::Line.new(line) }
+    end
+
+    def amount=(amount)
+      @amount = Mollie::Amount.new(amount)
+    end
+
+    def amount_captured=(amount)
+      @amount_captured = Mollie::Amount.new(amount)
+    end
+
+    def amount_refunded=(amount)
+      @amount_refunded = Mollie::Amount.new(amount)
+    end
+
+    def billing_address=(address)
+      @billing_address = OpenStruct.new(address) if address.is_a?(Hash)
+    end
+
+    def shipping_address=(address)
+      @shipping_address = OpenStruct.new(address) if address.is_a?(Hash)
+    end
+
+    def metadata=(metadata)
+      @metadata = OpenStruct.new(metadata) if metadata.is_a?(Hash)
+    end
+
+    def created_at=(created_at)
+      @created_at = Time.parse(created_at.to_s)
+    end
+
+    def expires_at=(expires_at)
+      @expires_at = Time.parse(expires_at.to_s)
+    end
+
+    def expired_at=(expired_at)
+      @expired_at = Time.parse(expired_at.to_s)
+    end
+
+    def paid_at=(paid_at)
+      @paid_at = Time.parse(paid_at.to_s)
+    end
+
+    def authorized_at=(authorized_at)
+      @authorized_at = Time.parse(authorized_at.to_s)
+    end
+
+    def canceled_at=(canceled_at)
+      @canceled_at = Time.parse(canceled_at.to_s)
+    end
+
+    def completed_at=(completed_at)
+      @completed_at = Time.parse(completed_at.to_s)
+    end
+
+    def refunds(options = {})
+      Order::Refund.all(options.merge(order_id: id))
+    end
+
+    def refund!(options = {})
+      options[:order_id] = id
+      options[:lines] ||= []
+      Order::Refund.create(options)
+    end
+  end
+end