warrant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d582aad391d045a0560fa31d72874b6daab745730fde4166a8a928372b0dfd1a
+  data.tar.gz: b8b88e6cb72cca841e4261460a9562c3f6228894cab278c88de4bb69b4838aeb
+SHA512:
+  metadata.gz: af98bc58266547012886473b49d3d8e0a4434e922dedc6d7372fb4b1d90f95d7d77cdba276281dde5f0316ffa4ba60b575d9331ba0f30774fbe2cc30d7cbafe3
+  data.tar.gz: d99f3dccc78f9855ff239671ebde3ac5903e26311e4c1a2d2122ff864fa642b1801d03529a713037de26c510dc6030e32c2fb276bb779206aba8e532d44830de

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2021-11-22
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in warrant.gemspec
+gemspec
+
+gem "rake"
+gem "minitest", "~> 5.0"
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Warrant (Forerunner Labs, Inc.)
+
+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,80 @@
+# Warrant Ruby Library
+
+Use [Warrant](https://warrant.dev/) in ruby projects.
+
+[![Gem Version](https://badge.fury.io/rb/warrant.svg)](https://badge.fury.io/rb/warrant)
+[![Discord](https://img.shields.io/discord/865661082203193365?label=discord)](https://discord.gg/QNCMKWzqET)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'warrant'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install warrant
+
+## Usage
+
+```ruby
+require 'warrant'
+Warrant.api_key = 'api_test_f5dsKVeYnVSLHGje44zAygqgqXiLJBICbFzCiAg1E='
+```
+
+### `createUser(user_id, username)`
+
+This method creates a user entity in Warrant with the specified `userId`. Provide an optional `username` to make it easier to identify users in the Warrant dashboard.
+
+```ruby
+# Create user with `user.id` as the user_id and `user.email` as the username
+Warrant::WarrantClient.create_user(user.id, user.email)
+
+# Create user with generated id
+Warrant::WarrantClient.create_user()
+```
+
+### `createWarrant(objectType, objectId, relation, user)`
+
+This method creates a warrant which specifies that the provided `user` (or userset) has `relation` on the object of type `objectType` with id `objectId`.
+
+```ruby
+# Create a warrant allowing user.id to "view" the store with id store.id
+Warrant::WarrantClient.create_warrant('store', store.id, 'view', { userId: user.id })
+```
+
+### `createSession(userId)`
+
+This method creates a session in Warrant for the user with the specified `userId` and returns a session token which can be used to make authorized requests to the Warrant API only for the specified user. This session token can safely be used to make requests to the Warrant API's authorization endpoint to determine user access in web and mobile client applications.
+
+```ruby
+# Create session token for user
+Warrant::WarrantClient.create_session(user.id)
+```
+
+### `isAuthorized(objectType, objectId, relation, userId)`
+
+This method returns `true` if the user with the specified `userId` has the specified `relation` to the object of type `objectType` with id `objectId` and `false` otherwise.
+
+```ruby
+# Example: user 123 can only view store 824
+Warrant::WarrantClient.is_authorized('store', '824', 'view', '123') # true
+Warrant::WarrantClient.is_authorized('store', '824', 'edit', '123') # false
+```
+
+We’ve used a random API key in these code examples. Replace it with your [actual publishable API keys](https://app.warrant.dev) to
+test this code through your own Warrant account.
+
+For more information on how to use the Warrant API, please refer to the [Warrant API reference](https://docs.warrant.dev).
+
+Note that we may release new [minor and patch](https://semver.org/) versions of this library with small but backwards-incompatible fixes to the type declarations. These changes will not affect Warrant itself.
+
+## Warrant Documentation
+
+- [Warrant Docs](https://docs.warrant.dev/)

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "warrant"
+
+# 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/warrant/models/user.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Warrant
+  class User
+    attr_reader :user_id
+
+    def initialize(user_id)
+      @user_id = user_id
+    end
+  end
+end

data/lib/warrant/models/user_warrant.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Warrant
+    class UserWarrant
+        attr_reader :object_type, :object_id, :relation, :user
+
+        def initialize(object_type, object_id, relation, user_id)
+            @object_type = object_type
+            @object_id = object_id
+            @relation = relation
+            @user = User.new(user_id)
+        end
+    end
+end

data/lib/warrant/models/userset.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Warrant
+    class Userset
+        attr_reader :object_type, :object_id, :relation
+
+        def initialize(object_type, object_id, relation)
+            @object_type = object_type
+            @object_id = object_id
+            @relation = relation
+        end
+    end
+end

data/lib/warrant/models/userset_warrant.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Warrant
+    class UsersetWarrant
+        attr_reader :object_type, :object_id, :relation, :user
+
+        def initialize(object_type, object_id, relation, user)
+            @object_type = object_type
+            @object_id = object_id
+            @relation = relation
+            @user = Userset.new(user['objectType'], user['objectId'], user['relation'])
+        end
+    end
+end

data/lib/warrant/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Warrant
+  VERSION = "0.1.0"
+end

data/lib/warrant/warrant_client.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Warrant
+    class WarrantClient
+        class << self
+            def create_user(user_id = '', username = '')
+                uri = URI.parse("#{Warrant.config.api_base}/v1/users")
+                params = {
+                    userId: user_id,
+                    username: username
+                }
+                res = post(uri, params)
+                res_json = JSON.parse(res.body)
+                
+                case res
+                when Net::HTTPSuccess
+                    User.new(res_json['userId'])
+                else
+                    res_json
+                end
+            end
+
+            def create_warrant(object_type, object_id, relation, user)
+                uri = URI.parse("#{Warrant.config.api_base}/v1/warrants")
+                params = {
+                    objectType: object_type,
+                    objectId: object_id,
+                    relation: relation,
+                    user: user
+                }
+                res = post(uri, params)
+                res_json = JSON.parse(res.body)
+                
+                case res
+                when Net::HTTPSuccess
+                    if res_json['user']['userId']
+                        UserWarrant.new(res_json['objectType'], res_json['objectId'], res_json['relation'], res_json['user']['userId'])
+                    elsif res_json['user']['objectType']
+                        UsersetWarrant.new(res_json['objectType'], res_json['objectId'], res_json['relation'], res_json['user'])
+                    end
+                else
+                    res_json
+                end
+            end
+
+            def create_session(user_id)
+                uri = URI.parse("#{Warrant.config.api_base}/v1/users/#{user_id}/sessions")
+                res = post(uri)
+                res_json = JSON.parse(res.body)
+
+                case res
+                when Net::HTTPSuccess
+                    res_json['token']
+                else
+                    res_json
+                end
+            end
+
+            def is_authorized(object_type, object_id, relation, user_id)
+                uri = URI.parse("#{Warrant.config.api_base}/v1/authorize")
+                params = {
+                    objectType: object_type,
+                    objectId: object_id,
+                    relation: relation,
+                    user: {
+                        userId: user_id
+                    }
+                }
+                res = post(uri, params)
+                res_json = JSON.parse(res.body)
+
+                if res.is_a? Net::HTTPSuccess
+                    true
+                else
+                    false
+                end
+            end
+
+            private
+
+            def post(uri, params = {}) 
+                http = Net::HTTP.new(uri.host, uri.port)
+                http.use_ssl = true
+                headers = {
+                    "Authorization": "ApiKey #{Warrant.config.api_key}"
+                }
+                http.post(uri.path, params.to_json, headers)
+            end
+        end
+    end
+end

data/lib/warrant/warrant_configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Warrant
+    class WarrantConfiguration
+        attr_accessor :api_key
+
+        attr_reader :api_base
+
+        def initialize
+            @api_base = "https://api.warrant.dev"
+        end
+    end
+end

data/lib/warrant.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "warrant/version"
+
+require "net/http"
+require "json"
+require "forwardable"
+
+require "warrant/models/user"
+require "warrant/models/userset"
+require "warrant/models/user_warrant"
+require "warrant/models/userset_warrant"
+require "warrant/warrant_configuration"
+require "warrant/warrant_client"
+
+module Warrant
+    @config = Warrant::WarrantConfiguration.new
+
+    class << self
+        extend Forwardable
+
+        attr_reader :config
+
+        def_delegators :@config, :api_key, :api_key=
+    end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: warrant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Warrant
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-11-23 00:00:00.000000000 Z
+dependencies: []
+description: Ruby library for the Warrant API at https://warrant.dev.
+email: hello@warrant.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/warrant.rb
+- lib/warrant/models/user.rb
+- lib/warrant/models/user_warrant.rb
+- lib/warrant/models/userset.rb
+- lib/warrant/models/userset_warrant.rb
+- lib/warrant/version.rb
+- lib/warrant/warrant_client.rb
+- lib/warrant/warrant_configuration.rb
+homepage: https://github.com/warrant-dev/warrant-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/warrant-dev/warrant-ruby
+  source_code_uri: https://github.com/warrant-dev/warrant-ruby
+  changelog_uri: https://github.com/warrant-dev/warrant-ruby/CHANGELOG.md
+  documentation_uri: https://docs.warrant.dev/
+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.2.14
+signing_key: 
+specification_version: 4
+summary: Warrant Ruby Library
+test_files: []