hws-resources 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42ec8ec2906b290d7d0543dd289bb7ef6e5b6e2ace24acb5070bccbaeec5d295
+  data.tar.gz: 7c7b9b8123dec773d4de42aa8e1f92b34f0ad5152d4e4c8f98bce53f50c2e2d6
+SHA512:
+  metadata.gz: d59f5b30144b0bea35e5e40b6d39480998421f638579d7f0b00d7ccb8d30ea4087d00445757f53b1a3ac76399bda795b176ac340a970f3d6eae880ba27f6ebd3
+  data.tar.gz: cf34c91ff55368dbb948801eb13b1673e453fe5c1318b16cff5a49978502c1faeb493e32c3c52abff01e641717fb5c1ec4bfaf813ce8a5a8c74caf1efdd0a6e7

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/ClassAndModuleChildren:
+  Enabled: true
+  EnforcedStyle: compact
+
+Style/RedundantSelf:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-11-23
+
+- Initial release

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hws-resources-ruby.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.7'
+
+gem 'json_schemer', '0.2.16'
+gem 'lsuuid', '0.1.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Karthick
+
+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,55 @@
+# Hws::Resources
+
+We define resource as an independent financial entity that can be used to represent any physical or virtual component of value. A resource can be stored or used as a medium of exchange to create any use case in centralized and decentralized finance. This library can be used to programmatically define and manage resources.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hws-resources'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hws-resource
+
+## Usage
+
+### Create a resource
+
+```ruby
+Hws::Resources::Models::Resource.create(name: "hypto_coin", schema: {"type": "integer", "multipleOf" => 0.001})
+
+=> #<Hws::Resources::Models::Resource id: "99dbf504-ffc4-46d3-aea1-802f91ebd0b0", name: "hypto_coin", description: nil, resource_type: "fungible_connected", schema: {"type"=>"integer", "multipleOf"=>0.001}, created_at: "2021-11-25 13:46:27", updated_at: "2021-11-25 13:46:27">
+```
+
+### Update a resource
+
+Schema is marked a read_only and cannot be updated. Only the name and description of the resource can be updated
+
+```ruby
+Hws::Resources::Models::Resource
+    .find_by(id: "99dbf504-ffc4-46d3-aea1-802f91ebd0b0")
+    .update!(name: 'Hypto Duper Coin', description: 'Sample primitive financial resource')
+=> true
+```
+### Delete a resource
+
+```ruby
+Hws::Resources::Models::Resource
+    .find_by(id: "99dbf504-ffc4-46d3-aea1-802f91ebd0b0")
+    .delete
+=> #<Hws::Resources::Models::Resource id: "99dbf504-ffc4-46d3-aea1-802f91ebd0b0", ...>
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hwslabs/hws-resources-ruby.
+
+## 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,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,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'hws-resources'
+
+# 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/generators/hws/resources/install_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module Hws
+  module Resources
+    class InstallGenerator < ::Rails::Generators::Base # :nodoc:
+      include Rails::Generators::Migration
+      source_root File.expand_path('templates', __dir__)
+
+      def self.next_migration_number(path)
+        ActiveRecord::Generators::Base.next_migration_number(path)
+      end
+
+      desc 'copying migrations to db/migrate'
+      def copy_migrations
+        migration_template 'migration.rb.erb', 'db/migrate/create_hws_resources_tables.rb'
+      end
+    end
+  end
+end

data/lib/generators/hws/resources/templates/migration.rb.erb

@@ -0,0 +1,16 @@
+class <%= @migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def self.up
+    enable_extension 'pgcrypto' unless extensions.include?('pgcrypto')
+    create_table :resources, id: :uuid, force: true do |t|
+      t.string   :name
+      t.text     :description
+      t.string   :resource_type # fungible_backed, fungible_soft, non_fungibe
+      t.jsonb    :schema, default: {}
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :resources
+  end
+end

data/lib/hws-resources/models/resource.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'json_schemer'
+
+class Hws::Resources::Models::Resource < ActiveRecord::Base # :nodoc:
+  attr_readonly :schema
+
+  validate :validate_schema, on: :create
+
+  private
+
+  def validate_schema
+    if self.schema.blank?
+      errors.add(:schema, 'blank schema  specified')
+      return
+    end
+    JSONSchemer.schema(self.schema)
+  rescue StandardError => _e
+    errors.add(:schema, 'invalid schema specified')
+  end
+end

data/lib/hws-resources.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Hws
+  module Resources
+    module Models # :nodoc:
+    end
+  end
+end
+
+require 'hws-resources/models/resource'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: hws-resources
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hypto Engineering Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.16
+- !ruby/object:Gem::Dependency
+  name: lsuuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Experimental resource primitive
+email:
+- engineering@hypto.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/hws/resources/install_generator.rb
+- lib/generators/hws/resources/templates/migration.rb.erb
+- lib/hws-resources.rb
+- lib/hws-resources/models/resource.rb
+homepage: https://github.com/hwslabs/hws-resources-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hwslabs/hws-resources-ruby
+  source_code_uri: https://github.com/hwslabs/hws-resources-ruby
+  changelog_uri: https://github.com/hwslabs/hws-resources-ruby/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.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: Experimental resource primitive
+test_files: []