bundler-thankyou 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e83194e1e683b5aad584eca997d6acc0409a8b5db294196728473743a143067
+  data.tar.gz: 1e4e2e02a1c10b841277d9789f5e885e2dca73d076f4b61faea78cc2816920d8
+SHA512:
+  metadata.gz: bf960135a2c1923d549c50ebd63c501f6c752a6b0c9583084809f2618463f42742f25f93f60ff556fa58b8411f5aaf7848bda534ed4167d905f519f018d21719
+  data.tar.gz: 0ad710a81c5a1df0e88f547514e10e444e2ad47db6c1b5e4f4da295dc810435dec0e2ff214831ef6f463a59a90d5e885afbea506a7667aff9c853859fb95b5dc

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bundle-thankyou.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    bundler-thankyou (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler-thankyou!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Michael Bumann
+
+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,76 @@
+
+
+# Bundler::Thankyou
+## lightning donation system for rubygems (and other package managers)
+
+
+## Background
+
+### What the author needs to do:
+
+The gem authoer adds a funding details to the gemspec (in the metadata hash). This currently either can be a lightning node pubkey (that can receive keysend payments) or a LNURL.
+
+That's it. That is all the author needs to do. 
+
+Because of the funding details are in the gemspec we can be sure it is where the author/maintainer wants the money to go to. 
+
+The author could also decide to dedicate the donations to somebody else. For example the rails gems could say thankyous should go to RailsGirls or similar projects. 
+
+### What the user has to do:
+
+Use this tool and basically run `bundle thankyou` and specify a desired amount. The amount will automatically be split among all the used gems.
+
+### Advantages
+
+* No signup whatsover
+* User and maintainer do not need to agree on a service (like paypal) to perform the transaction
+* No central directories
+* Based on existing tools (rubygems)
+* Implemented on a "protocol level" - additional service can be built and integrated. (like subscriptions, etc.)
+* Works internationally
+* Usable at the moment where the user interacts with the gems (in the terminal running a bundle command)
+* Minimal fees and all the Bitcoin/Lightning advantages
+
+## Questions?
+
+### Why Bitcoin? 
+
+It is pretty much the only adopted solution to build such things.
+
+### But I want to pay with credit card (or whatever else)
+
+Bitcoin is used as a method/"protocol" to transfer value. 
+
+We could provide additional services (for both user and project separately) to better fit their needs - for example different payment methods, subscriptions, etc. 
+
+### But I want to receive payments on my credit card
+
+Again Bitcoin is the "protocol". There are already plenty tools out there that for example give you a visa/master card for spending the received bitcoins. 
+
+## A comment about money
+
+I am very critical about the human perception of the "payment". I do not want it to feel like I've "paid" somebody for something.   
+The tone/message is super important and it should not be "payment" but a way of saying "thank you"... thus bundle thankyou. 
+
+
+## Installation
+
+
+## Usage
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bumi/bundler-thankyou.
+
+
+## Contact
+
+If you have questions, feedback, ideas please contact me... or even better open an issue. 
+
+Michael Bumann  
+[@bumi](http://twitter.com/bumi)  
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bundle/thankyou"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bundler-thankyou.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/bundler/thankyou/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bundler-thankyou'
+  spec.version       = Bundler::Thankyou::VERSION
+  spec.authors       = ['Michael Bumann']
+  spec.email         = ['hello@michaelbumann.com"']
+
+  spec.summary       = %q{Lightning based donation system for rubygems}
+  spec.description   = %q{A Bitcoin lightning based donation system that allows to send a "thankyou" to the gems in your Gemfile}
+  spec.homepage      = 'https://michaelbumann.com'
+  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/bumi/bundle-thankyou'
+
+  spec.metadata['funding'] = 'lightning:02ad33d99d0bb3bf3bb8ec8e089cbefa8fd7de23a13cfa59aec9af9730816be76f'
+
+  # 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('..', __FILE__)) 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_runtime_dependency 'lightning-invoice', '~> 0.1.5'
+  spec.add_runtime_dependency 'lnurl'
+  spec.add_runtime_dependency 'lnrpc', '>= 0.10.0'
+end

data/exe/bundler-thankyou

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'bundler/thankyou'
+require 'bundler/thankyou/cli'
+Bundler::Thankyou::CLI.start(ARGV)

data/lib/bundler/thankyou.rb

@@ -0,0 +1,52 @@
+require 'json'
+require 'bundler'
+require 'bundler/thankyou/version'
+require 'bundler/thankyou/disbursement'
+
+module Bundler
+  module Thankyou
+    class Error < StandardError; end
+
+    @lnd_client = nil
+
+    def self.lnd_client
+      @lnd_client ||= Lnrpc::Client.new
+    end
+
+    def self.lnd_client=(client)
+      @lnd_client = client
+    end
+
+    def self.specs_from_bundler(options = {})
+      Bundler.load.specs.to_a.tap do |specs|
+        specs.filter! { |s| s.metadata['funding'] && s.metadata['funding'].match?(/^lightning:/) }
+        if options[:only]&.any?
+          specs.filter! { |s| options[:only].include?(s.name) }
+        end
+      end
+    end
+
+    def self.recipients_from_bundler(options = {})
+      specs_from_bundler(options).each_with_object({}) do |spec, memo|
+        memo[spec.name] = 'LNURL1DP68GUP69UHKCMMRV9KXSMMNWSARXVPSXYHKCMN4WFKR76TY85MRXVMRVGERXDPSXQNXU0T9XFNXZVP3X9NRWETP89SKVV34YE6XZEEAWPSHJ5N9W96K2UM5YEKKJMJNV4HXGCTZD3JN6VFSXQCRQFNDV9U9XETWV3SKYMR9856NQVPSXQCRQVPXD4JHGCTYV96XZ02MTVJNYVN5V4U8GFFJGECXCCTFDCJNYV39XFPJ2V3JWA5XZAR9WEJHYFFJXFW46FNN85UKZCFNX4JRZDMRXUCNGVPEVGCXYDNRXYEKXDFKVVCKYWFKXYERYCE3XSEKXWF48Q6NVVTZX33KYD3EXFJRJE3HXQMR2VE4V4JXGDE5FH9YHF' #spec.metadata['funding'].gsub(/^lightning:/, '')
+      end
+    end
+
+    def self.specs_from_rubygems(names)
+      specs = names.collect do |name|
+        uri = URI("https://rubygems.org/api/v1/gems/#{name}.json")
+        response = Net::HTTP.get_response(uri)
+        if response.is_a?(Net::HTTPSuccess) # ignore gems that are not found
+          JSON.parse(response.body)
+        end
+      end.compact
+      specs.filter { |s| s['metadata'] && s['metadata']['funding'] && s['metadata']['funding'].match?(/^lightning:/) }
+    end
+
+    def self.recipients_from_rubygems(names)
+      specs_from_rubygems(names).each_with_object({}) do |spec, memo|
+        memo[spec['name']] = 'LNURL1DP68GUP69UHKCMMRV9KXSMMNWSARXVPSXYHKCMN4WFKR76TY85MRXVMRVGERXDPSXQNXU0T9XFNXZVP3X9NRWETP89SKVV34YE6XZEEAWPSHJ5N9W96K2UM5YEKKJMJNV4HXGCTZD3JN6VFSXQCRQFNDV9U9XETWV3SKYMR9856NQVPSXQCRQVPXD4JHGCTYV96XZ02MTVJNYVN5V4U8GFFJGECXCCTFDCJNYV39XFPJ2V3JWA5XZAR9WEJHYFFJXFW46FNN85UKZCFNX4JRZDMRXUCNGVPEVGCXYDNRXYEKXDFKVVCKYWFKXYERYCE3XSEKXWF48Q6NVVTZX33KYD3EXFJRJE3HXQMR2VE4V4JXGDE5FH9YHF' #spec['metadata']['funding'].gsub(/^lightning:/, '')
+      end
+    end
+  end
+end

data/lib/bundler/thankyou/cli.rb

@@ -0,0 +1,115 @@
+require 'bundler'
+require 'bundler/vendored_thor'
+require 'yaml'
+require 'lnrpc'
+
+module Bundler
+  module Thankyou
+    class CLI < Thor
+      include Thor::Actions
+      MINIMUM_AMOUNT = 100 # minimum amount in sats for each recipient
+
+      CONFIG_FILE = File.join(ENV['HOME'], '.bundle-thankyou.yml')
+      attr_accessor :recipients, :amount
+
+      default_task :gemfile
+
+      method_option :amount,  type: :numeric, aliases: '-a'
+      method_option :only,    type: :array,   aliases: '-o'
+      method_option :verbose, type: :boolean, aliases: '-v'
+      desc 'gemfile', 'Send a payment to gems in the Gemfile'
+      def gemfile
+        say "Analyzing Gemfile: #{Bundler.default_gemfile}"
+        say '...'
+
+        self.recipients = Bundler::Thankyou.recipients_from_bundler(options)
+        disburse!
+      end
+
+      method_option :amount,  type: :numeric, aliases: '-a'
+      method_option :only,    type: :array,   aliases: '-o'
+      method_option :verbose, type: :boolean, aliases: '-v'
+      desc 'fund <names>', 'Send to to specific gems'
+      def fund(*names)
+        if names.empty?
+          invoke :gemfile
+        else
+          self.recipients = Bundler::Thankyou.recipients_from_rubygems(names)
+          disburse!
+        end
+      end
+
+      desc 'setup', 'Setup your lnd connection'
+      def setup
+        say 'Connecting your LND node'
+        config = {}
+        config['address'] = ask('Address of your LND node (e.g. localhost:10009):')
+        config['macaroon_path'] = ask('Macaroon file path: (e.g. /path/to/admin.macaroon):', path: true)
+        config['credentials_path'] = ask('Credentials file path: (e.g. /path/to/tls.cert):', path: true)
+        add_file(CONFIG_FILE, YAML.dump(config))
+        node_info = lnd_client.lightning.get_info
+        say "Successfully connected to #{node_info['alias']} #{node_info['identity_pubkey']}"
+      end
+
+      no_commands do
+
+        def disburse!
+          say "Found #{recipients.count} fundable gems", Shell::Color::BLUE
+          if recipients.count < 1
+            exit
+          end
+          shell.print_table(recipients.to_a, indent: 4, truncate: true)
+          say
+
+          if options[:amount].nil?
+            self.amount = ask('How many sats do you want do send in total?', Shell::Color::RED).to_i
+            say
+          end
+          Bundler::Thankyou.lnd_client = lnd_client
+
+          say "Sending #{amount} sats split among #{recipients.count} recipients"
+          say
+          if amount / recipients.count < MINIMUM_AMOUNT
+            say "A minimum of #{MINIMUM_AMOUNT * recipients.count} sats is required", Shell::Color::RED
+            exit
+          end
+
+          disbursment = Disbursement.new(recipients: recipients, total_amount: amount)
+
+          shell.indent do
+            disbursment.pay! do |result|
+              states = result[:payment_states].map(&:status)
+              if states.include?(:SUCCEEDED)
+                say "Sent #{result[:amount]} to #{result[:name]}"
+              else
+                say "Failed to send to #{result[:name]}"
+                result[:payment_states].each do |r|
+                  say r.inspect
+                end if options[:verbose]
+              end
+            end
+          end
+
+          say
+          say 'Done! Thank you!', Shell::Color::BLUE
+        end
+
+        def lnd_config
+          if File.exist?(CONFIG_FILE)
+            YAML.safe_load(File.read(CONFIG_FILE)).transform_keys(&:to_sym)
+          else # TODO: check env variables
+            {}
+          end
+        end
+
+        def lnd_client
+          @lnd_client ||= Lnrpc::Client.new(lnd_config)
+        end
+
+        def amount
+          @amount || options[:amount]
+        end
+      end
+    end
+  end
+end

data/lib/bundler/thankyou/disbursement.rb

@@ -0,0 +1,80 @@
+require 'lnrpc'
+require 'lnurl'
+require 'lightning/invoice'
+
+module Bundler
+  module Thankyou
+    class Disbursement
+      attr_accessor :total_amount, :recipients
+
+      def initialize(recipients:, total_amount:)
+        self.recipients   = recipients
+        self.total_amount = total_amount
+      end
+
+      def amount_per_recipient
+        @amount_per_recipient ||= total_amount / recipients.count
+      end
+
+      def amount_per_recipient_msat
+        amount_per_recipient * 1000
+      end
+
+      def pay!
+        recipients.each do |name, pubkey_or_lnurl|
+          result_array = if Lnurl.valid?(pubkey_or_lnurl)
+                           pay_lnurl(pubkey_or_lnurl)
+                         else
+                           pay_keysend(pubkey_or_lnurl)
+                         end
+          yield({ name: name, payment_states: result_array, amount: amount_per_recipient }) if block_given?
+        end
+      end
+
+      def pay_keysend(pubkey)
+        dest = Lnrpc.to_byte_array(pubkey)
+        Bundler::Thankyou.lnd_client.keysend(dest: dest, amt: amount_per_recipient).to_a
+      end
+
+      def pay_lnurl(lnurl)
+        lnurl = Lnurl.decode(lnurl)
+        lnurl_response = lnurl.response
+        invoice_response = lnurl_response.request_invoice(amount: amount_per_recipient_msat )
+        if invoice_response.status.to_s.downcase == 'error'
+          return [OpenStruct.new(status: 'ERROR', lnurl_response: invoice_response)] # ignore for now. returning an error similar to the response from send_payment_v2
+        end
+        invoice = Lightning::Invoice.parse(invoice_response.pr)
+        if invoice_valid?(invoice: invoice, lnurl_response: lnurl_response)
+          args = { payment_request: invoice_response.pr }
+          args[:amt] = amount_per_recipient if invoice.amount.nil? # if the invoice does not specify an amount
+          Bundler::Thankyou.lnd_client.pay(args).to_a
+        else
+          [OpenStruct.new(status: 'ERROR', message: 'invoice invalid')] # ignoring invalid invoices but keeping the method signature, returning an error similar to the response from send_payment_v2
+        end
+      end
+
+      def invoice_valid?(invoice:, lnurl_response:)
+        # invalid if the amount is too high
+        return false if !invoice.amount.nil? && invoice_amount_in_satoshi(invoice) > amount_per_recipient
+        # invalid if it is expired
+        return false if Time.now.to_i > invoice.timestamp + (invoice.expiry || 3600).to_i
+
+        # if the invoice does not specify an amount we check if the amount_per_recipient is within the sendable amount defined in the lnurl
+        return false if invoice.amount.nil? && (amount_per_recipient_msat < lnurl_response.minSendable || amount_per_recipient_msat > lnurl_response.maxSendable)
+
+        return true # default
+      end
+
+      def invoice_amount_in_satoshi(invoice)
+        return if invoice.amount.nil?
+        multi = {
+          'm' => 0.001,
+          'u' => 0.000001,
+          'n' => 0.000000001,
+          'p' => 0.000000000001
+        }[invoice.multiplier]
+        (invoice.amount * multi * 100000000).to_i # amount in bitcoin * 100000000
+      end
+    end
+  end
+end

data/lib/bundler/thankyou/version.rb

@@ -0,0 +1,5 @@
+module Bundler
+  module Thankyou
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: bundler-thankyou
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Bumann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lightning-invoice
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: lnurl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lnrpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: A Bitcoin lightning based donation system that allows to send a "thankyou"
+  to the gems in your Gemfile
+email:
+- hello@michaelbumann.com"
+executables:
+- bundler-thankyou
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bundler-thankyou.gemspec
+- exe/bundler-thankyou
+- lib/bundler/thankyou.rb
+- lib/bundler/thankyou/cli.rb
+- lib/bundler/thankyou/disbursement.rb
+- lib/bundler/thankyou/version.rb
+homepage: https://michaelbumann.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://michaelbumann.com
+  source_code_uri: https://github.com/bumi/bundle-thankyou
+  funding: lightning:02ad33d99d0bb3bf3bb8ec8e089cbefa8fd7de23a13cfa59aec9af9730816be76f
+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: Lightning based donation system for rubygems
+test_files: []