mobilepay 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bab5344a65d680df787fc9f5b05c9d46b0e7a07
-  data.tar.gz: d634adad086b8fec11b7ee7321fc3e237bca86b1
+  metadata.gz: ab2ecb74f00ea4ee578b918b4cf847729883292b
+  data.tar.gz: 78c3295ec71aa6a5e3d38eda4e6098e1e10cb173
 SHA512:
-  metadata.gz: 336d31e06c454f751bb83b660f5d75dbaa9d2d7e1e742792606808888e9b186687a7e927f8c1374689060cafdf471856a7f1d51480de2ef3c3425b77f7645c66
-  data.tar.gz: 5ac2ffd3fc2fcc26dabfc0df7a8892d0157a1b54c85951546e02285450c96b1515d821f0adc7ece59cccd54ed9fb2b7352d6f50d30e11e7579bbc5ca3e6ca5d3
+  metadata.gz: 2a1c19eb27c62f2d2eaa21a452d5da47686b417acbf33ed6d7302733d847934860fc6706216b7cfb2cf52ce9222391d63f6a729d844b9d0db4f823a37e437509
+  data.tar.gz: a6be43d4de495cb1397ed951353a4044ca6006e907edbe3a16ac8b86b8c6ee776b78d0da3937e042df2cf551e469a40d5c15b82d8c5863a7e0593a7fe4fc2793

data/README.md

@@ -20,11 +20,203 @@ Or install it yourself as:
 
 ## Usage
 
-Create MobilePay object.
+### Create Security object
 
 ```ruby
   require 'mobilepay'
-  translator = MobilePay::Client.new('merchant_id', 'subscription_key')
+  security = Mobilepay::Security.new subscription_key: 'subscription_key'
+```
+    merchant_id - Merchant ID, required
+
+### Create MobilePay object
+
+```ruby
+  require 'mobilepay'
+  client = Mobilepay::Client.new merchant_id: 'merchant_id', subscription_key: 'subscription_key'
+```
+    subscription_key - Subscription Key for MobilePay, required
+    merchant_id - Merchant ID, required
+
+### Public Key
+
+Request for getting MobilePay's public key to use when signing up new merchants.
+
+```ruby
+  security.public_key
+```
+
+#### Responces
+
+```ruby
+  {
+    "PublicKey": "-----BEGIN CERTIFICATE-----certificate body-----END CERTIFICATE-----"
+  }
+```
+
+### Payment Status
+
+Request for getting the status of a given order is #payment_status.
+
+```ruby
+  client.payment_status order_id: '111'
+```
+    order_id - Order ID, required
+
+#### Responces
+
+```ruby
+  {
+    "LatestPaymentStatus": "Captured",
+    "TransactionId": "61872634691623746",
+    "OriginalAmount": 123.45
+  }
+```
+
+### Payment Transactions
+
+Request for getting the transactions for a given order is #payment_transactions.
+
+```ruby
+  client.payment_transactions order_id: '111'
+```
+    order_id - Order ID, required
+
+#### Responces
+
+```ruby
+  [
+    {
+      "TimeStamp": "2016-04-08T07:45:36.533Z",
+      "PaymentStatus": "Captured",
+      "TransactionId": "61872634691623746",
+      "Amount": 11.5
+    },
+    {
+      "TimeStamp": "2016-04-09T07:45:36.672Z",
+      "PaymentStatus": "Cancelled",
+      "TransactionId": "61872634691623799",
+      "Amount": 18.9
+    }
+  ]
+```
+
+### Reservations
+
+Request for getting the reservations for a particular date/time interval, and alternatively also for a specific customer is #reservations.
+
+```ruby
+  client.reservations datetime_from: 'YYYY-MM-DDTHH_MM', datetime_to: 'YYYY-MM-DDTHH_MM', customer_id: '111'
+```
+    datetime_from - Date from, required
+    datetime_to - Date to, required
+    customer_id - Customer ID, optional
+
+#### Responces
+
+```ruby
+  [
+    {
+      "TimeStamp": "2016-04-08T07_45_36Z",
+      "OrderId": "DB TESTING 2015060908",
+      "TransactionId": "61872634691623746",
+      "Amount": 100.25,
+      "CaptureType": "Full"
+    },
+    {
+      "TimeStamp": "2016-04-09T07_45_36Z",
+      "OrderId": "DB TESTING 2015060908",
+      "TransactionId": "61872634691623799"
+      "Amount": 100.25,
+      "CaptureType": "Partial"
+    }
+  ]
+```
+
+### Refund Amount
+
+Request for refunding the transaction amount, either the entire amount or just a part of the amount is #refund_amount.
+
+```ruby
+  client.refund_amount order_id: '111', body: '{}'
+```
+    order_id - Order ID, required
+    body - text body for request, optional
+
+#### Request body examples
+
+```ruby
+  {
+    "Amount" : 100.00,
+    "BulkRef" : "123456789"
+  }
+
+  {
+    "Amount" : 100.00
+  }
+
+  {
+  }
+```
+
+#### Responces
+
+```ruby
+  {
+    "TransactionId" : "61872634691623757",
+    "OriginalTransactionId" : "61872634691623746",
+    "Remainder" : 20.00
+  }
+```
+
+### Capture Amount
+
+Request for capturing the transaction, i.e. carries out the actual payment is #capture_amount.
+
+```ruby
+  client.capture_amount order_id: '111', body: '{}'
+```
+    order_id - Order ID, required
+    body - text body for request, optional
+
+#### Request body examples
+
+```ruby
+  {
+    "Amount" : 100.00,
+    "BulkRef" : "123456789"
+  }
+
+  {
+    "Amount" : 100.00
+  }
+
+  {
+  }
+```
+
+#### Responces
+
+```ruby
+  {
+    "TransactionId" : "61872634691623746"
+  }
+```
+
+### Cancel Reservation
+
+Request for canceling previously made reservations is #cancel_reservation.
+
+```ruby
+  client.cancel_reservation order_id: '111'
+```
+    order_id - Order ID, required
+
+#### Responces
+
+```ruby
+  {
+    "TransactionId" : "61872634691623746"
+  }
 ```
 
 ## Contributing

data/lib/mobilepay.rb

@@ -1,4 +1,6 @@
-require 'mobilepay/version'
+require_relative 'mobilepay/version'
+require_relative 'mobilepay/client'
+require_relative 'mobilepay/security'
 
 module Mobilepay
 end

data/lib/mobilepay/client.rb

@@ -0,0 +1,55 @@
+require 'json'
+require_relative 'client/payment_status'
+require_relative 'client/payment_transactions'
+require_relative 'client/reservations'
+require_relative 'client/refund_amount'
+require_relative 'client/capture_amount'
+require_relative 'client/cancel_reservation'
+require_relative 'requests'
+
+module Mobilepay
+    class Client
+        include Mobilepay::Client::PaymentStatus
+        include Mobilepay::Client::PaymentTransactions
+        include Mobilepay::Client::Reservations
+        include Mobilepay::Client::RefundAmount
+        include Mobilepay::Client::CaptureAmount
+        include Mobilepay::Client::CancelReservation
+        include Mobilepay::Requests
+
+        class MobilePayFailure < StandardError; end
+
+        attr_reader :merchant_id, :subscription_key, :base_uri
+
+        def initialize(args = {})
+            @merchant_id = args[:merchant_id] || ''
+            @subscription_key = args[:subscription_key] || ''
+            @base_uri = 'https://api.mobeco.dk/appswitch/api/v1'
+        end
+
+        private
+
+        def call(req, address, args = {})
+            response = case req
+                when :get, :put, :delete then http_request(req, address, args)
+                else raise MobilePayFailure, 'Undefined  type for call'
+            end
+            check_response(response)
+            response
+        end
+
+        def check_response(response)
+            if response.code != '200'
+                raise MobilePayFailure, JSON.parse(response.body)['message']
+            end
+        end
+
+        def check_args(args)
+            args.each do |arg_name, value|
+                if value.nil? || !value.is_a?(String)
+                    raise MobilePayFailure, "Invalid argument '#{arg_name}', must be string"
+                end
+            end
+        end
+    end
+end

data/lib/mobilepay/client/cancel_reservation.rb

@@ -0,0 +1,17 @@
+module Mobilepay
+    class Client
+        module CancelReservation
+
+            # Reservations_CancelReservation
+            # Cancels a specific reservation
+            def cancel_reservation(args = {})
+                check_args(order_id: args[:order_id])
+                response = call(:delete, "/reservations/merchants/#{merchant_id}/orders/#{args[:order_id]}", { body: '{}' })
+                JSON.parse(response.body)
+            rescue MobilePayFailure => ex
+                return { error: ex.message }
+            end
+
+        end
+    end
+end

data/lib/mobilepay/client/capture_amount.rb

@@ -0,0 +1,17 @@
+module Mobilepay
+    class Client
+        module CaptureAmount
+
+            # Reservations_CaptureAmount
+            # Captures a previously reserved amount, either in full or partially
+            def capture_amount(args = {})
+                check_args(order_id: args[:order_id])
+                response = call(:put, "/reservations/merchants/#{merchant_id}/orders/#{args[:order_id]}", { body: args[:body] || '{}' })
+                JSON.parse(response.body)
+            rescue MobilePayFailure => ex
+                return { error: ex.message }
+            end
+
+        end
+    end
+end

data/lib/mobilepay/client/payment_status.rb

@@ -0,0 +1,17 @@
+module Mobilepay
+    class Client
+        module PaymentStatus
+
+            # Merchants_GetPaymentStatus
+            # Gets the status of a given order
+            def payment_status(args = {})
+                check_args(order_id: args[:order_id])
+                response = call(:get, "/merchants/#{merchant_id}/orders/#{args[:order_id]}", { body: '{}' })
+                JSON.parse(response.body)
+            rescue MobilePayFailure => ex
+                return { error: ex.message }
+            end
+
+        end
+    end
+end

data/lib/mobilepay/client/payment_transactions.rb

@@ -0,0 +1,17 @@
+module Mobilepay
+    class Client
+        module PaymentTransactions
+
+            # Merchants_GetPaymentTransactions
+            # Gets the transactions for a given order
+            def payment_transactions(args = {})
+                check_args(order_id: args[:order_id])
+                response = call(:get, "/merchants/#{merchant_id}/orders/#{args[:order_id]}/transactions", { body: '{}' })
+                JSON.parse(response.body)
+            rescue MobilePayFailure => ex
+                return { error: ex.message }
+            end
+
+        end
+    end
+end

data/lib/mobilepay/client/refund_amount.rb

@@ -0,0 +1,17 @@
+module Mobilepay
+    class Client
+        module RefundAmount
+
+            # Merchants_RefundAmount
+            # Refunds an amount to the customer based on an order id
+            def refund_amount(args = {})
+                check_args(order_id: args[:order_id])
+                response = call(:put, "/merchants/#{merchant_id}/orders/#{args[:order_id]}", { body: args[:body] || '{}' })
+                JSON.parse(response.body)
+            rescue MobilePayFailure => ex
+                return { error: ex.message }
+            end
+
+        end
+    end
+end

data/lib/mobilepay/client/reservations.rb

@@ -0,0 +1,19 @@
+module Mobilepay
+    class Client
+        module Reservations
+
+            # Reservations_GetReservations
+            # Get the reservations for a particular date/time interval, and alternatively also for a specific customer
+            def reservations(args = {})
+                check_args(datetime_from: args[:datetime_from], datetime_to: args[:datetime_to])
+                address = "/reservations/merchants/#{merchant_id}/#{args[:datetime_from]}/#{args[:datetime_to]}"
+                address += "?customerId=#{args[:customer_id]}" if args[:customer_id]
+                response = call(:get, address, { body: '{}' })
+                JSON.parse(response.body)
+            rescue MobilePayFailure => ex
+                return { error: ex.message }
+            end
+
+        end
+    end
+end

data/lib/mobilepay/requests.rb

@@ -0,0 +1,35 @@
+require 'net/http'
+
+module Mobilepay
+    module Requests
+
+        private
+
+        def http_request(req, address, args = {})
+            uri = generate_uri(address)
+            req = generate_request(req, uri)
+            req = generate_headers(req, args[:body])
+            Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
+        end
+
+        def generate_uri(address = '')
+            URI("#{base_uri}#{address}")
+        end
+
+        def generate_request(req, uri)
+            case req
+                when :get then Net::HTTP::Get.new(uri)
+                when :put then Net::HTTP::Put.new(uri)
+                when :delete then Net::HTTP::Delete.new(uri)
+            end
+        end
+
+        def generate_headers(req, body)
+            req['Content-Type'] = 'application/json'
+            req['Ocp-Apim-Subscription-Key'] = subscription_key
+            req.body = body
+            req
+        end
+
+    end
+end

data/lib/mobilepay/security.rb

@@ -0,0 +1,33 @@
+require 'json'
+require_relative 'security/public_key'
+require_relative 'requests'
+
+module Mobilepay
+    class Security
+        include Mobilepay::Security::PublicKey
+        include Mobilepay::Requests
+
+        class SecurityFailure < StandardError; end
+
+        attr_reader :subscription_key, :base_uri
+
+        def initialize(args = {})
+            @subscription_key = args[:subscription_key] || ''
+            @base_uri = 'https://api.mobeco.dk/merchantsecurity/api'
+        end
+
+        private
+
+        def call
+            response = http_request(:get, '/publickey')
+            check_response(response)
+            response
+        end
+
+        def check_response(response)
+            if response.code != '200'
+                raise SecurityFailure, JSON.parse(response.body)['message']
+            end
+        end
+    end
+end

data/lib/mobilepay/security/public_key.rb

@@ -0,0 +1,16 @@
+module Mobilepay
+    class Security
+        module PublicKey
+
+            # Secutiry_PublicKey
+            # Get MobilePay's public key to use when signing up new merchants
+            def public_key
+                response = call
+                JSON.parse(response.body)
+            rescue SecurityFailure => ex
+                return { error: ex.message }
+            end
+
+        end
+    end
+end

data/lib/mobilepay/version.rb

@@ -1,3 +1,3 @@
 module Mobilepay
-    VERSION = '0.1.0'
+    VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mobilepay
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Anton Bogdanov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-20 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,6 +69,16 @@ files:
 - bin/console
 - bin/setup
 - lib/mobilepay.rb
+- lib/mobilepay/client.rb
+- lib/mobilepay/client/cancel_reservation.rb
+- lib/mobilepay/client/capture_amount.rb
+- lib/mobilepay/client/payment_status.rb
+- lib/mobilepay/client/payment_transactions.rb
+- lib/mobilepay/client/refund_amount.rb
+- lib/mobilepay/client/reservations.rb
+- lib/mobilepay/requests.rb
+- lib/mobilepay/security.rb
+- lib/mobilepay/security/public_key.rb
 - lib/mobilepay/version.rb
 - mobilepay.gemspec
 homepage: https://github.com/kortirso/mobilepay