digistore24 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f18a71470dbbfe186cffdc587c8c85677e38929045d4d942bbd9c25dfccbef54
+  data.tar.gz: f911ca74a16b8cd3221eaf71332e0683b2062c03c4735eb3214ff43237e6c1ee
+SHA512:
+  metadata.gz: 694e0b7bafdbef4fad569d62e59910de4dd86df878b28836a65d35bff63cdd805144e0bc3a3d02ba817b7f717d7733f51075bd0a5ff3ec458e5f516e3b8e76e8
+  data.tar.gz: 5254b4d65f449beeb8909dc6ecb075ca8ba7bef34feb5597404759e2a5a1bb9b2fa424199133630dd45fc0e34a0aca2a24031cf508c9775c38afde3ac6e8dc84

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.reek.yml

@@ -0,0 +1,4 @@
+---
+UncommunicativeModuleName:
+  accept:
+    - Digistore24

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Metrics/LineLength:
+  Exclude:
+    - *.gemspec

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5
+  - 2.2
+script:
+  - bundle exec rspec

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 digistore24.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Henning Vogt
+
+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,52 @@
+# Digistore24
+[![Build Status](https://travis-ci.org/henvo/digistore24.svg?branch=master)](https://travis-ci.org/henvo/digistore24)
+
+Digistore24 IPN integration library for rails and other web applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'digistore24'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install digistore24
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Configuration
+
+You can configure this gem by running:
+
+``` ruby
+Digistore24.configure |config|
+  config.passphrase = 'xxxxx'
+end
+```
+
+You can define any key here. But you have to provide at least:
+
+* `passphrase` The IPN passphrase
+
+## 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/henvo/digistore24.
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "digistore24"
+
+# 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/digistore24.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path('lib', __dir__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'digistore24/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'digistore24'
+  spec.version       = Digistore24::VERSION
+  spec.authors       = ['Henning Vogt']
+  spec.email         = ['git@henvo.de']
+
+  spec.summary       = 'Digistore24 IPN integration library for rails and ' \
+                       'other web applications.'
+  spec.homepage      = 'https://github.com/henvo/digistore24'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) 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_dependency 'recursive-open-struct', '~> 1.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
+end

data/lib/digistore24.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'recursive_open_struct'
+
+require 'digistore24/version'
+require 'digistore24/notification'
+
+# The main module for all Digistore24 related models and methods.
+module Digistore24
+  class << self
+    attr_writer :configuration
+
+    # Returns the gem wide configuration.
+    #
+    # @return [RecursiveOpenStruct]
+    def configuration
+      @configuration ||= RecursiveOpenStruct.new
+    end
+
+    # Configure the gem wide configuration object.
+    # There are currently no regulations on what to store inside this object
+    # - any key is allowed.
+    #
+    # @example:
+    #   Digistore24.configure do |config|
+    #     config.passphrase = 'xxxxx'
+    #   end
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/digistore24/notification.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module Digistore24
+  # A basic NotificationError that implies that there is an error.
+  class NotificationError < StandardError; end
+
+  # The main notification class which represents an Instant Payment
+  # Notification (IPN).
+  class Notification
+    attr_reader :payload
+
+    # Initialize the notification.
+    #
+    # @param params [Hash] The request parameters from Digistore24.
+    # @return [Notification]
+    def initialize(params)
+      @payload = RecursiveOpenStruct.new(params)
+    end
+
+    # Calculate SHA512 signature for payload.
+    #
+    # @return [String] The signature.
+    def signature
+      # Remove 'sha_sign' key from request params and concatenate all
+      # key value pairs
+      params = payload.to_h
+        .reject { |key, value| key == :sha_sign }.sort
+        .map { | key, value| "#{key}=#{value}#{passphrase}" }.join
+
+      # Calculate SHA512 and upcase all letters, since Digistore will
+      # also return upcased letters in the signature.
+      Digest::SHA512.hexdigest(params).upcase
+    end
+
+    # Checks if the provided sha_sign is valid.
+    #
+    # @return [Booleand] The answer
+    def valid?
+      # If payload does not contain the sha_sign definitely return false.
+      return false unless payload.sha_sign
+
+      signature == payload.sha_sign
+    end
+
+    # Checks the request parameters signature and raises an error if it
+    # does not equal to the calculated signature.
+    #
+    # @return [NilClass]
+    # @raise [Digistore24::NotificationError]
+    def validate!
+      return if valid?
+      raise NotificationError, 'Request signature invalid!'
+    end
+
+    def to_h
+      payload.to_h
+    end
+    alias_method :to_hash, :to_h
+
+
+    private
+
+    # Return the passphrase from the global configuration.
+    #
+    # @return [String] The passphrase
+    def passphrase
+      Digistore24.configuration.passphrase
+    end
+  end
+end

data/lib/digistore24/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Digistore24
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: digistore24
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henning Vogt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: 
+email:
+- git@henvo.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- digistore24.gemspec
+- lib/digistore24.rb
+- lib/digistore24/notification.rb
+- lib/digistore24/version.rb
+homepage: https://github.com/henvo/digistore24
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/henvo/digistore24
+  source_code_uri: https://github.com/henvo/digistore24
+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: Digistore24 IPN integration library for rails and other web applications.
+test_files: []