code0-license 0.1.0.pre.release.testing → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a873c8ebbcf3823d0172aefb63983db2a55313e3b6427b77e21fcebd0140bba6
-  data.tar.gz: '0459751c4df8fea3f7f1ee7fad190a9ae6db9841b7eed8281c316ff986afac57'
+  metadata.gz: 8dfaf3a42ef1ce5ff31278efad3b056e7b1ddddea1f7efd2127a1cfe40a84def
+  data.tar.gz: 7c8677d8ac90e245476b4693759325046383f59cf81ea2dc44e30b11e855984c
 SHA512:
-  metadata.gz: 71ec932d10edbd3085691e257b6c0b6817a5baa8fd7fc88a6d362a2b72d9efb2afbd5ba1d17c15517c4f1d43608155a208a6191bf521bed70a95dba524357871
-  data.tar.gz: 60cc0049743b50bcd25705a95cb4627062ed498a9ad2b19f06780c2eb529aca5276d6fe939ea6b33cfa22e2357e6c91da43d255a9a299a8f89512f863aa387bf
+  metadata.gz: '0196591d15caf009be98dd60b476a2642fcd8ae4bc2535b00406eaf134c48a003c4605d1c9999b89db62db1091a50423dabaa18543cbb9e94058dfaa29358689'
+  data.tar.gz: f509897df098ea964896d6edf7e08a49de6e1ea113c315d5c620d039b4a62acad09e4b58122b68ea23e9178b4e842c11722eb3733adf18bb587122db5572795e

data/.rubocop.yml

@@ -31,3 +31,6 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+RSpec/ExampleLength:
+  Enabled: false

data/.tool-versions

@@ -1 +1 @@
-ruby 3.2.2
+ruby 3.2.2

data/README.md

@@ -15,3 +15,54 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## Usage
 
 To start using the gem, you need to have a public and private RSA key.
+If you don't have a key pair, you can generate one by running `bin/create_key`
+
+To generate a license, use the private key as encryption key:
+
+```ruby
+require "code0/license"
+
+# read private key from file
+private_key_file = File.read('license_key.key')
+private_key = OpenSSL::PKey::RSA.new(private_key_file)
+
+# set private key as encryption key
+Code0::License.encryption_key = private_key
+
+# create a license
+license = Code0::License.new(
+  {
+    'licensee' => { 'company' => 'Code0' }, # content of licensee can be as you want, it just can't be empty
+    'start_date' => '2024-05-01', # when is the first date where this license is valid?
+    'end_date' => '2025-05-01', # until when is the license valid?
+    'restrictions' => {}, # content can be as you wish, can be used to semantically store some restrictions that are evaluated by your application
+    'options' => {}, # content can be as you wish, can be used to semantically provide some options of this license
+  }
+)
+
+# export the license
+File.write('license.txt', Code0::License.export(license, 'CODE0'))
+```
+
+To verify the license in your application, use the public key
+
+```ruby
+require "code0/license"
+
+# read public key from file
+public_key_file = File.read('license_key.pub')
+public_key = OpenSSL::PKey::RSA.new(public_key_file)
+
+# set public key as encryption key
+Code0::License.encryption_key = public_key
+
+# load the license
+license = Code0::License.load(File.read('license.txt'))
+
+# exit if license is valid or outside of the valid time
+exit unless license.valid?
+exit unless license.in_active_time?
+
+# for example, exit if users exceed licensed amount
+exit if User.count > license.restrictions['user_count']
+```

data/lib/code0/license/version.rb

@@ -2,6 +2,6 @@
 
 module Code0
   class License
-    VERSION = "0.1.0.pre.release.testing"
+    VERSION = "0.1.0"
   end
 end

data/lib/code0/license.rb

@@ -74,7 +74,7 @@ module Code0
     end
 
     def data
-      ATTRIBUTES.map { |attr| [attr, send(attr)] }.to_h
+      ATTRIBUTES.to_h { |attr| [attr, send(attr)] }
     end
 
     private

data/sig/code0/license/boundary.rbs

@@ -1,16 +1,16 @@
-module Code0
-  class License
-    module Boundary
-      BOUNDARY_END: Regexp
-      BOUNDARY_START: Regexp
-
-      def self.add_boundary: (String, String) -> String
-
-      def self.pad: (String, Integer) -> String
-
-      private
-
-      def self.remove_boundary: (String) -> String
-    end
-  end
-end
+module Code0
+  class License
+    module Boundary
+      BOUNDARY_END: Regexp
+      BOUNDARY_START: Regexp
+
+      def self.add_boundary: (String, String) -> String
+
+      def self.pad: (String, Integer) -> String
+
+      private
+
+      def self.remove_boundary: (String) -> String
+    end
+  end
+end

data/sig/code0/license.rbs

@@ -14,7 +14,7 @@ module Code0
 
     def self.encryptor: -> Encryptor
 
-    attr_reader data: Hash[String, any]
+    attr_reader data: Hash[Symbol, any]
 
     def in_active_time?: -> bool
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code0-license
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.release.testing
+  version: 0.1.0
 platform: ruby
 authors:
 - Niklas van Schrick
@@ -95,7 +95,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- code0-license.gemspec
 - lib/code0/license.rb
 - lib/code0/license/boundary.rb
 - lib/code0/license/encryptor.rb
@@ -122,9 +121,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.10
 signing_key: 

data/code0-license.gemspec

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/code0/license/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "code0-license"
-  spec.version = Code0::License::VERSION
-  spec.authors = ["Niklas van Schrick"]
-  spec.email = ["mc.taucher2003@gmail.com"]
-
-  spec.summary = "code0-license is used to validate software licenses"
-  spec.homepage = "https://github.com/code0-tech/code0-license"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.0.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/releases"
-
-  # 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(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ spec/ .git .github])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 1.21"
-  spec.add_development_dependency "rubocop-rake", "~> 0.6"
-  spec.add_development_dependency "rubocop-rspec", "~> 2.29"
-  spec.metadata["rubygems_mfa_required"] = "true"
-end