barzahlen 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d22d4228515d62a086a459066ed7d35a5fa596fb
-  data.tar.gz: add4528a9bb87a690c17609c81831f384bc9a06c
+  metadata.gz: ba4379a6be0c31f8284c55d814bf82c97aa4a011
+  data.tar.gz: 9f28715903860a7685dc5fc32c0e734322b376ca
 SHA512:
-  metadata.gz: bf406f3231504cd7c6047a5df34e3f4253d1a79e4a730323cfd92718f54b7380a9fb8cc90624f37d3d28c2d74a3a727a12a347978a968e1401597caefae24854
-  data.tar.gz: 5f9ca948df4a0fdb4c032eaf11271b61456b0c89008d7bce56b2bac805b49ebb10f9f7ecf3bf33897bdbfecd3bb9e44a96ddc50a46ff61b4f1c81f80d87b57a3
+  metadata.gz: 399821910a344a8568298987061ba410fc5a4917c89f0dcad08c8e395570546c2eca6f3f2abd5c99186221d7ae0e1db5fef121354f3cd0f7504ad3d8c8c671f0
+  data.tar.gz: 671aa7a285cbda33132585721adcee37c8002067dc18e2d7da076d8266ca518d41af087b0c9d74a22dfc9b47ea5080aa0f1df0fec618afd46a93ea4dfbc0ff1a

data/lib/barzahlen.rb

@@ -0,0 +1,7 @@
+require "grac"
+
+require_relative "./barzahlen/version"
+require_relative "./barzahlen/error"
+require_relative "./barzahlen/configuration"
+require_relative "./barzahlen/middleware"
+require_relative "./barzahlen/slip"

data/lib/barzahlen/configuration.rb

@@ -0,0 +1,32 @@
+module Barzahlen
+  class Configuration
+    API_HOST = "https://api.barzahlen.de/v2"
+    API_HOST_SANDBOX = "https://api-sandbox.barzahlen.de/v2"
+
+    attr_accessor :sandbox
+    attr_accessor :division_id
+    attr_accessor :payment_key
+
+    def initialize
+      @sandbox = false
+      @division_id = "not_valid_division_id"
+      @payment_key = "not_valid_payment_key"
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/barzahlen/error.rb

@@ -0,0 +1,116 @@
+require "json"
+
+module Barzahlen
+  module Error
+    class ClientError < StandardError
+      attr_reader :error_message
+
+      def initialize(error_message)
+        @error_message = error_message
+      end
+
+      def message
+        return @error_message
+      end
+
+      alias_method :to_s, :message
+    end
+
+    class SignatureError < ClientError; end
+
+    class ApiError < StandardError
+      attr_reader :error_class
+      attr_reader :error_code
+      attr_reader :error_message
+      attr_reader :documentation_url
+      attr_reader :request_id
+
+      def initialize(error_hash = {})
+        @error_class = error_hash[:error_class]
+        @error_code = error_hash[:error_code]
+        @error_message = error_hash[:message]
+        @documentation_url = error_hash[:documentation_url]
+        @request_id = error_hash[:request_id]
+      end
+
+      def message
+        return "Error occurred with: #{@error_message}"
+      end
+
+      alias_method :to_s, :message
+    end
+
+    class AuthError             < ApiError; end
+    class TransportError        < ApiError; end
+    class IdempotencyError      < ApiError; end
+    class RateLimitError        < ApiError; end
+    class InvalidFormatError    < ApiError; end
+    class InvalidStateError     < ApiError; end
+    class InvalidParameterError < ApiError; end
+    class NotAllowedError       < ApiError; end
+    class ServerError           < ApiError; end
+    class UnexpectedError       < ApiError; end
+
+    # This generates ApiErrors based on the response error classes of CPS
+    def self.generate_error_from_response(response_body)
+      error_hash = generate_error_hash_with_symbols(response_body)
+
+      case error_hash[:error_class]
+      when "auth"
+        return AuthError.new( error_hash )
+      when "transport"
+        return TransportError.new( error_hash )
+      when "idempotency"
+        return IdempotencyError.new( error_hash )
+      when "rate_limit"
+        return RateLimitError.new( error_hash )
+      when "invalid_format"
+        return InvalidFormatError.new( error_hash )
+      when "invalid_state"
+        return InvalidStateError.new( error_hash )
+      when "invalid_parameter"
+        return InvalidParameterError.new( error_hash )
+      when "not_allowed"
+        return NotAllowedError.new( error_hash )
+      when "server_error"
+        return ServerError.new( error_hash )
+      else
+        return UnexpectedError.new( error_hash )
+      end
+    end
+
+
+    private
+
+      def self.parse_json(json)
+        begin
+          hash = JSON.parse(json)
+        rescue JSON::ParserError => e
+          return nil
+        end
+        self.symbolize_keys(hash)
+      end
+
+      def self.generate_error_hash_with_symbols(body)
+        if body.is_a?(Hash)
+          error_hash = self.symbolize_keys(body)
+        elsif body.is_a?(String)
+          error_hash = parse_json(body) || {}
+        else
+          error_hash = Hash.new
+        end
+
+        error_hash[:error_class]       ||= "Unexpected_Error"
+        error_hash[:error_code]        ||= "Unknown error code (body): \"#{body.to_s}\""
+        error_hash[:message]           ||= "Please contact CPS to help us fix that as soon as possible."
+        error_hash[:documentation_url] ||= "https://www.cashpaymentsolutions.com/de/geschaeftskunden/kontakt"
+        error_hash[:request_id]        ||= "not_available"
+
+        error_hash
+      end
+
+      def self.symbolize_keys(hash)
+        Hash[hash.map{ |k, v| [k.to_sym, v] }]
+      end
+  end
+end

data/lib/barzahlen/middleware.rb

@@ -0,0 +1,69 @@
+require "openssl"
+require "uri"
+require "time"
+
+module Barzahlen
+  module Middleware
+    class Signature
+      def initialize(request, config)
+        @request  = request
+        @config   = config
+      end
+
+      def call (opts, request_uri, method, params, body)
+        parsed_uri              = URI.parse(request_uri)
+        request_host_header     = parsed_uri.host + ":" + parsed_uri.port.to_s
+        request_method          = method
+        request_host_path       = parsed_uri.path
+        request_query_string    = URI.encode_www_form(params)
+        request_idempotency_key = opts[:headers]["Idempotency-Key"]
+        request_date_header     = Time.now.utc.strftime("%a, %d %b %Y %H:%M:%S GMT")
+
+        signature               = Barzahlen::Middleware.generate_bz_signature(
+                                    @config.payment_key,
+                                    request_host_header,
+                                    request_method,
+                                    request_date_header,
+                                    request_host_path,
+                                    request_query_string,
+                                    body,
+                                    request_idempotency_key
+                                  )
+
+        # Attach the Date, Authorization and Host to the request
+        new_headers =  opts[:headers].merge(
+          {
+              Date: request_date_header,
+              Authorization: "BZ1-HMAC-SHA256 DivisionId=#{@config.division_id}, Signature=#{signature}",
+              Host: request_host_header,
+          }
+        )
+
+        return @request.call({headers: new_headers}, request_uri, method, params, body)
+      end
+    end
+
+    def self.generate_bz_signature(
+      payment_key,
+      request_host_header,
+      request_method,
+      request_date_header,
+      request_host_path = "",
+      request_query_string = "",
+      request_body = "",
+      request_idempotency_key = "")
+
+      request_body_digest = OpenSSL::Digest.hexdigest("SHA256", request_body.to_s || "")
+
+      raw_signature = "#{request_host_header}\n"\
+                      "#{request_method.upcase}\n"\
+                      "#{request_host_path}\n"\
+                      "#{request_query_string}\n"\
+                      "#{request_date_header}\n"\
+                      "#{request_idempotency_key}\n"\
+                      "#{request_body_digest}"
+
+      OpenSSL::HMAC.hexdigest("SHA256", payment_key, raw_signature)
+    end
+  end
+end

data/lib/barzahlen/slip.rb

@@ -0,0 +1,113 @@
+require "securerandom"
+require "json"
+
+module Barzahlen
+  IDEMPOTENCY_ENABLED = true
+
+  # For idempotency purposes a class takes care of refund and payment
+
+  class CreateSlipRequest
+    def initialize(opts = {})
+      @request = Barzahlen.get_grac_client(Barzahlen::IDEMPOTENCY_ENABLED)
+      @request_hash = opts
+    end
+
+    def send
+      @request_hash.freeze
+      @request_hash.each do |key, value|
+        @request_hash[key].freeze
+      end
+      Barzahlen.execute_with_error_handling do
+        @request.path("/slips").post(@request_hash)
+      end
+    end
+  end
+
+  # If idempotency is not important a simple request is more than enough
+
+  def self.retrieve_slip(slip_id)
+    self.execute_with_error_handling do
+      self.get_grac_client.path("/slips/{id}", id: slip_id.to_s).get
+    end
+  end
+
+  def self.update_slip(slip_id, opts = {})
+    self.execute_with_error_handling do
+      self.get_grac_client.path("/slips/{id}", id: slip_id.to_s).patch(opts)
+    end
+  end
+
+  def self.resend_email(slip_id)
+    self.execute_with_error_handling do
+      self.get_grac_client.path("/slips/{id}/resend/email", id: slip_id.to_s).post
+    end
+  end
+
+  def self.resend_text_message(slip_id)
+    self.execute_with_error_handling do
+      self.get_grac_client.path("/slips/{id}/resend/text_message", id: slip_id.to_s).post
+    end
+  end
+
+  def self.invalidate_slip(slip_id)
+    self.execute_with_error_handling do
+      self.get_grac_client.path("/slips/{id}/invalidate", id: slip_id.to_s).post
+    end
+  end
+
+  # Handle a webhook request
+
+  def self.webhook_request(request)
+    bz_hook_format = request["Bz-Hook-Format"]
+
+    #stop processing when bz-hook-format = v1 because it will be or was send as v2
+    if bz_hook_format.include? "v1"
+      return nil
+    end
+
+    signature = Barzahlen::Middleware.generate_bz_signature(
+      Barzahlen.configuration.payment_key,
+      request["Host"] + ":" + (request["Port"] || "443"),
+      request["Method"] ? request["Method"].upcase : "POST",
+      request["Date"],
+      request["Path"].split("?")[0] || request["Path"],
+      request["Path"].split("?")[1] || "",
+      request["Body"]
+    )
+
+    if request["Bz-Signature"].include? signature
+      return JSON.parse(request["Body"])
+    else
+      raise Barzahlen::Error::SignatureError.new("Signature not valid")
+    end
+  end
+
+
+  private
+
+    @@grac_client = nil
+
+    def self.get_grac_client(idempotency = false)
+      @@grac_client ||= Grac::Client.new(
+          Barzahlen.configuration.sandbox ?
+            Barzahlen::Configuration::API_HOST_SANDBOX : Barzahlen::Configuration::API_HOST,
+          middleware: [ [ Barzahlen::Middleware::Signature, Barzahlen.configuration ] ]
+          )
+
+      if idempotency
+        return @@grac_client.set( headers: { "Idempotency-Key" => SecureRandom.uuid} )
+      else
+        return @@grac_client
+      end
+    end
+
+    def self.execute_with_error_handling
+      begin
+        yield
+      rescue Grac::Exception::RequestFailed => e
+        raise Barzahlen::Error.generate_error_from_response("")
+      rescue  Grac::Exception::ClientException => e
+        raise Barzahlen::Error.generate_error_from_response(e.body)
+      end
+    end
+end

data/lib/barzahlen/version.rb

@@ -0,0 +1,3 @@
+module Barzahlen
+  VERSION = "2.0.0"
+end

metadata

@@ -1,126 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: barzahlen
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
-- Mathias Hertlein
+- David Leib
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2016-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: 10.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: 10.4.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 10.0.4
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 10.0.4
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 0.6.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 0.6.3
 - !ruby/object:Gem::Dependency
-  name: builder
+  name: grac
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
+        version: 2.2.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-description: The official Ruby-SDK for accessing the Barzalen Payment Service
+        version: 2.2.1
+description: This is a ruby gem to access the Barzahlen API v2.
 email:
-- mathias.hertlein@barzahlen.de
-executables:
-- test.rb
+- david.leib@barzahlen.de
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
-- README.md
-- Rakefile
-- bin/test.rb
-- lib/barzahlen/api/online.rb
-- lib/barzahlen/api/online/api.rb
-- lib/barzahlen/api/online/hash_builder.rb
-- lib/barzahlen/api/online/http.rb
-- lib/barzahlen/api/online/notification_handler.rb
-- lib/barzahlen/api/online/response_parser.rb
-- lib/barzahlen/api/online/transaction.rb
-- lib/barzahlen/api/online/version.rb
-- lib/ruby_sdk.rb
-- lib/ruby_sdk/version.rb
-- spec/barzahlen/api/online/api_spec.rb
-- spec/barzahlen/api/online/hash_builder_spec.rb
-- spec/barzahlen/api/online/http_spec.rb
-- spec/barzahlen/api/online/notification_handler_spec.rb
-- spec/barzahlen/api/online/response_parser_spec.rb
-- spec/barzahlen/api/online/transaction_spec.rb
-- spec/barzahlen/api/online_spec.rb
-- spec/spec_helper.rb
-homepage: https://www.barzahlen.de/
+- lib/barzahlen.rb
+- lib/barzahlen/configuration.rb
+- lib/barzahlen/error.rb
+- lib/barzahlen/middleware.rb
+- lib/barzahlen/slip.rb
+- lib/barzahlen/version.rb
+homepage: ''
 licenses:
 - MIT
 metadata: {}
@@ -143,13 +102,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Barzahlen Ruby-SDK
-test_files:
-- spec/barzahlen/api/online/api_spec.rb
-- spec/barzahlen/api/online/hash_builder_spec.rb
-- spec/barzahlen/api/online/http_spec.rb
-- spec/barzahlen/api/online/notification_handler_spec.rb
-- spec/barzahlen/api/online/response_parser_spec.rb
-- spec/barzahlen/api/online/transaction_spec.rb
-- spec/barzahlen/api/online_spec.rb
-- spec/spec_helper.rb
+summary: Client gem for API Barzahlen v2.
+test_files: []