hws-stores 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df778df2c24ca37092d638b8f8ff395716d5738ec27636d9f08412dad1c4febd
+  data.tar.gz: 733159fd624275c6d8af1b94698a675c667c0cea0142636e78e52d1088b1a825
+SHA512:
+  metadata.gz: 7386668d6d2efcc1ebccee0cc2e230547fb066a51c103333c4ed742b723e2c9b40381a86c7c6404ec0086a702f2674391ddd66cc62324a172303d779d02633f9
+  data.tar.gz: 5323e02639997ca6ce08fafd0e4e10f54aa1f5f5f662c09974c7aa9a70a14fd6697c66503b52579355fa9eab406fbd5a63a0b6fd4bcefc475f62cdd44a689e48

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*/.DS_Store
+.DS_Store

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-25
+
+- Initial release

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 tholkappiyan@hypto.in. 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,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hws-stores.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.7'
+
+gem 'lsuuid', '0.1.0'
+
+gem 'json_schemer', '0.2.16'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Tholkappiyan
+
+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,66 @@
+# Hws::Stores
+
+**Financial Primitive - Store**
+
+This primitive is to contain and assign ownership for the value that is transacted in a financial usecase.
+There are two entities - Store and Owner.
+
+- Store - Holds the value that is managed in the usecase.
+- Owner - This entity can be used to maintain the owner details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hws-stores'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hws-stores
+
+## Usage
+
+### Create an empty store
+
+```ruby
+Hws::Stores.create_store(name: 'test1', schema: {"type"=> "object", "require"=>["a"], "properties"=> {"a"=>{"type"=>"number"}}})
+=> "619f5ce9-075b-0778-7969-7413c37452e9" # returns id of the created store
+```
+
+### Add data to store
+```ruby
+Hws::Stores.update_store("619f5ce9-075b-0778-7969-7413c37452e9", {"a": 54})
+=> true # Update successful
+```
+
+### Create a store with data
+```ruby
+
+Hws::Stores.create_store(name: 'test1', schema: {"type"=> "object", "require"=>["a"], "properties"=> {"a"=>{"type"=>"number"}}}, data: {"a": 6})
+=> "619f5ce9-075b-0778-7969-7413c37452e9" # returns id of the created store
+```
+
+### Delete a store
+```ruby
+
+Hws::Stores.delete_store("619f5ce9-075b-0778-7969-7413c37452e9")
+=> true # Delete successful
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hwslabs/hws-stores. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Hws::Stores project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/hws-stores/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hws/store"
+
+# 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/hws-stores.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hws-stores'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Hypto Engineering Team']
+  spec.email         = ['engineering@hypto.in']
+
+  spec.summary       = 'Experimental store primitive'
+  spec.description   = 'Experimental store primitive'
+  spec.homepage      = 'https://github.com/hwslabs/hws-stores-ruby'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = 'http://mygemserver.com'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/hwslabs/hws-stores-ruby'
+    spec.metadata['changelog_uri'] = 'https://github.com/hwslabs/hws-stores-ruby/blob/main/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  # 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_dependency 'json_schemer', '0.2.16'
+  spec.add_dependency 'lsuuid', '0.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/generators/hws/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Adds necessary ActiveRecord migrations to the rails application
+
+Example:
+    rails generate hws_stores:install
+
+    This will create:
+        db/migrate/<migration_number>_create_hws_store_tables.rb

data/lib/generators/hws/stores/install_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module Hws
+  module Stores
+    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_store_tables.rb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+class <%= @migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def self.up
+    enable_extension 'pgcrypto' unless extensions.include?('pgcrypto')
+
+    create_table :stores, id: :uuid do |t|
+      t.string   :name
+      t.text     :description
+      t.jsonb    :data, default: {}
+      t.decimal  :value, precision: 15, scale: 2 
+      t.jsonb    :schema, default: {}
+      t.jsonb    :tags, default: {}
+      t.timestamps
+    end
+
+    create_table :owners, id: :uuid do |t|
+      t.string   :name
+      t.text     :description
+      t.jsonb    :tags, default: {}
+      t.timestamps
+    end
+
+    create_join_table :stores, :owners, column_options: { type: :uuid } do |t|
+      t.index %I[store_id owner_id]
+      t.index %I[owner_id store_id]
+    end
+
+    add_index :stores, :tags, using: :gin
+    add_index :owners, :tags, using: :gin
+  end
+
+  def self.down
+    drop_table :owners_stores
+    drop_table :owners
+    drop_table :stores
+  end
+end

data/lib/hws-stores/models/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Hws::Stores::Models::Base < ActiveRecord::Base # :nodoc:
+  self.abstract_class = true
+
+  before_create :set_uuid
+
+  def set_uuid
+    self.id = LSUUID.generate if self.id.blank?
+  end
+end

data/lib/hws-stores/models/owner.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'hws-stores/models/base'
+
+class Hws::Stores::Models::Owner < Hws::Stores::Models::Base
+  has_and_belongs_to_many :stores
+end

data/lib/hws-stores/models/store.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'hws-stores/models/base'
+require 'json_schemer'
+
+class Hws::Stores::Models::Store < Hws::Stores::Models::Base # :nodoc:
+  has_and_belongs_to_many :owners
+
+  validate :validate_against_pattern
+
+  private
+
+  def validate_against_pattern
+    if self.schema.blank?
+      errors.add(:schema, 'schema of the store is not specified')
+      return
+    end
+
+    schemer = JSONSchemer.schema(self.schema)
+
+    return if self.data.blank? && self.value.blank?
+
+    if self.data.present? && self.value.present?
+      errors.add(:data, 'data and value cannot be stored together')
+      return
+    end
+
+    if self.data.blank? && !schemer.valid?(self.value)
+      errors.add(:value, 'Value does not conform to the schema. For value, schema should be of the form {"type": "integer" / "number"}')
+      return
+    end
+    errors.add(:data, 'Data does not conform to the specified schema') if self.value.nil? && !schemer.valid?(self.data)
+
+  end
+end

data/lib/hws-stores.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Hws
+  module Stores # :nodoc:
+    def self.create_store(input)
+      allowed_input = input.with_indifferent_access.slice('name', 'description', 'data', 'schema', 'tags')
+
+      if allowed_input.key?('data')
+        if allowed_input['data'].is_a?(Numeric)
+          allowed_input['value'] == allowed_input.delete('data')
+        else
+          allowed_input['data'] = allowed_input['data'].with_indifferent_access
+        end
+      end
+
+      store = Hws::Stores::Models::Store.create(allowed_input)
+      store.try(:id)
+    end
+
+    def self.update_store(store_id, data)
+      data = data.with_indifferent_access
+      store = ::Hws::Stores::Models::Store.find(store_id)
+      return false if store.nil?
+
+      if data.is_a?(Numeric)
+        store.update!(value: data, data: nil)
+      else
+        store.update!(value: nil, data: data)
+      end
+    end
+
+    def self.delete_store(store_id)
+      store = ::Hws::Stores::Models::Store.find(store_id)
+      return false if store.nil?
+
+      store.delete.present?
+    end
+
+    module Models # :nodoc:
+    end
+  end
+end
+
+require 'hws-stores/models/store'
+require 'hws-stores/models/owner'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: hws-stores
+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
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+description: Experimental store primitive
+email:
+- engineering@hypto.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hws-stores.gemspec
+- lib/generators/hws/USAGE
+- lib/generators/hws/stores/install_generator.rb
+- lib/generators/hws/stores/templates/migration.rb.erb
+- lib/hws-stores.rb
+- lib/hws-stores/models/base.rb
+- lib/hws-stores/models/owner.rb
+- lib/hws-stores/models/store.rb
+homepage: https://github.com/hwslabs/hws-stores-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hwslabs/hws-stores-ruby
+  source_code_uri: https://github.com/hwslabs/hws-stores-ruby
+  changelog_uri: https://github.com/hwslabs/hws-stores-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: '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 store primitive
+test_files: []