integral-yandex-money-notification_validator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e238282eda4f0f0fc91bc297336234aebf561fd734536fbe0860e71ad41a2fb2
-  data.tar.gz: be0f816d1e311364d19f8b0bc02e7a724eb98a0a49dcf27297795128e29481f8
+  metadata.gz: 82bd2764d93ebfa9dfbcfce38e1cd897bf322f491f347256997301e35773500a
+  data.tar.gz: 3762c7d5d44c1195dcf6cf9d218182fe9e9cf8f3f35721b47d24f9e8d944e1b0
 SHA512:
-  metadata.gz: 23e1e258224cd3e91bb52422dcea93ec90917e7a35e191b0ad3d21f1ceffd1fef6590289998955ae91244f4f74dcc742b320a75bf61ced542d7834d544bc562f
-  data.tar.gz: d9dd652e80ccc2a156e7272adb7aaa9c333aeac3f6884cead87e10e52372fc4582e1ac50bb079029c6e7126c10114957f489ab7f903ec0abaad127529bf78f95
+  metadata.gz: af4e829fcd93024a55418a8cba369b4cbff9d2b3d7eedc9448354b49de18f35d44ed0cb6639d4a90038c28dd9d12f9f02092c4e425d1d5da55777f067a37e896
+  data.tar.gz: e559498a1b6dcedb5a8e4a1885839c488683f5f56c1bf229e66a98b46283396b1c28bd85fef858a3bfacb303de2051feb67c220cc04cbe2dc80885325cc9b5ae

data/README.md

@@ -3,6 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/integral-yandex-money-notification_validator.svg)](http://badge.fury.io/rb/integral-yandex-money-notification_validator)
 [![Maintainability](https://api.codeclimate.com/v1/badges/5b7ba150248e751ccbc9/maintainability)](https://codeclimate.com/github/sergeypedan/integral-yandex-money-notification_validator/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/5b7ba150248e751ccbc9/test_coverage)](https://codeclimate.com/github/sergeypedan/integral-yandex-money-notification_validator/test_coverage)
+[![Build Status](https://travis-ci.org/sergeypedan/integral-yandex-money-notification_validator.svg?branch=master)](https://travis-ci.org/sergeypedan/integral-yandex-money-notification_validator)
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 
@@ -25,7 +26,10 @@ Here are the official docs for the [notification service](https://tech.yandex.ru
 
 ## Requirements
 
-[Ruby 2.5.0](https://www.ruby-lang.org) or higher.
+- [Ruby 2.5.0](https://www.ruby-lang.org) or higher.
+- An account in [Yandex.Money](https://money.yandex.ru)
+- A notifications secret key (obtained from Yandex.Money [somewehre in the settings](https://money.yandex.ru/myservices/online.xml))
+- Rails is assumed but not required
 
 ## Setup
 
@@ -60,7 +64,7 @@ end
 
 `validator.errors` returns an Array of message strings — most often only 1 message, but who knows.
 
-`secret` is obtained from Yandex.Money [somewehre in the settings](https://money.yandex.ru/myservices/online.xml). Recommended to keep in Rails credentials, ENV variable or elsewhere secure.
+`secret` is recommended to be kept in an ENV variable, Rails credentials or elsewhere secure.
 
 ## Tests
 

data/lib/integral/yandex/money/notification_validator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "digest"
-require "integral/yandex/money/notification_validator/identity"
+require_relative "notification_validator/identity"
+require_relative "notification_validator/helpers"
 
 module Integral
   module Yandex
@@ -10,15 +10,15 @@ module Integral
       # Validation is documented here: https://tech.yandex.ru/money/doc/dg/reference/notification-p2p-incoming-docpage/#notification-p2p-incoming__verify-notification
       class NotificationValidator
 
-        # Order is crucial for `KEYS_FOR_DIGEST`
-        KEYS_FOR_DIGEST      = %w[notification_type operation_id amount currency datetime sender codepro notification_secret label].freeze
-        PERMITTED_HASH_TYPES = ["ActionController::Parameters", "Hash"].freeze
-        REQUIRED_KEYS        = %w[amount codepro datetime notification_type operation_id sender].freeze
+        include Helpers
 
+        # Order is crucial for `KEYS_FOR_DIGEST`
+        KEYS_FOR_DIGEST = %w[notification_type operation_id amount currency datetime sender codepro notification_secret label].freeze
+        REQUIRED_KEYS   = %w[amount codepro datetime notification_type operation_id sender].freeze
 
         def initialize params:, secret:
           fail ArgumentError, "Yandex.Money notifications secret is required" if secret.to_s == ""
-          validate_params_hash!(params)
+          validate_argument_type! argument: params, permitted_types: ["ActionController::Parameters", "Hash"]
           @secret = secret
           @params = params
           @errors = []
@@ -26,51 +26,33 @@ module Integral
 
         attr_reader :errors
 
-
         def valid?
           return false unless all_param_values_present?
           return false unless integrity_correct?
           true
         end
 
-
         private
 
         def all_param_values_present?
-          missing_keys = REQUIRED_KEYS.select { |key| @params[key].to_s == "" }
+          missing_keys = find_missing_hash_values required_keys: REQUIRED_KEYS, hash: @params
           return true if missing_keys.empty?
           (@errors << "Required `params` keys missing: #{missing_keys.uniq.join(", ")}") and return false
         end
 
-
-        def encode_sha string
-          Digest::SHA1.hexdigest string
-        end
-
-
         def integrity_correct?
-          stringified_params = stringify_params params_with_secret(@params)
           return true if @params["sha1_hash"] == encode_sha(stringified_params)
           (@errors << "SHA hashes do not match") and return false
         end
 
-
-        def params_with_secret params
-          params.merge("notification_secret" => @secret)
+        def params_with_secret
+          @params.merge("notification_secret" => @secret)
         end
 
-
-        def stringify_params params
-          KEYS_FOR_DIGEST.map { |key| params[key] }.join("&")
-          # this way and not just `.to_s` is to enforce required order of params
+        def stringified_params
+          stringify_params_with_order KEYS_FOR_DIGEST, params_with_secret
         end
 
-
-        def validate_params_hash! params
-          names = PERMITTED_HASH_TYPES.map { |name| "`#{name}`" }.join(" or ")
-          valid = PERMITTED_HASH_TYPES.include? params.class.to_s
-          fail ArgumentError, "`params` must be a #{names}, you passed #{params.inspect}" unless valid
-        end
       end
     end
   end

data/lib/integral/yandex/money/notification_validator/helpers.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module Integral
+  module Yandex
+    module Money
+
+      module Helpers
+
+        module_function
+
+        def encode_sha string
+          Digest::SHA1.hexdigest string
+        end
+
+        def find_missing_hash_values required_keys:, hash:
+          required_keys.select { |key| hash[key].to_s == "" }
+        end
+
+        def stringify_params_with_order keys, params
+          keys.map { |key| params[key] }.join("&")
+          # this way and not just `.to_s` is to enforce required order of params
+        end
+
+        def validate_argument_type! argument:, permitted_types:
+          names = permitted_types.map { |name| "`#{name}`" }.join(" or ")
+          valid = permitted_types.include? argument.class.to_s
+          fail ArgumentError, "`argument` must be a #{names}, you passed #{argument.inspect}" unless valid
+        end
+
+      end
+    end
+  end
+end

data/lib/integral/yandex/money/notification_validator/identity.rb

@@ -15,7 +15,7 @@ module Integral
           end
 
           def self.version
-            "0.1.0"
+            "0.1.1"
           end
 
           def self.version_label

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: integral-yandex-money-notification_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sergey Pedan
@@ -162,13 +162,15 @@ files:
 - LICENSE.md
 - README.md
 - lib/integral/yandex/money/notification_validator.rb
+- lib/integral/yandex/money/notification_validator/helpers.rb
 - lib/integral/yandex/money/notification_validator/identity.rb
 homepage: https://github.com/sergeypedan/integral-yandex-money-notification_validator
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/sergeypedan/integral-yandex-money-notification_validator
+  source_code_uri: https://github.com/sergeypedan/integral-yandex-money-notification_validator/blob/master/lib/integral/yandex/money/notification_validator.rb
   changelog_uri: https://github.com/sergeypedan/integral-yandex-money-notification_validator/blob/master/CHANGES.md
+  bug_tracker_uri: https://github.com/sergeypedan/integral-yandex-money-notification_validator/issues
 post_install_message: 
 rdoc_options: []
 require_paths: