authy 2.5.0.pre → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5848053b422cea54e69e26d534fdf5b040e6fc99
-  data.tar.gz: a50794e2a7ac0e82e3039743688ac8965af94259
+  metadata.gz: 50f02ebdae5f8d72a5f3199ae44feae6ff4a5c83
+  data.tar.gz: abb373f80d53746ac1c0d500823dbc4986ec53c8
 SHA512:
-  metadata.gz: 2732e0a2bb42b00878dd4ac3a1e7df58507bcc3f6ecfe8182cf1f24ee801306d7c07060e7d5887f4ed2099339be88eeeb425dcc6b2fa7282c2340da94da9f976
-  data.tar.gz: 95273c144d7d607b876fa4dc63376798149e5fc736bb31b468053b1160371dde33653b9e15f4288926427d3cb69a874e89fc49c9a1d2a9cbfba51897105744e6
+  metadata.gz: 268299200179efd6c7ba165202dcffe54b3376f3e105de6ddf84e75140367dea212ca3f06394c447898f44904682d6b1367e38f0336b65f2514b03fb0d9ddf73
+  data.tar.gz: cee6a3a6df933fa48b16ff3b9f58b035257a633ae6ac9b4fbcc8265305a1ca5b650231cdbd02d9e15238ce23491a469b28a4e2f9e9fcc2e6b792665f66e305c6

data/.gitignore

@@ -54,5 +54,4 @@ examples/db
 .ruby-version
 .ruby-gemset
 .rvmrc
-Gemfile.lock
 

data/Gemfile.lock

@@ -0,0 +1,122 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.7)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    addressable (2.3.8)
+    ast (2.1.0)
+    builder (3.2.2)
+    coderay (1.1.0)
+    concord (0.1.5)
+      adamantium (~> 0.2.0)
+      equalizer (~> 0.0.9)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    equalizer (0.0.11)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.4)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.6)
+      oauth2
+    hashie (3.4.3)
+    highline (1.7.8)
+    httpclient (2.7.0.1)
+    ice_nine (0.11.1)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.2)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    parser (2.2.3.0)
+      ast (>= 1.1, < 3.0)
+    private_attr (1.1.0)
+    procto (0.0.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rdoc (4.2.0)
+    reek (3.6.0)
+      parser (~> 2.2, >= 2.2.2.5)
+      private_attr (~> 1.1)
+      rainbow (~> 2.0)
+      unparser (~> 0.2.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    unparser (0.2.4)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.2.5)
+      equalizer (~> 0.0.9)
+      parser (~> 2.2.2)
+      procto (~> 0.0.2)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httpclient (>= 2.5.3.3)
+  jeweler
+  pry
+  rdoc
+  reek
+  rspec
+  simplecov
+  yard
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2014 Authy Inc
+Copyright (c) 2012-2016 Authy Inc
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -134,7 +134,32 @@ This call will be ignored if the user is using the Authy Mobile App. If you ensu
     end
 ```
 
-### Contributing to authy
+## Phone Verification
+
+### Starting a phone verification
+
+`Authy::PhoneVerification.start` takes a country code, phone number and a method (sms or call) to deliver the code.
+
+```ruby
+response = Authy::PhoneVerification.start(via: "sms", country_code: 1, phone_number: "111-111-1111")
+if response.ok?
+  # verification was started
+end
+```
+
+### Checking a phone verification
+
+`Authy::PhoneVerification.check` takes a country code, phone number and a verification code.
+
+```ruby
+response = Authy::PhoneVerification.start(verification_code: "1234", country_code: 1, phone_number: "111-111-1111")
+if response.ok?
+  # verification was successful
+end
+```
+
+
+## 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.
@@ -147,5 +172,5 @@ This call will be ignored if the user is using the Authy Mobile App. If you ensu
 Copyright
 ==
 
-Copyright (c) 2012-2014 Authy Inc. See LICENSE.txt for
+Copyright (c) 2012-2016 Authy Inc. See LICENSE.txt for
 further details.

data/lib/authy.rb

@@ -12,4 +12,5 @@ require 'authy/models/user'
 require 'authy/config'
 require 'authy/api'
 require 'authy/phone_intelligence'
+require 'authy/phone_verification'
 require 'authy/onetouch'

data/lib/authy/onetouch.rb

@@ -1,33 +1,39 @@
 module Authy
   class OneTouch < Authy::API
 
+    # Maximum String size for the parameters
+    MAX_STRING_SIZE = 200
+
     # options:
     #   :id
     #   :details Hash containing the approval request details
     #   :hidden_details
     #   :phone_number The persons phone number.
     def self.send_approval_request(params)
-      user_id =        params.delete(:id) || params.delete('id')
-      message =        (params.delete(:message) || params.delete('message')).to_s
-      details =        params.delete(:details) || params.delete('details')
-      hidden_details = params.delete(:hidden_details) || params.delete('hidden_details')
-      logos =          params.delete(:logos) || params.delete('logos')
+      user_id           = params.delete(:id) || params.delete('id')
+      message           = (params.delete(:message) || params.delete('message')).to_s
+      details           = params.delete(:details) || params.delete('details')
+      hidden_details    = params.delete(:hidden_details) || params.delete('hidden_details')
+      logos             = params.delete(:logos) || params.delete('logos')
+      seconds_to_expire = params.delete(:seconds_to_expire) || params.delete('seconds_to_expire')
 
-      return invalid_response("Message cannot be blank") if message.empty?
-      return invalid_response('User id is invalid') unless is_digit?(user_id)
+      return invalid_response("message cannot be blank") if message.empty?
+      return invalid_response('user id is invalid') unless is_digit?(user_id)
 
       begin
         self.clean_hash!(details)
         self.clean_hash!(hidden_details)
+        self.clean_logos!(logos)
       rescue => e
-        return invalid_response("Invalid details or hidden details: #{e.message}")
+        return invalid_response("Invalid parameters: #{e.message}")
       end
 
       post_request("onetouch/json/users/#{user_id}/approval_requests", {
-        message: message,
+        message: message[0, MAX_STRING_SIZE],
         details: details,
         hidden_details: hidden_details,
-        logos: logos
+        logos: logos,
+        seconds_to_expire: seconds_to_expire
       })
     end
 
@@ -39,8 +45,27 @@ module Authy
 
   private
     def self.clean_hash!(test_hash)
+      return if test_hash.nil? # Allow nil hash
+
       raise "Hash expected. Got: #{test_hash.class}" unless test_hash.is_a? Hash
       test_hash = test_hash.map { |k, v| [k, v.to_s] }.to_h
     end
+
+    def self.clean_logos!(logos)
+      return if logos.nil? # Allow nil logos
+
+      raise "Array expected. Got #{logos.class}" unless logos.is_a? Array
+      logos = logos.map do |logo|
+        raise "Invalid logo format: #{logo}" unless logo.is_a? Hash
+        res = logo.delete(:res) || logo.delete('res')
+        url = logo.delete(:url) || logo.delete('url')
+
+        raise "Logo should include res and url" if res.nil? || url.nil?
+
+        # We ignore any additional parameter on the logos, and truncate
+        # string size to the maximum allowed.
+        { res: res[0, MAX_STRING_SIZE], url: url[0, MAS_STRING_SIZE] }
+      end
+    end
   end
 end

data/lib/authy/phone_intelligence.rb

@@ -1,22 +1,16 @@
 module Authy
   class PhoneIntelligence < Authy::API
 
-    # options:
-    #   :via (sms|call)
-    #   :country_code Numeric calling country code of the country.
-    #   :phone_number The persons phone number.
+    # @deprecated
     def self.verification_start(params)
-      params[:via] = "sms" unless %w(sms, call).include?(params[:via])
-
-      post_request("protected/json/phones/verification/start", params)
+      warn "[DEPRECATION] `PhoneIntelligence.verification_start` is deprecated.  Please use `PhoneVerification.start` instead."
+      Authy::PhoneVerification.start(params)
     end
 
-    # options:
-    #   :country_code Numeric calling country code of the country.
-    #   :phone_number The persons phone number.
-    #   :verification_code The verification code entered by the user.
+    # @deprecated
     def self.verification_check(params)
-      get_request("protected/json/phones/verification/check", params)
+      warn "[DEPRECATION] `PhoneIntelligence.verification_check` is deprecated.  Please use `PhoneVerification.check` instead."
+      Authy::PhoneVerification.check(params)
     end
 
     # options:
@@ -26,4 +20,4 @@ module Authy
       get_request("protected/json/phones/info", params)
     end
   end
-end
+end

data/lib/authy/phone_verification.rb

@@ -0,0 +1,22 @@
+module Authy
+  class PhoneVerification < Authy::API
+    # options:
+    #   :via (sms|call)
+    #   :country_code Numeric calling country code of the country.
+    #   :phone_number The persons phone number.
+    def self.start(params)
+      params[:via] = "sms" unless %w(sms, call).include?(params[:via])
+
+      post_request("protected/json/phones/verification/start", params)
+    end
+
+    # options:
+    #   :country_code Numeric calling country code of the country.
+    #   :phone_number The persons phone number.
+    #   :verification_code The verification code entered by the user.
+    def self.check(params)
+      get_request("protected/json/phones/verification/check", params)
+    end
+
+  end
+end

data/lib/authy/version.rb

@@ -1,3 +1,3 @@
 module Authy
-  VERSION = "2.5.0.pre"
+  VERSION = "2.6.0"
 end

data/spec/authy/onetouch_spec.rb

@@ -20,11 +20,39 @@ describe Authy::OneTouch do
           'Bank account' => '23527922',
           'Amount' => '10 BTC',
         },
+        hidden_details: {
+          'IP Address' => '192.168.0.3'
+        },
+        seconds_to_expire: 150
+      )
+
+      expect(response).to be_kind_of(Authy::Response)
+      expect(response).to be_ok
+    end
+
+    it 'requires message as mandatory' do
+      response = Authy::OneTouch.send_approval_request(
+        id: @user.id,
+        details: {
+          'Bank account' => '23527922',
+          'Amount' => '10 BTC',
+        },
         hidden_details: {
           'IP Address' => '192.168.0.3'
         }
       )
 
+      expect(response).to be_kind_of(Authy::Response)
+      expect(response).to_not be_ok
+      expect(response.message).to eq 'message cannot be blank'
+    end
+
+    it 'does not require other fields as mandatory' do
+      response = Authy::OneTouch.send_approval_request(
+        id: @user.id,
+        message: 'Test message'
+      )
+
       expect(response).to be_kind_of(Authy::Response)
       expect(response).to be_ok
     end

data/spec/authy/phone_verification_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe "Authy::PhoneVerification" do
+  describe "Sending the verification code" do
+
+    it "should send the code via SMS" do
+      response = Authy::PhoneVerification.start(
+        :via => "sms",
+        :country_code => "1",
+        :phone_number => "111-111-1111"
+      )
+
+      response.should be_kind_of(Authy::Response)
+      response.should be_ok
+      response.message.should == "Text message sent to +1 111-111-1111."
+    end
+
+    # it "should send the code via CALL" do
+    #   response = Authy::PhoneVerification.start(
+    #     :via => "call",
+    #     :country_code => "1",
+    #     :phone_number => "111-111-1111"
+    #   )
+
+    # response.should be_kind_of(Authy::Response)
+    #   response.success.should be_truthy
+    #   response.message.should == "Text message sent to +1 111-111-1111."
+    # end
+  end
+
+  describe "validate the fields required" do
+    it "should return an error. Country code is required" do
+      response = Authy::PhoneVerification.start(
+        :via => "sms",
+        :phone_number => "111-111-1111"
+      )
+
+      response.should_not be_ok
+      response.errors['message'] =~ /Country code is mandatory/
+    end
+
+    it "should return an error. Cellphone is invalid" do
+      response = Authy::PhoneVerification.start(
+        :via => "sms",
+        :country_code => "1",
+        :phone_number => "123"
+      )
+
+      response.should_not be_ok
+      response.errors['message'] =~ /Phone number is invalid/
+    end
+  end
+
+  describe "Check the verification code" do
+    it "should return success true if code is correct" do
+      response = Authy::PhoneVerification.check(
+        :country_code => "1",
+        :phone_number => "111-111-1111",
+        :verification_code => "0000"
+      )
+
+      response.should be_ok
+      response.message.should == "Verification code is correct."
+    end
+
+    it "should return an error if code is incorrect" do
+      response = Authy::PhoneVerification.check(
+        :country_code => "1",
+        :phone_number => "111-111-1111",
+        :verification_code => "1234"
+      )
+
+      response.should_not be_ok
+      response.message.should == "Verification code is incorrect."
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authy
 version: !ruby/object:Gem::Version
-  version: 2.5.0.pre
+  version: 2.6.0
 platform: ruby
 authors:
 - Authy Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2015-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -134,10 +134,10 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
 - authy.gemspec
 - bin/authy-api-console
 - examples/demo.rb
@@ -148,6 +148,7 @@ files:
 - lib/authy/models/user.rb
 - lib/authy/onetouch.rb
 - lib/authy/phone_intelligence.rb
+- lib/authy/phone_verification.rb
 - lib/authy/response.rb
 - lib/authy/url_helpers.rb
 - lib/authy/version.rb
@@ -155,6 +156,7 @@ files:
 - spec/authy/config_spec.rb
 - spec/authy/onetouch_spec.rb
 - spec/authy/phone_intelligence_spec.rb
+- spec/authy/phone_verification_spec.rb
 - spec/authy/response_spec.rb
 - spec/authy/url_helpers_spec.rb
 - spec/spec_helper.rb
@@ -173,9 +175,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: authy
 rubygems_version: 2.4.6
@@ -187,6 +189,7 @@ test_files:
 - spec/authy/config_spec.rb
 - spec/authy/onetouch_spec.rb
 - spec/authy/phone_intelligence_spec.rb
+- spec/authy/phone_verification_spec.rb
 - spec/authy/response_spec.rb
 - spec/authy/url_helpers_spec.rb
 - spec/spec_helper.rb

data/VERSION

@@ -1 +0,0 @@
-2.5.0