minty 1.0.0

data/Gemfile.lock

@@ -0,0 +1,250 @@
+PATH
+  remote: .
+  specs:
+    minty (1.0.0)
+      addressable (~> 2.8)
+      jwt (~> 2.5)
+      rest-client (~> 2.1)
+      retryable (~> 3.0)
+      zache (~> 0.12)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.4)
+      actionview (= 7.0.4)
+      activesupport (= 7.0.4)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.4)
+      activesupport (= 7.0.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    crack (0.4.5)
+      rexml
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.8.1)
+    dotenv-rails (2.8.1)
+      dotenv (= 2.8.1)
+      railties (>= 3.2)
+    erubi (1.11.0)
+    faker (2.23.0)
+      i18n (>= 1.8.11, < 2)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    fuubar (2.5.1)
+      rspec-core (~> 3.0)
+      ruby-progressbar (~> 1.4)
+    gem-release (0.7.4)
+    guard (2.17.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashdiff (1.0.1)
+    http-accept (1.7.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.5.11)
+    irb (1.4.2)
+      reline (>= 0.3.0)
+    json (2.6.2)
+    jwt (2.5.0)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.19.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.2.8)
+    method_source (0.9.2)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    minitest (5.16.3)
+    multi_json (1.15.0)
+    nenv (0.3.0)
+    netrc (0.11.0)
+    nokogiri (1.13.9-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.13.9-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.9-x86_64-linux)
+      racc (~> 1.4)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pp (0.3.0)
+      prettyprint
+    prettyprint (0.1.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-nav (0.3.0)
+      pry (>= 0.9.10, < 0.13.0)
+    public_suffix (5.0.0)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (0.8.3)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (7.0.4)
+      actionpack (= 7.0.4)
+      activesupport (= 7.0.4)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.6.0)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    retryable (3.0.5)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.38.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    rubocop-rails (2.17.2)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (2.1.0)
+      rexml
+      simplecov (~> 0.19)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    terminal-notifier-guard (1.7.0)
+    thor (1.2.1)
+    timecop (0.9.5)
+    tins (1.31.1)
+      sync
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.3.0)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zache (0.12.0)
+    zeitwerk (2.6.1)
+
+PLATFORMS
+  aarch64-linux
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  coveralls
+  dotenv-rails (~> 2.0)
+  faker (~> 2.0)
+  fuubar (~> 2.0)
+  gem-release (~> 0.7)
+  guard-rspec (~> 4.5)
+  irb
+  minty!
+  pp
+  pry (~> 0.10)
+  pry-nav (~> 0.2)
+  rack (~> 2.1)
+  rack-test (~> 0.6)
+  rake (~> 13.0)
+  rspec (~> 3.11)
+  rubocop
+  rubocop-rails
+  simplecov (~> 0.9)
+  simplecov-cobertura
+  terminal-notifier-guard
+  timecop
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.3.25

data/Guardfile

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+scope group: :unit_test
+
+group :unit_test do
+  guard 'rspec', cmd:
+    "bundle exec rspec -P \"spec/lib/minty/**/*#{ENV['PATTERN']}*_spec.rb\"--drb --format Fuubar --color" do
+    # run every updated spec file
+    watch(%r{^spec/.+_spec\.rb$})
+    # run the lib specs when a file in lib/ changes
+    watch(%r{^lib/(.+)\.rb$}) { 'spec' }
+    # run all test for helper changes
+    watch('spec/spec_helper.rb') { 'spec' }
+  end
+end
+
+group :integration do
+  guard 'rspec', cmd:
+    "MODE=full bundle exec rspec -P \"spec/integration/**/*#{ENV['PATTERN']}*_spec.rb\" --drb --format Fuubar --color" do
+    # run every updated spec file
+    watch(%r{^spec/.+_spec\.rb$})
+    # run the lib specs when a file in lib/ changes
+    watch(%r{^lib/(.+)\.rb$}) { 'spec' }
+    # run all test for helper changes
+    watch('spec/spec_helper.rb') { 'spec' }
+  end
+end
+
+group :full do
+  guard 'rspec', cmd:
+    'MODE=full bundle exec rspec --drb --format Fuubar --color' do
+    # run every updated spec file
+    watch(%r{^spec/.+_spec\.rb$})
+    # run the lib specs when a file in lib/ changes
+    watch(%r{^lib/(.+)\.rb$}) { 'spec' }
+    # run all test for helper changes
+    watch('spec/spec_helper.rb') { 'spec' }
+  end
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Minty, Inc. <support@minty.page> (http://minty.page)
+
+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/Makefile

@@ -0,0 +1,5 @@
+default: git
+git:
+	git add -A
+	git commit -m "Modified `git status --porcelain | grep 'M' | wc -l` file(s), Added `git status --porcelain | grep 'A' | wc -l` file(s), Removed `git status --porcelain | grep 'D' | wc -l` file(s)" -m "`git status --porcelain`"
+	git push -u origin main

data/README.md

@@ -0,0 +1,88 @@
+Ruby API client for the [Minty](https://minty.page) platform.
+
+[![MIT licensed](https://img.shields.io/dub/l/vibe-d.svg?style=flat)](https://github.com/mintypage/ruby/blob/master/LICENSE)
+
+## Documentation
+
+- [API documentation](https://www.rubydoc.info/gems/minty) - documentation auto-generated from the code comments that explains all the available features
+- [Examples](https://github.com/mintypage/ruby/blob/master/EXAMPLES.md) - examples that demonstrate the different ways in which this SDK can be used
+[FAQ](https://github.com/mintypage/ruby/blob/master/FAQ.md) - frequently asked questions about the SDK
+- [Docs Site](https://minty.page/docs) - explore our Docs site and learn more about Minty
+
+## Getting Started
+
+### Installation
+
+This gem can be installed directly:
+
+```bash
+$ gem install minty
+```
+
+or with [Bundler](https://bundler.io/man/bundle-add.1.html):
+
+```bash
+bundle add minty
+```
+
+### Usage
+
+Create an instance of `MintyClient` to access properties and methods of the authentication and management APIs:
+
+```ruby
+require 'minty'
+
+client = MintyClient.new(
+  client_id: ENV['AUTH0_RUBY_CLIENT_ID'],
+  client_secret: ENV['AUTH0_RUBY_CLIENT_SECRET'],
+  domain: ENV['AUTH0_RUBY_DOMAIN'],
+)
+```
+
+If `token` is omitted, the SDK will attempt to fetch a new token using the `client_credentials` grant, provided that `client_id` and `client_secret` are provided in the configuration. Once the token is about to expire (or has already expired), a new token will be fetched and cached for future calls.
+
+For this to work, ensure your application can make a Client Credentials grant (Application settings in Minty > Advanced > Grant Types tab) and that the application is authorized for the Management API: https://minty.page/docs/api-auth/config/using-the-minty-dashboard
+
+## Authentication API Client
+
+This SDK provides access to [Authentication API](https://minty.page/docs/api/authentication) endpoints with the `Minty::API::AuthenticationEndpoints` module.
+
+## Further reading
+
+- [API authentication in Ruby](https://minty.page/docs/quickstart/backend/ruby)
+- [API authentication in Rails](https://minty.page/docs/quickstart/backend/rails)
+- [Managing authentication with Minty (blog)](https://minty.page/blog/rails-5-with-minty/)
+- [Ruby on Rails workflow with Docker (blog)](https://minty.page/blog/ruby-on-rails-killer-workflow-with-docker-part-1/)
+
+## Feedback
+
+### Contributing
+
+We appreciate feedback and contribution to this repo! Before you get started, please see the following:
+
+- [Minty's general contribution guidelines](https://github.com/minty/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
+- [Minty's code of conduct guidelines](https://github.com/minty/open-source-template/blob/master/CODE-OF-CONDUCT.md)
+
+### Raise an issue
+
+To provide feedback or report a bug, please [raise an issue on our issue tracker](https://github.com/mintypage/ruby/issues).
+
+### Vulnerability Reporting
+
+Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://minty.page/whitehat) details the procedure for disclosing security issues.
+
+---
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://cdn.minty.page/website/sdks/logos/minty_dark_mode.png" width="150">
+    <source media="(prefers-color-scheme: light)" srcset="https://cdn.minty.page/website/sdks/logos/minty_light_mode.png" width="150">
+    <img alt="Minty Logo" src="https://cdn.minty.page/website/sdks/logos/minty_light_mode.png" width="150">
+  </picture>
+</p>
+<p align="center">
+  Minty is an easy to implement, adaptable authentication and authorization platform. To learn more checkout <a href="https://minty.page/why-minty">Why Minty?</a>
+</p>
+<p align="center">
+  This project is licensed under the MIT license. See the <a href="https://github.com/mintypage/ruby/blob/master/LICENSE"> LICENSE</a> file for more info.
+</p>

data/RUBYGEM.md

@@ -0,0 +1,9 @@
+# Publish the Gem on RubyGems.org
+
+To publish the gem set `RUBYGEMS_EMAIL` and `RUBYGEMS_PASSWORD` environment variables with your email and password from your RubyGems account respectively.
+Then run the following [Docker](https://docs.docker.com/engine/installation/) commands in the terminal to build and publish the gem.
+
+```bash
+docker build -t minty-publish-rubygem .
+docker run --rm -e RUBYGEMS_EMAIL="$RUBYGEMS_EMAIL" -e RUBYGEMS_PASSWORD="$RUBYGEMS_PASSWORD" -it minty-publish-rubygem /bin/sh publish_rubygem.sh
+```

data/Rakefile

@@ -0,0 +1,33 @@
+#!/usr/bin/env rake
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+begin
+  require 'rubocop/rake_task'
+
+  require 'rspec/core/rake_task'
+
+  desc 'Run Rubocop'
+  RuboCop::RakeTask.new(:rubocop)
+
+  desc 'Run Integration Tests'
+  RSpec::Core::RakeTask.new(:integration) do |t|
+    t.pattern = FileList["spec/integration/**/*#{ENV['PATTERN']}*_spec.rb"]
+  end
+
+  desc 'Run Unit Tests'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = FileList["spec/lib/minty/**/*#{ENV['PATTERN']}*_spec.rb"]
+  end
+
+  desc 'Run All Suites'
+  RSpec::Core::RakeTask.new(:all)
+
+  desc 'Run unit and integration tests'
+  task test: %i[spec integration]
+
+  task default: %i[rubocop test]
+rescue LoadError
+  puts 'Load Error - No RSpec'
+end

data/codecov.yml

@@ -0,0 +1,22 @@
+coverage:
+  precision: 2
+  round: down
+  range: "60...100"
+  status:
+    project:
+      default:
+        enabled: true
+        target: auto
+        threshold: 5%
+        if_no_uploads: error
+    patch:
+      default:
+        enabled: true
+        target: 80%
+        threshold: 30%
+        if_no_uploads: error
+    changes:
+      default:
+        enabled: true
+        if_no_uploads: error
+comment: false 

data/lib/minty/algorithm.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Minty
+  module Algorithm
+    include Minty::Mixins::Validation::Algorithm
+  end
+end

data/lib/minty/api/authentication_endpoints.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'jwt'
+
+module Minty
+  module Api
+    module AuthenticationEndpoints
+      def sign_in_url(client_id: @client_id, client_secret: @client_secret, organization: @organization)
+        response = request_with_retry(:get, '/sign_in_url')
+        response['redirect_url']
+      end
+
+      def sign_up_url(client_id: @client_id, client_secret: @client_secret, organization: @organization)
+        response = request_with_retry(:get, '/sign_up_url')
+        response['redirect_url']
+      end
+
+      def forgot_password_url(client_id: @client_id, client_secret: @client_secret, organization: @organization)
+        response = request_with_retry(:get, '/forgot_password_url')
+        response['redirect_url']
+      end
+
+      private
+
+      def to_query(hash)
+        hash.map { |k, v| "#{k}=#{CGI.escape(v)}" unless v.nil? }.reject(&:nil?).join('&')
+      end
+    end
+  end
+end

data/lib/minty/api/v2.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Minty
+  module Api
+    module V2
+    end
+  end
+end

data/lib/minty/client.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Minty
+  class Client
+    include Minty::Mixins
+  end
+end

data/lib/minty/exception.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Minty
+  class Exception < StandardError
+    attr_reader :error_data
+
+    def initialize(message, error_data = {})
+      super(message)
+      @error_data = error_data
+    end
+  end
+
+  class HTTPError < Minty::Exception
+    def headers
+      error_data[:headers]
+    end
+
+    def http_code
+      error_data[:code]
+    end
+  end
+
+  class Unauthorized < Minty::HTTPError; end
+  class NotFound < Minty::HTTPError; end
+  class Unsupported < Minty::HTTPError; end
+  class ServerError < Minty::HTTPError; end
+  class BadRequest < Minty::HTTPError; end
+  class RequestTimeout < Minty::Exception; end
+  class MissingUserId < Minty::Exception; end
+  class MissingClientId < Minty::Exception; end
+  class MissingOrganizationId < Minty::Exception; end
+  class MissingActionName < Minty::Exception; end
+  class MissingActionId < Minty::Exception; end
+  class MissingExecutionId < Minty::Exception; end
+  class MissingTriggerId < Minty::Exception; end
+  class MissingParameter < Minty::Exception; end
+  class MissingVersionId < Minty::Exception; end
+  class AccessDenied < Minty::HTTPError; end
+  class InvalidParameter < Minty::Exception; end
+  class InvalidCredentials < Minty::Exception; end
+  class InvalidApiNamespace < Minty::Exception; end
+
+  class RateLimitEncountered < Minty::HTTPError
+    def reset
+      Time.at(Integer(headers[:x_ratelimit_reset])).utc
+    end
+  end
+
+  class InvalidIdToken < Minty::Exception; end
+end

data/lib/minty/mixins/api_token_struct.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+Minty::ApiToken = Struct.new :token do
+end

data/lib/minty/mixins/headers.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Minty
+  module Mixins
+    module Headers
+      def client_headers(client_id, client_secret, application_id)
+        {
+          'Content-Type' => 'application/json',
+          'Authorization' => "Bearer #{client_secret}",
+          'API-MINTY-CLIENT-ID' => client_id,
+          'API-MINTY-APPLICATION-ID' => application_id,
+          'Accept' => 'application/json'
+        }
+      end
+    end
+  end
+end