authful 0.5.12 → 0.5.13

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDAzNmNmNjdlNDkyMTYzYmEyOTNmNjIxZTYwOWJkNTU2N2E1ZTIxMw==
+    ODhlYTdkYWM5ZGE0NmVhMWUyNjI3NDc2ZDBlNzhhYzRiMjcwZDVkMg==
   data.tar.gz: !binary |-
-    MTg4ZWRjODI0NWYxYjExN2VhYjk4MjBlZjgwM2UwYWNjY2E3YTYzNw==
+    NWVhMTkxNWFkZjQ5N2FlMzlkOTI3ODhhY2I2OWFhODNkY2YxMDQ4OA==
 SHA512:
   metadata.gz: !binary |-
-    MWY5ZTE1YTJiZTE0YzE0MzI5ZGUwMjdiYTA1NDgxODZiMWNhOTRjYjdkZGQw
-    ZTQ2ZWUyZWM2NDA0Zjc0ZDA5OWQ0MWFkNWI0YWJkNmM5NGUxMTU3N2YxMGY4
-    NTYyZTM1YjM4NGU4NjU3OGQ2MmY4ZTYxNDkxZGM2NTkxNGUxM2U=
+    NDQ0MDVhYTM2ZjcxYzlmMzBjZTljY2RmZGY1M2I0ZDExZWQyMzY5NmRhMzVm
+    OWFjZDBiNGRkNTY4ZDZlZTViOGQ2ODQ5ZTU2OGFkY2IzNDIxNWI3NzllNTIz
+    ZTE0M2Y4NWIzZWUwYTBmMDVkOWNiZjEyNTJkMDQyNzQ1OGJkMjg=
   data.tar.gz: !binary |-
-    YmUzMWNkYzk0NjRiZmI0NWQ4YjdlY2UwMWY5MWQ4MDlmOGJlZDVkNGE3MDVm
-    Yjc3ZGJkZTY2ZjJiNjAxNDBhY2RmNTBhMTk2ZTUwZDIxMGZlYmQzNjlkYTc0
-    YjcwNzRiYjU2Yjc4NmJkOTcxMTcxOGYwZDg2MGIyYTFlYzYyYmI=
+    YjlhN2M1MGI4ZmM3Nzk3ZDk3ZWQzNzQ3OGI4ZWI1YWY4ZmUyZmE3MDkxMmM0
+    NGJmZDUyMzQ2ZjlmZDk4MWFhNmQ4M2ZlODdiNzg2MTZlNTIzNzUxZGU2MDUw
+    MTc0NWE0MmI5MTdhOTQ2YTRiY2NjNmVmNjA1MGQ5OWUzZWU4NWY=

data/authful.gemspec

@@ -6,10 +6,10 @@ 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.authors       = ["Ben Wyrosdick", "Chris Winslett"]
+  spec.email         = ["ben@mongohq.com", "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.summary       = %q{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"
 
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'rest-client'
+  spec.add_dependency 'active_support'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/authful.rb

@@ -1,41 +1,19 @@
-require 'json'
+require 'active_support/concern'
 require 'rest-client'
+require 'json'
 
-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
+require_relative './authful/endpoint'
+require_relative './authful/api'
+require_relative './authful/response'
 
-  def self.unenroll(token)
-    Authful::User[token].destroy
-  end
+module Authful
+  include Authful::Endpoint
+  include Authful::Api
 
   module Errors
     class IncorrectApiToken < RuntimeError; end
+    class InvalidUserToken < RuntimeError; end
+    class InvallidOtpToken < RuntimeError; end
+    class AlreadyEnrolled < RuntimeError; end
   end
 end
-
-require_relative './authful/user'
-require_relative './authful/response'

data/lib/authful/api.rb

@@ -0,0 +1,33 @@
+module Authful
+  module Api
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def enroll(email)
+        res = Authful.send_request(:post, "/api/users", email: email)
+        return Authful::Response.new(token: res["token"], qr_code: res["qr_code"], error: res["error"])
+      end
+
+      def validate(token, otp)
+        Authful.send_request(:get, "/api/users/#{token}/validate?token=#{otp}")["ok"] == 1
+      end
+
+      def send_sms(token)
+        Authful.send_request(:get, "/api/users/#{token}/send_sms")["ok"] == 1
+      end
+
+      def set_phone(token, phone)
+        Authful.send_request(:patch, "/api/users/#{token}", send_sms: true, phone: phone)["error"] == nil
+      end
+
+      def reset(token, send_sms = false)
+        res = Authful.send_request(:patch, "/api/users/#{token}", send_sms: send_sms, reset: true)
+        return Authful::Response.new(token: res["token"], qr_code: res["qr_code"], error: res["error"])
+      end
+
+      def unenroll(token)
+        Authful.send_request(:delete, "/api/users/#{token}")["ok"] == 1
+      end
+    end
+  end
+end

data/lib/authful/endpoint.rb

@@ -0,0 +1,52 @@
+module Authful
+  module Endpoint
+    extend ActiveSupport::Concern
+
+    included do
+      @config = Struct.new(:endpoint, :api_key).new
+    end
+
+    module ClassMethods
+      def configure(&block)
+        block.call(@config)
+      end
+
+      def config
+        @config
+      end
+
+      def send_request(method, path, data = nil)
+        if data
+          r = RestClient.send(method, url_for(path), data, headers)
+        else
+          r = RestClient.send(method, url_for(path), headers)
+        end
+        JSON.parse(r)
+      rescue
+        capture_common_errors($!)
+      end
+
+      def capture_common_errors(error)
+        if error.http_code == 400
+          JSON.parse($!.response)
+        elsif error.http_code == 401
+          raise Authful::Errors::IncorrectApiToken
+        elsif error.http_code == 403
+          JSON.parse($!.response)
+        elsif error.http_code == 409
+          JSON.parse($!.response)
+        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
+end

data/lib/authful/user.rb

@@ -66,44 +66,5 @@ module Authful
         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

@@ -5,7 +5,7 @@ module Authful
     if ENV['CIRCLE_BUILD_NUM']
       VERSION = "#{VERSION}.#{ENV['CIRCLE_BUILD_NUM']}"
     else
-      VERSION = "#{VERSION}-head"
+      VERSION = "#{VERSION}.head"
     end
   end
 end

data/spec/lib/authful/{user_spec.rb → api_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Authful::User do
+describe Authful do
 
   before :each do
     Authful.configure do |c|
@@ -12,98 +12,75 @@ describe Authful::User do
   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)
+    -> { Authful.enroll "john.doe@gmail.com" }.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")
+    res = Authful.enroll "john.doe@gmail.com"
 
-    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
+    res.token.should eq('user-authful-token')
+    res.qr_code.should eq('qr-code')
+    res.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")
+    res = Authful.enroll "john.doe@gmail.com"
 
-    u.save.should eq('user-authful-token')
-    u.token.should eq('user-authful-token')
-    u.error.should be_nil
+    res.token.should eq('user-authful-token')
+    res.error.should eq("already enrolled")
   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: "")
+    res = Authful.enroll ""
 
-    u.save.should eq(false)
-    u.error.should eq("Invalid user, email is required.")
+    res.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)
+    Authful.validate("user-authful-token", "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)
+    Authful.validate("user-authful-token", "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)
+    Authful.send_sms("user-authful-token").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"
+    Authful.send_sms("user-authful-token").should eq(false)
   end
 
-  it "deletes users" do
-    FakeWeb.register_uri :delete, "https://my-endpoint.dev/authful/api/users/user-authful-token", {body: {ok: 1}.to_json}
+  it "resets secret for user" do
+    FakeWeb.register_uri :patch, "https://my-endpoint.dev/authful/api/users/user-authful-token", {body: {token: "user-authful-token", email: "john.doe@gmail.com", qr_code: "qr-code"}.to_json}
 
-    u = Authful::User["user-authful-token"]
-    u.destroy.should eq(true)
+    res = Authful.reset("user-authful-token")
+    res.token.should eq('user-authful-token')
+    res.qr_code.should eq('qr-code')
   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}
+  it "sets phone number for user" do
+    FakeWeb.register_uri :patch, "https://my-endpoint.dev/authful/api/users/user-authful-token", {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
+    res = Authful.set_phone("user-authful-token", "12005551212").should eq(true)
   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
+  it "deletes users" 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)

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: authful
 version: !ruby/object:Gem::Version
-  version: 0.5.12
+  version: 0.5.13
 platform: ruby
 authors:
+- Ben Wyrosdick
 - Chris Winslett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-03 00:00:00.000000000 Z
+date: 2014-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -24,6 +25,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +125,7 @@ dependencies:
         version: '0'
 description: A wrapper for the Authful service
 email:
+- ben@mongohq.com
 - chris@mongohq.com
 executables: []
 extensions: []
@@ -124,10 +140,12 @@ files:
 - authful.gemspec
 - circle.yml
 - lib/authful.rb
+- lib/authful/api.rb
+- lib/authful/endpoint.rb
 - lib/authful/response.rb
 - lib/authful/user.rb
 - lib/authful/version.rb
-- spec/lib/authful/user_spec.rb
+- spec/lib/authful/api_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -152,8 +170,8 @@ rubyforge_project:
 rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
-summary: Both authful is an open source tool that enables rapid implementation of
-  2fa for your application.  This is the client for the service.
+summary: 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/lib/authful/api_spec.rb
 - spec/spec_helper.rb