covert 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 90aa90ca29e52c1a1310fac23fd33c1f31b369d2ae6f8356963c30f7810a6862
+  data.tar.gz: 662422c58628c014f87fcd53e440c4d55b9b5d41a01051f4c9eb7c77b3c39e70
+SHA512:
+  metadata.gz: 1284badb03b840c79449ef139fbd864a9b984cbb9d3cfcbfbd1518f1fa2833aac053ee5716b87b7566b1654ec75f2847230d31b1f0cff76787a8414c4881e7b6
+  data.tar.gz: 1c22ecd1222ba5b07c5b252f9175dd39b722192c9c170aee69ff751fe3d60a20e88c4e4fa4c644eae8cdcda551d7720b7d7ba86cced3181294bdc840f5384f74

data/.circleci/config.yml

@@ -0,0 +1,39 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@1.0.0
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.7.2
+
+    steps:
+      - checkout
+      - ruby/install-deps
+
+  minitest:
+    docker:
+      - image: circleci/ruby:2.7.2
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: vendor/bundle
+
+    steps:
+      - checkout
+      - ruby/install-deps
+
+      - run:
+          name: Stale code fix
+          command: git fetch && git reset --hard origin/${CIRCLE_BRANCH}
+      - run:
+          name: Minitest
+          command: bundle exec rake test
+
+workflows:
+  tests:
+    jobs:
+      - build
+      - minitest:
+          requires:
+            - build

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version

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 merkulov@uchi.ru. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in covert.gemspec
+gemspec
+
+gem 'minitest', '~> 5.0'
+
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    covert (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.3)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  covert!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Alexander Merkulov
+
+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,58 @@
+# Covert
+
+Covert makes your string securely obfuscated.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'covert'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install covert
+
+## Usage
+
+### Configuration
+```ruby
+Covert.configure do |config|
+  config.cipher_key = 'blah!'
+  config.cipher = 'AES-256-CBC' # default
+end
+```
+
+### Obfuscation
+```ruby
+Covert.obfuscate('mystring') #=> "7hSfzDwp2JXZcieFpGCndA=="
+```
+
+### Unobfuscation
+```ruby
+Covert.unobfuscate('7hSfzDwp2JXZcieFpGCndA==') #=> "mystring"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, 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/merqloveu/covert. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/merqloveu/covert/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 Covert project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/merqloveu/covert/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

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

@@ -0,0 +1,27 @@
+require_relative 'lib/covert/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'covert'
+  spec.version       = Covert::VERSION
+  spec.authors       = ['Alexander Merkulov']
+  spec.email         = ['merkulov@uchi.ru']
+
+  spec.summary       = 'Makes your string securely obfuscated.'
+  spec.description   = 'Fast & secure way to provide obfuscated ids and text.'
+  spec.homepage      = 'https://github.com/merqloveu/covert'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/merqloveu/covert'
+  spec.metadata['changelog_uri'] = 'https://github.com/merqloveu/covert'
+
+  # 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{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/covert.rb

@@ -0,0 +1,49 @@
+require 'openssl'
+require 'base64'
+require 'covert/version'
+
+#
+# Covert - makes your string securely obfuscated.
+#
+module Covert
+  class Error < StandardError; end
+
+  autoload :Config, 'covert/config.rb'
+  autoload :Obfuscation, 'covert/obfuscation.rb'
+  autoload :Obfuscate, 'covert/obfuscate.rb'
+  autoload :Unobfuscate, 'covert/unobfuscate.rb'
+
+  class << self
+    attr_writer :config
+
+    # @return [Config]
+    def config
+      @config ||= Config.new
+    end
+
+    # @return [Config]
+    def reset
+      @config = Config.new
+    end
+
+    def configure
+      yield(config)
+    end
+  end
+
+  # @param [String] str String to obfuscate
+  # @example Obfuscate a String
+  #   Covert.obfuscate("mystring") #=> "7hSfzDwp2JXZcieFpGCndA=="
+  # @return [String] Obfuscated string
+  def self.obfuscate(str)
+    Obfuscate.call(value: str)
+  end
+
+  # @param [String] str Obfuscated string
+  # @example Unobfuscate a String
+  #   Covert.unobfuscate("7hSfzDwp2JXZcieFpGCndA==") #=> "mystring"
+  # @return [String] Unobfuscated string
+  def self.unobfuscate(str)
+    Unobfuscate.call(value: str)
+  end
+end

data/lib/covert/config.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Covert
+  #
+  # Covert configuration
+  #
+  class Config
+    attr_accessor :cipher_key, :cipher
+
+    def initialize
+      @cipher_key = nil
+      @cipher = 'AES-256-CBC'
+    end
+  end
+end

data/lib/covert/obfuscate.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Covert
+  #
+  # Obfuscation class
+  #
+  class Obfuscate < Obfuscation
+    def call
+      c = cipher.encrypt
+      c.key = digest
+      encode(c.update(value.to_s) + c.final)
+    end
+  end
+end

data/lib/covert/obfuscation.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Covert
+  class Obfuscation
+    class << self
+      def call(value:)
+        new(value).call
+      end
+    end
+
+    def initialize(value)
+      @value = value
+    end
+
+    private
+
+    attr_reader :value
+
+    def cipher
+      OpenSSL::Cipher.new(Covert.config.cipher)
+    end
+
+    def cipher_key
+      Covert.config.cipher_key
+    end
+
+    def digest
+      Digest::SHA256.digest(cipher_key)
+    end
+
+    def decode(value)
+      Base64.strict_decode64(value)
+    end
+
+    def encode(value)
+      Base64.strict_encode64(value)
+    end
+  end
+end

data/lib/covert/unobfuscate.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Covert
+  #
+  # Unobfuscation class
+  #
+  class Unobfuscate < Obfuscation
+    def call
+      c = cipher.decrypt
+      c.key = digest
+      c.update(decode(value.to_s)) + c.final
+    end
+  end
+end

data/lib/covert/version.rb

@@ -0,0 +1,3 @@
+module Covert
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: covert
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Merkulov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-02-22 00:00:00.000000000 Z
+dependencies: []
+description: Fast & secure way to provide obfuscated ids and text.
+email:
+- merkulov@uchi.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- covert.gemspec
+- lib/covert.rb
+- lib/covert/config.rb
+- lib/covert/obfuscate.rb
+- lib/covert/obfuscation.rb
+- lib/covert/unobfuscate.rb
+- lib/covert/version.rb
+homepage: https://github.com/merqloveu/covert
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/merqloveu/covert
+  source_code_uri: https://github.com/merqloveu/covert
+  changelog_uri: https://github.com/merqloveu/covert
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Makes your string securely obfuscated.
+test_files: []