golden_ticket 0.9.12 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31002f606f2b87d064e661ed72409d9eb70a2e4b
-  data.tar.gz: 0be235c7d717a6ccee4c20d8f207b06ecf043085
+  metadata.gz: 75e746f3d97a596f6318fb232b284b858f9a219d
+  data.tar.gz: 547087fd393f723f372a13f3f1b00beebb8a6b6a
 SHA512:
-  metadata.gz: 3c9f488e5a91a90bcec751372b88808a9f2aae8333a6d85ad321db8320ea8b3f31ef67ba730cc4bc6a1759e48557861771570ae685436a8ad8b409d9c1355f0b
-  data.tar.gz: b0665be5681a73133a1102fe56521de5ff0dc2ab968800b4766e5fe7e5305ba1e8154387fb6787ec2864a8c68e50c9d010dcb34d016039ff99bd51b6cbd0b7fc
+  metadata.gz: a3a260c28b16d24150104c1182d8b9ee8ddd2dfa4fb7f58e2cb21deb2cc7d12cf85e0cd1a4b8036a7ee45edd4abba1c50ce38e2c305c654651b9d04e516f0cc1
+  data.tar.gz: d51e3ba3968a9be2e307198dfcc58d359b0bf5fe8e0aac9e523e507cf87a94d2bb38695b4912be72e82644bbbf5378db925581618af186dda88b72c36b2f71aa

data/README.md

@@ -2,6 +2,42 @@
 
 Simple JSON Web Token tools
 
+## Presentation
+
+This library provides utilities for manipulating [JSON Web Tokens (JWT)](https://jwt.io/).
+
+## Installation
+
+### Gemfile
+```ruby
+gem 'golden_ticket'
+```
+
+### Terminal
+```bash
+gem install -V golden_ticket
+```
+
+## Usage
+
+Any payload can be encoded as a JWT using the *encode* method:
+
+```ruby
+key = 'supersecret'
+payload = { user_id: 0, foo: :bar }
+GoldenTicket.encode key, payload
+# => 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjowLCJmb28iOiJiYXIifQ.4Tn4B_uV-FJ_xh2Vcg4LB24DP2faPoEll4Cttjblkhs'
+```
+
+Any JWT can be decoded using the *decode* method:
+
+```ruby
+key = 'supersecret'
+token = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjowLCJmb28iOiJiYXIifQ.4Tn4B_uV-FJ_xh2Vcg4LB24DP2faPoEll4Cttjblkhs'
+GoldenTicket.decode key, token
+# => { user_id: 0, foo: 'bar' }
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/golden_ticket.gemspec

@@ -4,21 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'golden_ticket/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "golden_ticket"
-  spec.version       = GoldenTicket::VERSION
-  spec.authors       = ["Eresse"]
-  spec.email         = ["eresse@eresse.net"]
+	spec.name = "golden_ticket"
+	spec.version = GoldenTicket::VERSION
+	spec.authors = ["Eresse"]
+	spec.email = ["eresse@eresse.net"]
 
-  spec.summary       = "Simple JWT Tools"
-  spec.description   = "Provides simple tools to manipulate JSON Web Token"
-  spec.homepage      = "http://redmine.eresse.net/projects/golden_ticket"
-  spec.license       = "MIT"
+	spec.summary = "Simple JWT Tools"
+	spec.description = "Provides simple tools to manipulate JSON Web Token"
+	spec.homepage = "http://redmine.eresse.net/projects/golden_ticket"
+	spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+	spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+	spec.bindir = "exe"
+	spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+	spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+	spec.add_development_dependency "bundler", "~> 1.12"
+	spec.add_development_dependency "rake", "~> 10.0"
+	spec.add_runtime_dependency 'aromat'
 end

data/lib/golden_ticket.rb

@@ -5,22 +5,32 @@
 require 'json'
 require 'base64'
 require 'openssl'
+require 'aromat'
 require 'golden_ticket/version'
 
 # GoldenTicket Module
 module GoldenTicket
 
-	# Encode Base64URL
+	# Encode Base64URL:
+	# Base64-encodes a String in way that plays nice with URLs (no special characters).
+	# @param [String] s A chunk to encode
+	# @return [String] The encoded string
 	def self.b64url_encode s
 		Base64.urlsafe_encode64(s).gsub('=', '').gsub "\n", ''
 	end
 
-	# Decode Base64URL
+	# Decode Base64URL:
+	# Base64-decodes a String which has been encoded with #b64url_encode.
+	# @param [String] s An encoded String
+	# @return [String] The decoded chunk
 	def self.b64url_decode s
 		Base64.urlsafe_decode64 s + ('=' * (((s.length % 4) > 0) ? (4 - (s.length % 4)) : 0))
 	end
 
-	# Encode (Generate JWT)
+	# Encode (Generate JWT):
+	# Produces a JSON Web Token (JWT) by SHA-256-hashing a payload's JSON representation.
+	# @param [String] key Used for SHA-256 hashing
+	# @param [Object] payload The Actual token information payload
 	def self.encode key, payload
 
 		# Prep Header - Always HMAC SHA 256 / JWT
@@ -38,7 +48,11 @@ module GoldenTicket
 		"#{header_data}.#{payload_data}.#{secret_data}"
 	end
 
-	# Decode (Parse JWT)
+	# Decode (Parse JWT):
+	# Splits up and decodes a given JSON Web Token, after having verified its authenticity.
+	# @param [String] key Used for SHA-256 hashing
+	# @param [String] token The token itself (duh...)
+	# @return [Object] The actual token information payload
 	def self.decode key, token
 
 		# Split Token
@@ -49,6 +63,6 @@ module GoldenTicket
 		raise 'Invalid Token' unless secret_data == b64url_encode(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), key, secret))
 
 		# Pull dat Payload
-		JSON.parse b64url_decode payload_data
+		JSON.parse(b64url_decode(payload_data)).sym_keys
 	end
 end

data/lib/golden_ticket/version.rb

@@ -5,5 +5,5 @@
 module GoldenTicket
 
 	# Version
-	VERSION = '0.9.12'
+	VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: golden_ticket
 version: !ruby/object:Gem::Version
-  version: 0.9.12
+  version: 1.0.0
 platform: ruby
 authors:
 - Eresse
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-08 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: aromat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides simple tools to manipulate JSON Web Token
 email:
 - eresse@eresse.net