tokenizer2fa-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e7aea321c3dc5462fb08c7d288912f1b42b36fb
+  data.tar.gz: a6c3ffb5f853588b2a85953347d4f89c82dfcd6e
+SHA512:
+  metadata.gz: 15bb931b7c4ca5eca66b15c7883f81c19c3297116efab67c03260c08f82fa27f745526bc10c08d1aa66b5ec504afc7896fe0ae392285ccb116c6d082897169d3
+  data.tar.gz: 063c7b5a05333d185b5568f3d58839ff3ca02bd1f0aa9abf7b4d93ea4d4e1de065305a2756d15d25255fa09854919f52d81b4c4ba13c48a4db3b3942d0e53de4

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tokenizer2fa-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Radek Fąfara
+
+MIT License
+
+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,62 @@
+# Tokenizer2fa::Client
+
+This is an integration SDK for [tokenizer.com](https://tokenizer.com) service. The SDK is framework independent and works with pure Ruby 1.9 (or above).
+
+Tokenizer is a cloud-based Two-Factor authentication solution developed by [Amsterdam Standard](http://amsterdamstandard.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tokenizer2fa-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tokenizer2fa-client
+
+## Usage
+
+#### Configuration
+In order to connect with Tokenizer, we need the APP ID and APP KEY that you receive via email, when creating a Tokenizer service.
+```ruby
+tokenizer_config = {
+    app_id:  'YOUR-APP-ID',
+    app_key: 'YOUR-APP-KEY',
+    host:    'https://api.tokenizer.com/'
+}
+tokenizer = Tokenizer2fa::Client.new tokenizer_config
+```
+
+#### Creating a token
+```ruby
+id = tokenizer.create_auth 'email@example.com'
+```
+
+#### Verifying a token
+```ruby
+auth_state = tokenizer.verify_auth id
+puts auth_state.to_s
+```
+
+#### Polling token verification
+This gem does not use the Tokenizer provided waiting page, but allows you to poll the API whilst waiting for the user to Tokenize.
+```ruby
+auth_state = tokenizer.poll_verify_auth id
+if auth_state.is_accepted?
+  puts 'Authenticated'
+else
+  puts 'Denied'
+end
+```
+
+## Contributing
+
+1. Fork it ( https://bitbucket.org/tokenizer-integrations/tokenizer-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/tokenizer2fa/client.rb

@@ -0,0 +1,76 @@
+require 'tokenizer2fa/token/state'
+require 'tokenizer2fa/token/adapter/json'
+require 'tokenizer2fa/token/adapter/xml'
+
+require 'uri'
+require 'net/http'
+
+module Tokenizer2fa
+  class Client
+    attr_reader :app_id, :app_key, :host, :format
+
+    DEFAULT_CREATE_AUTH_URL = '%{host}v1/authentications.%{format}'
+    DEFAULT_USER_AUTH_URL = '%{host}v1/authentication/%{id}.%{format}?%{params}'
+
+    def initialize config={}
+      @format = 'json'
+      config.each { |key,value| instance_variable_set("@#{key}",value) }
+      begin
+        @adapter = Object.class.const_get("Token::Adapter::#{@format.capitalize}").new
+      rescue
+        @format = 'json'
+        @adapter = Token::Adapter::Json.new
+      end
+    end
+
+    # Checks whether all required settings are set
+    def validate_config
+      @app_id && @app_key && @host
+    end
+
+    # Generates authentication token for an email address
+    def create_auth email, url=DEFAULT_CREATE_AUTH_URL
+      config_params = {
+          app_id: @app_id,
+          app_key: @app_key,
+          usr_email: email  # notice the missing e in usr_email
+      }
+
+      uri = URI(url % { host: @host, format:  @format })
+      https = Net::HTTP.new(uri.hostname, uri.port)
+      https.use_ssl = true
+
+      request = Net::HTTP::Post.new uri.request_uri
+      request.set_form_data config_params
+      request.content_type = 'application/x-www-form-urlencoded'
+
+      response = https.request request
+      @adapter.parse(response.body)['id']
+    end
+
+    # Checks whether token ID is valid
+    def verify_auth id, url=DEFAULT_USER_AUTH_URL
+      config_params = URI.encode_www_form({
+                                              app_id:  @app_id,
+                                              app_key: @app_key
+                                          })
+
+      uri = URI(url % { host: @host, id: id, format: @format, params: config_params })
+      https = Net::HTTP.new(uri.hostname, uri.port)
+      https.use_ssl = true
+
+      request = Net::HTTP::Get.new uri.request_uri
+
+      response = https.request(request)
+      Token::State.new @adapter.parse(response.body)['state']
+    end
+
+    def poll_verify_auth id, url=DEFAULT_USER_AUTH_URL
+      loop do
+        state = verify_auth id, url
+        return state unless state.is_pending?
+        sleep 1
+      end
+    end
+  end
+end

data/lib/tokenizer2fa/token/adapter/json.rb

@@ -0,0 +1,11 @@
+require 'json'
+
+module Tokenizer2fa::Token::Adapter
+  class Json
+
+    def parse data
+      JSON.parse(data)
+    end
+
+  end
+end

data/lib/tokenizer2fa/token/adapter/xml.rb

@@ -0,0 +1,9 @@
+module Tokenizer2fa::Token::Adapter
+  class Xml
+
+    def parse data
+      raise 'Not implemented'
+    end
+
+  end
+end

data/lib/tokenizer2fa/token/state.rb

@@ -0,0 +1,21 @@
+module Tokenizer2fa::Token
+  class State
+
+    def initialize state
+      @state = state
+    end
+
+    def is_pending?
+      @state == 'pending'
+    end
+
+    def is_accepted?
+      @state == 'accepted'
+    end
+
+    def to_s
+      @state
+    end
+
+  end
+end

data/lib/tokenizer2fa/version.rb

@@ -0,0 +1,3 @@
+module Tokenizer2fa
+  VERSION = "1.0.0"
+end

data/spec/features/external_request_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+feature 'External request' do
+  it 'makes sure external HTTP requests are disabled' do
+    uri = URI('https://tokenizer.com')
+
+    expect {
+      response = Net::HTTP.get(uri)
+    }.to raise_error(WebMock::NetConnectNotAllowedError)
+  end
+end

data/spec/features/manage_token_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+tokenizer_config = {
+    app_id:  'fake_app',
+    app_key: 'fake_key',
+    host:    'https://api.tokenizer.com/'
+}
+tokenizer = Tokenizer2fa::Client.new tokenizer_config
+
+feature 'Validating configuration' do
+  it 'succeeds only for a fully a configured instance of tokenizer connector' do
+    expect(tokenizer.validate_config).to be_truthy
+  end
+
+  it 'fails when a user skips any of the params when initializing connector' do
+    expect(Tokenizer2fa::Client.new.validate_config).to be_falsey
+  end
+end
+
+feature 'Creating a token' do
+  it 'requests Tokenizer API for a new token ID for e-mail address' do
+
+    id = tokenizer.create_auth 'valid@example.com'
+    expect(id).not_to be_falsey
+  end
+
+  it 'fails when provided invalid e-mail address' do
+
+    id = tokenizer.create_auth 'not-an-email-address'
+    expect(id).to be_nil
+  end
+end
+
+feature 'Verifying a token' do
+  it 'succeeds after at least one trial using valid token' do
+    state = nil
+    10.times do
+      state = tokenizer.verify_auth '666'
+      break unless state.is_pending?
+      sleep 1
+    end
+    expect(state.is_accepted?).to be_truthy
+  end
+
+  it 'fails when using non-existing token_id' do
+    state = nil
+    10.times do
+      state = tokenizer.verify_auth 'non-existing-token'
+      break unless state.is_pending?
+      sleep 1
+    end
+    expect(state.is_accepted?).to be_falsey
+  end
+
+  it 'never gives pending state when polling token verification' do
+    state = tokenizer.poll_verify_auth '666'
+    expect(state.is_pending?).to be_falsey
+
+    state = tokenizer.poll_verify_auth 'non-existing-token'
+    expect(state.is_pending?).to be_falsey
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'support/fake_tokenizer_api'
+require 'tokenizer2fa/client'
+
+require 'capybara/rspec'
+require 'webmock/rspec'
+WebMock.disable_net_connect!(allow_localhost: true)
+
+RSpec.configure do |config|
+  config.before(:each) do
+    stub_request(:any, /api.tokenizer.com/).to_rack(FakeTokenizerApi)
+  end
+end

data/spec/support/fake_tokenizer_api.rb

@@ -0,0 +1,46 @@
+require 'sinatra/base'
+
+class FakeTokenizerApi < Sinatra::Base
+  
+  post '/v1/authentications.json' do
+    valid_params.each do |k, v|
+      params[k].to_s != v and return json_response 400, 'invalid_auth.json'
+    end
+    json_response 200, 'valid_auth.json'
+  end
+
+  get '/v1/authentication/:token_id.json' do
+    valid_user.each do |k, v|
+      params[k].to_s != v and return json_response 400, 'invalid_user.json'
+    end
+    if Time.now.to_i % 5 == 0
+      json_response 200, 'valid_user.json'
+    else
+      json_response 200, 'pending_auth.json'
+    end
+  end
+
+  private
+
+    def json_response http_code, fixture_filename
+      content_type :json
+      status http_code
+      File.open(File.dirname(__FILE__) + '/fixtures/' + fixture_filename, 'rb').read
+    end
+
+    def valid_params
+      {
+          app_id:     'fake_app',
+          app_key:    'fake_key',
+          usr_email:  'valid@example.com'
+      }
+    end
+
+    def valid_user
+      {
+          app_id:     'fake_app',
+          app_key:    'fake_key',
+          token_id:   '666'
+      }
+    end
+end

data/spec/support/fixtures/invalid_auth.json

@@ -0,0 +1,9 @@
+{
+  "status_code": 400,
+  "error_name": "ContextError",
+  "error_time": 1415970967,
+  "error_messages": "Missing request parameters",
+  "error_reason": "",
+  "error_code": 100,
+  "status_messages": "400 ContextError"
+}

data/spec/support/fixtures/invalid_user.json

@@ -0,0 +1,10 @@
+{
+  "status_code": 400,
+  "error_name": "AuthError",
+  "error_time": 1415971954,
+  "error_messages": "Invalid Token",
+  "error_reason": "",
+  "error_code": 101,
+  "status_messages": "400 AuthError",
+  "state": "denied"
+}

data/spec/support/fixtures/pending_auth.json

@@ -0,0 +1,7 @@
+{
+  "status_code": 200,
+  "error_name": "OK",
+  "error_time": 1415965000,
+  "error_code": 0,
+  "state": "pending"
+}

data/spec/support/fixtures/valid_auth.json

@@ -0,0 +1,7 @@
+{
+  "status_code": 200,
+  "error_name": "OK",
+  "error_time": 1415971000,
+  "error_code": 0,
+  "id": 666
+}

data/spec/support/fixtures/valid_user.json

@@ -0,0 +1,7 @@
+{
+    "status_code": 200,
+    "error_name": "OK",
+    "error_time": 1415972000,
+    "error_code": 0,
+    "state": "accepted"
+}

data/tokenizer2fa-client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tokenizer2fa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tokenizer2fa-client"
+  spec.version       = Tokenizer2fa::VERSION
+  spec.authors       = ["Radosław Fąfara"]
+  spec.email         = ["radek@amsterdam-standard.pl"]
+  spec.summary       = 'Tokenizer2fa is an integration client for tokenizer.com service.'
+  spec.description   = 'The SDK allows framework independent two-factor authentication for your web application. Client handles both token generation and validation.'
+  spec.homepage      = "https://bitbucket.org/tokenizer-integrations/tokenizer-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 1.9'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "sinatra"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: tokenizer2fa-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Radosław Fąfara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The SDK allows framework independent two-factor authentication for your
+  web application. Client handles both token generation and validation.
+email:
+- radek@amsterdam-standard.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tokenizer2fa/client.rb
+- lib/tokenizer2fa/token/adapter/json.rb
+- lib/tokenizer2fa/token/adapter/xml.rb
+- lib/tokenizer2fa/token/state.rb
+- lib/tokenizer2fa/version.rb
+- spec/features/external_request_spec.rb
+- spec/features/manage_token_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_tokenizer_api.rb
+- spec/support/fixtures/invalid_auth.json
+- spec/support/fixtures/invalid_user.json
+- spec/support/fixtures/pending_auth.json
+- spec/support/fixtures/valid_auth.json
+- spec/support/fixtures/valid_user.json
+- tokenizer2fa-client.gemspec
+homepage: https://bitbucket.org/tokenizer-integrations/tokenizer-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Tokenizer2fa is an integration client for tokenizer.com service.
+test_files:
+- spec/features/external_request_spec.rb
+- spec/features/manage_token_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_tokenizer_api.rb
+- spec/support/fixtures/invalid_auth.json
+- spec/support/fixtures/invalid_user.json
+- spec/support/fixtures/pending_auth.json
+- spec/support/fixtures/valid_auth.json
+- spec/support/fixtures/valid_user.json