token_chain 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 877b8521a7597a6aedfb24724b85549c49de3a63
-  data.tar.gz: 6959f880395bb00ee5dc938adf69161b9cd8e8d6
+  metadata.gz: 479d3adff4faf57359d9ca967bda2bbac3042a75
+  data.tar.gz: 4f42d31273559187b440141e02c688b1fe245dbb
 SHA512:
-  metadata.gz: b43d61f54a8bb43a509d0dea506e22895d2b4093099a3151373c4d279fb16412f79b896aba3378e208b9692305c7316b6b3ae78a87fffeb4af80d3cca4bd4349
-  data.tar.gz: a11b081c7cf5209c1977d09288cb146ef3a597c0f67d40c228c2d3e4d313061e2545af53fee2963097bd2b407c7f82dede6b552b70c57b9d2181a2f34ebeaf93
+  metadata.gz: 692274eb0d93aa194d4f8a3d2aa612ead67026984b7a70b31f9c3960c5204b2495888045b5edef08fe989e33a6be33cfaf1acc4ad909aba64333e10737fa6582
+  data.tar.gz: 6638b86a0eb1ddbb8cb32d68c7b3e87610f242fb5e1c0c962b3e55b53b957036dc844c8ab8cd6677a896806bb15f6e4e900568b8b6ac36df58c0855ef9d7b10e

data/lib/token_chain/emittable_token.rb

@@ -0,0 +1,9 @@
+require 'squares'
+
+module TokenChain
+  class EmittableToken < Squares::Base
+    property :last_consumed_token
+
+    alias_method :anchor, :id
+  end
+end

data/lib/token_chain/emitter.rb

@@ -0,0 +1,32 @@
+require 'token_chain/emittable_token'
+
+module TokenChain
+  class Emitter
+
+    def initialize(anchor: nil, passphrase: nil)
+      @emitter = weigh_anchor(anchor, passphrase)
+    end
+
+    def next_token!
+      anchor         = @emitter.anchor
+      previous_token = @emitter.last_consumed_token
+      generator      = Generator.new(anchor, previous_token)
+
+      generator.generate.tap do |token|
+        @emitter.last_consumed_token = token
+        @emitter.save
+      end
+    end
+
+    private
+
+    def weigh_anchor(anchor, passphrase)
+      unless anchor || passphrase
+        raise ArgumentError.new("You must provide an anchor or a passphrase.")
+      end
+      anchor = anchor || Anchor.from(passphrase)
+      EmittableToken.find(anchor) || EmittableToken.create(anchor)
+    end
+
+  end # class Emitter
+end

data/lib/token_chain/receivable_token.rb

@@ -0,0 +1,14 @@
+require 'squares'
+
+module TokenChain
+  class ReceivableToken < Squares::Base
+    property :anchor
+    property :sequence, default: 0
+
+    alias_method :token, :id
+
+    def available?
+      sequence >= 0
+    end
+  end
+end

data/lib/token_chain/receiver.rb

@@ -0,0 +1,61 @@
+require 'token_chain/anchor'
+require 'token_chain/generator'
+require 'token_chain/receivable_token'
+
+module TokenChain
+  class Receiver
+
+    def initialize_chain(anchor)
+      @generator = Generator.new anchor
+      @generator.generate(10).each_with_index do |token, i|
+        ReceivableToken.create token, anchor: anchor, sequence: i
+      end
+    end
+
+    def validate!(token)
+      receivable = ReceivableToken.find(token)
+
+      if receivable.nil?
+        raise UnknownTokenError.new("Invalid token")
+      elsif ! receivable.available?
+        raise InvalidTokenError.new("Token was previously submitted")
+      else # it's a valid, available token
+        response = { result: 'success' }
+
+        anchor = receivable.anchor
+        incoming_token_seq = receivable.sequence
+
+        if incoming_token_seq > 0
+          response[:warning] = 'Token submitted out of sequence.'
+        end
+
+        # resequence and prune
+        ReceivableToken.where(anchor: anchor).each do |rt|
+          old_sequence = rt.sequence
+          new_sequence = old_sequence - (incoming_token_seq + 1)
+          rt.sequence = new_sequence
+          if rt.sequence >= -10
+            rt.save
+          else
+            rt.delete
+          end
+        end
+
+        # replentish tokens
+        first_new_token_seq = 9 - incoming_token_seq
+        (first_new_token_seq..9).each do |sequence|
+          ReceivableToken.create @generator.generate,
+            anchor: anchor,
+            sequence: sequence
+        end
+
+        return response
+      end
+    end
+
+  end
+
+  class UnknownTokenError < ArgumentError; end
+  class InvalidTokenError < ArgumentError; end
+end
+

data/lib/token_chain/version.rb

@@ -1,3 +1,3 @@
 module TokenChain
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'rspec/given'
+require 'pry'
 require 'digest/sha2'
 require 'token_chain'
 

data/spec/token_chain/emitter_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'token_chain/anchor'
+require 'token_chain/emittable_token'
+require 'token_chain/emitter'
+
+module TokenChain
+  describe Emitter do
+    Given { EmittableToken.store = {} }
+    Given(:passphrase) { 'the rain in spain' }
+    Given(:anchor) { Anchor.from passphrase }
+    Given(:generator) { Generator.new anchor }
+
+    describe '#initialize' do
+      describe 'with an anchor' do
+        When { Emitter.new anchor: anchor }
+        Then { expect( EmittableToken[anchor] ).to_not be_nil }
+        Then { expect( EmittableToken[anchor].last_consumed_token ).to be_nil }
+      end
+
+      describe 'with a passphrase' do
+        When { Emitter.new passphrase: passphrase }
+        Then { expect( EmittableToken[anchor] ).to_not be_nil }
+        Then { expect( EmittableToken.find(anchor).last_consumed_token ).to be_nil }
+      end
+
+      describe 'with neither anchor nor passphrase' do
+        Then { expect{ Emitter.new }.to raise_error(/provide an anchor or a passphrase/) }
+      end
+    end #initialize
+
+    describe '#next_token!' do
+      Given(:emitter) { Emitter.new anchor: anchor }
+
+      context 'first consumed token' do
+        Given(:expected_token) { generator.generate }
+
+        When(:token) { emitter.next_token! }
+
+        Then { expect(token).to eq(expected_token) }
+        Then { expect(EmittableToken[anchor].last_consumed_token).to eq(expected_token) }
+      end
+
+      context 'second consumed token' do
+        Given(:expected_token) { generator.generate(2).last }
+        Given { emitter.next_token! }
+
+        When(:token) { emitter.next_token! }
+
+        Then { expect(token).to eq(expected_token) }
+        Then { expect(EmittableToken[anchor].last_consumed_token).to eq(expected_token) }
+      end
+    end
+
+  end
+end

data/spec/token_chain/receiver_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+require 'token_chain/anchor'
+require 'token_chain/generator'
+require 'token_chain/receivable_token'
+require 'token_chain/receiver'
+
+module TokenChain
+  describe Receiver do
+    Given { ReceivableToken.store = {} }
+    Given(:anchor) { Anchor.from 'the rain in spain' }
+    Given(:generator) { Generator.new anchor }
+    Given(:store) { {} }
+    Given(:receiver) { Receiver.new }
+
+    describe '#initialize_chain' do
+      When { receiver.initialize_chain anchor }
+      Then { expect(ReceivableToken.keys.count).to eq(10) }
+      Then { expect(ReceivableToken.map{|t| t.sequence}).to eq((0..9).to_a) }
+      Then { expect(ReceivableToken[generator.generate(5).last]).to_not be_nil }
+    end
+
+    describe '#validate!' do
+      # Return states:
+      #   ✓ success (received token zero)
+      #   ✓ success, warn token out of sequence
+      #   ✓ fail: unknown token
+      #   ✓ fail: previously submitted token
+      context 'totally bogus token' do
+        Given(:token) { 'ABC!@#' }
+        Then { expect{receiver.validate!(token)}.to raise_error(UnknownTokenError, "Invalid token") }
+      end
+
+      context 'valid token' do
+        Given { receiver.initialize_chain anchor }
+
+        context 'token zero' do
+          Given(:token) { generator.generate }
+          When(:response) { receiver.validate!(token) }
+          Then { expect(response[:result]).to eq('success') }
+        end
+
+        context 'out of sequence' do
+          Given(:skipping_to) { 3 }
+          When(:token) { generator.generate(skipping_to).last }
+          When(:response) { receiver.validate!(token) }
+          describe 'response' do
+            context 'when skipping ahead' do
+              Then { expect(response[:result]).to eq('success') }
+              Then { expect(response[:warning]).to match(/out of sequence/) }
+            end
+            context 'when submitting a previously validated token' do
+              Then { expect{receiver.validate!(token)}.to raise_error(/previously submitted/) }
+            end
+          end
+          describe 'receivable tokens' do
+            describe 'old/new token zero' do
+              Then { ReceivableToken[token].sequence == -1 }
+              Then { ReceivableToken[generator.generate].sequence == 0 }
+            end
+            describe 'new tokens created' do
+              Given(:new_last_token) { Generator.new(anchor).generate(13).last }
+              Given(:expected_sequences) { (-3..9).to_a }
+              Then { expect(ReceivableToken[new_last_token]).to be_available }
+              Then { ReceivableToken[new_last_token].sequence == 9 }
+              Then { expect(ReceivableToken.map{|rt| rt.sequence}).to eq(expected_sequences) }
+            end
+            describe 'skipped tokens' do
+              Given(:skipped_token) { Generator.new(anchor).generate }
+              Then { expect(ReceivableToken[skipped_token]).to_not be_available }
+            end
+            describe 'more than 10 tokens consumed' do
+              Given(:first_token) { Generator.new(anchor).generate }
+              Given(:second_token) { Generator.new(anchor).generate(2).last }
+              Given(:skipping_to) { 10 }
+              When { receiver.validate! generator.generate }
+              Then { expect(ReceivableToken[second_token]).to_not be_available }
+              Then { expect(ReceivableToken[first_token]).to be_nil }
+            end
+          end
+        end
+
+        describe 'working repeatedly through a whole bunch of iterations' do
+          Given { receiver.initialize_chain anchor }
+          Given(:client_generator) { Generator.new anchor }
+          Then do
+            (0..50).map do
+              skipping_to = 1 + rand(10)
+              token = [client_generator.generate(skipping_to)].flatten.last
+              response = receiver.validate!(token)
+              response[:result] == 'success' && ReceivableToken.keys.count <= 20
+            end.all? { |result| result == true }
+          end
+
+        end
+
+      end
+
+    end #validate!
+
+  end
+end

data/token_chain.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "squares", ">= 0.3.0"
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: token_chain
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Joel Helbling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-06 00:00:00.000000000 Z
+date: 2015-02-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: squares
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -96,11 +110,17 @@ files:
 - Rakefile
 - lib/token_chain.rb
 - lib/token_chain/anchor.rb
+- lib/token_chain/emittable_token.rb
+- lib/token_chain/emitter.rb
 - lib/token_chain/generator.rb
+- lib/token_chain/receivable_token.rb
+- lib/token_chain/receiver.rb
 - lib/token_chain/version.rb
 - spec/spec_helper.rb
 - spec/token_chain/anchor_spec.rb
+- spec/token_chain/emitter_spec.rb
 - spec/token_chain/generator_spec.rb
+- spec/token_chain/receiver_spec.rb
 - spec/token_chain_spec.rb
 - token_chain.gemspec
 homepage: http://github.com/joelhelbling/token_chain
@@ -130,5 +150,7 @@ summary: Generates a deterministic chain of tokens from a passphrase.
 test_files:
 - spec/spec_helper.rb
 - spec/token_chain/anchor_spec.rb
+- spec/token_chain/emitter_spec.rb
 - spec/token_chain/generator_spec.rb
+- spec/token_chain/receiver_spec.rb
 - spec/token_chain_spec.rb