fabric-gateway 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51017a36a52c447bd52777486b764ddc09fcfc1c19bca1943da465c49cbc4294
-  data.tar.gz: 52e5b9b209eb53cfe246c4a41b9f7d91d1abee940162cc9c23599f75d0c0e6b0
+  metadata.gz: 97655326a3d8126a2a70b6a58063695c944b6620e9b2b8611ed4962d4d95337e
+  data.tar.gz: b7d8f9b3ae323335e40477bd4f66943d8c1a72e194e6624c53dcbc495ab01d4b
 SHA512:
-  metadata.gz: e8f61a0b72d738c832c48bbdc56b4c4aa182802e9f892eb12c701b755ff158c560e106aca0ce914e411fca58a322139d6ebd8ee09c7cf921d6ab671322912f8d
-  data.tar.gz: 63b48fe7fa040153d0142f537fe6d73a7285c0d7652d5e73901df816101c536108ade11f438918c69eabbb0c43a8fdd5d594b015b8140dea4d8b5208e79d3c29
+  metadata.gz: f8a83cf4492950b145988ce9a7aaf88c49da2a7f23e3e2559f9f4a95ced9997d8bb567696a52995504ae49de90a80c7825055e6affc61b5fab251f9f29eabeeb
+  data.tar.gz: 4b406361a801e789d1bffd7059c595d5f46f76e30e4b8a9c6262fd7d06f381b767b0a1f4f649a37dd6452595352f3f150b43f9e85a920cffc051cfe5e7087c27

data/.github/workflows/rspec.yml

@@ -19,19 +19,21 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['3.0', '3.1', '3.2']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
     # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      uses: ruby/setup-ruby@master
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests
       run: bundle exec rake
-      env:
-        CODECOV_TOKEN: 4b75ccca-3149-4610-99fb-3a5aeff4ff00
+    - uses: codecov/codecov-action@v3
+      with:
+        token: 4b75ccca-3149-4610-99fb-3a5aeff4ff00
+   

data/.github/workflows/rubocop.yml

@@ -8,10 +8,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby 2.7
+    - name: Set up Ruby 3.0
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
+        ruby-version: 3.0
     - name: Cache gems
       uses: actions/cache@v1
       with:
@@ -22,7 +22,6 @@ jobs:
     - name: Install gems
       run: |
         bundle config path vendor/bundle
-        bundle config set without 'default doc job cable storage ujs test db'
         bundle install --jobs 4 --retry 3
     - name: Run RuboCop
       run: bundle exec rubocop --parallel

data/.github/workflows/yardoc.yml

@@ -11,7 +11,7 @@ jobs:
     - name: Set up Ruby 2.7
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
+        ruby-version: 3.2
     - name: Cache gems
       uses: actions/cache@v1
       with:
@@ -22,7 +22,6 @@ jobs:
     - name: Install gems
       run: |
         bundle config path vendor/bundle
-        bundle config set without 'default doc job cable storage ujs test db'
         bundle install --jobs 4 --retry 3
     - name: Run yard stats
       run: bundle exec yard stats --list-undoc --no-cache --fail-on-warning

data/.rubocop.yml

@@ -9,7 +9,7 @@ Metrics/BlockLength:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
   Exclude:
     - vendor/bundle/**/*
     # exclude protoc generated code
@@ -20,4 +20,6 @@ AllCops:
     - 'lib/orderer/*'
     - 'lib/peer/*'
 
-
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - spec/fabric/entities/*

data/.ruby-version

@@ -1 +1 @@
-2.7.5
+3.2.2

data/Gemfile

@@ -7,3 +7,12 @@ gemspec
 
 gem 'rake', '~> 12.3.3'
 gem 'rspec', '~> 3.0'
+
+gem 'factory_bot', '~> 6.3.0'
+gem 'grpc-tools', '~> 1.59.0'
+gem 'rubocop', '~> 1.57', '>= 1.57.1'
+gem 'rubocop-rspec', '~> 2.24.1'
+gem 'simplecov', '~> 0.22.0'
+gem 'simplecov-cobertura', '~> 2.1'
+gem 'timecop', '~> 0.9.8'
+gem 'yard', '~> 0.9.34'

data/README.md

@@ -22,14 +22,6 @@ Or install it yourself as:
 
     $ gem install fabric-gateway
 
-### ISSUES
-
-Note, there is an issue with the grpc library for MacOS (https://github.com/grpc/grpc/issues/28271). It results in a segfault in ruby when trying to make a connection. 
-
-Workaround: Either run on linux or use a docker container as a workaround.
-
-Will update to new version of grpc when fix is released.
-
 ## Usage
 
 This is a beta stage library with all the main hyperledger gateway calls implemented. Although this library has good unit test coverage, it is fairly new and has not yet been run in production environments. The library will be updated to 1.0.0 when the library has proven to be stable.
@@ -56,7 +48,7 @@ client_opts = {
     GRPC::Core::Channel::SSL_TARGET => 'peer0.org1.example.com'
   }
 }
-# optional, if you want to set deadlines to the individual calls (in seconds)
+# optional, if you want to set an absolute deadline for each of the individual calls (in seconds)
 default_call_options = {
   endorse_options: { deadline: GRPC::Core::TimeConsts.from_relative_time(5) },
   evaluate_options: { deadline: GRPC::Core::TimeConsts.from_relative_time(5) },
@@ -64,6 +56,16 @@ default_call_options = {
   commit_status_options: { deadline: GRPC::Core::TimeConsts.from_relative_time(5) },
   chaincode_events_options: { deadline: GRPC::Core::TimeConsts.from_relative_time(60) }
 }
+
+# for a relative time from when the call is made, pass an integer instead of a GRPC::Core::TimeConsts (still in seconds)
+default_call_options = {
+  endorse_options: { deadline: 5 },
+  evaluate_options: { deadline: 5 },
+  submit_options: { deadline: 5 },
+  commit_status_options: { deadline: 5 },
+  chaincode_events_options: { deadline: 60 }
+}
+
 creds = GRPC::Core::ChannelCredentials.new(load_certs[0])
 client=Fabric::Client.new(host: 'localhost:7051', creds: creds, default_call_options: default_call_options, **client_opts)
 

data/Rakefile

@@ -2,7 +2,6 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require 'rake/notes/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/fabric-gateway.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Ruby port of the Hyperledger Fabric Gateway SDK'
   spec.homepage      = 'https://github.com/ethicalidentity/fabric-gateway-ruby'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.0')
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
@@ -28,17 +28,8 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.add_dependency('google-protobuf', '>= 3.19.1')
+  spec.add_dependency('google-protobuf', '~> 3.24', '>= 3.24.4')
   spec.add_dependency('grpc', '~> 1.42')
-  spec.add_development_dependency('codecov', '~> 0.6.0')
-  spec.add_development_dependency('factory_bot', '~> 6.2.0')
-  spec.add_development_dependency('grpc-tools', '~> 1.46.2')
-  spec.add_development_dependency('rake-notes', '~> 0.2.0')
-  spec.add_development_dependency('rubocop', '~> 1.23.0')
-  spec.add_development_dependency('rubocop-rspec', '~> 2.6.0')
-  spec.add_development_dependency('simplecov', '~> 0.21.2')
-  spec.add_development_dependency('timecop', '~> 0.9.4')
-  spec.add_development_dependency('yard', '~> 0.9.27')
   spec.metadata = {
     'rubygems_mfa_required' => 'true'
   }

data/lib/fabric/client.rb

@@ -60,7 +60,7 @@ module Fabric
     # @return [Gateway::EvaluateResponse] evaluate_response
     #
     def evaluate(evaluate_request, options = {})
-      @grpc_client.evaluate(evaluate_request, @default_call_options[:evaluate_options].merge(options))
+      @grpc_client.evaluate(evaluate_request, final_call_options(:evaluate, options))
     end
 
     #
@@ -72,7 +72,7 @@ module Fabric
     # @return [Gateway::EndorseResponse] endorse_response
     #
     def endorse(endorse_request, options = {})
-      @grpc_client.endorse(endorse_request, @default_call_options[:endorse_options].merge(options))
+      @grpc_client.endorse(endorse_request, final_call_options(:endorse, options))
     end
 
     #
@@ -84,7 +84,7 @@ module Fabric
     # @return [Gateway::SubmitResponse] submit_response
     #
     def submit(submit_request, options = {})
-      @grpc_client.submit(submit_request, @default_call_options[:submit_options].merge(options))
+      @grpc_client.submit(submit_request, final_call_options(:submit, options))
     end
 
     #
@@ -97,7 +97,7 @@ module Fabric
     # @return [Gateway::CommitStatusResponse] commit_status_response
     #
     def commit_status(commit_status_request, options = {})
-      @grpc_client.commit_status(commit_status_request, @default_call_options[:commit_status_options].merge(options))
+      @grpc_client.commit_status(commit_status_request, final_call_options(:commit_status, options))
     end
 
     #
@@ -164,7 +164,7 @@ module Fabric
     #
     def chaincode_events(chaincode_events_request, options = {}, &block)
       @grpc_client.chaincode_events(chaincode_events_request,
-                                    @default_call_options[:chaincode_events_options].merge(options), &block)
+                                    final_call_options(:chaincode_events, options), &block)
     end
 
     private
@@ -195,5 +195,13 @@ module Fabric
       @default_call_options[:commit_status_options] ||= {}
       @default_call_options[:chaincode_events_options] ||= {}
     end
+
+    def final_call_options(call_type, call_options)
+      options = @default_call_options["#{call_type}_options".to_sym].merge(call_options || {})
+      if (deadline = options[:deadline]) && !(deadline.is_a? Time)
+        options[:deadline] = GRPC::Core::TimeConsts.from_relative_time(deadline)
+      end
+      options
+    end
   end
 end

data/lib/fabric/ec_crypto_suite.rb

@@ -40,7 +40,7 @@ module Fabric
 
     def verify(public_key, message, signature)
       digest = digest message
-      openssl_pkey = openssl_pkey_from_public_key public_key
+      openssl_pkey = pkey_from_public_key public_key
       sequence = OpenSSL::ASN1.decode signature
       return false unless check_malleability sequence, openssl_pkey.group.order
 
@@ -48,8 +48,7 @@ module Fabric
     end
 
     def generate_private_key
-      key = OpenSSL::PKey::EC.new curve
-      key.generate_key!
+      key = OpenSSL::PKey::EC.generate(curve)
 
       key.private_key.to_s(16).downcase
     end
@@ -133,15 +132,35 @@ module Fabric
       aes.update(encrypted_data) + aes.final
     end
 
-    def pkey_pem_from_private_key(private_key)
+    # when https://github.com/ruby/openssl/pull/555 gets merged, consider refactoring
+    # the code here
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
+    def pkey_from_private_key(private_key)
       public_key = restore_public_key private_key
-      key = OpenSSL::PKey::EC.new curve
-      key.private_key = OpenSSL::BN.new private_key, 16
-      key.public_key = OpenSSL::PKey::EC::Point.new key.group,
-                                                    OpenSSL::BN.new(public_key, 16)
 
-      pkey = OpenSSL::PKey::EC.new(key.public_key.group)
-      pkey.public_key = key.public_key
+      group = OpenSSL::PKey::EC::Group.new(curve)
+
+      private_key_bn   = OpenSSL::BN.new(private_key, 16)
+      public_key_bn    = OpenSSL::BN.new(public_key, 16)
+      public_key_point = OpenSSL::PKey::EC::Point.new(group, public_key_bn)
+
+      asn1 = OpenSSL::ASN1::Sequence(
+        [
+          OpenSSL::ASN1::Integer.new(1),
+          OpenSSL::ASN1::OctetString(private_key_bn.to_s(2)),
+          OpenSSL::ASN1::ObjectId(curve, 0, :EXPLICIT),
+          OpenSSL::ASN1::BitString(public_key_point.to_octet_string(:uncompressed), 1, :EXPLICIT)
+        ]
+      )
+
+      OpenSSL::PKey::EC.new(asn1.to_der)
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+
+    def pem_from_private_key(private_key)
+      pkey = pkey_from_private_key(private_key)
 
       pkey.to_pem
     end
@@ -151,29 +170,33 @@ module Fabric
       key.private_key.to_s(16).downcase
     end
 
-    def pkey_from_x509_certificate(certificate)
+    def public_key_from_x509_certificate(certificate)
       cert = OpenSSL::X509::Certificate.new(certificate)
       cert.public_key.public_key.to_bn.to_s(16).downcase
     end
 
-    def openssl_pkey_from_public_key(public_key)
-      pkey = OpenSSL::PKey::EC.new curve
-      pkey.public_key = OpenSSL::PKey::EC::Point.new(pkey.group, OpenSSL::BN.new(public_key, 16))
+    # rubocop:disable Metrics/MethodLength
+    def pkey_from_public_key(public_key)
+      group = OpenSSL::PKey::EC::Group.new(curve)
 
-      pkey
-    end
+      public_key_bn    = OpenSSL::BN.new(public_key, 16)
+      public_key_point = OpenSSL::PKey::EC::Point.new(group, public_key_bn)
 
-    private
-
-    def pkey_from_private_key(private_key)
-      public_key = restore_public_key private_key
-      key = OpenSSL::PKey::EC.new curve
-      key.private_key = OpenSSL::BN.new private_key, 16
-      key.public_key = OpenSSL::PKey::EC::Point.new key.group,
-                                                    OpenSSL::BN.new(public_key, 16)
+      asn1 = OpenSSL::ASN1::Sequence.new(
+        [
+          OpenSSL::ASN1::Sequence.new([
+                                        OpenSSL::ASN1::ObjectId.new('id-ecPublicKey'),
+                                        OpenSSL::ASN1::ObjectId.new(group.curve_name)
+                                      ]),
+          OpenSSL::ASN1::BitString.new(public_key_point.to_octet_string(:uncompressed))
+        ]
+      )
 
-      key
+      OpenSSL::PKey::EC.new(asn1.to_der)
     end
+    # rubocop:enable Metrics/MethodLength
+
+    private
 
     # barely understand this code - this link provides a good explanation:
     # http://coders-errand.com/malleability-ecdsa-signatures/

data/lib/fabric/entities/identity.rb

@@ -42,7 +42,7 @@ module Fabric
     # @return [boolean] true if valid, false otherwise
     #
     def validate_key_integrity
-      cert_pubkey = @crypto_suite.pkey_from_x509_certificate(certificate)
+      cert_pubkey = @crypto_suite.public_key_from_x509_certificate(certificate)
       priv_pubkey = @crypto_suite.restore_public_key(@private_key)
 
       @public_key == cert_pubkey && @public_key == priv_pubkey

data/lib/fabric/entities/status.rb

@@ -6,9 +6,9 @@ module Fabric
   #
   class Status
     TRANSACTION_STATUSES = ::Protos::TxValidationCode.constants.map(&::Protos::TxValidationCode.method(:const_get))
-                                                     .collect do |i|
+                                                     .to_h do |i|
       [::Protos::TxValidationCode.lookup(i), i]
-    end.to_h
+    end
 
     # @return [Integer] Block number in which the transaction committed.
     attr_reader :block_number

data/lib/fabric/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fabric
-  VERSION = '0.4.1'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: fabric-gateway
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Jonathan Chan
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2023-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.19.1
+        version: 3.24.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.19.1
+        version: 3.24.4
 - !ruby/object:Gem::Dependency
   name: grpc
   requirement: !ruby/object:Gem::Requirement
@@ -38,132 +44,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.42'
-- !ruby/object:Gem::Dependency
-  name: codecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: factory_bot
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.2.0
-- !ruby/object:Gem::Dependency
-  name: grpc-tools
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.46.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.46.2
-- !ruby/object:Gem::Dependency
-  name: rake-notes
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.23.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.23.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.6.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.21.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.21.2
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.4
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.27
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.27
 description: Ruby port of the Hyperledger Fabric Gateway SDK
 email:
 - jonathan.chan@ethicalidentity.com
@@ -237,7 +117,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -245,15 +125,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Hyperledger Fabric Gateway SDK
 test_files: []