authy 2.0.1 → 2.1.0

data/Gemfile.lock

@@ -1,49 +1,49 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    coderay (1.0.8)
-    diff-lcs (1.1.3)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
     git (1.2.5)
-    httpclient (2.3.2)
+    httpclient (2.3.3)
     jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
-    json (1.7.6)
+    json (1.8.0)
     method_source (0.8.1)
-    multi_json (1.5.0)
-    pry (0.9.11.4)
+    multi_json (1.7.5)
+    pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
-    rake (10.0.3)
-    rdoc (3.12)
+    rake (10.0.4)
+    rdoc (4.0.1)
       json (~> 1.4)
-    reek (1.3)
-      ruby2ruby (~> 2.0.0)
-      ruby_parser (~> 3.0.4)
+    reek (1.3.1)
+      ruby2ruby (~> 2.0.2)
+      ruby_parser (~> 3.1.1)
       sexp_processor
-    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 (2.0.1)
-      ruby_parser (~> 3.0.0)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    ruby2ruby (2.0.5)
+      ruby_parser (~> 3.1)
       sexp_processor (~> 4.0)
-    ruby_parser (3.0.4)
+    ruby_parser (3.1.3)
       sexp_processor (~> 4.1)
-    sexp_processor (4.1.4)
+    sexp_processor (4.2.1)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
-    slop (3.4.3)
-    yard (0.8.3)
+    slop (3.4.5)
+    yard (0.8.6.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,14 +1,15 @@
-# Authy
+# Authy [![Build Status](https://travis-ci.org/authy/authy-ruby.png?branch=api-updates)](https://travis-ci.org/authy/authy-ruby) [![Code Climate](https://codeclimate.com/github/authy/authy-ruby.png)](https://codeclimate.com/github/authy/authy-ruby)
 
 Ruby library to access the Authy API
 
 ## Usage
 
+```ruby
     require 'authy'
 
     Authy.api_key = 'your-api-key'
     Authy.api_uri = 'https://api.authy.com/'
-
+```
 
 ## Registering a user
 
@@ -21,6 +22,7 @@ USA. The call will return you the authy id for the user that you need to store i
 
 Assuming you have a `users` database with a `authy_id` field in the `users` database.
 
+```ruby
     authy = Authy::API.register_user(:email => 'users@email.com', :cellphone => "111-111-1111", :country_code => "1")
 
     if authy.ok?
@@ -28,7 +30,7 @@ Assuming you have a `users` database with a `authy_id` field in the `users` data
     else
       authy.errors # this will return an error hash
     end
-
+```
 
 ## Verifying a user
 
@@ -39,6 +41,7 @@ __NOTE: Token verification is only enforced if the user has completed registrati
 
 `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
 
+```ruby
     response = Authy::API.verify(:id => user.authy_id, :token => 'token-user-entered')
 
     if response.ok?
@@ -46,17 +49,21 @@ __NOTE: Token verification is only enforced if the user has completed registrati
     else
       # token is invalid
     end
-
+```
+    
 ### Forcing Verification
 
 If you wish to verify tokens even if the user has not yet complete registration, pass force=true when verifying the token.
 
+```ruby
     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.
 
+```ruby
     response = Authy::API.request_sms(:id => user.authy_id)
 
     if response.ok?
@@ -65,13 +72,50 @@ If you wish to verify tokens even if the user has not yet complete registration,
       response.errors
       #sms failed to send
     end
-
+```
 
 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
 
+```ruby
     response = Authy::API.request_sms(:id => user.authy_id, :force => true)
+```
+
+## Requesting token via a phone call
+
+`Authy::API.request_phone_call` takes the authy_id that you want to deliver the token by a phone call. This requires Authy Calls addon, please contact us to support@authy.com to enable this addon.
+
+```ruby
+    response = Authy::API.request_phone_call(:id => user.authy_id)
+
+    if response.ok?
+      # call was done
+    else
+      response.errors
+      # call failed
+    end
+```
+
+This call will be ignored if the user is using the Authy Mobile App. If you ensure that user receives the phone call, you must pass force=true as an option
+
+```ruby
+    response = Authy::API.request_phone_call(:id => user.authy_id, :force => true)
+```
+
+## Deleting users
+
+`Authy::API.delete_user` takes the authy_id of the user that you want to remove from your app.
 
+```ruby
+    response = Authy::API.delete_user(:id => user.authy_id)
+
+    if response.ok?
+      # the user was deleted
+    else
+      response.errors
+      # we were unavailable to delete the user
+    end
+```
 
 ### Contributing to authy
 

data/VERSION

@@ -1 +1 @@
-2.0.1
+2.1.0

data/authy.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "authy"
-  s.version = "2.0.1"
+  s.version = "2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Authy", "David A. Cuadrado"]
-  s.date = "2013-04-09"
+  s.date = "2013-06-03"
   s.description = "Ruby library to access Authy services"
   s.email = "krawek@gmail.com"
   s.executables = ["authy-api-console"]

data/lib/authy/api.rb

@@ -50,11 +50,34 @@ module Authy
       Authy::Response.new(response)
     end
 
+    # options:
+    # :id user id
+    # :force force phone_call
+    def self.request_phone_call(params)
+      user_id = params.delete(:id) || params.delete('id')
+
+      url = "#{Authy.api_uri}/protected/json/call/#{escape_for_url(user_id)}"
+      response = http_client.get(url, {:api_key => Authy.api_key}.merge(params))
+
+      Authy::Response.new(response)
+    end
+
+    # options:
+    # :id user id
+    def self.delete_user(params)
+      user_id = params.delete(:id) || params.delete('id')
+
+      url = "#{Authy.api_uri}/protected/json/users/delete/#{escape_for_url(user_id)}"
+      response = http_client.post(url, {:api_key => Authy.api_key}.merge(params))
+
+      Authy::Response.new(response)
+    end
+
     private
     def self.escape_for_url(field)
       URI.escape(field.to_s.strip, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
     end
-    
+
     # Copied and extended from httpclient's HTTP::Message#escape_query()
     def self.escape_query(query, namespace = nil) # :nodoc:
       pairs = []

data/spec/authy/api_spec.rb

@@ -14,7 +14,7 @@ describe "Authy::API" do
       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",
@@ -43,20 +43,12 @@ describe "Authy::API" do
       @user.should be_ok
     end
 
-    #it "should validate a given token if the user is not registered when the verification is not forced" do
-      #pending "Sandbox api always auto-confirm all users so there's no way check this atm"
-      #response = Authy::API.verify(:token => 'invalid_token', :id => @user['id'], :force => false)
-
-      #response.should be_kind_of(Authy::Response)
-      #response.ok?.should be_true
-    #end
-
     it "should fail to validate a given token if the user is not registered" do
       response = Authy::API.verify(:token => 'invalid_token', :id => @user['id'])
 
       response.should be_kind_of(Authy::Response)
       response.ok?.should be_false
-      response.errors['token'].should == 'is invalid'
+      response.errors['message'].should == 'token is invalid'
     end
 
     it "should allow to override the API key" do
@@ -67,21 +59,59 @@ describe "Authy::API" do
     end
   end
 
-  describe "Requesting SMS" do
-    before do
-      @user = Authy::API.register_user(:email => generate_email, :cellphone => generate_cellphone, :country_code => 1)
-      @user.should be_ok
+  ["sms", "phone_call"].each do |kind|
+    title = kind.upcase
+    describe "Requesting #{title}" 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 #{title} token" do
+        uri_param = kind == "phone_call" ? "call" : kind
+        url = "#{Authy.api_uri}/protected/json/#{uri_param}/#{Authy::API.escape_for_url(@user.id)}"
+        HTTPClient.any_instance.should_receive(:request).with(:get, url, {:query=>{:api_key=> Authy.api_key}, :header=>nil, :follow_redirect=>nil}) { mock(:ok? => true, :body => "", :status => 200) }
+        response = Authy::API.send("request_#{kind}", :id => @user.id)
+        response.should be_ok
+      end
+
+      it "should allow to override the API key" do
+        response = Authy::API.send("request_#{kind}", :id => @user.id, :api_key => "invalid_api_key")
+        response.should_not be_ok
+        response.errors['message'].should =~ /invalid api key/i
+      end
+
+      context "user doesn't exist" do
+        it "should not be ok" do
+          response = Authy::API.send("request_#{kind}", :id => "tony")
+          response.errors['message'].should == "User doesn't exist."
+          response.should_not be_ok
+        end
+      end
+
     end
+  end
 
-    it "should request a SMS token" do
-      response = Authy::API.request_sms(:id => @user.id)
-      response.should be_ok
+  describe "delete users" do
+    context "user doesn't exist" do
+      it "should not be ok" do
+        response = Authy::API.delete_user(:id => "tony")
+        response.errors['message'].should == "User doesn't exist."
+        response.should_not be_ok
+      end
     end
 
-    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
+    context "user exists" do
+      before do
+        @user = Authy::API.register_user(:email => generate_email, :cellphone => generate_cellphone, :country_code => 1)
+        @user.should be_ok
+      end
+
+      it "should be ok" do
+        response = Authy::API.delete_user(:id => @user.id)
+        response.message.should == "User was added to remove."
+        response.should be_ok
+      end
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: authy
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Authy
@@ -10,10 +10,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000 Z
+date: 2013-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -21,6 +20,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.2.6
   name: httpclient
+  type: :runtime
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
@@ -29,7 +29,6 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.2.6
 - !ruby/object:Gem::Dependency
-  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -37,6 +36,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: rspec
+  type: :development
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
@@ -45,7 +45,6 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -53,6 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: pry
+  type: :development
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
@@ -61,7 +61,6 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -69,6 +68,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: yard
+  type: :development
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
@@ -77,7 +77,6 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -85,6 +84,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: rdoc
+  type: :development
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
@@ -93,7 +93,6 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -101,6 +100,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: jeweler
+  type: :development
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
@@ -109,7 +109,6 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -117,6 +116,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: simplecov
+  type: :development
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
@@ -125,7 +125,6 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -133,6 +132,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: reek
+  type: :development
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
@@ -183,7 +183,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: -4420740530967124060
+      hash: 1227098339926430603
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false