sepa_reason_codes 1.0.1

data/lib/sepa_reason_codes.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'sepa_reason_codes/version'
+require 'yaml'
+
+# Usage:
+#
+# SepaReasonCodes.find('AC01')
+#
+# @returns ReasonCodeStruct{
+#   code: 'AC01',
+#   iso_name: '',
+#   description: '',
+#   probable_status: ''
+# }
+
+module SepaReasonCodes
+  class Error < StandardError; end
+
+  ParsedReasonCodes =
+    YAML.load_file(File.join(__dir__, ['reason_codes.yml'])).freeze
+
+  ReasonCodeStruct =
+    Struct.new(:code, :iso_name, :description, :probable_status)
+
+  # @param ~String~ Sepa Reason Code; Case insensitive
+  # Read more at : https://www.hettwer-beratung.de/sepa-spezialwissen/sepa-reason-codes/
+
+  # Parses lib/reason_codes.yml, retrieves and
+  # returns ReasonCode Struct with accessors
+  # code, iso_name, description, probable_status
+
+  def self.find(code)
+    reason_code =
+      ParsedReasonCodes.fetch(code&.upcase, nil)
+
+    return unless reason_code
+
+    reason_code_struct(reason_code)
+  end
+
+  # @returns collection [reason_code]
+
+  def self.all
+    ParsedReasonCodes.values.map do |reason_code|
+      reason_code_struct(reason_code)
+    end
+  end
+
+  def self.reason_code_struct(reason_code)
+    ReasonCodeStruct.new(
+      reason_code.fetch('code'),
+      reason_code.fetch('iso_name'),
+      reason_code.fetch('description'),
+      reason_code.fetch('probable_status')
+    )
+  end
+
+  private_constant :ParsedReasonCodes
+  private_class_method :reason_code_struct
+end

data/lib/sepa_reason_codes/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SepaReasonCodes
+  VERSION = '1.0.1'
+end

data/sepa_reason_codes.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/sepa_reason_codes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sepa_reason_codes'
+  spec.version       = SepaReasonCodes::VERSION
+  spec.authors       = ['Sahil Gadimbayli']
+  spec.email         = ['hi@ramblingcode.dev']
+
+  spec.summary       = 'Minimal, plain old ruby gem to work with Sepa Reason Codes.'
+  spec.homepage      = 'https://github.com/ramblingcode/sepa-reason-codes'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/ramblingcode/sepa-reason-codes'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: sepa_reason_codes
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Sahil Gadimbayli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- hi@ramblingcode.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/reason_codes.yml
+- lib/sepa_reason_codes.rb
+- lib/sepa_reason_codes/version.rb
+- sepa_reason_codes.gemspec
+homepage: https://github.com/ramblingcode/sepa-reason-codes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ramblingcode/sepa-reason-codes
+  source_code_uri: https://github.com/ramblingcode/sepa-reason-codes
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Minimal, plain old ruby gem to work with Sepa Reason Codes.
+test_files: []