lnurl 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7443ff0fc221e5247543a75d527c698530044a6393d4fc801df66007a434778
-  data.tar.gz: c988ccbcd5bab31a03611f0e6d47558285e3adff4fd973d948854e8677e35253
+  metadata.gz: bb41a73ee0984e37274f04544835308f492c64fb1a53f64f86160320b440a501
+  data.tar.gz: 4f0a3139f4e8ac0e6f55d8933ac7afc8b7afd55219da5a0c7846230d34ec17fd
 SHA512:
-  metadata.gz: edcd40864609a8c8d769009591d38bf831f226bc0edaeea0f06a368dcee87a1adc71b67d555c3a6ae8099512e6aec88ceff2d51ba95e0ea7fc5c1db71bcd9324
-  data.tar.gz: 63a3143050e8b271a0aa33ecb07bbaf76bf29e3f3105d2b9afcdd50631539dbc188bee4d0dcb7764bd81633b17543c50314642a74fc9ef5b30469d39b3e576ad
+  metadata.gz: 46d6ab4938ad39f8810cd640f51c4476775ac22f1f09ab73ae93613789e3ea8d4d4fbcd4cbfa5c221a31ee6b72f40070b907961500669d1c8a2a91c479ab1d9e
+  data.tar.gz: 6416737b60aaf96f4881d92657789d8e2527def63b035a449bd70fc0989afa61511deaf9bc318d952c9eeb27332436187a51949ef8a51216cdb479040e9bf25b

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    lnurl (0.1.1)
-      bech32 (~> 1.2.0)
+    lnurl (1.1.1)
+      bech32 (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    bech32 (1.2.1)
+    bech32 (1.4.2)
       thor (>= 1.1.0)
     diff-lcs (1.4.4)
     rake (12.3.3)
@@ -24,7 +24,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    thor (1.1.0)
+    thor (1.2.2)
 
 PLATFORMS
   ruby
@@ -35,4 +35,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.2.23
+   2.4.4

data/README.md

@@ -42,6 +42,18 @@ lnurl = Lnurl.decode('LNURL1DP68GURN8GHJ7MRWW4EXCTNRDAKJ7URP0YVM59LW')
 lnurl.uri # => #<URI::HTTPS https://lnurl.com/pay>
 ```
 
+By default we accept long LNURLs but you can configure a custom max length:
+```ruby
+lnurl = Lnurl.decode(a_short_lnurl, 90)
+```
+
+### [Lightning Address](https://github.com/andrerfneves/lightning-address)
+
+```ruby
+lnurl = Lnurl.from_lightning_address('user@lnurl.com')
+lnurl.uri # => #<URI::HTTPS https://lnurl.com/.well-known/lnurlp/user>
+```
+
 ### LNURL responses
 
 ```ruby

data/lib/lnurl.rb

@@ -4,7 +4,11 @@ require 'json'
 require 'ostruct'
 
 class Lnurl
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.1.1'.freeze
+
+  # Maximum integer size
+  # Useful for max_length when decoding
+  MAX_INTEGER = 2**31 - 1
 
   InvoiceResponse = Class.new(OpenStruct)
   LnurlResponse = Class.new(OpenStruct) do
@@ -16,7 +20,7 @@ class Lnurl
         args = Hash[URI.decode_www_form(callback_uri.query)].merge(args) # reverse merge
       end
       callback_uri.query = URI.encode_www_form(args)
-      body = Net::HTTP.get(callback_uri)
+      body = Lnurl.http_get(callback_uri)
       InvoiceResponse.new JSON.parse(body)
     end
   end
@@ -40,7 +44,7 @@ class Lnurl
 
   def response
     @response ||= begin
-                    body = Net::HTTP.get(uri) # TODO: redirects?
+                    body = self.class.http_get(uri)
                     LnurlResponse.new JSON.parse(body)
                   end
   end
@@ -61,17 +65,26 @@ class Lnurl
     return decoded.match?(URI.regexp) # check if the URI is valid
   end
 
-  def self.decode(lnurl)
-    Lnurl.new(decode_raw(lnurl))
+  def self.decode(lnurl, max_length = MAX_INTEGER)
+    Lnurl.new(decode_raw(lnurl, max_length))
   end
 
-  def self.decode_raw(lnurl)
+  def self.decode_raw(lnurl, max_length = MAX_INTEGER)
     lnurl = lnurl.gsub(/^lightning:/, '')
-    hrp, data, sepc = Bech32.decode(lnurl)
+    hrp, data, sepc = Bech32.decode(lnurl, max_length)
     # raise 'no lnurl' if hrp != HRP
     convert_bits(data, 5, 8, false).pack('C*').force_encoding('utf-8')
   end
 
+  def self.from_lightning_address(lightning_address)
+    Lnurl.new(decode_lightning_address(lightning_address))
+  end
+
+  def self.decode_lightning_address(lightning_address)
+    username, domain = lightning_address.split('@')
+    "https://#{domain}/.well-known/lnurlp/#{username}"
+  end
+
   # FROM: https://github.com/azuchi/bech32rb/blob/master/lib/bech32/segwit_addr.rb
   def self.convert_bits(data, from, to, padding=true)
     acc = 0
@@ -95,4 +108,19 @@ class Lnurl
     end
     ret
   end
+
+  # Handles HTTP GET requests and follows redirects if necessary
+  def self.http_get(uri, limit = 10)
+    raise ArgumentError, 'too many HTTP redirects' if limit.zero?
+
+    response = Net::HTTP.get_response(uri)
+
+    case response
+    when Net::HTTPRedirection
+      location = response['location']
+      http_get(URI(location), limit - 1)
+    else
+      response.body
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lnurl
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Michael Bumann
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-13 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bech32
@@ -51,7 +51,7 @@ metadata:
   homepage_uri: https://github.com/bumi/lnurl-ruby
   source_code_uri: https://github.com/bumi/lnurl-ruby
   funding: lightning:02ad33d99d0bb3bf3bb8ec8e089cbefa8fd7de23a13cfa59aec9af9730816be76f
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -66,8 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.23
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: LNURL implementation for ruby
 test_files: []