saferpay_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57e63198c38d91722de6ac1dc0ee87fc2adb8dd4
+  data.tar.gz: f68068578a2a3144cf20f95b5e22e92405affa9f
+SHA512:
+  metadata.gz: ef3610c4065fe5e2ff6b70dce22402030858521c88a07a0f15a872c6ad85e623d1aec8daacf5f421e8dc9a14df195c1255f4822193ae9852b1de69999a7ce152
+  data.tar.gz: c4a9f611cd8ad82e16ebadff50942e7828eb3679526b599cc4a7b7f394782a8117cdaf9821f978f3c6d6d96272e5b1992f01d0baf5184649dcc10d4186f10529

data/.gitignore

@@ -0,0 +1,11 @@
+/.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/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

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 nischay.dhiman@weboniselab.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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in saferpay_ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    saferpay_ruby (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  saferpay_ruby!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 nischay
+
+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,129 @@
+# SaferpayRuby
+
+Saferpay JSON application programming interface with a ruby API wrapper built with Net::HTTP
+
+Saferpay API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. Saferpay use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients. JSON will be returned in all responses from the API, including errors.
+
+You can contact Saferpay to get ahold of your documentation PDF. Ask for the Payment Page integration documentation.
+
+
+For more information about Saferpay API, please visit
+[https://saferpay.github.io/jsonapi](https://saferpay.github.io/jsonapi)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'saferpay_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install saferpay_ruby
+
+## Usage
+
+Following are brief instructions to create and setup a saferpay account for testing.
+
+
+Firstly You'll need to create a test account on [https://test.saferpay.com](https://test.saferpay.com)
+
+
+For Production use [https://myportal.six-payment-services.com/](https://myportal.six-payment-services.com/merchantportal/?login&isiweblang=en)
+
+
+After Logging in, Go to Settings Section,
+
+
+You'll need to create a Payment Mean / Terminal, Remember to fetch terminalId and customerId.
+
+
+Add JSON API basic authentication, returning username and password, which will base 64 encoded and then used as authentication header in API
+
+
+Configure the credentials in saferpay_ruby.rb in initializers as follows:
+
+```
+SaferpayRuby.configure do |config|
+  config.endpoint = URI('https://test.saferpay.com/api/Payment/v1/PaymentPage/Initialize')
+  #config.endpoint = URI('https://www.saferpay.com/api/Payment/v1/PaymentPage/Initialize')  # For production
+  config.assert_endpoint = URI('https://test.saferpay.com/api/Payment/v1/PaymentPage/Assert')
+  config.terminal_id = "17989968"
+  config.customer_id = "240918"
+  config.authentication = 'Basic QVBJlzI0OTYxOF84OTI0Mzc2MDpXZWJvbmlzZUxhYkRvdEMpbQ=='
+end
+```
+
+Transaction Flow
+```
+  Step 1: Payment Page Initialize
+    > Initializes the Payment and generates the RedirectUrl for the Payment Page.
+  Step 2: Redirect to the RedirectUrl
+  Step 3: Return to ReturnUrl depending on the outcome of the transaction. The ReturnUrls are defined in step 1!
+  Step 4: Payment Page Assert
+    >Gathers all the information about the payment, like LiabilityShift through 3D Secure and more, using the Token, gathered in step 1!
+  Step 5: Depending on the outcome of step 4 you may
+    > Capture/Finalize the Transaction
+    > Cancel/Abort the Transaction
+  Step 6: Transaction is finished!
+```
+Note: We have only covered Step 1 to Step 4
+
+
+```
+  def initialize_payment
+    options = {
+      payment_methods: [params[:payment_method]],
+      amount: 150 * 100,
+      currency: 'EUR',
+      order_id: '123123',
+      description: 'Payment description',
+      request_id: "33e8af17-35c1-4165-a343-c1c86a320f3b"
+    }
+    service = SaferpayRuby::PaymentGatewayApi.new(
+      success_url: "http://localhost:3010/success?order_id=1231&user_id=22",
+      failure_url: "http://localhost:3010/failure?order_id=1231&user_id=22"
+    )
+    response = service.initialize_payment_api(options)
+
+    initialize_assert_api(response, request_id)           #initialize assert API in redirect URL method
+
+    # save the details of transaction response
+  end
+
+  def initialize_assert_api(response, request_id)
+    # Record the transaction response whether it is success or failure
+    options = {
+      request_id: request_id,
+      token: response['Token']
+    }
+    service = SaferpayRuby::PaymentGatewayApi.new
+    response = service.initialize_payment_assert_api(options)
+    response_json = JSON.parse(response.read_body)
+  end
+```
+
+
+## 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/[nischay-dhiman]/saferpay_ruby. 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.
+
+## 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 SaferpayRuby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[nischay-dhiman]/saferpay_ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "saferpay_ruby"
+
+# 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/saferpay_ruby.rb

@@ -0,0 +1,76 @@
+require "saferpay_ruby/version"
+require "saferpay_ruby/configuration"
+
+module SaferpayRuby
+  extend Configuration
+  class Error < StandardError; end
+
+  class PaymentGatewayApi
+    attr_accessor *Configuration::VALID_CONFIG_KEYS
+ 
+    def initialize(options = {})
+      options.delete(:endpoint)
+      options.delete_if { |k, v| v.nil? }
+      @options = SaferpayRuby.options.merge(options)
+
+      @options.each_pair do |key, val|
+        send "#{key}=", val
+      end
+    end
+
+    def initialize_payment_api(options = {})
+      http = Net::HTTP.new(endpoint.host, endpoint.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  
+      request = Net::HTTP::Post.new(endpoint)
+      request["content-type"] = 'application/json; charset=utf-8'
+      request["accept"] = 'application/json'
+      request["authorization"] = authentication
+
+      request.body = {
+        "RequestHeader": {
+          "SpecVersion": "1.7",
+          "CustomerId": customer_id,
+          "RequestId": options[:request_id],
+          "RetryIndicator": 0
+        },
+        "TerminalId": terminal_id,
+        "Payment": {
+          "Amount": {
+            "Value": options[:amount],
+            "CurrencyCode": options[:currency]
+          },
+          "OrderId": options[:order_id],
+          "Description": options[:description]
+        },
+        "PaymentMethods": options[:payment_methods],
+        "ReturnUrls": {
+          "Success": success_url,
+          "Fail": failure_url
+        }
+      }.to_json
+      http.request(request)
+    end
+
+    def initialize_payment_assert_api(options = {})
+      http = Net::HTTP.new(assert_endpoint.host, assert_endpoint.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      request = Net::HTTP::Post.new(assert_endpoint)
+      request["content-type"] = 'application/json; charset=utf-8'
+      request["accept"] = 'application/json'
+      request["authorization"] = authentication
+      request.body = {
+        "RequestHeader": {
+          "SpecVersion": "1.15",
+          "CustomerId": customer_id,
+          "RequestId": options[:request_id],
+          "RetryIndicator": 0
+        },
+        "Token": options[:token]
+      }.to_json
+      http.request(request)
+    end
+  end
+end

data/lib/saferpay_ruby/configuration.rb

@@ -0,0 +1,39 @@
+module SaferpayRuby
+  module Configuration
+    DEFAULTS = {
+      endpoint: URI('https://test.saferpay.com/api/Payment/v1/PaymentPage/Initialize'),
+      user_agent: 'Saferpay Ruby Library',
+      terminal_id: "1111111",
+      customer_id: "2222222", 
+      authentication: 'Basic PVBJXzI0OTYxOF84OTI0Mzc2MDpXZWJvbmlzZUxhYkRvdEMwbQ==',  # Base 64 encoded string of 'username:password'
+      success_url: "http://localhost:3010/",
+      failure_url: "http://localhost:3010/",
+      back_link: nil,
+      notify_url: nil,
+    }.freeze
+
+    VALID_CONFIG_KEYS = DEFAULTS.keys.freeze
+
+    # Build accessor methods for every config options so we can do this, for example: Saferpay.account_id = 'xxxxx'
+    attr_accessor *VALID_CONFIG_KEYS
+
+    def options
+      @options = Hash[ * DEFAULTS.map { |key, val| [key, send(key)] }.flatten ].freeze
+    end
+
+    # Make sure we have the default values set when we get 'extended'
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      options.each_pair do |key, val|
+        send "#{key}=", DEFAULTS[key]
+      end
+    end
+
+    def configure
+      yield self
+    end
+  end
+end

data/lib/saferpay_ruby/version.rb

@@ -0,0 +1,3 @@
+module SaferpayRuby
+  VERSION = "0.1.0"
+end

data/saferpay_ruby.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "saferpay_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "saferpay_ruby"
+  spec.version       = SaferpayRuby::VERSION
+  spec.authors       = ["nischay"]
+  spec.email         = ["nischay.dhiman@gmail.com"]
+
+  spec.summary       = "Saferpay JSON application programming interface with a ruby API wrapper built with Net::HTTP "
+  spec.description   = "
+  Saferpay JSON application programming interface with a ruby API wrapper built with Net::HTTP
+
+  Saferpay API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. Saferpay use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients. JSON will be returned in all responses from the API, including errors."
+  spec.homepage      = "https://github.com/nischay-dhiman/saferpay_ruby"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/nischay-dhiman/saferpay_ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/nischay-dhiman/saferpay_ruby"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: saferpay_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nischay
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |2-
+
+    Saferpay JSON application programming interface with a ruby API wrapper built with Net::HTTP
+
+    Saferpay API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. Saferpay use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients. JSON will be returned in all responses from the API, including errors.
+email:
+- nischay.dhiman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/saferpay_ruby.rb
+- lib/saferpay_ruby/configuration.rb
+- lib/saferpay_ruby/version.rb
+- saferpay_ruby.gemspec
+homepage: https://github.com/nischay-dhiman/saferpay_ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/nischay-dhiman/saferpay_ruby
+  source_code_uri: https://github.com/nischay-dhiman/saferpay_ruby
+  changelog_uri: https://github.com/nischay-dhiman/saferpay_ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Saferpay JSON application programming interface with a ruby API wrapper built
+  with Net::HTTP
+test_files: []