isolating modules

Author: icebaker

README.md

@@ -2,6 +2,8 @@
 
 > ⚠️ Warning: Early-stage, breaking changes are expected.
 
+This is a low-level client library. For a better experience, you may want to check out the [Lighstorm](https://github.com/icebaker/lighstorm) abstraction.
+
 - [Usage](#usage)
   - [Channel Arguments](#channel-arguments)
   - [Documentation](#documentation)

Rakefile

@@ -5,6 +5,6 @@ require_relative './controllers/grpc_generator'
 namespace :grpc do
   desc 'Upgrade lnd Protocol Buffers for gGRPC'
   task :upgrade do
-    GrpcGeneratorController.upgrade!
+    LNDClientInternal::GrpcGeneratorController.upgrade!
   end
 end

components/grpc.rb

@@ -3,9 +3,11 @@
 require_relative './grpc/lightning_services_pb'
 require_relative './grpc/routerrpc/router_services_pb'
 
-module GRPC
-  SERVICES = {
-    lightning: Lnrpc::Lightning,
-    router: Routerrpc::Router
-  }.freeze
+module LNDClientInternal
+  module GRPC
+    SERVICES = {
+      lightning: Lnrpc::Lightning,
+      router: Routerrpc::Router
+    }.freeze
+  end
 end

controllers/client.rb

@@ -4,28 +4,34 @@
 require_relative 'config'
 require_relative 'service'
 
-class ClientController
-  attr_reader :config, :doc
+module LNDClientInternal
+  class ClientController
+    attr_reader :config, :doc
 
-  def initialize(options)
-    @config = ConfigController.new(self, options)
-    @services = {}
+    def initialize(options)
+      @config = LNDClientInternal::ConfigController.new(self, options)
+      @services = {}
 
-    doc = Struct.new(:services)
-    @doc = doc.new(GRPC::SERVICES.keys.map(&:to_s))
-  end
+      doc = Struct.new(:services)
+      @doc = doc.new(LNDClientInternal::GRPC::SERVICES.keys.map(&:to_s))
+    end
 
-  def respond_to_missing?(method_name, include_private = false)
-    service_key = method_name.to_sym
+    def respond_to_missing?(method_name, include_private = false)
+      service_key = method_name.to_sym
 
-    GRPC::SERVICES.include?(service_key) || super
-  end
+      LNDClientInternal::GRPC::SERVICES.include?(service_key) || super
+    end
 
-  def method_missing(method_name, *args)
-    service_key = method_name.to_sym
+    def method_missing(method_name, *args)
+      service_key = method_name.to_sym
 
-    raise ArgumentError, "Method `#{method_name}` doesn't exist." unless GRPC::SERVICES.include?(service_key)
+      unless LNDClientInternal::GRPC::SERVICES.include?(service_key)
+        raise ArgumentError, "Method `#{method_name}` doesn't exist."
+      end
 
-    @services[service_key] ||= ServiceController.new(self, GRPC::SERVICES[service_key], *args)
+      @services[service_key] ||= LNDClientInternal::ServiceController.new(
+        self, LNDClientInternal::GRPC::SERVICES[service_key], *args
+      )
+    end
   end
 end

controllers/config.rb

@@ -2,34 +2,36 @@
 
 require 'grpc'
 
-class ConfigController
-  attr_reader :socket_address, :credentials, :certificate, :macaroon
+module LNDClientInternal
+  class ConfigController
+    attr_reader :socket_address, :credentials, :certificate, :macaroon
 
-  def initialize(client, options)
-    @client = client
+    def initialize(client, options)
+      @client = client
 
-    @certificate_path = options[:certificate_path]
-    @certificate = options[:certificate]
+      @certificate_path = options[:certificate_path]
+      @certificate = options[:certificate]
 
-    @macaroon_path = options[:macaroon_path]
-    @macaroon = options[:macaroon]
+      @macaroon_path = options[:macaroon_path]
+      @macaroon = options[:macaroon]
 
-    @socket_address = options[:socket_address] || '127.0.0.1:10009'
+      @socket_address = options[:socket_address] || '127.0.0.1:10009'
 
-    setup_certificate!
-    setup_macaroon!
-  end
+      setup_certificate!
+      setup_macaroon!
+    end
 
-  def setup_certificate!
-    raise 'conflicting options for certificate' if @certificate && @certificate_path
+    def setup_certificate!
+      raise 'conflicting options for certificate' if @certificate && @certificate_path
 
-    @certificate = File.read(@certificate_path) if @certificate_path
-    @credentials = GRPC::Core::ChannelCredentials.new(@certificate)
-  end
+      @certificate = File.read(@certificate_path) if @certificate_path
+      @credentials = ::GRPC::Core::ChannelCredentials.new(@certificate)
+    end
 
-  def setup_macaroon!
-    raise 'conflicting options for macaroon' if @macaroon && @macaroon_path
+    def setup_macaroon!
+      raise 'conflicting options for macaroon' if @macaroon && @macaroon_path
 
-    @macaroon = File.read(@macaroon_path).unpack('H*') if @macaroon_path
+      @macaroon = File.read(@macaroon_path).unpack('H*') if @macaroon_path
+    end
   end
 end

controllers/documentation.rb

@@ -2,44 +2,46 @@
 
 require_relative '../logic/string'
 
-class DocumentationController
-  attr_reader :available_methods
+module LNDClientInternal
+  class DocumentationController
+    attr_reader :available_methods
 
-  def initialize(service)
-    @service = service
-    @descriptions = {}
-    @grpc = {}
+    def initialize(service)
+      @service = service
+      @descriptions = {}
+      @grpc = {}
 
-    build!
-  end
+      build!
+    end
 
-  def build!
-    @available_methods = @service.service.rpc_descs.values.map do |desc|
-      method_name = StringLogic.underscore(desc.name.to_s)
+    def build!
+      @available_methods = @service.service.rpc_descs.values.map do |desc|
+        method_name = LNDClientInternal::StringLogic.underscore(desc.name.to_s)
 
-      build_description!(method_name, desc)
+        build_description!(method_name, desc)
 
-      @grpc[method_name] = desc
+        @grpc[method_name] = desc
 
-      method_name
-    end.sort
-  end
+        method_name
+      end.sort
+    end
 
-  def build_description!(method_name, desc)
-    input = desc.input.new.to_h if desc.input.respond_to?(:new)
-    output = desc.output.new.to_h if desc.output.respond_to?(:new)
+    def build_description!(method_name, desc)
+      input = desc.input.new.to_h if desc.input.respond_to?(:new)
+      output = desc.output.new.to_h if desc.output.respond_to?(:new)
 
-    @descriptions[method_name] = { method: method_name }
+      @descriptions[method_name] = { method: method_name }
 
-    @descriptions[method_name][:input] = input if input
-    @descriptions[method_name][:output] = output if output
-  end
+      @descriptions[method_name][:input] = input if input
+      @descriptions[method_name][:output] = output if output
+    end
 
-  def describe(method_name)
-    @descriptions[method_name.to_s]
-  end
+    def describe(method_name)
+      @descriptions[method_name.to_s]
+    end
 
-  def grpc(method_name)
-    @grpc[method_name.to_s]
+    def grpc(method_name)
+      @grpc[method_name.to_s]
+    end
   end
 end

controllers/grpc_generator.rb

@@ -3,78 +3,80 @@
 require 'fileutils'
 require 'rainbow'
 
-module GrpcGeneratorController
-  REQUIRE_REGEX = /^require\s+['"].*_pb['"]/
+module LNDClientInternal
+  module GrpcGeneratorController
+    REQUIRE_REGEX = /^require\s+['"].*_pb['"]/
 
-  def self.upgrade!
-    cleanup!
+    def self.upgrade!
+      cleanup!
 
-    download!
+      download!
 
-    Dir['temp/grpc-upgrade/lnd/lnrpc/**/*.proto'].each do |proto_file|
-      next if proto_file =~ /googleapis/
+      Dir['temp/grpc-upgrade/lnd/lnrpc/**/*.proto'].each do |proto_file|
+        next if proto_file =~ /googleapis/
 
-      run!(generate_command(proto_file.sub('temp/grpc-upgrade/lnd/lnrpc/', '')), print_output: true)
-    end
+        run!(generate_command(proto_file.sub('temp/grpc-upgrade/lnd/lnrpc/', '')), print_output: true)
+      end
 
-    fix_requires!
+      fix_requires!
 
-    remove_references!
+      remove_references!
 
-    puts "\nDone!"
-  end
+      puts "\nDone!"
+    end
 
-  def self.remove_references!
-    run!('rm -rf temp/grpc-upgrade', print_output: false)
-  end
+    def self.remove_references!
+      run!('rm -rf temp/grpc-upgrade', print_output: false)
+    end
 
-  def self.cleanup!
-    run!('rm -rf components/grpc', print_output: false)
-    run!('rm -rf temp/grpc-upgrade', print_output: false)
+    def self.cleanup!
+      run!('rm -rf components/grpc', print_output: false)
+      run!('rm -rf temp/grpc-upgrade', print_output: false)
 
-    FileUtils.mkdir_p('components/grpc')
-    FileUtils.mkdir_p('temp/grpc-upgrade')
-  end
+      FileUtils.mkdir_p('components/grpc')
+      FileUtils.mkdir_p('temp/grpc-upgrade')
+    end
 
-  def self.download!
-    run!('git clone https://github.com/lightningnetwork/lnd.git temp/grpc-upgrade/lnd', print_output: false)
-    run!('git clone https://github.com/googleapis/googleapis.git temp/grpc-upgrade/lnd/lnrpc/googleapis',
-         print_output: false)
-  end
+    def self.download!
+      run!('git clone https://github.com/lightningnetwork/lnd.git temp/grpc-upgrade/lnd', print_output: false)
+      run!('git clone https://github.com/googleapis/googleapis.git temp/grpc-upgrade/lnd/lnrpc/googleapis',
+           print_output: false)
+    end
 
-  def self.generate_command(proto_file)
-    [
-      'cd temp/grpc-upgrade/lnd/lnrpc/; grpc_tools_ruby_protoc',
-      '--proto_path googleapis:.',
-      '--ruby_out=../../../../components/grpc/',
-      '--grpc_out=../../../../components/grpc/',
-      proto_file
-    ].join(' ')
-  end
+    def self.generate_command(proto_file)
+      [
+        'cd temp/grpc-upgrade/lnd/lnrpc/; grpc_tools_ruby_protoc',
+        '--proto_path googleapis:.',
+        '--ruby_out=../../../../components/grpc/',
+        '--grpc_out=../../../../components/grpc/',
+        proto_file
+      ].join(' ')
+    end
 
-  def self.fix_requires!
-    5.times do
-      Dir['components/grpc/**/*.rb'].each do |file|
-        content = File.read(file)
-        next unless content =~ REQUIRE_REGEX
+    def self.fix_requires!
+      5.times do
+        Dir['components/grpc/**/*.rb'].each do |file|
+          content = File.read(file)
+          next unless content =~ REQUIRE_REGEX
 
-        apply!(file, content)
+          apply!(file, content)
+        end
       end
     end
-  end
 
-  def self.apply!(file, content)
-    old_code = content[REQUIRE_REGEX]
-    new_code = content[REQUIRE_REGEX].sub('require', 'require_relative')
+    def self.apply!(file, content)
+      old_code = content[REQUIRE_REGEX]
+      new_code = content[REQUIRE_REGEX].sub('require', 'require_relative')
 
-    puts "\n#{Rainbow('>').yellow} #{file}"
-    puts "  #{Rainbow(old_code).red} -> #{Rainbow(new_code).green}"
-    File.write(file, content.gsub(old_code, new_code))
-  end
+      puts "\n#{Rainbow('>').yellow} #{file}"
+      puts "  #{Rainbow(old_code).red} -> #{Rainbow(new_code).green}"
+      File.write(file, content.gsub(old_code, new_code))
+    end
 
-  def self.run!(command, print_output: false)
-    puts "\n#{Rainbow('>').yellow} #{command}"
-    output = `#{command}`
-    puts output if print_output
+    def self.run!(command, print_output: false)
+      puts "\n#{Rainbow('>').yellow} #{command}"
+      output = `#{command}`
+      puts output if print_output
+    end
   end
 end