gitstamp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1774534fb07609cd455470e861ec4b0afd377e8b8b46c4123b5a673084388d03
+  data.tar.gz: a814125b30c20e4d42934c9141265a711d699189c2c7e3446033db473b9c440d
+SHA512:
+  metadata.gz: 9c00982820e2af67d2dea03d4e53d81aeb53e066e0878dec11ff31c814035b795bd0345fcaba4b64c952d7c51262d474a378476327cef0ad26f8a353c21db00b
+  data.tar.gz: 816b1398692ac5a41d63bb5e50be645ebacbd4c196324259a0c431ed4a338799076a99eecd681bb603506c96f3c4a442d7b1a26ede5ae73590634cf0f54b6fbc

data/AUTHORS

@@ -0,0 +1 @@
+Arto Bendiken <arto@bendiken.net>

data/CHANGES.md

@@ -0,0 +1,6 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

data/CREDITS.md

@@ -0,0 +1 @@
+# Credits

data/README.md

@@ -0,0 +1,26 @@
+# Gitstamp Command-Line Interface (CLI)
+
+[![Project license](https://img.shields.io/badge/license-Public%20Domain-blue.svg)](https://unlicense.org)
+[![Ruby compatibility](https://img.shields.io/badge/ruby-2.4%2B-blue)](https://rubygems.org/gems/gitstamp)
+[![RubyGems gem](https://img.shields.io/gem/v/gitstamp.svg)](https://rubygems.org/gems/gitstamp)
+
+## Prerequisites
+
+- [Ruby](https://www.ruby-lang.org/en/) 2.4+
+
+## Installation
+
+The tool can be installed quickly and easily on any computer that has [Ruby]
+available:
+
+```bash
+$ gem install gitstamp
+```
+
+In case the command wasn't found after installation, you likely need to
+configure your `PATH` environment variable to include your [RubyGems] program
+path.
+
+[Ruby]:      https://www.ruby-lang.org/en/
+[RubyGems]:  https://guides.rubygems.org/faqs/
+[Unlicense]: https://unlicense.org

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org/>

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/gitstamp

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby -W1
+# This is free and unencumbered software released into the public domain.
+
+require_relative '../lib/gitstamp'
+
+require 'arweave'  # https://rubygems.org/gems/arweave
+require 'rugged'   # https://rubygems.org/gems/rugged
+require 'thor'     # https://rubygems.org/gems/thor
+
+require 'json'
+
+class CLI < Thor
+  def self.exit_on_failure?() true end
+
+  class_option :debug, aliases: '-d', type: :boolean, desc: "Enable debugging"
+  class_option :verbose, aliases: '-v', type: :boolean, desc: "Be verbose (print warnings)"
+  class_option :quiet, aliases: '-q', type: :boolean, desc: "Be quiet (silence non-fatal errors)"
+  class_option :wallet, aliases: '-W', banner: 'FILE', desc: "Specify Arweave wallet FILE (in JWK format)"
+
+  desc "publish COMMIT...", "Publish commits to Gitstamp"
+  option :author, banner: 'URI', desc: "Override author URI (mailto: or https://)"
+  option :committer, banner: 'URI', desc: "Override committer URI (mailto: or https://)"
+  option :link, banner: 'URL', desc: "Include commit link URL (https://)"
+  def publish(*commits)
+    wallet = self.wallet
+    author, committer, link = self.options[:author], self.options[:committer], self.options[:link]
+    git = Rugged::Repository.new('.')
+    commits = commits.empty? ? [git.head.target] : commits.map { |sha1| git.lookup(sha1) }
+    commits.each do |commit|
+      commit = Gitstamp::Commit.from_git(commit, author: author, committer: committer, link: link)
+      warn commit.to_tags.inspect if debug?
+      transaction_id = Gitstamp::Transaction.new(commit).publish!(wallet)
+      puts "#{set_color(transaction_id, :green)}" unless quiet?
+    end
+  rescue => error
+    raise error if debug?
+    warn "#{$0}: #{set_color(error, :red)}"
+    exit error.respond_to?(:exit_code) ? error.exit_code : -1
+  end
+
+  protected
+
+  def wallet
+    @wallet ||= begin
+      wallet_path = self.options[:wallet]
+      raise "wallet path required" if wallet_path.nil?
+      raise "#{wallet_path}: wallet file not found" if !File.exist?(wallet_path)
+      begin
+        Arweave::Wallet.new(JSON.parse(File.read(wallet_path)))
+      rescue JSON::ParserError => error
+        raise "#{wallet_path}: #{error}"
+      end
+    end
+  end
+
+  def debug?() self.options[:debug] end
+  def verbose?() self.options[:verbose] || self.debug? end
+  def quiet?() self.options[:quiet] end
+end # CLI
+
+# Fix for https://github.com/erikhuda/thor/issues/398
+class Thor::Shell::Basic
+  def print_wrapped(message, options = {})
+    indent = (options[:indent] || 0).to_i
+    if indent.zero?
+      self.stdout.puts message
+    else
+      message.each_line do |message_line|
+        self.stdout.print ' ' * indent
+        self.stdout.puts message_line.chomp
+      end
+    end
+  end
+end # Thor::Shell::Basic
+
+CLI.start(ARGV)

data/lib/gitstamp/commit.rb

@@ -0,0 +1,40 @@
+# This is free and unencumbered software released into the public domain.
+
+##
+# A Gitstamp commit contains the Git commit message and relevant metadata.
+class Gitstamp::Commit < ::Struct.new(:id, :link, :author, :committer, :committer_date, :message, keyword_init: true)
+  ##
+  # Constructs a Gitstamp commit from a Git commit.
+  #
+  # @param  [Rugged::Commit] git the Git commit object
+  # @param  [URI, #to_s] author an optional author URI override
+  # @param  [URI, #to_s] committer an optional committer URI override
+  # @param  [URI, #to_s] link an optional commit link URL
+  # @return [Commit]
+  def self.from_git(git, author: nil, committer: nil, link: nil)
+    self.new(
+      id: git.oid.to_s,
+      link: link&.to_s,
+      author: (author || "mailto:#{git.author[:email]}").to_s,
+      committer: (committer || "mailto:#{git.committer[:email]}").to_s,
+      committer_date: git.committer[:time],  # preserves the timezone
+      message: git.message.to_s,
+    )
+  end
+
+  ##
+  # Returns the Arweave metadata tags for this commit.
+  #
+  # @return [Hash<String, String>]
+  def to_tags
+    {
+      'Content-Type' => 'text/plain',
+      'App-Name' => 'Gitstamp',
+      'Git-Commit' => self.id.to_s,
+      'Git-Commit-Link' => self.link&.to_s,
+      'Git-Author' => self.author&.to_s,
+      'Git-Committer' => self.committer&.to_s,
+      'Git-Committer-Date' => self.committer_date&.strftime("%Y-%m-%dT%H:%M:%S%:z"),
+    }.delete_if { |k, v| v.nil? }
+  end
+end # Gitstamp::Commit

data/lib/gitstamp/transaction.rb

@@ -0,0 +1,44 @@
+# This is free and unencumbered software released into the public domain.
+
+##
+# A Gitstamp transaction is an Arweave transaction with specific tags.
+class Gitstamp::Transaction
+  ##
+  # The transaction's associated commit.
+  #
+  # @return [Commit] commit
+  attr_reader :commit
+
+  ##
+  # Constructs a transaction from a commit.
+  #
+  # @param  [Commit] commit
+  # @return [void]
+  def initialize(commit)
+    @commit = commit
+  end
+
+  ##
+  # Signs this transaction as originating from the given wallet.
+  #
+  # @param  [Arweave::Wallet] wallet
+  # @return [Arweave::Transaction] the signed Arweave transaction
+  def sign(wallet)
+    tx = Arweave::Transaction.new(data: @commit.message.to_s)
+    @commit.to_tags.each do |name, value|
+      tx.add_tag(name: name, value: value)
+    end
+    tx.sign(wallet)
+  end
+
+  ##
+  # Submits this transaction to the Arweave network.
+  #
+  # @param  [Arweave::Wallet] wallet
+  # @return [String] the posted Arweave transaction ID
+  def publish!(wallet)
+    tx = self.sign(wallet)
+    tx.commit
+    tx.attributes[:id]
+  end
+end # Gitstamp::Transaction

data/lib/gitstamp/version.rb

@@ -0,0 +1,21 @@
+# This is free and unencumbered software released into the public domain.
+
+module Gitstamp
+  module VERSION
+    FILE = File.expand_path('../../VERSION', __dir__).freeze
+    STRING = File.read(FILE).chomp.freeze
+    MAJOR, MINOR, PATCH, EXTRA = STRING.split('.').map(&:to_i).freeze
+
+    ##
+    # @return [String]
+    def self.to_s() STRING end
+
+    ##
+    # @return [String]
+    def self.to_str() STRING end
+
+    ##
+    # @return [Array(Integer, Integer, Integer)]
+    def self.to_a() [MAJOR, MINOR, PATCH].freeze end
+  end # VERSION
+end # Gitstamp

data/lib/gitstamp.rb

@@ -0,0 +1,6 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'gitstamp/version'
+
+require_relative 'gitstamp/commit'
+require_relative 'gitstamp/transaction'

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: gitstamp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arto Bendiken
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: arweave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Gitstamp Command-Line Interface (CLI)
+email: arto@bendiken.net
+executables:
+- gitstamp
+extensions: []
+extra_rdoc_files: []
+files:
+- AUTHORS
+- CHANGES.md
+- CREDITS.md
+- README.md
+- UNLICENSE
+- VERSION
+- bin/gitstamp
+- lib/gitstamp.rb
+- lib/gitstamp/commit.rb
+- lib/gitstamp/transaction.rb
+- lib/gitstamp/version.rb
+homepage: https://github.com/artob/gitstamp-cli
+licenses:
+- Unlicense
+metadata:
+  bug_tracker_uri: https://github.com/artob/gitstamp-cli/issues
+  changelog_uri: https://github.com/artob/gitstamp-cli/blob/master/CHANGES.md
+  documentation_uri: https://www.rubydoc.info/github/artob/gitstamp-cli/master
+  homepage_uri: https://gitstamp.dev
+  source_code_uri: https://github.com/artob/gitstamp-cli
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.8
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Gitstamp Command-Line Interface (CLI)
+test_files: []