monerorequest 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4efb26bf1513834ee0b68535033a34350a5f159adba869ff3e8682d8612cdabf
-  data.tar.gz: 48ee1c05ae0db4195692ecc06a14bc2a26504982a0c81c9ab8ec1ee390832cb9
+  metadata.gz: 1eb8bfed0d690a9ea26e823821d01f213036b54f72dbf0f4b860c81b46860092
+  data.tar.gz: 6ff77765db25d97e72f8cdb156bb3077587608bed69a66c947cce6433ffbd717
 SHA512:
-  metadata.gz: c27b72a81046b8bf050f0118f5c0cb683b7929a0921ffb592ec45388f99d6bb2c82c9695e9e95225a6a051165f7ac6c2c6bfe6d9520dd2d4f1725d89520d4a1a
-  data.tar.gz: 65e8f263bf3280a640471114d45658e148725c50dc88d4455c75a3620dc27f0b4e61eced65c9150427ee140f8c72948b7d8899b99a22bc530dcafa3b036605ad
+  metadata.gz: ade67de2f1881fa4e46309c0e0a6187a55c7b965199f1e0fa8e1990845d6a28f6217459185e2b3c3026a2334a107f71734c6692a0805ba2995dfac76f630869b
+  data.tar.gz: 7f50f46fb99f008027789bf5a528e98cd32d960eaebc9cc8c32dc8a72e124aaa386c89126d216c00f5685c82303253ef562d7fe07904ecfcc8b982a31b499957

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    monerorequest (0.1.0)
+    monerorequest (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,24 +1,80 @@
 # 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)
+enc.encode(1)
+```
+
+Decode a request:
+```ruby
+require 'monerorequest'
+
+req = "monero-request:1:H4sIAAAAAAACAy2QS4vUQBSF/0qondA9XanqJJ3sZjEozGYW4kooKpWbTjmVqnQ9pjuKID7HlStxZiEo4pMBQRAcFPwvCq5c2O0fMD24utxzOR/n3FuItyZoj4o0iWm+k8YjJBqu58CkrqTg3lg
+WrEIFarzvisnEGlOOG5AVaAtSNDuw4m2nYCJsuIkGd7AWtOgHx8GVgwvBedMyxUvYYtafHrz49fT13+8nb+rNnS/nm7ff3v04vb+/fvj8w/WAcQw/3z++dDnai67tbp4cP4ouRP7787M/Z69eJtF+tNycnd/bW9/9+NUN+Ir3jnVgWSmVknrORC8
+UoCKnI6RDWw4XU7OO9y1o71BB8hH6vzFZDYFIlRFe1yTPeVblpB6YDpQC69iSD3P4DZruUtybtGxXcqZS08yrlMeYmMNF1lF+o1FULvzMxwL3C3DikAM/8jSmSpbG9NbWqll1mQtJ6jgJJqFHIe+obDQsLU22NZzn1rOKe9hGwmQ6xskYp1fjWTE
+lBaFjnBUYo9v/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)
+enc.encode(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
 
@@ -28,7 +84,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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,51 @@
+# 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) } || minutes == ["*"]
+    end
+
+    def self.valid_hours?(hours)
+      hours.all? { |hr| ("0".."23").member?(hr) } || hours == ["*"]
+    end
+
+    def self.valid_days?(days)
+      days.all? { |dy| (1..31).member?(dy.to_i) } || days == ["*"]
+    end
+
+    def self.valid_months?(months)
+      months.all? { |mth| (1..12).member?(mth.to_i) || MONTH_CODES.include?(mth.downcase) } || months == ["*"]
+    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

@@ -9,11 +9,13 @@ module Monerorequest
 
     def decode
       _, version, encoded_str = @request.split(":")
-      raise RequestVersionError, "Only Request Version 1 is supported." unless version == "1"
+      raise RequestVersionError, "Request Versions 1 and 2 are supported." unless [1, 2].include?(version.to_i)
 
       compressed_data = Base64.decode64(encoded_str)
       json_str = Zlib::GzipReader.new(StringIO.new(compressed_data)).read
-      JSON.parse(json_str)
+      decoded_hash = JSON.parse(json_str)
+      decoded_hash["version"] = version.to_i
+      decoded_hash
     end
   end
 end

data/lib/monerorequest/encoder.rb

@@ -23,7 +23,7 @@ module Monerorequest
     end
 
     def encode(version)
-      raise RequestVersionError, "Only Request Version 1 is supported." unless version == 1
+      raise RequestVersionError, "Request Versions 1 and 2 are supported." unless [1, 2].include?(version.to_i)
 
       json_str = @request.sort.to_h.to_json.force_encoding("ascii")
       compressed_data = StringIO.new
@@ -32,7 +32,7 @@ module Monerorequest
       gz.write(json_str)
       gz.close
       encoded_str = Base64.encode64(compressed_data.string).gsub("\n", "")
-      "monero-request:1:#{encoded_str}"
+      "monero-request:#{version}:#{encoded_str}"
     end
 
     private
@@ -44,7 +44,8 @@ module Monerorequest
       validate_amount!
       validate_payment_id!
       validate_start_date!
-      validate_days_per_billing_cycle!
+      validate_days_per_billing_cycle! if @request["version"] == 1
+      validate_schedule! if @request["version"] == 2
       validate_change_indicator_url!
     end
 
@@ -88,7 +89,9 @@ module Monerorequest
     end
 
     def validate_days_per_billing_cycle!
-      @errors.push("days_per_billing_cycle must be present.") unless @request.key?("days_per_billing_cycle")
+      unless @request.key?("days_per_billing_cycle") && @request["version"] == "1"
+        @errors.push("days_per_billing_cycle must be present.")
+      end
       @errors.push("days_per_billing_cycle must be a Integer.") unless @request["days_per_billing_cycle"].is_a?(Integer)
     end
 
@@ -101,5 +104,10 @@ module Monerorequest
 
       @errors.push("change_indicator_url must be a URL.")
     end
+
+    def validate_schedule!
+      @errors.push("schedule must be present.") unless @request.key?("schedule")
+      @errors.push("schedule must be a valid Cron.") unless Cron.valid?(@request.fetch("schedule", ""))
+    end
   end
 end

data/lib/monerorequest/version.rb

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

data/lib/monerorequest.rb

@@ -11,6 +11,7 @@ require_relative "monerorequest/encoder"
 require_relative "monerorequest/monero_address"
 require_relative "monerorequest/monero_payment_id"
 require_relative "monerorequest/version"
+require_relative "monerorequest/cron"
 
 module Monerorequest
   class RequestVersionError < StandardError; end

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: 0.2.0
 platform: ruby
 authors:
 - David Havlicek
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2025-01-10 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -26,11 +26,13 @@ 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/version.rb
+- monerorequest.gemspec
 - sig/monerorequest.rbs
 homepage: https://github.com/snex/monerorequest-ruby
 licenses: