pay_u 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5da37021ad0126ffb8adb641a058d99afbb7db8ee5910ee1941149ec8c0f609
+  data.tar.gz: e1b7a2fab724cff1825ec14293f0f7c39b6797ae35f4400911de3a860181e2ac
+SHA512:
+  metadata.gz: 6a02f9bf74a152b829cea24cb3427073f54496912f5c38ffa3b06117a4d9580d0c82cfdf2ef56f0b0fed8a4dbb9e1a433ce9745d5b3e0c15a125bbcd816d9c94
+  data.tar.gz: 92a636bcf0b22857520cc78ba89a85130b1a68624ad5e36282f00e898be21c00c43b66b261cffe83c82fdcf2109488cbe5f1321cbcabd1b1e0e40750f2ae2686

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.5
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in payu.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    pay_u (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  pay_u!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 michal.kosyk
+
+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,141 @@
+# PayU
+
+A lightweight client for PayU's payment system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'payu'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install payu
+
+## Usage
+
+First - read the API documentation here: `http://developers.payu.com/en/restapi.html#overview` to get a grip of what this client does.
+Configure the library with your PayU Merchant configuration. You can do it like this in `config/initializers/pay_u`:
+
+```
+PayU.configure do |c|
+  c.pos_id = ENV['PAY_U_POS_ID']
+  c.second_key = ENV['PAY_U_SECOND_KEY']
+  c.oauth_client_id = ENV['PAY_U_OAUTH_CLIENT_ID']
+  c.oauth_client_secret = ENV['PAY_U_OAUTH_CLIENT_SECRET']
+  c.env = 'sandbox' # optional, it defaults to 'production'
+  c.notify_url = 'https://example.com'
+end
+```
+
+After that, you are free to use it. The main concern here is the PayU::Client which is accessible throught `PayU.client` method.
+
+Available functionality:
+
+### Placing orders
+
+```
+  meta = {
+    "customer_ip": "127.0.0.1",
+    "description": "RTV market",
+    "currency_code": "PLN",
+    "total_amount": "15000",
+    "ext_order_id":"XEGB34325" # your order's id
+  }
+
+  buyer = {
+    email: "john.doe@example.com",
+    phone: "654111654",
+    first_name: "John",
+    last_name: "Doe"
+  }
+
+  products = [
+    {
+      name: "Wireless Mouse for Laptop",
+      unit_price: "15000",
+      quantity: "1"
+    }
+  ]
+
+  total_amount = "15000"
+
+  response = PayU.client.place_order(buyer, products, total_amount, meta)
+
+  response.success?
+  #=> true
+  response.order_id
+  #=> "WZHF5FFDRJ140731GUEST000P01"
+  response.ext_order_id
+  #=> "XEGB34325"
+  response.redirect_url
+  #=> # this will return a redirection url to PayU
+```
+
+Which will return a `PayU::Orders::Response` object which wraps up everything from the response.
+
+### Refunding orders
+
+```
+  order_id = "WZHF5FFDRJ140731GUEST000P01"
+  amount = 15000 # optional
+
+  response = PayU.client.refund_order(order_id, amount = nil)
+
+  response.success?
+  #=> true
+  response.ext_order_id
+  #=> "XEGB34325"
+  response.order_id
+  #=> "WZHF5FFDRJ140731GUEST000P01"
+```
+
+### Canceling Orders
+
+```
+  order_id = "WZHF5FFDRJ140731GUEST000P01"
+
+  response = PayU.client.cancel_order(order_id)
+
+  response.success?
+  #=> true
+  response.ext_order_id
+  #=> "XEGB34325"
+  response.order_id
+  #=> "WZHF5FFDRJ140731GUEST000P01"
+```
+
+## 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).
+
+## Testing
+
+To run RSpec, you need to set up environment variables for PayU. For that, you need to get necessary secrets for a Sandbox account at http://developers.payu.com/en/overview.html.
+
+After registering your account and creating your test shop, you can then run the tests and add functionality (WRITE THE TESTS).
+
+Add those to your `bash_profile` or any other environment variables manager of your choice.
+
+```
+export PAY_U_POS_ID=<POS_ID>
+export PAY_U_SECOND_KEY=<SECOND_KEY>
+export PAY_U_OAUTH_CLIENT_ID=<CLIENT_ID>
+export PAY_U_OAUTH_CLIENT_SECRET=<CLIENT_SECRET>
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/payu.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "payu"
+
+PayU.configure do |c|
+  c.pos_id = ENV['PAY_U_POS_ID']
+  c.second_key = ENV['PAY_U_SECOND_KEY']
+  c.oauth_client_id = ENV['PAY_U_OAUTH_CLIENT_ID']
+  c.oauth_client_secret = ENV['PAY_U_OAUTH_CLIENT_SECRET']
+  c.env = 'sandbox'
+  c.notify_url = 'https://example.com'
+end
+
+# 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/pay_u/base_request.rb

@@ -0,0 +1,63 @@
+module PayU
+  class BaseRequest
+    def initialize(headers, json_params = {})
+      @headers = headers
+      @keys = []
+      json_params.each_pair do |key, value|
+        @keys << key
+        define_singleton_method(key) do
+          value
+        end
+      end
+    end
+
+    attr_reader :headers
+
+    def to_h
+      result = {}
+      @keys.each do |key|
+        result.merge!(camelize_key(key, false) => camelized_value(send(key)))
+      end
+      result
+    end
+
+    def to_json
+      to_h.to_json
+    end
+
+    private
+
+    def camelized_value(value)
+      if value.respond_to?(:each_pair)
+        camelize_keys(value)
+      elsif value.respond_to?(:each)
+        camelize_array(value)
+      else
+        value
+      end
+    end
+
+    def camelize_array(array)
+      array.map do |element|
+        camelize_keys(element)
+      end
+    end
+
+    def camelize_keys(hash)
+      camelized_hash = {}
+      hash.each_pair do |key, value|
+        camelized_hash[camelize_key(key, false)] = value
+      end
+      camelized_hash
+    end
+
+    def camelize_key(key, capitalize)
+      index = capitalize ? 0 : 1
+      stringified_key = key.to_s
+      stringified_key.split('_').each_with_index.map do |str, i|
+        index <= i ? str.capitalize : str
+      end.join('').to_sym
+    end
+  end
+end
+

data/lib/pay_u/client.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative 'o_auth/authorization'
+require_relative 'orders/service'
+require_relative 'base_request'
+
+module PayU
+  class Client
+    def initialize(configuration, http_client)
+      @configuration = configuration
+      @http_client = http_client
+    end
+
+    def authorize
+      authorization.authorize
+    end
+
+    def place_order(buyer, products, total_amount, meta = {})
+      request_hash = order_meta(meta).merge({ buyer: buyer,
+                                              products: products,
+                                              total_amount: total_amount })
+
+      request = PayU::BaseRequest.new(headers, request_hash)
+      orders_service.place_order(request)
+    end
+
+    def refund_order(order_id, amount = nil)
+      request_hash = { refund: { description: "Refund" } }.merge(refund_amount(amount))
+      orders_service.refund_order(order_id, PayU::BaseRequest.new(headers, request_hash))
+    end
+
+    def cancel_order(order_id)
+      orders_service.cancel_order(order_id, PayU::BaseRequest.new(headers))
+    end
+
+    private
+
+    def refund_amount(amount)
+      amount.nil? ? {} : { amount: amount }
+    end
+
+    def order_meta(meta)
+      default_order_params.merge(meta)
+    end
+
+    def orders_service
+      @orders_service ||= Orders::Service.new(@http_client)
+    end
+
+    def default_order_params
+      { notify_url: @configuration.notify_url, merchant_pos_id: @configuration.pos_id }
+    end
+
+    def authorization
+      @authorization ||= OAuth::Authorization.new(@http_client,
+                                                  @configuration.oauth_client_id,
+                                                  @configuration.oauth_client_secret)
+    end
+
+    def headers
+      { "Authorization" => "Bearer #{authorization.access_token}" }
+    end
+  end
+end
+

data/lib/pay_u/http_client.rb

@@ -0,0 +1,42 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module PayU
+  class HttpClient
+    DEFAULT_HEADER = { "Content-Type" => "application/json" }
+
+    def initialize(host)
+      @host = formatted_url(host)
+    end
+
+    def post_form(path, params)
+      response = Net::HTTP.post_form(uri(path), params)
+      parse_json(response.body)
+    end
+
+    def post(path, request)
+      Net::HTTP.post(uri(path), request.to_json, DEFAULT_HEADER.merge(request.headers))
+    end
+
+    def delete(path, request)
+      NET::HTTP.delete(path, DEFAULT_HEADER.merge(request.headers))
+    end
+
+    private
+
+    def parse_json(json_string)
+      JSON.parse(json_string)
+    end
+
+    def uri(path)
+      URI(@host + path)
+    end
+
+    def formatted_url(url)
+      url.chomp('/')
+    end
+  end
+end
+
+

data/lib/pay_u/o_auth/authorization.rb

@@ -0,0 +1,39 @@
+require_relative "response"
+
+module PayU
+  module OAuth
+    class UnauthorizedError < StandardError; end
+
+    class Authorization
+      GRANT_TYPE = "client_credentials"
+      ENDPOINT = "/pl/standard/user/oauth/authorize"
+
+      def initialize(http_client, client_id, client_secret)
+        @http_client = http_client
+        @client_id = client_id
+        @client_secret = client_secret
+      end
+
+      def access_token
+        response = authorize
+        raise UnauthorizedError unless response.success?
+        authorize.access_token
+      end
+
+      def authorize
+        OAuth::Response.new(fetch_response)
+      end
+
+      private
+
+      def fetch_response
+        @http_client.post_form(ENDPOINT, authorization_options)
+      end
+
+      def authorization_options
+        { grant_type: GRANT_TYPE, client_id: @client_id, client_secret: @client_secret }
+      end
+    end
+  end
+end
+

data/lib/pay_u/o_auth/response.rb

@@ -0,0 +1,18 @@
+module PayU
+  module OAuth
+    class Response
+      def initialize(response_body)
+        @response_body = response_body
+      end
+
+      def success?
+        @response_body["error"].nil?
+      end
+
+      def access_token
+        @response_body["access_token"]
+      end
+    end
+  end
+end
+

data/lib/pay_u/orders/response.rb

@@ -0,0 +1,61 @@
+require 'json'
+
+module PayU
+  module Orders
+    class Response
+      def initialize(response)
+        @response = response
+        @body = JSON.parse(response.body)
+      end
+
+      def code
+        @response.code
+      end
+
+      def success?
+        status.success?
+      end
+
+      def status
+        Status.new(@body['status'])
+      end
+
+      def redirect_url
+        @body['redirectUri']
+      end
+
+      def order_id
+        @body['orderId']
+      end
+
+      def ext_order_id
+        @body['extOrderId']
+      end
+
+      class Status
+        SUCCESS_STATUS = 'SUCCESS'
+
+        def initialize(status)
+          @status = status
+        end
+
+        def success?
+          status_code == SUCCESS_STATUS
+        end
+
+        def status_code
+          @status['statusCode']
+        end
+
+        def code_literal
+          @status['codeLiteral']
+        end
+
+        def code
+          @status['code']
+        end
+      end
+    end
+  end
+end
+

data/lib/pay_u/orders/service.rb

@@ -0,0 +1,32 @@
+require_relative 'response'
+
+module PayU
+  module Orders
+    class Service
+      ENDPOINT = "/api/v2_1/orders"
+
+      def initialize(http_client)
+        @http_client = http_client
+      end
+
+      def place_order(request)
+        Orders::Response.new(
+          @http_client.post(ENDPOINT, request)
+        )
+      end
+
+      def refund_order(order_id, request)
+        Orders::Response.new(
+          @http_client.post("#{ENDPOINT}/#{order_id}/refunds", request)
+        )
+      end
+
+      def cancel_order(order_id, request)
+        Orders::Response.new(
+          @http_client.delete("#{ENDPOINT}/#{order_id}", request)
+        )
+      end
+    end
+  end
+end
+

data/lib/pay_u/version.rb

@@ -0,0 +1,3 @@
+module PayU
+  VERSION = "0.4.0"
+end

data/lib/payu.rb

@@ -0,0 +1,38 @@
+require "pay_u/version"
+require "pay_u/client"
+require "pay_u/http_client"
+
+module PayU
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration, :client
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+    self.client = Client.new(configuration, HttpClient.new(configuration.host))
+  end
+
+  class Configuration
+    PRODUCTION_ENV_NAME = "production"
+    SANDBOX_HOST_URI = "https://secure.snd.payu.com/"
+    PRODUCTION_HOST_URI = "https://secure.payu.com/"
+
+    attr_accessor :pos_id, :second_key, :oauth_client_id, :oauth_client_secret, :env, :notify_url
+
+    def initialize
+      @env = PRODUCTION_ENV_NAME
+    end
+
+    def host
+      production? ? PRODUCTION_HOST_URI : SANDBOX_HOST_URI
+    end
+
+    def production?
+      @env == PRODUCTION_ENV_NAME
+    end
+  end
+end
+

data/payu.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pay_u/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pay_u"
+  spec.version       = PayU::VERSION
+  spec.authors       = ["michal.kosyk"]
+  spec.email         = ["michal.kosyk@naturaily.com"]
+
+  spec.summary       = "PayU client"
+  spec.description   = "PayU API client"
+  spec.homepage      = "https://naturaily.eu"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://naturaily.eu"
+    spec.metadata["changelog_uri"] = "https://naturaily.eu"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", '~> 0'
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: pay_u
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- michal.kosyk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '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: PayU API client
+email:
+- michal.kosyk@naturaily.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pay_u/base_request.rb
+- lib/pay_u/client.rb
+- lib/pay_u/http_client.rb
+- lib/pay_u/o_auth/authorization.rb
+- lib/pay_u/o_auth/response.rb
+- lib/pay_u/orders/response.rb
+- lib/pay_u/orders/service.rb
+- lib/pay_u/version.rb
+- lib/payu.rb
+- payu.gemspec
+homepage: https://naturaily.eu
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://naturaily.eu
+  source_code_uri: https://naturaily.eu
+  changelog_uri: https://naturaily.eu
+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.7.6
+signing_key: 
+specification_version: 4
+summary: PayU client
+test_files: []