multisafepay-ruby-wrapper 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9940155336a4cbf2c000893eff941266a112520c59bd5036b340ada9128dc0f4
+  data.tar.gz: 98453a0727f386ea277400992422e9f0ed6b3d184740d8cfe2eb66b122114941
+SHA512:
+  metadata.gz: d5641b717f15ab4b519a435facec46e1c24170903cc40333e6ce40e37799b0254c0c3c5cc903e1e276d40e968de8c288ecaf42f08cb40766b6808b0fff6804dd
+  data.tar.gz: fd9996ad99b79d06d5874db4f9354267ecf33a30d4f8bc585d158f6734c603b6704afad2abe12a0c45938bac8d06f5d9d31edb6280573370e229db3df9e5b97e

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake"
+gem "rspec", "~> 3.0"
+gem "standard"

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    multisafepay-ruby-wrapper (0.2.0)
+      faraday (~> 1.7)
+      faraday_middleware (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    faraday (1.7.1)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.1.0)
+      faraday (~> 1.0)
+    multipart-post (2.1.1)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.5)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    standard (1.3.0)
+      rubocop (= 1.20.0)
+      rubocop-performance (= 1.11.5)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  multisafepay-ruby-wrapper!
+  rake
+  rspec (~> 3.0)
+  standard
+
+BUNDLED WITH
+   2.2.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Diego
+
+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,66 @@
+<p align="center">
+  <img src="https://www.multisafepay.com/img/multisafepaylogo.svg" width="400px" position="center">
+</p>
+
+# Unofficial Ruby wrapper for the MultiSafepay API
+
+This wrapper simplifies working with the MultiSafepay API and allows you to integrate MultiSafepay within your Ruby application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'multisafepay-ruby-multisafepay'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install multisafepay-ruby-wrapper
+
+## Usage
+Setup the client for testing
+```ruby
+client = Multisafepay::Client.new(api_key: 'REPLACE WITH API KEY', env: :test)
+```
+Creating a test order
+```ruby
+# The following code will create a iDEAL order
+client.orders.create({
+  type: "redirect",
+  order_id: "my-order-id-1",
+  gateway: "IDEAL",
+  currency: "EUR",
+  amount: "1000",
+  description: "Test Order Description",
+  payment_options: {
+      notification_url: "https://www.example.com/client/notification?type=notification",
+      redirect_url: "https://www.example.com/client/notification?type=redirect",
+      cancel_url: "https://www.example.com/client/notification?type=cancel"
+  },
+  customer: {
+      locale: "en_US"
+  }
+})
+```
+Click [here](#) for more examples.
+## 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 the created tag, 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/denjamio/multisafepay-ruby-wrapper.
+
+## API Documentation
+[Click here](https://docs.multisafepay.com/api/) for the MultiSafepay API documentation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "multisafepay-ruby-wrapper"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+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

data/lib/multisafepay/client.rb

@@ -0,0 +1,54 @@
+module Multisafepay
+  class Client
+    attr_reader :api_key, :env, :adapter
+
+    def initialize(api_key: nil, env: :live, adapter: Faraday.default_adapter)
+      @api_key = api_key
+      @env = env
+      @adapter = adapter
+    end
+
+    def account
+      AccountResource.new(self)
+    end
+
+    def gateways
+      GatewaysResource.new(self)
+    end
+
+    def orders
+      OrdersResource.new(self)
+    end
+
+    def tokens
+      TokensResource.new(self)
+    end
+
+    def transactions
+      TransactionsResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new do |conn|
+        conn.url_prefix = base_url
+        conn.headers["api_key"] = api_key
+        conn.request :json
+
+        conn.response :json, content_type: "application/json"
+
+        conn.adapter adapter
+      end
+    end
+
+    private
+
+    def base_url
+      case env
+      when :live
+        "https://api.multisafepay.com/v1/json"
+      when :test
+        "https://testapi.multisafepay.com/v1/json"
+      end
+    end
+  end
+end

data/lib/multisafepay/error.rb

@@ -0,0 +1,4 @@
+module Multisafepay
+  class Error < StandardError
+  end
+end

data/lib/multisafepay/object.rb

@@ -0,0 +1,22 @@
+require "ostruct"
+
+module Multisafepay
+  class Object
+    def initialize(attributes)
+      @attributes = OpenStruct.new(attributes)
+    end
+
+    def success?
+      @attributes.success
+    end
+
+    def method_missing(method, *args, &block)
+      attribute = @attributes.send(method, *args, &block)
+      attribute.is_a?(Hash) ? Object.new(attribute) : attribute
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      true
+    end
+  end
+end

data/lib/multisafepay/objects/account.rb

@@ -0,0 +1,4 @@
+module Multisafepay
+  class Account < Object
+  end
+end

data/lib/multisafepay/objects/gateway.rb

@@ -0,0 +1,4 @@
+module Multisafepay
+  class Gateway < Object
+  end
+end

data/lib/multisafepay/objects/order.rb

@@ -0,0 +1,4 @@
+module Multisafepay
+  class Order < Object
+  end
+end

data/lib/multisafepay/objects/token.rb

@@ -0,0 +1,4 @@
+module Multisafepay
+  class Token < Object
+  end
+end

data/lib/multisafepay/objects/transaction.rb

@@ -0,0 +1,4 @@
+module Multisafepay
+  class Transaction < Object
+  end
+end

data/lib/multisafepay/resource.rb

@@ -0,0 +1,48 @@
+module Multisafepay
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, headers)
+    end
+
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Request malformed. #{response.body["error"]}"
+      when 401
+        raise Error, "Invalid api_key. #{response.body["error"]}"
+      when 403
+        raise Error, "Action not allowed. #{response.body}"
+      when 404
+        raise Error, "No results. #{response.body["error"]}"
+      when 500
+        raise Error, "Unable to perform the request due to server-side problems. #{response.body["error"]}"
+      end
+
+      response.body
+    end
+  end
+end

data/lib/multisafepay/resources/account.rb

@@ -0,0 +1,15 @@
+module Multisafepay
+  class AccountResource < Resource
+    def balances(affiliated_id:)
+      Account.new get_request("accounts/#{affiliated_id}/balances")
+    end
+
+    def charges(affiliated_id:, **attributes)
+      Account.new post_request("accounts/#{affiliated_id}/charges", body: attributes)
+    end
+
+    def payouts(affiliated_id:, **attributes)
+      Account.new post_request("accounts/#{affiliated_id}/payouts", body: attributes)
+    end
+  end
+end

data/lib/multisafepay/resources/gateways.rb

@@ -0,0 +1,11 @@
+module Multisafepay
+  class GatewaysResource < Resource
+    def list
+      Gateway.new get_request("gateways")
+    end
+
+    def retrieve(id)
+      Gateway.new get_request("gateways/#{id}")
+    end
+  end
+end

data/lib/multisafepay/resources/orders.rb

@@ -0,0 +1,19 @@
+module Multisafepay
+  class OrdersResource < Resource
+    def retrieve(id)
+      Order.new get_request("orders/#{id}")
+    end
+
+    def create(**attributes)
+      Order.new post_request("orders", body: attributes)
+    end
+
+    def update(id:, **attributes)
+      Order.new patch_request("orders/#{id}", body: attributes)
+    end
+
+    def delete(id:, **attributes)
+      Order.new patch_request("orders/#{id}", body: attributes)
+    end
+  end
+end

data/lib/multisafepay/resources/tokens.rb

@@ -0,0 +1,20 @@
+module Multisafepay
+  class TokensResource < Resource
+    def create
+      Token.new get_request("auth/api_token")
+    end
+
+    def retrieve(your_customer_reference:, your_token: nil)
+      url = your_token.nil? ? "recurring/#{your_customer_reference}" : "recurring/#{your_customer_reference}/token/#{your_token}"
+      Token.new get_request(url)
+    end
+
+    def update(your_customer_reference:, your_token:, **attributes)
+      Token.new patch_request("recurring/#{your_customer_reference}/update/#{your_token}", body: attributes)
+    end
+
+    def delete(your_customer_reference:, your_token:)
+      Token.new delete_request("recurring/#{your_customer_reference}/token/#{your_token}")
+    end
+  end
+end

data/lib/multisafepay/resources/transactions.rb

@@ -0,0 +1,7 @@
+module Multisafepay
+  class TransactionsResource < Resource
+    def list
+      Transaction.new get_request("transactions")
+    end
+  end
+end

data/lib/multisafepay/version.rb

@@ -0,0 +1,3 @@
+module Multisafepay
+  VERSION = "0.2.0".freeze
+end

data/lib/multisafepay-ruby-wrapper.rb

@@ -0,0 +1,22 @@
+require "faraday"
+require "faraday_middleware"
+require "multisafepay/version"
+
+module Multisafepay
+  autoload :Client, "multisafepay/client"
+  autoload :Error, "multisafepay/error"
+  autoload :Object, "multisafepay/object"
+  autoload :Resource, "multisafepay/resource"
+
+  autoload :AccountResource, "multisafepay/resources/account"
+  autoload :GatewaysResource, "multisafepay/resources/gateways"
+  autoload :OrdersResource, "multisafepay/resources/orders"
+  autoload :TokensResource, "multisafepay/resources/tokens"
+  autoload :TransactionsResource, "multisafepay/resources/transactions"
+
+  autoload :Account, "multisafepay/objects/account"
+  autoload :Gateway, "multisafepay/objects/gateway"
+  autoload :Order, "multisafepay/objects/order"
+  autoload :Token, "multisafepay/objects/token"
+  autoload :Transaction, "multisafepay/objects/transaction"
+end

data/multisafepay-ruby-wrapper.gemspec

@@ -0,0 +1,25 @@
+require_relative "lib/multisafepay/version"
+
+Gem::Specification.new do |gem|
+  gem.name = "multisafepay-ruby-wrapper"
+  gem.version = Multisafepay::VERSION
+  gem.authors = ["Diego"]
+  gem.email = ["denjamio@gmail.com"]
+
+  gem.summary = "Unofficial MultiSafePay API Library for Ruby"
+  gem.description = "Unofficial MultiSafePay API Library for Ruby. Simplifies integrating with the MultiSafePay API."
+  gem.homepage = "https://github.com/denjamio/multisafepay-ruby-wrapper"
+  gem.license = "MIT"
+
+  gem.required_ruby_version = ">= 2.3"
+
+  gem.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  gem.executables = gem.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "faraday", "~> 1.7"
+  gem.add_dependency "faraday_middleware", "~> 1.1"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: multisafepay-ruby-wrapper
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Diego
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Unofficial MultiSafePay API Library for Ruby. Simplifies integrating
+  with the MultiSafePay API.
+email:
+- denjamio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/multisafepay-ruby-wrapper.rb
+- lib/multisafepay/client.rb
+- lib/multisafepay/error.rb
+- lib/multisafepay/object.rb
+- lib/multisafepay/objects/account.rb
+- lib/multisafepay/objects/gateway.rb
+- lib/multisafepay/objects/order.rb
+- lib/multisafepay/objects/token.rb
+- lib/multisafepay/objects/transaction.rb
+- lib/multisafepay/resource.rb
+- lib/multisafepay/resources/account.rb
+- lib/multisafepay/resources/gateways.rb
+- lib/multisafepay/resources/orders.rb
+- lib/multisafepay/resources/tokens.rb
+- lib/multisafepay/resources/transactions.rb
+- lib/multisafepay/version.rb
+- multisafepay-ruby-wrapper.gemspec
+homepage: https://github.com/denjamio/multisafepay-ruby-wrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Unofficial MultiSafePay API Library for Ruby
+test_files: []