authful 0.5.0

data/.gitignore

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,15 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch('lib/authful.rb')
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Winslett
+
+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,51 @@
+# Authful Ruby Client
+
+Makes integration with 2fa as simple as possible.  This gem interacts
+with the open-sourced [Authful service](https://github.com/MongoHQ/authful) for 2fa.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'authful'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install authful
+
+## Usage
+
+To use, you will need an Authful endpoint.  You will need to install it,
+or if a successful project, you will probably find Authful endpoint as a
+service.
+
+To configure the gem, use:
+
+```ruby
+Authful.configure do |c|
+  c.endpoint = "https://<myendpoint>" 
+  c.api_key  = "<my api key>"
+end
+
+res = Authful.enroll("emailaddress@gmail.com", "12055555505")
+res.qr_code # use this to display the QR code for the user signup
+res.token   # You will want to save this token to your application, it is
+            # the user's primary key to the authful service.  It is **not**
+            # the secret token used to generate OTP.
+
+
+Authful.send_sms("token") # sends sms token
+Authful.validate("token", "000000") # validates OTP token
+Authful.unenroll("token") # Remove user from Authful service
+```
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/authful.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'authful/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "authful"
+  spec.version       = Authful::Client::VERSION
+  spec.authors       = ["Chris Winslett"]
+  spec.email         = ["chris@mongohq.com"]
+  spec.description   = %q{A wrapper for the Authful service}
+  spec.summary       = %q{Both authful is an open source tool that enables rapid implementation of 2fa for your application.  This is the client for the service.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rest-client'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "fakeweb"
+  spec.add_development_dependency "pry-debugger"
+end

data/lib/authful/response.rb

@@ -0,0 +1,11 @@
+module Authful
+  class Response
+    attr_accessor :token, :qr_code, :error
+
+    def initialize(args)
+      args.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+  end
+end

data/lib/authful/user.rb

@@ -0,0 +1,109 @@
+module Authful
+  class User
+    attr_accessor :token, :email, :phone, :error, :qr_code
+
+    def self.[](token)
+      self.new(token: token)
+    end
+
+    def initialize(args)
+      args.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    def save
+      r = post("/api/users", {email: email, phone: phone})
+      self.qr_code = r["qr_code"]
+      self.token = r["token"]
+    rescue
+      if Authful::Errors::IncorrectApiToken === $!
+        raise Authful::Errors::IncorrectApiToken
+      elsif $!.http_code == 409 # Catch duplicate user -- already enrolled
+        r = JSON.parse($!.response)
+        self.token = r["token"]
+      elsif $!.http_code == 400
+        r = JSON.parse($!.response)
+        self.error = r["error"]
+        false
+      else
+        raise $!
+      end
+    end
+
+    def self.create!(args)
+      self.new(args).save
+    end
+
+    def destroy
+      delete("/api/users/#{token}")["ok"] == 1
+    end
+
+    def send_sms
+      get("/api/users/#{token}/send_sms")["ok"] == 1
+    rescue
+      if Authful::Errors::IncorrectApiToken === $!
+        raise Authful::Errors::IncorrectApiToken
+      elsif $!.http_code == 400
+        r = JSON.parse($!.response)
+        self.error = r["error"]
+        false
+      else
+        raise $!
+      end
+    end
+
+    def valid?(otp_token)
+      get("/api/users/#{token}/validate?token=#{otp_token}")["ok"] == 1
+    rescue
+      if Authful::Errors::IncorrectApiToken === $!
+        raise Authful::Errors::IncorrectApiToken
+      elsif $!.http_code == 403
+        r = JSON.parse($!.response)
+        self.error = r["error"]
+        false
+      else
+        raise $!
+      end
+    end
+
+    private
+    def get(path)
+      r = RestClient.get url_for(path), headers
+      JSON.parse(r)
+    rescue
+      capture_common_errors($!)
+    end
+
+    def delete(path)
+      r = RestClient.delete url_for(path), headers
+      JSON.parse(r)
+    rescue
+      capture_common_errors($!)
+    end
+
+
+    def post(path, data)
+      r = RestClient.post url_for(path), data, headers
+      JSON.parse(r)
+    rescue
+      capture_common_errors($!)
+    end
+
+    def capture_common_errors(error)
+      if error.http_code == 401
+        raise Authful::Errors::IncorrectApiToken
+      else
+        raise error
+      end
+    end
+
+    def url_for(path)
+      [Authful.config.endpoint, path].join("")
+    end
+
+    def headers
+      {"Api-Token" => Authful.config.api_key}
+    end
+  end
+end

data/lib/authful/version.rb

@@ -0,0 +1,5 @@
+module Authful
+  module Client
+    VERSION = "0.5.0"
+  end
+end

data/lib/authful.rb

@@ -0,0 +1,41 @@
+require 'json'
+require 'rest-client'
+
+module Authful
+  @config = Struct.new(:endpoint, :api_key).new
+
+  def self.configure(&block)
+    block.call(@config)
+  end
+
+  def self.config
+    @config
+  end
+
+  ## API Calls
+  
+  def self.enroll(email, phone)
+    u = Authful::User.new(email: email, phone: phone)
+    u.save
+    return Authful::Response.new(token: u.token, qr_code: u.qr_code, error: u.error)
+  end
+
+  def self.validate(token, otp)
+    Authful::User[token].valid?(otp)
+  end
+
+  def self.send_sms(token)
+    Authful::User[token].send_sms
+  end
+
+  def self.unenroll(token)
+    Authful::User[token].destroy
+  end
+
+  module Errors
+    class IncorrectApiToken < RuntimeError; end
+  end
+end
+
+require_relative './authful/user'
+require_relative './authful/response'

data/spec/lib/authful/user_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+describe Authful::User do
+
+  before :each do
+    Authful.configure do |c|
+      c.endpoint = "https://my-endpoint.dev/authful"
+      c.api_key = "my-awesome-api-key"
+    end
+  end
+
+  it "handles bad api key errors" do
+    FakeWeb.register_uri :post, "https://my-endpoint.dev/authful/api/users", {body: {error: "Incrorrect API token"}.to_json, status: ["401", "Unauthorized"]}
+
+    -> { Authful::User.create!(email: "john.doe@gmail.com", phone: "12055555434") }.should raise_error(Authful::Errors::IncorrectApiToken)
+  end
+
+  it "creates a user" do
+    FakeWeb.register_uri :post, "https://my-endpoint.dev/authful/api/users", {body: {token: "user-authful-token", email: "john.doe@gmail.com", qr_code: "qr-code"}.to_json}
+
+    u = Authful::User.new(email: "john.doe@gmail.com", phone: "12055555434")
+
+    u.save.should eq('user-authful-token')
+    u.token.should eq('user-authful-token')
+    u.qr_code.should eq('qr-code')
+    u.error.should be_nil
+  end
+
+  it "accepts error on duplicate user, and finds user" do
+    FakeWeb.register_uri :post, "https://my-endpoint.dev/authful/api/users", {body: {error: "already enrolled", token: "user-authful-token"}.to_json, status: ["409", "Something"]}
+
+    u = Authful::User.new(email: "john.doe@gmail.com", phone: "12055555434")
+
+    u.save.should eq('user-authful-token')
+    u.token.should eq('user-authful-token')
+    u.error.should be_nil
+  end
+
+  it "errors on invalid user" do
+    FakeWeb.register_uri :post, "https://my-endpoint.dev/authful/api/users", {body: {error: "Invalid user, email is required."}.to_json, status: ["400", "Bad Request"]}
+
+    u = Authful::User.new(email: "", phone: "")
+
+    u.save.should eq(false)
+    u.error.should eq("Invalid user, email is required.")
+  end
+
+  it "validates the users token" do
+    FakeWeb.register_uri :get, "https://my-endpoint.dev/authful/api/users/user-authful-token/validate?token=000000", {body: {ok: 1}.to_json}
+
+    u = Authful::User["user-authful-token"]
+    u.valid?("000000").should eq(true)
+  end
+
+  it "does not validate invalid tokens" do
+    FakeWeb.register_uri :get, "https://my-endpoint.dev/authful/api/users/user-authful-token/validate?token=000000", {body: {error: "Invalid token"}.to_json, status: [403, "Forbidden"]}
+
+    u = Authful::User["user-authful-token"]
+    u.valid?("000000").should eq(false)
+  end
+
+  it "sends sms to users" do
+    FakeWeb.register_uri :get, "https://my-endpoint.dev/authful/api/users/user-authful-token/send_sms", {body: {ok: 1}.to_json} 
+
+    u = Authful::User["user-authful-token"]
+    u.send_sms.should eq(true)
+  end
+
+  it "catches failed sms" do
+    FakeWeb.register_uri :get, "https://my-endpoint.dev/authful/api/users/user-authful-token/send_sms", {body: {error: "It just didn't send"}.to_json, status: [400, "Bad Request"]}
+
+    u = Authful::User["user-authful-token"]
+    u.send_sms.should eq(false)
+    u.error = "It just didn't send"
+  end
+
+  it "deletes users" do
+    FakeWeb.register_uri :delete, "https://my-endpoint.dev/authful/api/users/user-authful-token", {body: {ok: 1}.to_json}
+
+    u = Authful::User["user-authful-token"]
+    u.destroy.should eq(true)
+  end
+
+  it "accepts the wrapper function for enroll" do
+    FakeWeb.register_uri :post, "https://my-endpoint.dev/authful/api/users", {body: {token: "user-authful-token", email: "john.doe@gmail.com", qr_code: "qr-code"}.to_json}
+
+    r = Authful.enroll("john.doe@gmail.com", "12055555434")
+
+    r.token.should eq('user-authful-token')
+    r.qr_code.should eq('qr-code')
+    r.error.should be_nil
+  end
+
+  it "accepts the wrapper function for validating the users token" do
+    FakeWeb.register_uri :get, "https://my-endpoint.dev/authful/api/users/user-authful-token/validate?token=000000", {body: {ok: 1}.to_json}
+
+    Authful.validate("user-authful-token", "000000").should eq(true)
+  end
+
+  it "accepts the wrapper function for send sms" do
+    FakeWeb.register_uri :get, "https://my-endpoint.dev/authful/api/users/user-authful-token/send_sms", {body: {ok: 1}.to_json} 
+
+    Authful.send_sms("user-authful-token").should eq(true)
+  end
+
+  it "accepts the wrapper function for unenroll" do
+    FakeWeb.register_uri :delete, "https://my-endpoint.dev/authful/api/users/user-authful-token", {body: {ok: 1}.to_json}
+
+    Authful.unenroll("user-authful-token").should eq(true)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'fakeweb'
+require_relative './../lib/authful'
+
+FakeWeb.allow_net_connect = false

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: authful
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Chris Winslett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A wrapper for the Authful service
+email:
+- chris@mongohq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- authful.gemspec
+- lib/authful.rb
+- lib/authful/response.rb
+- lib/authful/user.rb
+- lib/authful/version.rb
+- spec/lib/authful/user_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Both authful is an open source tool that enables rapid implementation of
+  2fa for your application.  This is the client for the service.
+test_files:
+- spec/lib/authful/user_spec.rb
+- spec/spec_helper.rb