cogitate 0.0.1 → 0.0.2

data/lib/cogitate/services/tokenizer.rb

@@ -0,0 +1,80 @@
+require 'figaro'
+require 'jwt'
+
+module Cogitate
+  module Services
+    # Responsible for decoding a token and encoding a token.
+    #
+    # @note This is a slight deviation from some of the class architecture in that there are two primary functions .from_token and
+    #    .to_token. There is an underlying parameter object (i.e. password, issuer claim, and encryption type) that can be teased apart
+    #    and thus create 1 data structure and 2 isolated functions instead of the bundled 1 object.
+    # @see https://github.com/jwt/ruby-jwt
+    class Tokenizer
+      # @api public
+      #
+      # Responsible for decoding a signed and encoded token and returning the `:data` portion of the JWT (JSON Web Token).
+      #
+      # @param token [String] An encoded token (as encoded via .to_token)
+      # @return the :data from the given token
+      # @see Cogitate::Services::Tokenizer.to_token
+      def self.from_token(token:, **keywords)
+        new(**keywords).from_token(token: token)
+      end
+
+      # @api public
+      #
+      # Responsible for encoding and signing a token who's `:data` payload is the input data.
+      #
+      # @param data [#as_json] An object that can be converted to a Hash as per #as_json
+      # @return [String] an encoded and signed token
+      # @see Cogitate::Services::Tokenizer.from_token
+      def self.to_token(data:, **keywords)
+        new(**keywords).to_token(data: data)
+      end
+
+      def initialize(configuration: default_configuration)
+        self.configuration = configuration
+      end
+
+      def to_token(data:)
+        JWT.encode({ data: data.as_json, iss: issuer_claim }, coerced_password, encryption_type)
+      end
+
+      def from_token(token:)
+        JWT.decode(token, coerced_password, false, 'iss' => issuer_claim, verify_iss: true).first.fetch('data')
+      end
+
+      private
+
+      attr_accessor :configuration
+
+      # I need to coerce the password into the correct format.
+      def coerced_password
+        case encryption_type.to_s
+        when /\ARS\d/i
+          OpenSSL::PKey::RSA.new(password)
+        else
+          encryption_type
+        end
+      end
+
+      def default_configuration
+        require 'cogitate'
+        Cogitate.configuration
+      end
+
+      # @note In the case of a Cogitate client this should be a public key; In the case of the Cogitate server this should be a private key.
+      def password
+        configuration.tokenizer_password
+      end
+
+      def encryption_type
+        configuration.tokenizer_encryption_type
+      end
+
+      def issuer_claim
+        configuration.tokenizer_issuer_claim
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cogitate
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: contracts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: A client library for the Cogitate service.
 email:
 - jeremy.n.friesen@gmail.com
@@ -34,6 +104,36 @@ files:
 - LICENSE
 - README.md
 - lib/cogitate.rb
+- lib/cogitate/README.md
+- lib/cogitate/client.rb
+- lib/cogitate/client/agent_builder.rb
+- lib/cogitate/client/data_to_object_coercer.rb
+- lib/cogitate/client/exceptions.rb
+- lib/cogitate/client/identifier_builder.rb
+- lib/cogitate/client/request.rb
+- lib/cogitate/client/response_parsers.rb
+- lib/cogitate/client/response_parsers/agents_with_detailed_identifiers_extractor.rb
+- lib/cogitate/client/response_parsers/agents_without_group_membership_extractor.rb
+- lib/cogitate/client/response_parsers/basic_extractor.rb
+- lib/cogitate/client/response_parsers/email_extractor.rb
+- lib/cogitate/client/retrieve_agent_from_ticket.rb
+- lib/cogitate/client/ticket_to_token_coercer.rb
+- lib/cogitate/client/token_to_object_coercer.rb
+- lib/cogitate/configuration.rb
+- lib/cogitate/exceptions.rb
+- lib/cogitate/generators/install_generator.rb
+- lib/cogitate/generators/templates/cogitate_initializer.rb.erb
+- lib/cogitate/interfaces.rb
+- lib/cogitate/models.rb
+- lib/cogitate/models/agent.rb
+- lib/cogitate/models/agent/serializer.rb
+- lib/cogitate/models/agent/with_token.rb
+- lib/cogitate/models/identifier.rb
+- lib/cogitate/models/identifiers.rb
+- lib/cogitate/models/identifiers/with_attribute_hash.rb
+- lib/cogitate/railtie.rb
+- lib/cogitate/services/identifiers_decoder.rb
+- lib/cogitate/services/tokenizer.rb
 homepage: https://github.com/ndlib/cogitate
 licenses:
 - APACHE2
@@ -44,9 +144,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -54,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A client library for the Cogitate service.