barzahlen 1.0.0 → 2.0.0

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec

data/README.md

@@ -1,207 +0,0 @@
-# Barzahlen Ruby-SDK
-
-The official Ruby-SDK for accessing the Barzalen Payment Service.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'barzahlen-sdk'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install barzahlen-sdk
-
-## Usage
-
-```Ruby
-require 'barzahlen/api/online'
-```
-
-### Configuration
-
-The configuration is a hash where :shop_id, :payment_key and :notification_key are required. For
-using the sandbox you can set the :host to 'api-sandbox.barzahlen.de'.
-
-```Ruby
-Barzahlen::Api::Online.config = {:shop_id => 'xxx',
-                                 :payment_key => 'xxx',
-                                 :notification_key => 'xxx',
-                                 :host => 'api-sandbox.barzahlen.de',}
-```
-
-The credentials, which are necessary to handle payments with Barzahlen, can be received at
-https://partner.barzahlen.de. After a successful registration a shop ID is assigned to you as
-well as a payment and a notification key. Furthermore you can set your callback URL which is used
-to send updates on payment and refund transactions.
-
-### Send requests
-
-After you set the config you can create the transaction-api object with the method
-Barzahlen::Api::Online.new_transaction_api.
-
-If there are any errors, a RuntimeError is thrown.
-
-#### Create transactions
-
-```Ruby
-transaction = {
-    :customer_email => 'barzahlen@example.com',
-    :amount => '13.37',
-    :currency => 'EUR',
-    :order_id => '123', #optional
-    :customer_street_nr => 'Wallstr. 14a',
-    :customer_zipcode => '10179',
-    :customer_city => 'Berlin',
-    :customer_country => 'DE',
-    :customer_custom_var_0 => 'customer_custom_var_0', #optional
-    :customer_custom_var_1 => 'customer_custom_var_1', #optional
-    :customer_custom_var_2 => 'customer_custom_var_2', #optional
-    :language => 'de',
-}
-api_transaction = Barzahlen::Api::Online.new_transaction_api
-response = api_transaction.create transaction
-# Response contains :transaction_id, :payment_slip_link, :expiration_notice, :infotext1,
-# :infotext2, :result, :hash
-```
-
-#### Update order-id of a transaction
-
-```Ruby
-transaction_id = 123
-order_id = 456
-api_transaction = Barzahlen::Api::Online.new_transaction_api
-response = api_transaction.update_order_id transaction_id, order_id
-# Response contains :transaction_id, :result, :hash
-```
-
-#### Resend E-Mail for a transaction
-
-```Ruby
-transaction_id = 123
-language = 'de'
-api_transaction = Barzahlen::Api::Online.new_transaction_api
-response = api_transaction.resend_email transaction_id, language
-# Response contains :transaction_id, :result, :hash
-```
-
-#### Cancel a transaction
-
-```Ruby
-transaction_id = 123
-language = 'de'
-api_transaction = Barzahlen::Api::Online.new_transaction_api
-response = api_transaction.cancel transaction_id, language
-# Response contains :transaction_id, :result, :hash
-```
-
-#### Create a refund for a transaction
-
-```Ruby
-transaction_id = 123
-amount = '1.23'
-currency = 'EUR'
-language = 'de'
-api_transaction = Barzahlen::Api::Online.new_transaction_api
-response = api_transaction.refund transaction_id, amount, currency, language
-# Response contains :origin_transaction_id, :refund_transaction_id, :result, :hash
-```
-
-### Handle notifications
-
-After you set the config you can create the notification-handler object with the method
-Barzahlen::Api::Online.new_notification_handler.
-
-#### Handle a transaction-paid notification
-
-```Ruby
-notification_handler = Barzahlen::Api::Online.new_notification_handler
-notification = notification_handler.validate_request(request_parameters)
-# Notification contains :state, :transaction_id, :shop_id, :customer_email, :amount, :currency,
-# :notification_key and, if set while request, :order_id, :custom_var_0, :custom_var_1, :custom_var_2
-if notification[:state] == Barzahlen::Api::Online::NotificationHandler::TRANSACTION_PAID
-  # ...
-end
-```
-
-#### Handle a transaction-expired notification
-
-```Ruby
-notification_handler = Barzahlen::Api::Online.new_notification_handler
-notification = notification_handler.validate_request(request_parameters)
-# Notification contains :state, :transaction_id, :shop_id, :customer_email, :amount, :currency,
-# :notification_key and, if set while request, :order_id, :custom_var_0, :custom_var_1, :custom_var_2
-if notification[:state] == Barzahlen::Api::Online::NotificationHandler::TRANSACTION_EXPIRED
-  # ...
-end
-```
-
-#### Handle a refund-completed notification
-
-```Ruby
-notification_handler = Barzahlen::Api::Online.new_notification_handler
-notification = notification_handler.validate_request(request_parameters)
-# Notification contains :state, :refund_transaction_id, :origin_transaction_id, :shop_id,
-#:customer_email, :amount, :currency, :notification_key and, if set while request, :origin_order_id,
-#:custom_var_0, :custom_var_1, :custom_var_2
-if notification[:state] == Barzahlen::Api::Online::NotificationHandler::REFUND_COMPLETED
-  # ...
-end
-```
-
-#### Handle a refund-expired notification
-
-```Ruby
-notification_handler = Barzahlen::Api::Online.new_notification_handler
-notification = notification_handler.validate_request(request_parameters)
-# Notification contains :state, :refund_transaction_id, :origin_transaction_id, :shop_id,
-#:customer_email, :amount, :currency, :notification_key and, if set while request, :origin_order_id,
-#:custom_var_0, :custom_var_1, :custom_var_2
-if notification[:state] == Barzahlen::Api::Online::NotificationHandler::REFUND_EXPIRED
-  # ...
-end
-```
-
-### Logging
-
-If you want to log all requests to the API and the raw responses, you have to implement your own
-http_client. As you can see this is not as hard is sounds.
-
-```Ruby
-class LoggingClient < Barzahlen::Api::Online::Http
-  def request(url, parameters)
-    response = super
-
-    puts url
-    puts parameters
-    puts response
-
-    response
-  end
-end
-
-config = {:shop_id => '13446',
-          :payment_key => '1c7439cda8256d9ead6602087462f0e478e3f2f4',
-          :notification_key => '390447f4a799dcae93d62bcd9567c1795188154b',
-          :host => 'api-sandbox.barzahlen.de',}
-
-http = LoggingClient.new
-Barzahlen::Api::Online.api = Barzahlen::Api::Online::Api.new http, config
-
-transaction_id = 123
-order_id = 456
-api_transaction = Barzahlen::Api::Online.new_transaction_api
-response = api_transaction.update_order_id transaction_id, order_id
-```
-
-## Contributing
-
-1. Fork it ( http://github.com/barzahlen/Barzahlen-Ruby/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/Rakefile

@@ -1,3 +0,0 @@
-# coding: utf-8
-
-require 'bundler/gem_tasks'

data/bin/test.rb

@@ -1,30 +0,0 @@
-#!/usr/bin/env ruby_executable_hooks
-# coding: utf-8
-
-$:.unshift '/home/mathiashertlein/Development/sdk/ruby_sdk/lib'
-require 'barzahlen/api/online'
-
-class LoggingClient < Barzahlen::Api::Online::Http
-  def request(url, parameters)
-    response = super
-
-    puts url
-    puts parameters
-    puts response
-
-    response
-  end
-end
-
-config = {:shop_id => '13446',
-          :payment_key => '1c7439cda8256d9ead6602087462f0e478e3f2f4',
-          :notification_key => '390447f4a799dcae93d62bcd9567c1795188154b',
-          :host => 'api-sandbox.barzahlen.de',}
-
-http = LoggingClient.new
-Barzahlen::Api::Online.api = Barzahlen::Api::Online::Api.new http, config
-
-transaction_id = 123
-order_id = 456
-Barzahlen::Api::Online.new_transaction_api
-response = api_transaction.update_order_id transaction_id, order_id

data/lib/barzahlen/api/online.rb

@@ -1,58 +0,0 @@
-# coding: utf-8
-
-require 'net/http'
-require 'barzahlen/api/online/http'
-require 'barzahlen/api/online/api'
-
-module Barzahlen
-  module Api
-    module Online
-
-      # Is responsible for initializing objects to access the Barzahlen-API and check
-      # notifications. For using it, you must set a config, in seldom cases an api object.
-      #
-      # For using the sandbox mode, you must pass the host api.barzahlen.de in the config.
-      #
-      # = Examples
-      # Barzahlen::Api::Online.config = {
-      #     :shop_id => 'your shop id',
-      #     :payment_key => 'your payment key',
-      #     :notification_key => 'your notification key',
-      # }
-      # api_transaction = Barzahlen::Api::Online.new_transaction_api
-      class << self
-        HOST = 'api.barzahlen.de'
-
-        attr_writer :config
-        attr_writer :api
-
-        # Returns an object that represents the Barzahlen-API and all it's methods.
-        def new_transaction_api
-          autoload :Transaction, 'barzahlen/api/online/transaction'
-
-          initialize_api
-          Barzahlen::Api::Online::Transaction.new @api
-        end
-
-        # Returns an object that validates notification requests, which came from  Barzahlen
-        def new_notification_handler
-          autoload :NotificationHandler, 'barzahlen/api/online/notification_handler'
-
-          initialize_api
-          Barzahlen::Api::Online::NotificationHandler.new @api
-        end
-
-        private
-          def initialize_api
-            raise ArgumentError, 'You must set a config or api' if @config == nil && @api == nil
-            @config[:host] = HOST unless @config.include? :host
-
-            if @api == nil && @config != nil
-              http = Barzahlen::Api::Online::Http.new
-              @api = Barzahlen::Api::Online::Api.new http, @config
-            end
-          end
-      end
-    end
-  end
-end

data/lib/barzahlen/api/online/api.rb

@@ -1,67 +0,0 @@
-# coding: utf-8
-
-require 'openssl'
-require 'net/http'
-
-require 'barzahlen/api/online/hash_builder'
-require 'barzahlen/api/online/response_parser'
-
-module Barzahlen
-  module Api
-    module Online
-
-      # Is responsible for assemble requests and send them via https to the Barzahlen API. It can
-      # send requests or just build and return the hash.
-      class Api
-        def initialize(http, config)
-          @http = http
-          @config = config
-        end
-
-        # Assembles and sends Request to the Barzahlen API, and returns the parsed response
-        # path is the url path.
-        # key_name is the name of the config field, that contains the secret key.
-        # parameters_order is the order of the parameters, in which they are concatenated for
-        # hash building.
-        # parameters contains the parameters of the request.
-        def request(path, key_name, parameters_order, parameters)
-          request_url = build_url path
-          request_parameters = build_parameters key_name, parameters_order, parameters
-
-          response = @http.request request_url, request_parameters
-          parsed_response = ResponseParser.parse response.body
-
-          if response.code != '200'
-            raise RuntimeError, 'Barzahlen-API returned http-status: ' + response.code.to_s + ',' +
-                                'error-message: ' + parsed_response[:error_message] + ',' +
-                                'error-code: ' + parsed_response[:result]
-          end
-
-          parsed_response
-        end
-
-        # Calculates hash from passed parameters.
-        #
-        # key_name is the name of the config field, that contains the secret key.
-        # parameters_order is the order of the parameters, in which they are concatenated.
-        # parameters contains the parameters of the request.
-        def build_hash(key_name, parameters_order, parameters)
-          request_parameters = parameters.merge :shop_id => @config[:shop_id]
-
-          hash_builder = HashBuilder.new parameters_order, key_name
-          hash_builder.build_hash @config[key_name], request_parameters
-        end
-
-        private
-          def build_url(path)
-            URI('https://' + @config[:host] + '/' + path)
-          end
-
-          def build_parameters(key_name, parameters_order, parameters)
-            hash = build_hash key_name, parameters_order, parameters
-            parameters.merge :shop_id => @config[:shop_id], :hash => hash
-          end
-        end
-    end
-  end
-end

data/lib/barzahlen/api/online/hash_builder.rb

@@ -1,43 +0,0 @@
-# coding: utf-8
-
-require 'digest/sha2'
-
-module Barzahlen
-  module Api
-    module Online
-
-      # Creates hashes from a set of parameters with th following algorithm:
-      # SHA512(param1;param2;param3;key)
-      class HashBuilder
-        def initialize(parameters_order, key_parameter_name)
-          @parameters_order = parameters_order
-          @key_parameter_name = key_parameter_name
-        end
-
-        # Calculates hash from passed parameters and key
-        def build_hash(key, parameters)
-          parameters_string = build_parameters_string key, parameters
-          Digest::SHA512.hexdigest parameters_string
-        end
-
-        private
-          def build_parameters_string(key, parameters)
-            parameters_string = ''
-
-            @parameters_order.each_with_index do |parameter_name, index|
-              if parameter_name == @key_parameter_name
-                parameter_value = key.to_s
-              else
-                parameter_value = parameters[parameter_name].to_s
-              end
-
-              parameters_string += parameter_value.to_s
-              parameters_string += ';' unless index == @parameters_order.size - 1
-            end
-
-            parameters_string
-          end
-      end
-    end
-  end
-end

data/lib/barzahlen/api/online/http.rb

@@ -1,31 +0,0 @@
-# coding: utf-8
-
-require 'openssl'
-require 'net/http'
-
-require 'barzahlen/api/online/hash_builder'
-require 'barzahlen/api/online/response_parser'
-
-module Barzahlen
-  module Api
-    module Online
-
-      # A wrapper class for Net::HTTP
-      # If you want to use your own http client, you must implement the request method and let it
-      # return an HTTPResponse compatible object
-      class Http
-        # sends a request with specified parameters to url, and returns an HTTPResponse object
-        def request(url, parameters)
-          http_client = Net::HTTP.new url.host, 443
-          http_client.use_ssl = true
-          http_client.verify_mode = OpenSSL::SSL::VERIFY_PEER
-
-          request = Net::HTTP::Post.new url.to_s
-          request.set_form_data parameters
-
-          http_client.request request
-        end
-      end
-    end
-  end
-end