monerorequest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4efb26bf1513834ee0b68535033a34350a5f159adba869ff3e8682d8612cdabf
+  data.tar.gz: 48ee1c05ae0db4195692ecc06a14bc2a26504982a0c81c9ab8ec1ee390832cb9
+SHA512:
+  metadata.gz: c27b72a81046b8bf050f0118f5c0cb683b7929a0921ffb592ec45388f99d6bb2c82c9695e9e95225a6a051165f7ac6c2c6bfe6d9520dd2d4f1725d89520d4a1a
+  data.tar.gz: 65e8f263bf3280a640471114d45658e148725c50dc88d4455c75a3620dc27f0b4e61eced65c9150427ee140f8c72948b7d8899b99a22bc530dcafa3b036605ad

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-05-04
+
+- Initial release

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in monerorequest.gemspec
+gemspec
+
+group :development, :test do
+  gem "faker", "~> 3.3"
+  gem "rake", "~> 13.0"
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 1.21"
+  gem "rubocop-rake", "~> 0.6"
+  gem "rubocop-rspec", "~> 2.29"
+end

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    monerorequest (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    concurrent-ruby (1.2.3)
+    diff-lcs (1.5.1)
+    faker (3.3.1)
+      i18n (>= 1.8.11, < 2)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    parallel (1.24.0)
+    parser (3.3.1.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.63.4)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.29.2)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.3)
+      rubocop (~> 1.40)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  faker (~> 3.3)
+  monerorequest!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.29)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 David Havlicek
+
+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,35 @@
+# Monerorequest
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/monerorequest`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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/[USERNAME]/monerorequest.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/monerorequest/decoder.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Monerorequest
+  # class to Decode an encoded Monerorequest
+  class Decoder
+    def initialize(request)
+      @request = request
+    end
+
+    def decode
+      _, version, encoded_str = @request.split(":")
+      raise RequestVersionError, "Only Request Version 1 is supported." unless version == "1"
+
+      compressed_data = Base64.decode64(encoded_str)
+      json_str = Zlib::GzipReader.new(StringIO.new(compressed_data)).read
+      JSON.parse(json_str)
+    end
+  end
+end

data/lib/monerorequest/encoder.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "base64"
+require "date"
+require "json"
+require "stringio"
+require "uri"
+require "zlib"
+
+module Monerorequest
+  # class to Encode a Monerorequest hash
+  class Encoder
+    class InvalidRequest < StandardError; end
+
+    attr_accessor :request
+    attr_reader :errors
+
+    def initialize(request)
+      @request = request
+      @errors = []
+
+      validate!
+    end
+
+    def encode(version)
+      raise RequestVersionError, "Only Request Version 1 is supported." unless version == 1
+
+      json_str = @request.sort.to_h.to_json.force_encoding("ascii")
+      compressed_data = StringIO.new
+      gz = Zlib::GzipWriter.new(compressed_data, 9)
+      gz.mtime = 0
+      gz.write(json_str)
+      gz.close
+      encoded_str = Base64.encode64(compressed_data.string).gsub("\n", "")
+      "monero-request:1:#{encoded_str}"
+    end
+
+    private
+
+    def validate!
+      validate_custom_label!
+      validate_sellers_wallet!
+      validate_currency!
+      validate_amount!
+      validate_payment_id!
+      validate_start_date!
+      validate_days_per_billing_cycle!
+      validate_change_indicator_url!
+    end
+
+    def validate_custom_label!
+      @errors.push("custom_label must be present.") unless @request.key?("custom_label")
+      @errors.push("custom_label must be a String.") unless @request["custom_label"].is_a?(String)
+    end
+
+    def validate_sellers_wallet!
+      @errors.push("sellers_wallet must be present.") unless @request.key?("sellers_wallet")
+      return if MoneroAddress.valid?(@request["sellers_wallet"])
+
+      @errors.push("sellers_wallet must be a main Monero address.")
+    end
+
+    def validate_currency!
+      @errors.push("currency must be present.") unless @request.key?("currency")
+      @errors.push("currency must be a String.") unless @request["currency"].is_a?(String)
+    end
+
+    def validate_amount!
+      @errors.push("amount must be present.") unless @request.key?("amount")
+      @errors.push("amount must be a Numeric.") unless @request["amount"].is_a?(Numeric)
+    end
+
+    def validate_payment_id!
+      @errors.push("payment_id must be present.") unless @request.key?("payment_id")
+      @errors.push("payment_id must be a Monero Payment ID.") unless MoneroPaymentID.valid?(@request["payment_id"])
+    end
+
+    def validate_start_date!
+      @errors.push("start_date must be present.") unless @request.key?("start_date")
+      unless @request["start_date"].is_a?(String)
+        @errors.push("start_date must be a String.") && @request["start_date"] = ""
+      end
+      begin
+        DateTime.rfc3339(@request["start_date"])
+      rescue Date::Error
+        @errors.push("start_date must be an RFC3339 timestamp.")
+      end
+    end
+
+    def validate_days_per_billing_cycle!
+      @errors.push("days_per_billing_cycle must be present.") unless @request.key?("days_per_billing_cycle")
+      @errors.push("days_per_billing_cycle must be a Integer.") unless @request["days_per_billing_cycle"].is_a?(Integer)
+    end
+
+    def validate_change_indicator_url!
+      @errors.push("change_indicator_url must be present.") unless @request.key?("change_indicator_url")
+      unless @request["change_indicator_url"].is_a?(String)
+        @errors.push("change_indicator_url must be a String.") && @request["change_indicator_url"] = ""
+      end
+      return if @request["change_indicator_url"] =~ URI::DEFAULT_PARSER.make_regexp
+
+      @errors.push("change_indicator_url must be a URL.")
+    end
+  end
+end

data/lib/monerorequest/monero_address.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Monerorequest
+  # provide a validator for a Monero main address
+  class MoneroAddress
+    def self.valid?(address)
+      return false unless address.is_a?(String)
+      return false unless address[0] == "4"
+      return false unless address[1] =~ /[0-9AB]/
+      return false unless address.length == 95
+
+      true
+    end
+  end
+end

data/lib/monerorequest/monero_payment_id.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Monerorequest
+  # provide a validator for a Monero Payment ID
+  class MoneroPaymentID
+    def self.valid?(payment_id)
+      return false unless payment_id.is_a?(String)
+      return false unless payment_id.length == 16
+      return false unless payment_id =~ /[0-9a-f]/
+
+      true
+    end
+  end
+end

data/lib/monerorequest/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Monerorequest
+  VERSION = "0.1.0"
+end

data/lib/monerorequest.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "base64"
+require "date"
+require "json"
+require "stringio"
+require "uri"
+require "zlib"
+require_relative "monerorequest/decoder"
+require_relative "monerorequest/encoder"
+require_relative "monerorequest/monero_address"
+require_relative "monerorequest/monero_payment_id"
+require_relative "monerorequest/version"
+
+module Monerorequest
+  class RequestVersionError < StandardError; end
+end

data/sig/monerorequest.rbs

@@ -0,0 +1,4 @@
+module Monerorequest
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: monerorequest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Havlicek
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-05-07 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- snex00@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/monerorequest.rb
+- lib/monerorequest/decoder.rb
+- lib/monerorequest/encoder.rb
+- lib/monerorequest/monero_address.rb
+- lib/monerorequest/monero_payment_id.rb
+- lib/monerorequest/version.rb
+- sig/monerorequest.rbs
+homepage: https://github.com/snex/monerorequest-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/snex/monerorequest-ruby
+  source_code_uri: https://github.com/snex/monerorequest-ruby
+  changelog_uri: https://github.com/snex/monerorequest-ruby/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Ruby Implementation of the Monero Payment Request Standard. https://github.com/lukeprofits/Monero_Payment_Request_Standard
+test_files: []