ecm-blockchain-api 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c29f674d6983fe3dcf4b95893a2303be793d7a5076376522f095be9fc49c11c
+  data.tar.gz: cc8b4f888bc347214ad4594ab2326c4c26772f77d0181708d80a04b2dc3128eb
+SHA512:
+  metadata.gz: c944def2149adf904e7e44b33772d42b12253124f8c3578d841be171ba0a8faf5004805fd95f105623ff2bcb9acc0ed70f8d378a181b5764cfe57a58251d99ab
+  data.tar.gz: 8b2ede233cc6bdd1f0da48568fcf69808a8ebc820a449d43bb16601226586fe32eebcb609277a34126d2c6d22c67c087d41dcefe3b4ed20ff8492815618fd79f

data/.gitignore

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

data/.gitlab-ci.yml

@@ -0,0 +1,9 @@
+image: ruby:2.7.2
+
+before_script:
+  - gem install bundler -v 2.2.5
+  - bundle install
+
+example_job:
+  script:
+    - bundle exec rake

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.5

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# 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).
+
+## [1.0.0] - 2023-02-28
+
+### Added
+- Initial Release
+- Ability to transact with certificate authority
+- Ability to transact with your ECM blockchain network

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ecm_blockchain_api.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem 'activesupport', '~> 7.0', '>= 7.0.4.3'
+gem 'activemodel', '~> 7.0', '>= 7.0.4.3'
+gem "rspec", "~> 3.0"
+gem 'pry'
+
+gem "rubocop", "~> 1.7"
+gem 'schemacop', '>= 3.0.0'
+
+group :development, :test do
+  gem 'factory_bot'
+  gem 'faker'
+  gem 'shoulda-matchers', '~> 5.0'
+end

data/Gemfile.lock

@@ -0,0 +1,127 @@
+PATH
+  remote: .
+  specs:
+    ecm_blockchain_api (1.0.1)
+      activemodel (~> 7.0, >= 7.0.4.3)
+      httparty (~> 0.22.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.1.4.2)
+      activesupport (= 7.1.4.2)
+    activesupport (7.1.4.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    csv (3.3.0)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    factory_bot (6.5.0)
+      activesupport (>= 5.0.0)
+    faker (3.5.1)
+      i18n (>= 1.8.11, < 2)
+    hashdiff (1.1.1)
+    httparty (0.22.0)
+      csv
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.14.6)
+      concurrent-ruby (~> 1.0)
+    json (2.7.4)
+    language_server-protocol (3.17.0.3)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    minitest (5.25.1)
+    multi_xml (0.6.0)
+    mutex_m (0.2.0)
+    parallel (1.26.3)
+    parser (3.3.5.0)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.9)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.67.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    schemacop (3.0.29)
+      activesupport (>= 4.0)
+      ruby2_keywords (>= 0.0.4)
+    shoulda-matchers (5.3.0)
+      activesupport (>= 5.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.6.0)
+    webmock (3.24.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-23
+  x86_64-darwin-19
+
+DEPENDENCIES
+  activemodel (~> 7.0, >= 7.0.4.3)
+  activesupport (~> 7.0, >= 7.0.4.3)
+  ecm_blockchain_api!
+  factory_bot
+  faker
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  schemacop (>= 3.0.0)
+  shoulda-matchers (~> 5.0)
+  webmock
+
+BUNDLED WITH
+   2.4.22

data/README.md

@@ -0,0 +1,144 @@
+# ECM Blockchain API
+
+Client library to connect and transact with your [ECM Blockchain network](https://www.ecmsecure.com) and Certificate Authorities.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ecm_blockchain_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install through a CLI with:
+
+    $ gem install ecm_blockchain_api
+
+## Usage
+Configure the library by initializing it with your access token.
+
+```ruby
+ECMBlockchain.access_token = 'abc'
+```
+
+Or create a Rails initializer file `ecm_api.rb`
+
+```ruby
+# file: config/initializers/ecm_api.rb
+
+require 'ecm_blockchain_api'
+
+ECMBlockchain.access_token = ENV['ECM_ACCESS_TOKEN']
+```
+
+Change the default production base_url
+```ruby
+ECMBlockchain.base_url = "https://sandbox.ecmsecure.com/v1"
+```
+
+## Interact with your Certificate Authority
+
+```ruby
+# Register and enroll member on the Certificate Authority
+@member = ECMBlockchain::CA.create(
+  uuid: "user@org1.example.com",
+  secret: "s3cr3t!",
+  customAttributes: [
+    {
+      name: "verified",
+      value: "true"
+    }
+  ]
+)
+
+# Retrieve a member by UUID
+member = ECMBlockchain::CA.retrieve("user@org1.example.com")
+member.custom_attributes
+
+# Update a member
+custom_attributes = [{ name: "verified", value: "false" }]
+ECMBlockchain::CA.update(identity, custom_attributes)
+
+# Delete a member
+ECMBlockchain::CA.delete("user@org1.example.com")
+```
+
+```ruby
+# Create an Asset on the blockchain
+@asset = ECMBlockchain::Asset.create(
+  'creator_identity',
+  {
+    uuid: "823737e4-bdc4-401a-b309-ef4c4d4f4733",
+    groupId: "contract-bdc4-401a",
+    title: "signable contract",
+    summary: "updated asset",
+    owner: "owner_identity",
+    file: {
+      identifier: "fb77d3e2-03a7-4de0-b571-957dd146edf8",
+      base64: "data:@file/pdf;base64,JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9D...",
+      storage: true,
+      digitallySigned: {
+        standard: "simple",
+        signatureType: "certification",
+      } 
+    },
+    content: {
+      unit_type: 'PU',
+      unit_id: 'TY23737e4-bdc4-401a-b309-ef4c4d4f4733',
+      date_purchased: '10th Jan 2025 09:02:41'
+    }
+  }
+)
+
+# Retrieve an Asset by UUID
+@asset = ECMBlockchain::Asset.retrieve("823737e4-bdc4-401a-b309-ef4c4d4f4733")
+@asset.title
+```
+
+```ruby
+# mint tokens
+@tokens = ECMBlockchain::Tokens.create(
+  'creator_identity',
+  {
+    kind: "CarbonCoins",
+    quantity: 100
+  }
+)
+
+# Burn tokens
+@tokens = ECMBlockchain::Tokens.burn(
+  'owner_identity',
+  {
+    kind: "CarbonCoins",
+    quantity: 100
+  }
+)
+
+
+# Retrieve tokens
+@tokens = ECMBlockchain::Tokens.retrieve(
+  'owner_identity',
+  kind # defaults to 'all'
+)
+
+# returns ECMBlockchain::TokensCollection
+
+@tokens.first.kind
+@tokens.first.quanitity
+@tokens.first.owner
+@tokens.first.transferee
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ecm_blockchain_api.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ecm_blockchain_api"
+
+# 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
+ECMBlockchain.base_url = "http://localhost:3000/v1"
+# ECMBlockchain.access_token = ""
+ECMBlockchain.access_token = "W4nd3rl4nds!"
+
+require "pry"
+Pry.start

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/ecm-blockchain-api.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/ecm-blockchain-api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ecm-blockchain-api"
+  spec.version       = ECMBlockchain::VERSION
+  spec.authors       = ["Wardy"]
+  spec.email         = ["info@ecmsecure.com"]
+
+  spec.summary       = "ECM Distributed Ledger & Blockchain API"
+  spec.description   = "Connect and transact with your ECM certificate authority and distributed ledger network."
+  spec.homepage      = "https://www.ecmsecure.com"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ecmsecure/ecm-blockchain-api"
+  spec.metadata["changelog_uri"] = "https://github.com/ecmsecure/ecm-blockchain-api/blob/main/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "httparty", "~> 0.22.0"
+  spec.add_dependency 'activemodel', '~> 7.0', '>= 7.0.4.3'
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/ecm-blockchain-api/asset.rb

@@ -0,0 +1,51 @@
+module ECMBlockchain
+  class Asset
+    extend ECMBlockchain::Routes
+    extend ECMBlockchain::Request
+
+    class << self
+      def create(identity, data)
+        verify_asset(data)
+        asset(request( :post, "/#{identity}#{ASSET_URL}", data ))
+      end
+
+      # def batch_create(identity, data)
+      #   verify_batch_assets(data)
+      #   request( :post, "/#{identity}#{ASSET_BATCH_URL}", data ). 
+      #     collect { |asset_response| asset(asset_response) }
+      # rescue => error; error
+      # end
+
+      # def retrieve(identity)
+      #   response = request( :get, "/#{identity}#{MEMBERS_URL}" )
+      #   return_any_errors(response)
+      #   ECMBlockchain::Member.new(JSON.parse(response.body).with_indifferent_access)
+      # end
+
+      # def update(identity, data)
+      #   response = request( :patch, "/#{identity}#{MEMBERS_URL}", data )
+      #   return_any_errors(response)
+      #   ECMBlockchain::Member.new(JSON.parse(response.body).with_indifferent_access)
+      # end
+
+      # def revoke(identity)
+      #   response = request( :delete, "/#{identity}#{MEMBERS_URL}")
+      #   return_any_errors(response)
+      #   OpenStruct.new(success: true, details: "Certificate successfully revoked")
+      # end
+      private 
+
+      def asset(asset_data) 
+        verify_asset(asset_data)
+      end
+
+      def verify_asset(asset)
+        ECMBlockchain::AssetModel.verify(asset) 
+      end
+
+      def verify_batch_assets(arr)
+        arr.find_all { |asset| verify_asset(asset) }  
+      end
+    end
+  end
+end

data/lib/ecm-blockchain-api/ca.rb

@@ -0,0 +1,31 @@
+module ECMBlockchain
+  class CA
+    extend ECMBlockchain::Routes
+    extend ECMBlockchain::Request
+
+    class << self
+      def create(data)
+        member(request( :post, MEMBERS_URL, data ))
+      end
+
+      def retrieve(identity)
+        member(request( :get, "/#{identity}#{MEMBERS_URL}" ))
+      end
+
+      def update(identity, data)
+        member(request( :patch, "/#{identity}#{MEMBERS_URL}", data ))
+      end
+
+      def revoke(identity)
+        response = request( :delete, "/#{identity}#{MEMBERS_URL}")
+        OpenStruct.new(success: true, details: "Certificate successfully revoked")
+      end
+
+      private
+
+      def member(params)
+        ECMBlockchain::Member.new(params)
+      end
+    end
+  end
+end

data/lib/ecm-blockchain-api/client.rb

@@ -0,0 +1,7 @@
+module ECMBlockchain
+  class Client
+    def initialize(access_token=nil)
+      @access_token = access_token || ENV['ECM_ACCESS_TOKEN']
+    end
+  end
+end

data/lib/ecm-blockchain-api/errors.rb

@@ -0,0 +1,64 @@
+module ECMBlockchain
+  class Error < StandardError
+    attr_reader :code, :details, :name
+
+    def self.raise_error(response)
+      klass = ERROR_CLASS_MAP[response.code] || self
+      res = response.body
+      res = '{}' if res == ''
+      err = JSON.parse(res).deep_symbolize_keys[:error]
+      raise klass.new(
+        message: err[:message] || response.headers["status"], 
+        code: err[:statusCode] || response.code, 
+        details: err[:details], 
+        name: klass.to_s
+      )
+    end
+
+    # Initializes a new Error object
+    #
+    # @param message [Exception, String]
+    # @param code [Integer]
+    # @return [ECMBlockchain::Error]
+    def initialize(message: "", code: nil, details: nil, name: nil)
+      super(message)
+
+      @code = code
+      @details = details
+      @name = name
+    end
+  end
+
+  class BadRequest < ECMBlockchain::Error;end;
+  class Unauthorized < ECMBlockchain::Error; end; 
+  class PaymentRequired < ECMBlockchain::Error; end; 
+  class Forbidden < ECMBlockchain::Error; end; 
+  class RequestEntityTooLarge < ECMBlockchain::Error; end; 
+  class NotFound < ECMBlockchain::Error; end; 
+  class NotAcceptable < ECMBlockchain::Error; end; 
+  class UnprocessableEntityError < ECMBlockchain::Error; end; 
+  class TooManyRequests < ECMBlockchain::Error; end; 
+  class ServerError < ECMBlockchain::Error; end; 
+  class InternalServerError < ECMBlockchain::Error; end; 
+  class BadGateway < ECMBlockchain::Error; end; 
+  class ServiceUnavailable < ECMBlockchain::Error; end; 
+  class GatewayTimeout < ECMBlockchain::Error; end; 
+  class TimeoutError < ECMBlockchain::Error; end; 
+
+  ERROR_CLASS_MAP = {
+    400 => ECMBlockchain::BadRequest,
+    401 => ECMBlockchain::Unauthorized,
+    402 => ECMBlockchain::PaymentRequired,
+    403 => ECMBlockchain::Forbidden,
+    404 => ECMBlockchain::NotFound,
+    406 => ECMBlockchain::NotAcceptable,
+    413 => ECMBlockchain::RequestEntityTooLarge,
+    422 => ECMBlockchain::UnprocessableEntityError,
+    429 => ECMBlockchain::TooManyRequests,
+    500 => ECMBlockchain::InternalServerError,
+    502 => ECMBlockchain::BadGateway,
+    503 => ECMBlockchain::ServiceUnavailable,
+    504 => ECMBlockchain::GatewayTimeout,
+  }.freeze
+
+end

data/lib/ecm-blockchain-api/models/asset_model.rb

@@ -0,0 +1,51 @@
+require 'active_model'
+
+module ECMBlockchain
+  class AssetModel
+    include ActiveModel::Validations
+
+    attr_accessor :uuid, :txId, :groupId, :title, :summary, :createdBy, :owner,
+                  :file, :content, :created_at, :access, :lastInteraction, :events
+
+    validates :uuid, :title, presence: true
+    validate :data_file_or_content?
+ 
+    class << self
+      def verify(data={})
+        asset = self.new(data)
+        raise ECMBlockchain::UnprocessableEntityError.new(
+          asset.errors.full_messages.first, 422
+        ) unless asset.valid?
+        asset
+      end
+    end
+
+    def initialize(data={})
+      @uuid = data.fetch(:uuid) { nil }
+      @txId = data.fetch(:txId) { nil }
+      @groupId = data.fetch(:groupId) { nil }
+      @title = data.fetch(:title) { nil }
+      @summary = data.fetch(:summary) { nil }
+      @createdBy = data.fetch(:createdBy) { nil }
+      @owner = data.fetch(:owner) { nil }
+      @file = ECMBlockchain::DataFile.new(data.fetch(:file) { })
+      @content = ECMBlockchain::DataContent.new(data.fetch(:content) { })
+    end
+
+    def success?
+      true
+    end
+
+    def error
+      nil
+    end
+
+    private
+
+    def data_file_or_content?
+      unless file.valid? || content.valid?
+        errors.add(:base, "Please supply either a file object or content object")
+      end
+    end
+  end
+end

data/lib/ecm-blockchain-api/models/custom_attribute.rb

@@ -0,0 +1,17 @@
+require 'active_model'
+
+module ECMBlockchain
+  class CustomAttribute
+    include ActiveModel::Validations
+
+    attr_accessor :name, :value
+
+    validates :name, presence: true
+    validates :value, presence: true
+    
+    def initialize(data = {})
+      @name = data.fetch(:name)
+      @value = data.fetch(:value)
+    end
+  end
+end

data/lib/ecm-blockchain-api/models/data_content_file.rb

@@ -0,0 +1,9 @@
+module ECMBlockchain
+  class DataContent
+    include ActiveModel::Validations
+
+    def initialize(data={})
+
+    end
+  end
+end