vonage-jwt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75f27de718f0fdf8dce4a63da2ea80d69921985dc41c4c056e6072bce3c7bb4d
+  data.tar.gz: 6e1dd89c4f5df012efb95a76d827f61ac5b1b1dce5a0d658e007e6e171f4229c
+SHA512:
+  metadata.gz: 025d062660e96cd6bcaef552ebb71fe2d5249cf4be450e492f48dedd1ac49f8464309f0de70ffdc909a03af140f626e89e212cd85e07af51143788a1be6c80c6
+  data.tar.gz: 61f33cf546932c49cbc7b0fb4433705edeb972746122bfdaea2f2f9db789eccd77d63f7859c42800d28ff90102835b05048b9243e742da60d74de1adfa32a9e1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Vonage
+
+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,78 @@
+# Vonage JWT Generator for Ruby
+
+[![Gem Version](https://badge.fury.io/rb/vonage-jwt.svg)](https://badge.fury.io/rb/vonage-jwt)![Coverage Status](https://github.com/Vonage/vonage-jwt-ruby/workflows/CI/badge.svg)[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
+
+This is the Ruby library to generate Vonage JSON Web Tokens (JWTs). To use it you'll
+need a Vonage account. Sign up [for free at vonage.com][signup].
+
+* [Requirements](#requirements)
+* [Installation](#installation)
+* [Usage](#usage)
+* [Documentation](#documentation)
+* [License](#license)
+
+## Requirements
+
+The JWT generator supports Ruby version 2.7 or newer.
+
+## Installation
+
+To install the Ruby client library using Rubygems:
+
+    gem install vonage-jwt
+
+Alternatively you can clone the repository:
+
+    git clone git@github.com:Vonage/vonage-jwt-ruby.git
+
+## Usage
+
+By default the Vonage JWT generator creates a short lived JWT (15 minutes) per request.
+To generate a long lived JWT for multiple requests, specify a longer value in the `exp`
+parameter during initialization. 
+
+Example with no custom configuration:
+
+```ruby
+@builder = Vonage::JWTBuilder.new(application_id: YOUR_APPLICATION_ID, private_key: YOUR_PRIVATE_KEY)
+@token = @builder.jwt.generate
+```
+
+Example providing custom configuration options:
+
+```ruby
+@builder = Vonage::JWTBuilder.new(
+  application_id: YOUR_APPLICATION_ID,
+  private_key: YOUR_PRIVATE_KEY,
+  ttl: 500,
+  paths: {
+    "acl": {
+      "paths": {
+        "/messages": {
+          "methods": ["POST", "GET"],
+          "filters": {
+            "from": "447977271009"  
+          }     
+        }  
+      }   
+    }
+  },
+  subject: 'My_Custom_Subject'
+)
+@token = @builder.jwt.generate
+```
+
+## Documentation
+
+Vonage Ruby JWT documentation: https://www.rubydoc.info/github/Vonage/vonage-jwt
+
+Vonage Ruby code examples: https://github.com/Vonage/vonage-ruby-code-snippets
+
+Vonage API reference: https://developer.vonage.com/api
+
+## License
+
+This library is released under the [MIT License][license]
+
+[signup]: https://ui.idp.vonage.com/ui/auth/registration?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library
+[license]: LICENSE.txt

data/lib/vonage-jwt/jwt.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'jwt'
+
+module Vonage
+  class JWT
+    attr_accessor :generator, :typ, :iat
+
+    def initialize(params = {})
+      @generator = params.fetch(:generator)
+      @typ = params.fetch(:typ, 'JWT')
+      @iat = params.fetch(:iat, Time.now.to_i)
+    end
+
+    def generate
+      ::JWT.encode(to_payload, generator.private_key, generator.alg, header_fields={typ: typ})
+    end
+
+    def to_payload
+      hash = {
+        iat: iat,
+        jti: generator.jti,
+        exp: generator.exp || iat + generator.ttl,
+        sub: generator.subject,
+        application_id: generator.application_id
+      }
+      hash.merge!(generator.paths) if generator.paths
+      hash.merge!(nbf: generator.nbf) if generator.nbf
+      hash.merge!(generator.additional_claims) if !generator.additional_claims.empty?
+      hash
+    end
+  end
+end

data/lib/vonage-jwt/jwt_builder.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'securerandom'
+require_relative 'jwt'
+
+module Vonage
+  class JWTBuilder
+    # Generate an encoded JSON Web Token.
+    #
+    # By default the Vonage JWT generator creates a short lived (15 minutes) JWT per request.
+    #
+    # To generate a long lived JWT for multiple requests, specify a longer value in the `exp`
+    # parameter during initialization.
+    #
+    # Example with no custom configuration:
+    #
+    # @example
+    #   @builder = Vonage::JWTBuilder.new(application_id: YOUR_APPLICATION_ID, private_key: YOUR_PRIVATE_KEY)
+    #   @token = @builder.jwt.generate
+    #
+    # Example providing custom configuration options:
+    #
+    # @example
+    #   @generator = Vonage::JWTBuilder.new(
+    #     application_id: YOUR_APPLICATION_ID,
+    #     private_key: YOUR_PRIVATE_KEY,
+    #     ttl: 500,
+    #     subject: 'My_Custom_Subject'
+    #   )
+    #   @token = @builder.jwt.generate
+    #
+    # @param [String] application_id
+    # @param [Integer] iat
+    # @param [SecureRandom::UUIDv4] jti
+    # @param [Integer] nbf
+    # @param [Integer] exp
+    # @param [Hash] paths
+    # @param [String] sub
+    # @param [String, OpenSSL::PKey::RSA] private_key
+    #
+    # @return [String]
+    #
+    attr_accessor :application_id, :private_key, :jti, :nbf, :ttl, :exp, :alg, :paths, :subject, :additional_claims, :jwt
+
+    def initialize(params = {})
+      Vonage::JWTBuilder.validate_parameters_not_conflicting(params)
+
+      @application_id = set_application_id(params.fetch(:application_id))
+      @private_key = set_private_key(params.fetch(:private_key))
+      @jti = params.fetch(:jti, SecureRandom.uuid)
+      @nbf = params.fetch(:nbf, nil)
+      @ttl = params.fetch(:ttl, 900)
+      @exp = params.fetch(:exp, nil)
+      @alg = params.fetch(:alg, 'RS256')
+      @paths = params.fetch(:paths, nil)
+      @subject = params.fetch(:subject, 'Subject')
+      @additional_claims = set_additional_claims(params)
+      @jwt = Vonage::JWT.new(generator: self)
+
+      after_initialize!(self)
+    end
+
+    def self.validate_parameters_not_conflicting(params)
+      return unless params[:ttl] && params[:exp]
+
+      raise ArgumentError, "Expected either 'ttl' or 'exp' parameter, preference is to set 'ttl' parameter"
+    end
+
+    def after_initialize!(builder)
+      validate_not_before(builder.nbf) if builder.nbf
+      validate_time_to_live(builder.ttl)
+      validate_paths(builder.paths) if builder.paths
+      validate_subject(builder.subject) if builder.subject
+    end
+
+    def set_application_id(application_id)
+      validate_application_id(application_id)
+
+      application_id
+    end
+
+    def set_private_key(private_key)
+      validate_private_key(private_key)
+
+      if File.exist?(private_key)
+        OpenSSL::PKey::RSA.new(File.read(private_key))
+      else
+        OpenSSL::PKey::RSA.new(private_key)
+      end
+    end
+
+    def set_additional_claims(params)
+      params.delete_if {|k,v| [:application_id, :private_key, :jti, :nbf, :ttl, :exp, :alg, :paths, :subject].include?(k) }
+    end
+
+    def set_exp
+      Time.now.to_i
+    end
+
+    def validate_application_id(application_id)
+      raise ArgumentError, "Missing required 'application_id' parameter" if application_id.nil?
+    end
+
+    def validate_private_key(private_key)
+      raise ArgumentError, "Missing required 'private_key' parameter" if private_key.nil?
+    end
+
+    def validate_not_before(nbf)
+      raise ArgumentError, "Expected Integer parameter type for NotBefore 'nbf' parameter" unless nbf.is_a?(Integer)
+    end
+
+    def validate_time_to_live(ttl)
+      raise ArgumentError, "Expected Integer parameter type for TimeToLive 'ttl' parameter" unless ttl.is_a?(Integer)
+    end
+
+    def validate_paths(acl_paths)
+      raise ArgumentError, "Expected Hash parameter type for Paths 'paths' parameter" unless acl_paths.is_a?(Hash)
+    end
+
+    def validate_subject(subject)
+      raise ArgumentError, "Expected String parameter type for Subject 'subject' parameter" unless subject.is_a?(String)
+    end
+  end
+end

data/lib/vonage-jwt/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Vonage
+  class JWT
+    VERSION = '0.1.0'
+  end
+end

data/lib/vonage-jwt.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'vonage-jwt/jwt_builder'
+
+module Vonage
+end

data/vonage-jwt.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/vonage-jwt/version', File.dirname(__FILE__))
+
+Gem::Specification.new do |s|
+  s.name = 'vonage-jwt'
+  s.version = Vonage::JWT::VERSION
+  s.license = 'MIT'
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Vonage']
+  s.email = ['devrel@vonage.com']
+  s.homepage = 'https://github.com/Vonage/vonage-jwt-ruby'
+  s.description = 'Vonage JWT Generator for Ruby'
+  s.summary = 'This is the Ruby client library to generate Vonage JSON Web Tokens (JWTs).'
+  s.files = Dir.glob('lib/**/*.rb') + %w[LICENSE.txt README.md vonage-jwt.gemspec]
+  s.required_ruby_version = '>= 2.7.0'
+  s.add_dependency('jwt', '~> 2')
+  s.require_path = 'lib'
+  s.metadata = {
+    'homepage' => 'https://github.com/Vonage/vonage-jwt-ruby',
+    'source_code_uri' => 'https://github.com/Vonage/vonage-jwt-ruby',
+    'bug_tracker_uri' => 'https://github.com/Vonage/vonage-jwt-ruby/issues',
+    'changelog_uri' => 'https://github.com/Vonage/vonage-jwt-ruby/blob/main/CHANGES.md',
+    'documentation_uri' => 'https://rubydoc.info/github/Vonage/vonage-jwt-ruby'
+  }
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: vonage-jwt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vonage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Vonage JWT Generator for Ruby
+email:
+- devrel@vonage.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/vonage-jwt.rb
+- lib/vonage-jwt/jwt.rb
+- lib/vonage-jwt/jwt_builder.rb
+- lib/vonage-jwt/version.rb
+- vonage-jwt.gemspec
+homepage: https://github.com/Vonage/vonage-jwt-ruby
+licenses:
+- MIT
+metadata:
+  homepage: https://github.com/Vonage/vonage-jwt-ruby
+  source_code_uri: https://github.com/Vonage/vonage-jwt-ruby
+  bug_tracker_uri: https://github.com/Vonage/vonage-jwt-ruby/issues
+  changelog_uri: https://github.com/Vonage/vonage-jwt-ruby/blob/main/CHANGES.md
+  documentation_uri: https://rubydoc.info/github/Vonage/vonage-jwt-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: This is the Ruby client library to generate Vonage JSON Web Tokens (JWTs).
+test_files: []