authy 0.0.7 → 0.0.8

data/Gemfile

@@ -3,11 +3,10 @@ source "http://rubygems.org"
 gem 'dcu-typhoeus', :require => 'typhoeus'
 
 group :development do
-  gem "rspec", "~> 2.8.0"
+  gem "rspec"
   gem 'pry'
   gem "yard", "~> 0.7"
   gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.1.0"
   gem "jeweler", "~> 1.8.3"
   gem "simplecov", ">= 0"
   gem "reek", "~> 1.2.8"

data/Gemfile.lock

@@ -1,69 +1,71 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.2.3)
+    activesupport (3.2.11)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    coderay (1.0.6)
-    dcu-typhoeus (0.4.1)
+    coderay (1.0.8)
+    dcu-typhoeus (0.4.3)
       activesupport (~> 3.2)
       ffi (~> 1.0)
       mime-types (~> 1.18)
     diff-lcs (1.1.3)
-    ffi (1.0.11)
+    ffi (1.3.1)
     git (1.2.5)
-    i18n (0.6.0)
-    jeweler (1.8.3)
+    i18n (0.6.1)
+    jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
-    json (1.7.3)
-    method_source (0.7.1)
-    mime-types (1.18)
-    multi_json (1.3.5)
-    pry (0.9.9.6)
+    json (1.7.6)
+    method_source (0.8.1)
+    mime-types (1.19)
+    multi_json (1.5.0)
+    pry (0.9.10)
       coderay (~> 1.0.5)
-      method_source (~> 0.7.1)
-      slop (>= 2.4.4, < 3)
-    rake (0.9.2.2)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rake (10.0.3)
     rdoc (3.12)
       json (~> 1.4)
-    reek (1.2.8)
-      ruby2ruby (~> 1.2)
+    reek (1.2.13)
+      ripper_ruby_parser (~> 0.0.7)
+      ruby2ruby (~> 1.2.5)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    ruby2ruby (1.3.1)
+    ripper_ruby_parser (0.0.8)
+      sexp_processor (~> 3.0)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    ruby2ruby (1.2.5)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
     ruby_parser (2.3.1)
       sexp_processor (~> 3.0)
     sexp_processor (3.2.0)
-    simplecov (0.6.4)
+    simplecov (0.7.1)
       multi_json (~> 1.0)
-      simplecov-html (~> 0.5.3)
-    simplecov-html (0.5.3)
-    slop (2.4.4)
-    yard (0.8.1)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.3.3)
+    yard (0.8.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.1.0)
   dcu-typhoeus
   jeweler (~> 1.8.3)
   pry
   rdoc (~> 3.12)
   reek (~> 1.2.8)
-  rspec (~> 2.8.0)
+  rspec
   simplecov
   yard (~> 0.7)

data/{README.rdoc → README.md}

@@ -10,7 +10,11 @@ Ruby library to access the Authy API
     Authy.api_uri = 'https://api.authy.com/'
 
 
-### Registering a user
+## Registering a user
+
+__NOTE: User is matched based on cellphone and country code not e-mail.
+A cellphone is uniquely associated with an authy_id.__  
+
 
 `Authy::API.register_user` requires the user e-mail address and cellphone. Optionally you can pass in the country_code or we will asume
 USA. The call will return you the authy id for the user that you need to store in your database.
@@ -26,7 +30,12 @@ Assuming you have a `users` database with a `authy_id` field in the `users` data
     end
 
 
-### Verifying a user
+## Verifying a user
+
+
+__NOTE: Token verification is only enforced if the user has completed registration. To change this behaviour see Forcing Verification section below.__  
+   
+   >*Registration is completed once the user installs and registers the Authy mobile app or logins once successfully using SMS.*
 
 `Authy::API.verify` takes the authy_id that you are verifying and the token that you want to verify. You should have the authy_id in your database
 
@@ -37,8 +46,13 @@ Assuming you have a `users` database with a `authy_id` field in the `users` data
     else
       //token is invalid
 
+### Forcing Verification
+
+If you wish to verify tokens even if the user has not yet complete registration, pass force=true when verifying the token.
 
-### Requesting a SMS token
+    response = Authy::API.verify(:id => user.authy_id, :token => 'token-user-entered', :force => true)
+
+## Requesting a SMS token
 
 `Authy::API.request_sms` takes the authy_id that you want to send a SMS token. This requires Authy SMS plugin to be enabled.
 
@@ -51,8 +65,13 @@ Assuming you have a `users` database with a `authy_id` field in the `users` data
       //sms failed to send
 
 
+This call will be ignored if the user is using the Authy Mobile App. If you still want to send
+the SMS pass force=true as an option
+
+    response = Authy::API.request_sms(:id => user.authy_id, :force => true)
 
-## Contributing to authy
+
+### Contributing to authy
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
@@ -62,8 +81,8 @@ Assuming you have a `users` database with a `authy_id` field in the `users` data
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+Copyright
+== 
 
-Copyright (c) 2012 David A. Cuadrado. See LICENSE.txt for
+Copyright (c) 2012 Authy Inc. See LICENSE.txt for
 further details.
-

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/authy.gemspec

@@ -5,17 +5,17 @@
 
 Gem::Specification.new do |s|
   s.name = "authy"
-  s.version = "0.0.7"
+  s.version = "0.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Authy", "David A. Cuadrado"]
-  s.date = "2012-06-18"
+  s.date = "2013-01-14"
   s.description = "Ruby library to access Authy services"
   s.email = "krawek@gmail.com"
   s.executables = ["authy-api-console"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "authy.gemspec",
@@ -49,32 +49,29 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<dcu-typhoeus>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<pry>, [">= 0"])
       s.add_development_dependency(%q<yard>, ["~> 0.7"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<reek>, ["~> 1.2.8"])
     else
       s.add_dependency(%q<dcu-typhoeus>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<pry>, [">= 0"])
       s.add_dependency(%q<yard>, ["~> 0.7"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<reek>, ["~> 1.2.8"])
     end
   else
     s.add_dependency(%q<dcu-typhoeus>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<pry>, [">= 0"])
     s.add_dependency(%q<yard>, ["~> 0.7"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
     s.add_dependency(%q<simplecov>, [">= 0"])
     s.add_dependency(%q<reek>, ["~> 1.2.8"])

data/lib/authy/api.rb

@@ -7,12 +7,14 @@ module Authy
     include Typhoeus
 
     def self.register_user(attributes)
-      user_data = {
+      api_key = attributes.delete(:api_key)
+      params = {
         :user => attributes,
-        :api_key => Authy.api_key
+        :api_key => api_key || Authy.api_key
       }
 
-      response = Typhoeus::Request.post("#{Authy.api_uri}/protected/json/users/new", :params => user_data)
+      url = "#{Authy.api_uri}/protected/json/users/new"
+      response = Typhoeus::Request.post(url, :params => params)
 
       Authy::User.new(response)
     end
@@ -26,7 +28,8 @@ module Authy
       token = params.delete(:token) || params.delete('token')
       user_id = params.delete(:id) || params.delete('id')
 
-      response = Typhoeus::Request.get("#{Authy.api_uri}/protected/json/verify/#{escape_for_url(token)}/#{escape_for_url(user_id)}", :params => params.merge({:api_key => Authy.api_key}))
+      url = "#{Authy.api_uri}/protected/json/verify/#{escape_for_url(token)}/#{escape_for_url(user_id)}"
+      response = Typhoeus::Request.get(url, :params => {:api_key => Authy.api_key}.merge(params))
 
       Authy::Response.new(response)
     end
@@ -37,7 +40,8 @@ module Authy
     def self.request_sms(params)
       user_id = params.delete(:id) || params.delete('id')
 
-      response = Typhoeus::Request.get("#{Authy.api_uri}/protected/json/sms/#{escape_for_url(user_id)}", :params => params.merge({:api_key => Authy.api_key}))
+      url = "#{Authy.api_uri}/protected/json/sms/#{escape_for_url(user_id)}"
+      response = Typhoeus::Request.get(url, :params => {:api_key => Authy.api_key}.merge(params))
 
       Authy::Response.new(response)
     end

data/spec/authy/api_spec.rb

@@ -1,46 +1,77 @@
 require 'spec_helper'
 
 describe "Authy::API" do
-  it "should find or create a user" do
-    user = Authy::API.register_user(:email => generate_email, :cellphone => generate_cellphone, :country_code => 1)
-    user.should be_kind_of(Authy::Response)
-
-    user.should be_kind_of(Authy::User)
-    user.should_not be_nil
-    user.id.should_not be_nil
-    user.id.should be_kind_of(Integer)
-  end
+  describe "Registering users" do
 
-  it "should validate a given token" do
-    user = Authy::API.register_user(:email => generate_email, :cellphone => generate_cellphone, :country_code => 1)
-    response = Authy::API.verify(:token => 'invalid_token', :id => user['id'])
+    it "should find or create a user" do
+      user = Authy::API.register_user(:email => generate_email, :cellphone => generate_cellphone, :country_code => 1)
+      user.should be_kind_of(Authy::Response)
 
-    response.should be_kind_of(Authy::Response)
-    response.ok?.should be_true
-    response['token'].should == 'is valid'
-  end
+      user.should be_kind_of(Authy::User)
+      user.should_not be_nil
+      user.id.should_not be_nil
+      user.id.should be_kind_of(Integer)
+    end
+ 
+    it "should return the error messages as a hash" do
+      user = Authy::API.register_user(:email => generate_email, :cellphone => "abc-1234", :country_code => 1)
+
+      user.errors.should be_kind_of(Hash)
+      user.errors['cellphone'].should == 'must be a valid cellphone number.'
+    end
 
-  it "should fail to validate a given token when force=true is given" do
-    user = Authy::API.register_user(:email => generate_email, :cellphone => generate_cellphone, :country_code => 1)
-    response = Authy::API.verify(:token => 'invalid_token', :id => user['id'], :force => true)
+    it "should allow to override the API key" do
+      user = Authy::API.register_user(:email => generate_email, :cellphone => generate_cellphone, :country_code => 1, :api_key => "invalid_api_key")
 
-    response.should be_kind_of(Authy::Response)
-    response.ok?.should be_false
-    response.errors['token'].should == 'is invalid'
+      user.should_not be_ok
+      user.errors['message'].should =~ /invalid api key/i
+    end
   end
 
-  it "should return the error messages as a hash" do
-    user = Authy::API.register_user(:email => generate_email, :cellphone => "abc-1234", :country_code => 1)
+  describe "verificating tokens" do
+    before do
+      @user = Authy::API.register_user(:email => generate_email, :cellphone => generate_cellphone, :country_code => 1)
+      @user.should be_ok
+    end
+
+    it "should validate a given token if the user is not registered when the verification is not forced" do
+      response = Authy::API.verify(:token => 'invalid_token', :id => @user['id'])
+
+      response.should be_kind_of(Authy::Response)
+      response.ok?.should be_true
+    end
 
-    user.errors.should be_kind_of(Hash)
-    user.errors['cellphone'].should == 'must be a valid cellphone number.'
+    it "should fail to validate a given token if the user is not registered when force=true is given" do
+      response = Authy::API.verify(:token => 'invalid_token', :id => @user['id'], :force => true)
+
+      response.should be_kind_of(Authy::Response)
+      response.ok?.should be_false
+      response.errors['token'].should == 'is invalid'
+    end
+
+    it "should allow to override the API key" do
+      response = Authy::API.verify(:token => 'invalid_token', :id => @user['id'], :force => true, :api_key => "invalid_api_key")
+
+      response.should_not be_ok
+      response.errors['message'].should =~ /invalid api key/i
+    end
   end
 
-  it "should request a SMS token" do
-    user = Authy::API.register_user(:email => generate_email, :cellphone => generate_cellphone, :country_code => 1)
-    user.should be_ok
+  describe "Requesting SMS" do
+    before do
+      @user = Authy::API.register_user(:email => generate_email, :cellphone => generate_cellphone, :country_code => 1)
+      @user.should be_ok
+    end
+
+    it "should request a SMS token" do
+      response = Authy::API.request_sms(:id => @user.id)
+      response.should be_ok
+    end
 
-    response = Authy::API.request_sms(:id => user.id)
-    response.should be_ok
+    it "should allow to override the API key" do
+      response = Authy::API.request_sms(:id => @user.id, :api_key => "invalid_api_key")
+      response.should_not be_ok
+      response.errors['message'].should =~ /invalid api key/i
+    end
   end
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: authy
 version: !ruby/object:Gem::Version
-  version: 0.0.7
   prerelease: 
+  version: 0.0.8
 platform: ruby
 authors:
 - Authy
@@ -10,147 +10,131 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-18 00:00:00.000000000 Z
+date: 2013-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: dcu-typhoeus
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: dcu-typhoeus
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '0'
+  name: rspec
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: pry
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
+  name: yard
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.12'
+  name: rdoc
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-  type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.3
+  name: jeweler
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.3
 - !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: simplecov
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.2.8
+  name: reek
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -163,14 +147,14 @@ executables:
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - authy.gemspec
@@ -196,10 +180,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
       segments:
       - 0
-      hash: 467914988991887564
+      hash: 4514592161514013586
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: