monerorequest 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4efb26bf1513834ee0b68535033a34350a5f159adba869ff3e8682d8612cdabf
-  data.tar.gz: 48ee1c05ae0db4195692ecc06a14bc2a26504982a0c81c9ab8ec1ee390832cb9
+  metadata.gz: 944c04e247c34be236e6071a5b8f384d11f12a21598b487068f8086ef9fdd7cb
+  data.tar.gz: e681abc0a5490f7fa86811a735d53f091b4ab8effd906cfa00b0737db11ba9c5
 SHA512:
-  metadata.gz: c27b72a81046b8bf050f0118f5c0cb683b7929a0921ffb592ec45388f99d6bb2c82c9695e9e95225a6a051165f7ac6c2c6bfe6d9520dd2d4f1725d89520d4a1a
-  data.tar.gz: 65e8f263bf3280a640471114d45658e148725c50dc88d4455c75a3620dc27f0b4e61eced65c9150427ee140f8c72948b7d8899b99a22bc530dcafa3b036605ad
+  metadata.gz: de8f025de01a42d3a6a4cb701e40122e6c115eee4683331da0789e5886f27ce82d99e5fd81811443b5a00c5f62c811ea3d2540bd1036579404fbe869301a5b04
+  data.tar.gz: c81846b18ec909a1c7b84130a17c1b6a7d7b88d884da06aa6634ee915842b4e14d6eaaf862361fa53af48d5f22b21cf56639b07fd2800d67390e1667711602ff

data/Gemfile

@@ -6,6 +6,7 @@ source "https://rubygems.org"
 gemspec
 
 group :development, :test do
+  gem "byebug", "~> 11.1"
   gem "faker", "~> 3.3"
   gem "rake", "~> 13.0"
   gem "rspec", "~> 3.0"
@@ -13,3 +14,7 @@ group :development, :test do
   gem "rubocop-rake", "~> 0.6"
   gem "rubocop-rspec", "~> 2.29"
 end
+
+group :test do
+  gem "simplecov", "~> 0.22", require: false
+end

data/Gemfile.lock

@@ -1,14 +1,16 @@
 PATH
   remote: .
   specs:
-    monerorequest (0.1.0)
+    monerorequest (1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    byebug (11.1.3)
     concurrent-ruby (1.2.3)
     diff-lcs (1.5.1)
+    docile (1.4.1)
     faker (3.3.1)
       i18n (>= 1.8.11, < 2)
     i18n (1.14.5)
@@ -64,12 +66,19 @@ GEM
     rubocop-rspec_rails (2.28.3)
       rubocop (~> 1.40)
     ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
     unicode-display_width (2.5.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  byebug (~> 11.1)
   faker (~> 3.3)
   monerorequest!
   rake (~> 13.0)
@@ -77,6 +86,7 @@ DEPENDENCIES
   rubocop (~> 1.21)
   rubocop-rake (~> 0.6)
   rubocop-rspec (~> 2.29)
+  simplecov (~> 0.22)
 
 BUNDLED WITH
    2.4.10

data/README.md

@@ -1,24 +1,75 @@
 # 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.
+ruby gem for encoding and decoding [Monero Payment Request Standard](https://github.com/lukeprofits/Monero_Payment_Request_Standard?tab=readme-ov-file#introduction) requests.
 
 ## 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
+    $ bundle add monerorequest
 
 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
+    $ gem install monerorequest
 
 ## Usage
 
-TODO: Write usage instructions here
+
+### V1
+Encode a request:
+```ruby
+require 'monerorequest'
+
+req = {
+  "custom_label" => "[some string here]",
+  "sellers_wallet" => "[monero main address, starts with 4]",
+  "currency" => "USD",
+  "amount" => 420.69,
+  "payment_id" => "[monero payment ID]",
+  "start_date" => "[timestamp in rfc3339 format]",
+  "days_per_billing_cycle" => 30,
+  "number_of_payments" => 12,
+  "change_indicator_url" => "[some url here]"
+}
+enc = Monerorequest::Encoder.new(req, 1)
+```
+
+Decode a request:
+```ruby
+require 'monerorequest'
+
+req = "monero-request:1:H4sIAAAAAAACAy2QS4vUQBSF/0qondA9XanqJJ3sZjEozGYW4kooKpWbTjmVqnQ9pjuKID7HlStxZiEo4pMBQRAcFPwvCq5c2O0fMD24utxzOR/n3FuItyZoj4o0iWm+k8YjJBqu58CkrqTg3lgWrEIFarzvisnEGlOOG5AVaAtSNDuw4m2nYCJsuIkGd7AWtOgHx8GVgwvBedMyxUvYYtafHrz49fT13+8nb+rNnS/nm7ff3v04vb+/fvj8w/WAcQw/3z++dDnai67tbp4cP4ouRP7787M/Z69eJtF+tNycnd/bW9/9+NUN+Ir3jnVgWSmVknrORC8UoCKnI6RDWw4XU7OO9y1o71BB8hH6vzFZDYFIlRFe1yTPeVblpB6YDpQC69iSD3P4DZruUtybtGxXcqZS08yrlMeYmMNF1lF+o1FULvzMxwL3C3DikAM/8jSmSpbG9NbWqll1mQtJ6jgJJqFHIe+obDQsLU22NZzn1rOKe9hGwmQ6xskYp1fjWTElBaFjnBUYo9v/ANjVPGWxAQAA"
+dec = Monerorequest::Decoder.new(req)
+dec.decode
+```
+
+### V2
+Encode a request:
+```ruby
+require 'monerorequest'
+
+req = {
+  "custom_label" => "[some string here]",
+  "sellers_wallet" => "[monero main address, starts with 4]",
+  "currency" => "USD",
+  "amount" => 420.69,
+  "payment_id" => "[monero payment ID]",
+  "start_date" => "[timestamp in rfc3339 format]",
+  "schedule" => '* * 1 * *',
+  "number_of_payments" => 12,
+  "change_indicator_url" => "[some url here]"
+}
+enc = Monerorequest::Encoder.new(req, 2)
+```
+
+Decode a request:
+```ruby
+require 'monerorequest'
+
+req = "monero-request:2:H4sIAAAAAAACAy2PTW/CMAyG/wrKEVFIE9rS3nbbkcPukZu4JCNNSj6Abtp/X5h2sCw/9vva/iYw++wSGdqm5v2+rXdEanAXFMYpIyH5IHKwZCA6pWU4HIL3Y6XRKHQBjdR7fMK8WDzIkL9IUecQ0Mm1KM7v5z8Qk5+FhRFfNgljKtTlecQg/CQWWGd0KZKB9TvyXwmjyixTHYNpYn0PnerZVHRRalTZYuluN9tNXWL7wmgthigeUHL5hhzfOF19O85Pc7Kt1xfVQk2Zv966hcOnttzc0inVkq43jPIKCPfEa27N6P0awmT1c+libtoILPuG33O/cKMdPgJv4mtlgpCEgvS6hVF2rGhT0fajPg1HNjBe0W6glPz8AihAH5JjAQAA"
+dec = Monerorequest::Decoder.new(req)
+dec.decode
+```
 
 ## Development
 
@@ -26,9 +77,18 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+## Adding a new Monerorequest version
+
+Adding a new Monerorequest version should be simple.
+
+1. Update SUPPORTED_MR_VERSIONS in ```lib/monerorequest.rb```.
+2. Add any necessary pipelines and validators in their respective folders.
+3. Define a file named "vX.rb" where X is your version that pulls in the pipelines and validators it needs.
+4. Make sure you add spec coverage for any new code you write and run ```bundle exec rubocop``` to ensure it passes the linter.
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/monerorequest.
+Bug reports and pull requests are welcome on GitHub at https://github.com/snex/monerorequest.
 
 ## License
 

data/lib/monerorequest/cron.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Monerorequest
+  # Parses and validates cron syntax string.
+  class Cron
+    MONTH_CODES = %w[jan feb mar apr may jun jul aug sep oct nov dec].freeze
+    DOW_CODES = %w[mon tue wed thu fri sat sun].freeze
+    DELIMITERS = %r{,|-|/}.freeze
+    def self.valid?(schedule)
+      parsed_schedule = parse(schedule)
+      return false unless parsed_schedule
+
+      valid_minutes?(parsed_schedule["minutes"]) && valid_hours?(parsed_schedule["hours"]) &&
+        valid_days?(parsed_schedule["days"]) && valid_months?(parsed_schedule["months"]) &&
+        valid_dow?(parsed_schedule["dow"])
+    end
+
+    def self.valid_minutes?(minutes)
+      minutes.all? { |min| ("0".."59").member?(min.to_s) } || minutes == ["*"]
+    end
+
+    def self.valid_hours?(hours)
+      hours.all? { |hr| ("0".."23").member?(hr.to_s) } || hours == ["*"]
+    end
+
+    def self.valid_days?(days)
+      days.all? { |dy| ("1".."31").member?(dy.to_s) } || days == ["*"]
+    end
+
+    def self.valid_months?(months)
+      months.all? do |mth|
+        ("1".."12").member?(mth.to_s) || MONTH_CODES.include?(mth.to_s.downcase)
+      end || months == ["*"] || months == ["L"]
+    end
+
+    def self.valid_dow?(dow)
+      dow.all? { |d| DOW_CODES.include?(d.downcase) } || dow == ["*"]
+    end
+
+    def self.parse(schedule)
+      schedule_parts = schedule.split
+      return false if schedule_parts.length != 5
+
+      {
+        "minutes" => schedule_parts[0].split(DELIMITERS),
+        "hours" => schedule_parts[1].split(DELIMITERS),
+        "days" => schedule_parts[2].split(DELIMITERS),
+        "months" => schedule_parts[3].split(DELIMITERS),
+        "dow" => schedule_parts[4].split(DELIMITERS)
+      }
+    end
+  end
+end

data/lib/monerorequest/decoder.rb

@@ -1,19 +1,43 @@
 # frozen_string_literal: true
 
+Monerorequest::SUPPORTED_MR_VERSIONS.each do |mr_v|
+  require_relative "v#{mr_v}"
+end
+
 module Monerorequest
-  # class to Decode an encoded Monerorequest
+  # class to choose a proper Decoder Version and then pass the encoded data to it for decoding
   class Decoder
+    attr_reader :errors
+
     def initialize(request)
       @request = request
+      _, @version, @encoded_str = @request.split(":")
+      raise RequestVersionError, @version unless Monerorequest::SUPPORTED_MR_VERSIONS.include?(@version.to_i)
+
+      @decoder = Object.const_get("Monerorequest::V#{@version}")
     end
 
     def decode
-      _, version, encoded_str = @request.split(":")
-      raise RequestVersionError, "Only Request Version 1 is supported." unless version == "1"
+      @data = @encoded_str
+
+      @decoder::Decoder::PIPELINES.each do |pipeline|
+        @data = pipeline.call(@data)
+      end
+
+      @data["version"] = @version.to_i
+      validate!
+      @data
+    end
+
+    private
+
+    def validate!
+      @errors = []
+      @decoder::VALIDATORS.each do |validator|
+        @errors += validator.validate!(@data)
+      end
 
-      compressed_data = Base64.decode64(encoded_str)
-      json_str = Zlib::GzipReader.new(StringIO.new(compressed_data)).read
-      JSON.parse(json_str)
+      raise InvalidRequestError, "Invalid request: #{@errors}" unless @errors.empty?
     end
   end
 end

data/lib/monerorequest/encoder.rb

@@ -1,105 +1,46 @@
 # frozen_string_literal: true
 
-require "base64"
-require "date"
-require "json"
-require "stringio"
-require "uri"
-require "zlib"
+Monerorequest::SUPPORTED_MR_VERSIONS.each do |mr_v|
+  require_relative "v#{mr_v}"
+end
 
 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 = []
+    def initialize(request, version)
+      raise RequestVersionError, version unless Monerorequest::SUPPORTED_MR_VERSIONS.include?(version.to_i)
 
+      @request = request
+      @version = version.to_i
+      set_encoder_version
       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 encode
+      data = @request
 
-    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
+      @encoder::Encoder::PIPELINES.each do |pipeline|
+        data = pipeline.call(data)
+      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"])
+      "monero-request:#{@version}:#{data}"
     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
+    private
 
-    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)
+    def set_encoder_version
+      @encoder = Object.const_get("Monerorequest::V#{@version}")
     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"] = ""
+    def validate!
+      @errors = []
+      @encoder::VALIDATORS.each do |validator|
+        @errors += validator.validate!(@request)
       end
-      return if @request["change_indicator_url"] =~ URI::DEFAULT_PARSER.make_regexp
 
-      @errors.push("change_indicator_url must be a URL.")
+      raise InvalidRequestError, "Invalid request: #{@errors}" unless @errors.empty?
     end
   end
 end

data/lib/monerorequest/pipeline/base64_decoder.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "base64"
+
+module Monerorequest
+  module Pipeline
+    # pipeline that takes a base64 encoded string and decodes it
+    class Base64Decoder
+      def self.call(input)
+        Base64.strict_decode64(input)
+      end
+    end
+  end
+end

data/lib/monerorequest/pipeline/base64_encoder.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "base64"
+
+module Monerorequest
+  module Pipeline
+    # pipeline that takes a string and base64 encodes it
+    class Base64Encoder
+      def self.call(input)
+        Base64.strict_encode64(input)
+      end
+    end
+  end
+end

data/lib/monerorequest/pipeline/gzip_reader.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "stringio"
+require "zlib"
+
+module Monerorequest
+  module Pipeline
+    # pipeline that takes a gzip blob and unzips it
+    class GzipReader
+      def self.call(input)
+        Zlib::GzipReader.new(StringIO.new(input)).read
+      end
+    end
+  end
+end

data/lib/monerorequest/pipeline/gzip_writer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "stringio"
+require "zlib"
+
+module Monerorequest
+  module Pipeline
+    # pipeline that takes a string and gzips it
+    class GzipWriter
+      def self.call(input)
+        output = StringIO.new
+        gz = Zlib::GzipWriter.new(output, 9)
+        gz.mtime = 0
+        gz.write(input)
+        gz.close
+        output.string
+      end
+    end
+  end
+end

data/lib/monerorequest/pipeline/json_encoder.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Monerorequest
+  module Pipeline
+    # pipeline that takes a hash, sorts by keys, then converts to valid JSON in ASCII encoding
+    class JSONEncoder
+      def self.call(input)
+        raise InvalidRequestError, "Request must be a Hash." unless input.is_a?(Hash)
+
+        input.sort.to_h.to_json.force_encoding("ascii")
+      end
+    end
+  end
+end

data/lib/monerorequest/pipeline/json_parser.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Monerorequest
+  module Pipeline
+    # pipeline that takes a JSON string and converts it into a ruby object
+    class JSONParser
+      def self.call(input)
+        JSON.parse(input)
+      end
+    end
+  end
+end

data/lib/monerorequest/v1.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "pipeline/base64_decoder"
+require_relative "pipeline/base64_encoder"
+require_relative "pipeline/gzip_reader"
+require_relative "pipeline/gzip_writer"
+require_relative "pipeline/json_parser"
+require_relative "pipeline/json_encoder"
+require_relative "validator/custom_label"
+require_relative "validator/sellers_wallet"
+require_relative "validator/currency"
+require_relative "validator/amount"
+require_relative "validator/payment_id"
+require_relative "validator/start_date"
+require_relative "validator/days_per_billing_cycle"
+require_relative "validator/number_of_payments"
+require_relative "validator/change_indicator_url"
+
+module Monerorequest
+  module V1
+    VALIDATORS = [
+      Monerorequest::Validator::CustomLabel,
+      Monerorequest::Validator::SellersWallet,
+      Monerorequest::Validator::Currency,
+      Monerorequest::Validator::Amount,
+      Monerorequest::Validator::PaymentID,
+      Monerorequest::Validator::StartDate,
+      Monerorequest::Validator::DaysPerBillingCycle,
+      Monerorequest::Validator::NumberOfPayments,
+      Monerorequest::Validator::ChangeIndicatorURL
+    ].freeze
+
+    module Encoder
+      PIPELINES = [
+        Monerorequest::Pipeline::JSONEncoder,
+        Monerorequest::Pipeline::GzipWriter,
+        Monerorequest::Pipeline::Base64Encoder
+      ].freeze
+    end
+
+    module Decoder
+      PIPELINES = [
+        Monerorequest::Pipeline::Base64Decoder,
+        Monerorequest::Pipeline::GzipReader,
+        Monerorequest::Pipeline::JSONParser
+      ].freeze
+    end
+  end
+end

data/lib/monerorequest/v2.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "pipeline/base64_decoder"
+require_relative "pipeline/base64_encoder"
+require_relative "pipeline/gzip_reader"
+require_relative "pipeline/gzip_writer"
+require_relative "pipeline/json_parser"
+require_relative "pipeline/json_encoder"
+require_relative "validator/custom_label"
+require_relative "validator/sellers_wallet"
+require_relative "validator/currency"
+require_relative "validator/amount"
+require_relative "validator/payment_id"
+require_relative "validator/start_date"
+require_relative "validator/schedule"
+require_relative "validator/number_of_payments"
+require_relative "validator/change_indicator_url"
+
+module Monerorequest
+  module V2
+    VALIDATORS = [
+      Monerorequest::Validator::CustomLabel,
+      Monerorequest::Validator::SellersWallet,
+      Monerorequest::Validator::Currency,
+      Monerorequest::Validator::Amount,
+      Monerorequest::Validator::PaymentID,
+      Monerorequest::Validator::StartDate,
+      Monerorequest::Validator::Schedule,
+      Monerorequest::Validator::NumberOfPayments,
+      Monerorequest::Validator::ChangeIndicatorURL
+    ].freeze
+
+    module Encoder
+      PIPELINES = [
+        Monerorequest::Pipeline::JSONEncoder,
+        Monerorequest::Pipeline::GzipWriter,
+        Monerorequest::Pipeline::Base64Encoder
+      ].freeze
+    end
+
+    module Decoder
+      PIPELINES = [
+        Monerorequest::Pipeline::Base64Decoder,
+        Monerorequest::Pipeline::GzipReader,
+        Monerorequest::Pipeline::JSONParser
+      ].freeze
+    end
+  end
+end

data/lib/monerorequest/validator/amount.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Monerorequest
+  module Validator
+    # validates the amount field
+    class Amount
+      def self.validate!(data)
+        errors = []
+        errors.push("amount must be present.") unless data.key?("amount")
+        errors.push("amount must be a Numeric.") unless data["amount"].is_a?(Numeric)
+        errors.push("amount must be positive.") unless data["amount"].to_f.positive?
+        errors
+      end
+    end
+  end
+end

data/lib/monerorequest/validator/change_indicator_url.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module Monerorequest
+  module Validator
+    # validates the change_indicator_url field
+    class ChangeIndicatorURL
+      def self.validate!(data)
+        return [] unless data.key?("change_indicator_url")
+
+        errors = []
+        unless data["change_indicator_url"].is_a?(String)
+          errors.push("change_indicator_url must be a String.")
+          data["change_indicator_url"] = ""
+        end
+        return errors if data["change_indicator_url"] =~ URI::DEFAULT_PARSER.make_regexp
+
+        errors.push("change_indicator_url must be a URL.")
+        errors
+      end
+    end
+  end
+end

data/lib/monerorequest/validator/currency.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Monerorequest
+  module Validator
+    # validates the currency field
+    class Currency
+      def self.validate!(data)
+        errors = []
+        errors.push("currency must be present.") unless data.key?("currency")
+        errors.push("currency must be a String.") unless data["currency"].is_a?(String)
+        errors
+      end
+    end
+  end
+end

data/lib/monerorequest/validator/custom_label.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Monerorequest
+  module Validator
+    # validates the custom_label field
+    class CustomLabel
+      def self.validate!(data)
+        errors = []
+        errors.push("custom_label must be present.") unless data.key?("custom_label")
+        errors.push("custom_label must be a String.") unless data["custom_label"].is_a?(String)
+        errors
+      end
+    end
+  end
+end

data/lib/monerorequest/validator/days_per_billing_cycle.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Monerorequest
+  module Validator
+    # validates the days_per_billing_cycle field
+    class DaysPerBillingCycle
+      def self.validate!(data)
+        errors = []
+        errors.push("days_per_billing_cycle must be present.") unless data.key?("days_per_billing_cycle")
+        errors.push("days_per_billing_cycle must be an Integer.") unless data["days_per_billing_cycle"].is_a?(Integer)
+        errors.push("days_per_billing_cycle must be positive.") unless data["days_per_billing_cycle"].to_i.positive?
+        errors
+      end
+    end
+  end
+end

data/lib/monerorequest/validator/number_of_payments.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Monerorequest
+  module Validator
+    # validates the number_of_payments field
+    class NumberOfPayments
+      def self.validate!(data)
+        errors = []
+        errors.push("number_of_payments must be present.") unless data.key?("number_of_payments")
+        errors.push("number_of_payments must be an Integer.") unless data["number_of_payments"].is_a?(Integer)
+        errors.push("number_of_payments must be 0 or positive.") if data["number_of_payments"].to_i.negative?
+        errors
+      end
+    end
+  end
+end

data/lib/monerorequest/validator/payment_id.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Monerorequest
+  module Validator
+    # validates the payment_id field
+    class PaymentID
+      def self.validate!(data)
+        errors = []
+        errors.push("payment_id must be present.") unless data.key?("payment_id")
+        errors.push("payment_id must be a Monero Payment ID.") unless MoneroPaymentID.valid?(data["payment_id"])
+        errors
+      end
+    end
+  end
+end

data/lib/monerorequest/validator/schedule.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Monerorequest
+  module Validator
+    # validates the schedule field
+    class Schedule
+      def self.validate!(data)
+        errors = []
+        errors.push("schedule must be present.") unless data.key?("schedule")
+        errors.push("schedule must be a valid Cron.") unless Cron.valid?(data.fetch("schedule", ""))
+        errors
+      end
+    end
+  end
+end

data/lib/monerorequest/validator/sellers_wallet.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Monerorequest
+  module Validator
+    # validates the sellers_wallet field
+    class SellersWallet
+      def self.validate!(data)
+        errors = []
+        errors.push("sellers_wallet must be present.") unless data.key?("sellers_wallet")
+        return errors if MoneroAddress.valid?(data["sellers_wallet"])
+
+        errors.push("sellers_wallet must be a main Monero address.")
+        errors
+      end
+    end
+  end
+end

data/lib/monerorequest/validator/start_date.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "date"
+
+module Monerorequest
+  module Validator
+    # validates the start_date field
+    class StartDate
+      def self.validate!(data)
+        errors = []
+        errors.push("start_date must be present.") unless data.key?("start_date")
+        errors.push("start_date must be a String.") && data["start_date"] = "" unless data["start_date"].is_a?(String)
+        begin
+          DateTime.rfc3339(data["start_date"])
+        rescue Date::Error
+          errors.push("start_date must be an RFC3339 timestamp.")
+        end
+        errors
+      end
+    end
+  end
+end

data/lib/monerorequest/version.rb

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

data/lib/monerorequest.rb

@@ -1,17 +1,26 @@
 # frozen_string_literal: true
 
-require "base64"
-require "date"
-require "json"
-require "stringio"
-require "uri"
-require "zlib"
+module Monerorequest
+  SUPPORTED_MR_VERSIONS = [1, 2].freeze
+
+  # error raised when an unsupported Monerorequest version is supplied
+  class RequestVersionError < StandardError
+    def initialize(version)
+      @version = version
+      super
+    end
+
+    def message
+      "Unknown version: #{@version}. Allowed versions: #{Monerorequest::SUPPORTED_MR_VERSIONS}"
+    end
+  end
+
+  class InvalidRequestError < StandardError; end
+end
+
 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
+require_relative "monerorequest/cron"

data/monerorequest.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/monerorequest/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "monerorequest"
+  spec.version = Monerorequest::VERSION
+  spec.authors = ["David Havlicek"]
+  spec.email = ["snex00@protonmail.com"]
+
+  spec.summary = "Ruby Implementation of the Monero Payment Request Standard. https://github.com/lukeprofits/Monero_Payment_Request_Standard"
+  spec.homepage = "https://github.com/snex/monerorequest-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/snex/monerorequest-ruby/blob/master/CHANGELOG.md"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monerorequest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - David Havlicek
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2025-01-13 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -26,12 +26,31 @@ files:
 - README.md
 - Rakefile
 - lib/monerorequest.rb
+- lib/monerorequest/cron.rb
 - lib/monerorequest/decoder.rb
 - lib/monerorequest/encoder.rb
 - lib/monerorequest/monero_address.rb
 - lib/monerorequest/monero_payment_id.rb
+- lib/monerorequest/pipeline/base64_decoder.rb
+- lib/monerorequest/pipeline/base64_encoder.rb
+- lib/monerorequest/pipeline/gzip_reader.rb
+- lib/monerorequest/pipeline/gzip_writer.rb
+- lib/monerorequest/pipeline/json_encoder.rb
+- lib/monerorequest/pipeline/json_parser.rb
+- lib/monerorequest/v1.rb
+- lib/monerorequest/v2.rb
+- lib/monerorequest/validator/amount.rb
+- lib/monerorequest/validator/change_indicator_url.rb
+- lib/monerorequest/validator/currency.rb
+- lib/monerorequest/validator/custom_label.rb
+- lib/monerorequest/validator/days_per_billing_cycle.rb
+- lib/monerorequest/validator/number_of_payments.rb
+- lib/monerorequest/validator/payment_id.rb
+- lib/monerorequest/validator/schedule.rb
+- lib/monerorequest/validator/sellers_wallet.rb
+- lib/monerorequest/validator/start_date.rb
 - lib/monerorequest/version.rb
-- sig/monerorequest.rbs
+- monerorequest.gemspec
 homepage: https://github.com/snex/monerorequest-ruby
 licenses:
 - MIT

data/sig/monerorequest.rbs

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