bitkassa 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8c745f83c512fc5cebfcc5e5b3d8c1813aa49dc
-  data.tar.gz: a52d91b27aee9ddb4340c7dfaa511cd82bf00de6
+  metadata.gz: ced241ac3d66937fcd864c09c71975f8dde92ab4
+  data.tar.gz: 598d15da58553b95ae9ab6bc7260dcf1e3c09df2
 SHA512:
-  metadata.gz: ea5699eb3b5e0df35e0b8f101e9fba318da601c7d9b20a480c2502a4cd5dac49458e0e8c516e927194e6017d3acc437b96cfda69678ba0c333499ec6b60db811
-  data.tar.gz: ce79cd9c2bfebb86cc91456e41ed1f2a78ea9e7b2d1b2524a9142623977c75d09d1157b233698abb857e6724a6d4cb006cf9f6858ad5c53c58da489a05addfe8
+  metadata.gz: 92602bcd6623a3e57c10bd276eb5fd331c8490c2912228d6db8afbbdcfdc20bf3d0d5d914e53a8eed81d599a175e4cb6fd1866112968fbf80c854c9f7d3ea24a
+  data.tar.gz: ed81996b1a92893e00a3b4e92a88e9508e8abf57846e0511de88e397cec14fccdd294b884274e0273050a025a0c6bae35eb666fddcb750c02f4b1b28ea4d0ee4

data/lib/bitkassa/authentication.rb

@@ -0,0 +1,18 @@
+module Bitkassa
+  ##
+  # Authenticates a message.
+  # Ensures that incoming requests originated at Bitkassa.
+  # And signs our own requests so Bitkassa knows it was us who sent the request.
+  class Authentication
+    def self.sign(payload, sent_at)
+      message = "#{Bitkassa.config.secret_api_key}#{payload}#{sent_at}"
+      digest  = Digest::SHA256.hexdigest(message)
+      "#{digest}#{sent_at}"
+    end
+
+    def self.valid?(signature, payload)
+      sent_at = signature[64..-1]
+      signature == sign(payload, sent_at)
+    end
+  end
+end

data/lib/bitkassa/config.rb

@@ -0,0 +1,35 @@
+module Bitkassa
+  ##
+  # Contains the global configuration for the library.
+  class Config
+    # The Secret API key you received with your Bitkassa Account.
+    attr_accessor :secret_api_key
+    # The Merchant ID you received with your Bitkassa Account.
+    attr_accessor :merchant_id
+    # Base URI where all calls are redirected to. Defaults to
+    # +https://www.bitkassa.nl/api/v1+.
+    # Use when e.g. a proxy or self-hosted variant is used.
+    attr_accessor :base_uri
+
+    # Gets the current debug mode.
+    attr_reader :debug
+
+    # Sets defaults for the configuration.
+    def initialize
+      @base_uri = "https://www.bitkassa.nl/api/v1"
+      self.debug = false
+    end
+
+    # Enable or disable debug mode. Boolean.
+    def debug=(mode)
+      @debug = mode
+
+      if mode
+        HTTPI.log = true
+        HTTPI.log_level = :debug
+      else
+        HTTPI.log = false
+      end
+    end
+  end
+end

data/lib/bitkassa/exception.rb

@@ -0,0 +1,6 @@
+module Bitkassa
+  ##
+  # Generic Bitkassa Exception.
+  class Exception < StandardError
+  end
+end

data/lib/bitkassa/payment_request.rb

@@ -0,0 +1,51 @@
+module Bitkassa
+  ##
+  # Make a PaymentRequest.
+  #
+  # This will return the payment-response whith all returned information.
+  # A payment-request consists of a payload containing the information for the
+  # payment and an authentication message, being a signed version of the
+  # payload.
+  class PaymentRequest < Request
+    attr_accessor :currency,
+                  :amount,
+                  :description,
+                  :return_url,
+                  :update_url,
+                  :meta_info
+    ##
+    # Attributes for the payload
+    #
+    # * +attributes+ +Hash+:
+    # ** +currency+ +String+ required. "EUR" or "BTC"
+    # ** +amount+ +Integer+ required, amount to be paid in cents or satoshis
+    # ** +description+,
+    # ** +return_url+,
+    # ** +update_url+,
+    # ** +meta_info+
+    def attributes
+      {
+        currency: @currency,
+        amount: @amount,
+        description: @description,
+        return_url: @return_url,
+        update_url: @update_url,
+        meta_info: @meta_info
+      }
+    end
+
+    ##
+    # Override can_perform the require "currency" and "amount"
+    def can_perform?
+      return false if currency.nil?
+      return false if amount.nil?
+      super
+    end
+
+    ##
+    # Payload action is "start_payment"
+    def payload_action
+      "start_payment"
+    end
+  end
+end

data/lib/bitkassa/payment_response.rb

@@ -0,0 +1,45 @@
+module Bitkassa
+  # A +PaymentResponse+ represents the immediate response after requesting a
+  # payment. It can will parse the JSON and contain the information nessecary
+  # to determine the status of the payment request.
+  class PaymentResponse
+    ##
+    # Refer to +Initialize+ for the description of all attributes.
+    attr_accessor :payment_id,
+                  :payment_url,
+                  :address,
+                  :amount,
+                  :bitcoin_url,
+                  :expire,
+                  :error,
+                  :success
+    ##
+    # Generate a PaymentResponse from a JSON payload.
+    def self.from_json(json)
+      new(JSON.parse(json))
+    end
+
+    ##
+    # Initialize a new payment response. Usually done by a +PaymentRequest+.
+    #
+    # Attributes:
+    # * +payment_id+, Unique ID assigned to this payment by Bitkassa
+    # * +payment_url+, The Bitcoin payment URL which you can show (as link
+    #   and/or QR) for the customer to pay from his wallet (if you're hosting
+    #   your own payment page)
+    # * +address+ The Bitcoin address where the customer is supposed to send
+    #   his payment.
+    # * +amount+, The amount in satoshis to be paid.
+    # * +expire+, Unix timestamp when the payment expires (typically 15
+    #   minutes after start)
+    # * +error+, Reason why the payment could not be initiated. Only set when
+    #   payment errord.
+    # * +success+, Confirmation that the API call was processed successfull
+    def initialize(attributes)
+      attributes.each do |key, value|
+        setter_method = "#{key}=".to_sym
+        send(setter_method, value)
+      end
+    end
+  end
+end

data/lib/bitkassa/payment_result.rb

@@ -0,0 +1,79 @@
+module Bitkassa
+  # A +PaymentResult+ represents the result which is posted to return_url.
+  # This callback contains the status of the payment.
+  class PaymentResult
+    # Contains the payload exactly as posted by Bitkassa
+    attr_accessor :raw_payload
+    # Contains the authentication_message as posted by Bitkass
+    attr_accessor :raw_authentication
+
+    ##
+    # Initialize a +PaymentResult+ from a www-url-encoded body.
+    def self.from_form_urlencoded(body)
+      params = Hash[URI.decode_www_form(body)]
+      new(raw_payload: params["p"], raw_authentication: params["a"])
+    end
+
+    ##
+    # Attributes:
+    # +raw_payload+ the original, unencoded string containing the payload.
+    # +raw_authentication+ the original string containing the signed message.
+    def initialize(attributes)
+      attributes.each do |key, value|
+        setter_method = "#{key}=".to_sym
+        send(setter_method, value)
+      end
+    end
+
+    ##
+    # Gives the extracted payment_id.
+    def payment_id
+      payload["payment_id"]
+    end
+
+    ##
+    # Gives the extracted payment_status.
+    def payment_status
+      payload["payment_status"]
+    end
+
+    ##
+    # Gives the extracted meta_info.
+    def meta_info
+      payload["meta_info"]
+    end
+
+    ##
+    # Wether or not this payment result can be considered valid.
+    # Authentication is checked, payload and authentication should be available
+    # and the decoded JSON should be valid JSON.
+    # When the result is valid, it is safe to assume no-one tampered with it
+    # and that it was sent by Bitkassa.
+    def valid?
+      return false if raw_payload.nil? || raw_payload.empty?
+      return false if raw_authentication.nil? || raw_authentication.empty?
+      return false unless json_valid?
+
+      Authentication.valid?(raw_authentication, json_payload)
+    end
+
+    private
+
+    def payload
+      @payload ||= JSON.parse(json_payload)
+    end
+
+    def json_payload
+      Base64.decode64(raw_payload)
+    end
+
+    def json_valid?
+      begin
+        payload
+      rescue JSON::ParserError
+        return false
+      end
+      true
+    end
+  end
+end

data/lib/bitkassa/request.rb

@@ -0,0 +1,104 @@
+module Bitkassa
+  ##
+  # Generic HTTP Request
+  class Request
+    # Override the class that is initialized to capture the +perform+ response.
+    # Defaults to +Bitkassa::PaymentResponse+.
+    attr_writer :responder
+
+    # Overrides the default +Bitkassa::Authentication+ to sign the
+    # authentication
+    attr_writer :authenticator
+
+    ## Initalize a request
+    # * +attributes+ +Hash+
+    def initialize(attributes = {})
+      @initialized_at = Time.now.to_i
+      assign_attributes(attributes)
+    end
+
+    ##
+    # Make the request.
+    #
+    # returns +Bitkassa::PaymentResponse+ Regardless of the response, this
+    # this PaymentResponse is initialized.
+    #
+    # When a payment cannot be made because of incorrect or missing data,
+    # a +Bitkassa::Exception+ is raised.
+    def perform
+      if can_perform?
+        response = HTTPI.post(uri, params_string)
+        responder.from_json(response.body)
+      else
+        fail Bitkassa::Exception,
+             "Your merchant_id or merchant_key are not set"
+      end
+    end
+
+    ##
+    # Defines the attributes to be serialised in the payload
+    # merchant_id and action will be merged by default.
+    def attributes
+      {}
+    end
+
+    ##
+    # Defines the action to insert into the payload.
+    def payload_action
+      ""
+    end
+
+    def can_perform?
+      return false if Bitkassa.config.merchant_id.nil?
+      return false if Bitkassa.config.merchant_id.empty?
+      return false if Bitkassa.config.secret_api_key.nil?
+      return false if Bitkassa.config.secret_api_key.empty?
+      true
+    end
+
+    protected
+
+    def json_payload
+      attributes.merge(
+        action: payload_action,
+        merchant_id: Bitkassa.config.merchant_id
+      ).to_json
+    end
+
+    def assign_attributes(attributes)
+      attributes.each do |name, value|
+        send("#{name}=", value)
+      end
+    end
+
+    def responder
+      @responder ||= Bitkassa::PaymentResponse
+    end
+
+    def authenticator
+      @authenticator ||= Authentication
+    end
+
+    private
+
+    def uri
+      Bitkassa.config.base_uri
+    end
+
+    def params
+      { p: payload, a: authentication }
+    end
+
+    def authentication
+      authenticator.sign(json_payload, @initialized_at)
+    end
+
+    def payload
+      Base64.urlsafe_encode64(json_payload)
+    end
+
+    def params_string
+      params.map { |k, v| [k, "=", v].join }.join("&")
+    end
+  end
+end

data/lib/bitkassa/status_request.rb

@@ -0,0 +1,20 @@
+module Bitkassa
+  # Checks the status of a payment
+  class StatusRequest < Request
+    attr_accessor :payment_id
+
+    def attributes
+      { payment_id: @payment_id }
+    end
+
+    def payload_action
+      "get_payment_status"
+    end
+
+    def can_perform?
+      return false if payment_id.nil?
+
+      super
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitkassa
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Bèr Kessels
@@ -30,7 +30,7 @@ cert_chain:
   Kh4io+CNPvyPs1ZT/YqWsWIoi0cW5LCWGSXMThk1AY80jVv3XrlzMRZewVMjUInv
   KOmiB20daFpjM5ZM
   -----END CERTIFICATE-----
-date: 2015-11-21 00:00:00.000000000 Z
+date: 2015-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpi
@@ -109,6 +109,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/bitkassa.rb
+- lib/bitkassa/authentication.rb
+- lib/bitkassa/config.rb
+- lib/bitkassa/exception.rb
+- lib/bitkassa/payment_request.rb
+- lib/bitkassa/payment_response.rb
+- lib/bitkassa/payment_result.rb
+- lib/bitkassa/request.rb
+- lib/bitkassa/status_request.rb
 homepage: http://github.com/berkes/bitkassa
 licenses:
 - MIT