c-lightningrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 217391984ad129f43d5a9c94faf0768d26bf1b58ea3693bb4c63699c74e08c1c
+  data.tar.gz: 3d535c1c49a4952e7f202ba4d6e67c2a90c873e2c2b0c5aa2bd8d1ab8c731a38
+SHA512:
+  metadata.gz: 0bfcbdefe33df305f684fefd8f6c636a9ba709742b409b3aa57a2eabb9f9f1493b70ffabba6fc60e3983eedca3cb44e2ec112a35bf5991e7cc4663648745db6f
+  data.tar.gz: 92440120dc13251e3beba89a0c10dd9c96593d26481f23626711c6de0d9059a8584e0d7db1934468ee3ac160c97f4f779a2e0c1ab8e5f63253330df5d55527b3

data/.gitignore

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

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+rubylightning

data/.ruby-version

@@ -0,0 +1 @@
+2.6.2

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.4.5
+  - 2.5.5
+  - 2.6.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at azuchi@chaintope.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in lightning.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 azuchi
+
+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,80 @@
+# c-lightningrb: A ruby client library for lightningd [![Build Status](https://travis-ci.org/chaintope/c-lightningrb.svg?branch=master)](https://travis-ci.org/chaintope/c-lightningrb) [![Gem Version](https://badge.fury.io/rb/c-lightningrb.svg)](https://badge.fury.io/rb/c-lightningrb) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
+
+This library is for writing c-lightning plugins in Ruby.
+You can write your own RPC, event notifications, and Hooks in DSL.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'c-lightningrb', require: 'lightning'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install c-lightningrb
+
+## Examples
+
+### Writing a plugin
+
+You can write your own Plugin by inheriting `Lightning::Plugin`.
+
+```ruby
+#!/usr/bin/env ruby
+require 'lightning'
+
+class HelloPlugin < Lightning::Plugin
+
+  # define new rpc. Usage and description are required only for the definition of RPC.
+  desc '[name]', 'Returns a personalized greeting for {greeting} (set via options).'
+  define_rpc :hello, -> (name) do
+    log.info "log = #{log}"
+    "hello #{name}"
+  end
+
+  # add subscription for event notification
+  subscribe :connect, ->(id, address) do
+    log.info "received connect notification. id = #{id}, address = #{address}"
+  end
+
+  subscribe :disconnect, ->(id) do
+    log.info "received disconnect notification. id = #{id}"
+  end
+
+  # add Hook
+  hook :peer_connected, ->(peer) do
+    log.info "peer_connected. peer = #{peer}"
+    {result: 'continue'}
+  end
+
+end
+
+p = HelloPlugin.new
+p.run
+```
+
+Write all RPC, notification, and hook handlers in Lambda. 
+These Lambdas are implemented as methods, so you can access any of the fields and methods of the Plugin.
+
+And it works if you specify Plugin as the parameter when c-lightning launches.
+
+```
+$ lightningd --plugin=<above file path>
+```
+
+Note: Plugin file needs execute permission.
+
+Note: If you write logs to stdout with puts etc., it will be sent as a response to lightningd. 
+Therefore, if you want to output the log, please use Plugin#log logger. 
+This log is output to under /tmp/ruby-lightnig directory.
+
+## 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 "lightning"
+
+# 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/lib/lightning/logger.rb

@@ -0,0 +1,42 @@
+require 'logger'
+require 'tmpdir'
+
+module Lightning
+
+  module Logger
+
+    Format = "%s, [%s#%d #%d] %5s -- %s: %s\n".freeze
+
+    module_function
+
+    # Create a logger with given +name+.log in $HOME/tmp/ruby-lightning.
+    def create(name, level = ::Logger::INFO)
+      dir = "#{Dir.tmpdir}/ruby-lightning"
+      FileUtils.mkdir_p(dir)
+      logger = ::Logger.new(dir + "/#{name}.log", 10)
+      logger.level = level
+      logger.formatter =  proc do |severity, datetime, progname, msg|
+        Format % [severity[0..0], format_datetime(datetime), $$,
+                  Thread.current.object_id, severity, progname, msg2str(msg)]
+      end
+      logger
+    end
+
+    def msg2str(msg)
+      case msg
+      when ::String
+        msg
+      when ::Exception
+        "#{ msg.message } (#{ msg.class })\n" << (msg.backtrace || []).join("\n")
+      else
+        msg.inspect
+      end
+    end
+
+    def format_datetime(time)
+      time.strftime(@datetime_format || "%Y-%m-%dT%H:%M:%S.%6N ".freeze)
+    end
+
+  end
+
+end

data/lib/lightning/plugin.rb

@@ -0,0 +1,218 @@
+require 'json'
+require 'pathname'
+
+module Lightning
+
+  class Method
+
+    TYPE = {rpc: 0, hook: 1}
+
+    attr_reader :name
+    attr_reader :type
+    attr_reader :usage
+    attr_reader :desc
+    attr_reader :long_desc
+
+    def initialize(name, usage = nil, desc = nil, type: TYPE[:rpc], long_desc: nil)
+      @name = name
+      @type = type
+      @usage = usage
+      @desc = desc
+      @long_desc = long_desc
+    end
+
+    def rpc?
+      type == TYPE[:rpc] && ![:init, :getmanifest].include?(name)
+    end
+
+    def hook?
+      type == TYPE[:hook]
+    end
+
+    def to_h
+      result = {name: name.to_s, usage: usage, description: desc}
+      result[:long_description] = long_desc if long_desc
+      result
+    end
+
+  end
+
+  class Plugin
+
+    class << self
+
+      # get RPM methods.
+      # @return [Hash] the hash of RPC method.
+      def methods
+        @methods ||= {}
+      end
+
+      # get subscriptions
+      # @return [Hash] the hash of subscriptions
+      def subscriptions
+        @subscriptions ||= []
+      end
+
+      # Define the definition of RPC method
+      # @param [String] usage the usage of RPC method.
+      # @param [String] desc the description of RPC method.
+      # @param [String] long_desc (Optional) the long description of RPC method.
+      def desc(usage, desc, long_desc = nil)
+        @usage = usage
+        @desc = desc
+        @long_desc = long_desc
+      end
+
+      # Define RPC method.
+      # @param [String] name the name of rpc method.
+      # @param [Proc] lambda Lambda which is the substance of RPC method.
+      def define_rpc(name, lambda)
+        m = name.to_sym
+        raise ArgumentError, 'method must be implemented using lambda.' unless lambda.is_a?(Proc) && lambda.lambda?
+        raise ArgumentError, "#{m} was already defined." if methods[m]
+        raise ArgumentError, "usage for #{m} dose not defined." unless @usage
+        raise ArgumentError, "description for #{m} dose not defined." unless @desc
+        define_method(m, lambda)
+        methods[m] = Method.new(m, @usage, @desc, long_desc: @long_desc)
+      end
+
+      # Define Event notification handler.
+      # @param [Symbol] event the event name.
+      # @param [Proc] lambda Lambda which is the event handler.
+      def subscribe(event, lambda)
+        e = event.to_sym
+        raise ArgumentError, 'handler must be implemented using lambda.' unless lambda.is_a?(Proc) && lambda.lambda?
+        raise ArgumentError, "Topic #{e} already has a handler." if subscriptions.include?(e)
+        define_method(e, lambda)
+        subscriptions << e
+      end
+
+      # Define hook handler.
+      # @param [Symbol] event the event name.
+      # @param [Proc] lambda Lambda which is the event handler.
+      def hook(event, lambda)
+        e = event.to_sym
+        raise ArgumentError, 'handler must be implemented using lambda.' unless lambda.is_a?(Proc) && lambda.lambda?
+        raise ArgumentError, "Hook #{e} was already registered." if methods[e]
+        define_method(e, lambda)
+        methods[e] = Method.new(e, type: Method::TYPE[:hook])
+      end
+
+    end
+
+    attr_reader :options
+    attr_reader :stdout
+    attr_reader :stdin
+    attr_reader :log
+    attr_accessor :lightning_dir
+    attr_accessor :rpc_filename
+    attr_accessor :rpc
+
+    def initialize
+      methods[:init] = Method.new(:init)
+      @options = {}
+      @stdout = STDOUT
+      @stdin = STDIN
+      methods[:getmanifest] = Method.new(:getmanifest)
+      @log = Lightning::Logger.create(:plugin)
+    end
+
+    def init(options, configuration)
+      log.info("init")
+      @lightning_dir = configuration['lightning-dir']
+      @rpc_filename = configuration['rpc-file']
+      socket_path = (Pathname.new(lightning_dir) + rpc_filename).to_path
+      @rpc = Lightning::RPC.new(socket_path, log)
+      @options.merge!(options)
+      nil
+    end
+
+    # get manifest information.
+    # @return [Hash] the manifest.
+    def getmanifest
+      log.info("getmanifest")
+      {
+          options: options.values,
+          rpcmethods: rpc_methods.map(&:to_h),
+          subscriptions: subscriptions,
+          hooks: hook_methods.map(&:name),
+      }
+    end
+
+    # shutdown this plugin.
+    def shutdown
+      log.info "Plugin shutdown"
+    end
+
+    # run plugin.
+    def run
+      log.info("Plugin run.")
+      begin
+      partial = ''
+      stdin.each_line do |l|
+        partial << l
+        msgs = partial.split("\n\n", -1)
+        next if msgs.size < 2
+        partial = multi_dispatch(msgs)
+      end
+      rescue Exception => e
+        if e.is_a?(Interrupt)
+          shutdown
+        else
+          log.error e
+          throw e
+        end
+      end
+      log.info("Plugin end.")
+    end
+
+    private
+
+    # get method list
+    # @return [Hash] the hash of method.
+    def methods
+      self.class.methods # delegate to class instance
+    end
+
+    # get subscriptions
+    def subscriptions
+      self.class.subscriptions # delegate to class instance
+    end
+
+    def multi_dispatch(msgs)
+      msgs[0...-1].each do |payload|
+        json = JSON.parse(payload)
+        log.info("receive payload = #{json}")
+        request = Lightning::Request.parse_from_json(self, json)
+        if request.id
+          dispatch_request(request)
+        else
+          dispatch_notification(request)
+        end
+      end
+      msgs[-1]
+    end
+
+    def dispatch_request(request)
+      method = methods[request.method]
+      raise ArgumentError, "No method #{request.method} found." unless method
+      result = request.method_args.empty? ? send(method.name) : send(method.name, *request.method_args)
+      request.apply_result(result) if result
+    end
+
+    def dispatch_notification(request)
+      name = request.method
+      raise ArgumentError, "No handler #{request.method} found." unless subscriptions.include?(request.method)
+      request.method_args.empty? ? send(name) : send(name, *request.method_args)
+    end
+
+    def rpc_methods
+      methods.values.select(&:rpc?)
+    end
+
+    def hook_methods
+      methods.values.select(&:hook?)
+    end
+
+  end
+end

data/lib/lightning/request.rb

@@ -0,0 +1,48 @@
+module Lightning
+
+  # c-lightning request
+  class Request
+
+    attr_reader :plugin
+    attr_reader :id
+    attr_reader :method
+    attr_reader :params
+    attr_accessor :result
+    attr_reader :log
+
+    def initialize(plugin, id, method, params)
+      @plugin = plugin
+      @id = id
+      @method = method
+      @params = params
+      @log = plugin.log
+    end
+
+    def self.parse_from_json(plugin, json)
+      self.new(plugin, json['id'], json['method']&.to_sym, json['params'])
+    end
+
+    def method_args
+      if params.is_a?(Array)
+        params
+      elsif params.is_a?(Hash)
+        params.values
+      else
+        raise ArgumentError, "params does not support format. #{params}"
+      end
+    end
+
+    def apply_result(result)
+      @result = result
+      json = {
+          jsonrpc: '2.0',
+          id: id,
+          result: result
+      }.to_json
+      log.info "write response: #{json.to_s}"
+      plugin.stdout.write(json.to_s + "\n\n")
+      plugin.stdout.flush
+    end
+
+  end
+end

data/lib/lightning/rpc.rb

@@ -0,0 +1,16 @@
+module Lightning
+
+  # RPC client for the `lightningd` daemon.
+  class RPC
+
+    attr_reader :socket_path
+    attr_reader :log
+
+    def initialize(socket_path, log)
+      @socket_path = socket_path
+      @log = log
+    end
+
+  end
+
+end

data/lib/lightning/version.rb

@@ -0,0 +1,3 @@
+module Lightning
+  VERSION = "0.1.0"
+end

data/lib/lightning.rb

@@ -0,0 +1,11 @@
+require "lightning/version"
+require_relative 'lightning/request'
+require_relative 'lightning/rpc'
+require_relative 'lightning/plugin'
+require_relative 'lightning/logger'
+
+module Lightning
+
+  class Error < StandardError; end
+
+end

data/rubylightning.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lightning/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "c-lightningrb"
+  spec.version       = Lightning::VERSION
+  spec.authors       = ["azuchi"]
+  spec.email         = ["azuchi@chaintope.com"]
+
+  spec.summary       = 'A ruby client library for lightningd'
+  spec.description   = 'A ruby client library for lightningd'
+  spec.homepage      = "https://github.com/chaintope/c-lightningrb"
+  spec.license       = "MIT"
+
+  # 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_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: c-lightningrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- azuchi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A ruby client library for lightningd
+email:
+- azuchi@chaintope.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lightning.rb
+- lib/lightning/logger.rb
+- lib/lightning/plugin.rb
+- lib/lightning/request.rb
+- lib/lightning/rpc.rb
+- lib/lightning/version.rb
+- rubylightning.gemspec
+homepage: https://github.com/chaintope/c-lightningrb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: A ruby client library for lightningd
+test_files: []