authy 2.7.2 → 2.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8113421bc21b13bc9ad8d67d40f0396448d3950f
-  data.tar.gz: e6d280e4e5e44a8a507531961d07c5e47199a122
+SHA256:
+  metadata.gz: e5538f6f51f1db240a5c94c81aa1705cc3754e8abfeeb2bbb1dce5427211d361
+  data.tar.gz: 16752c3c96190eca0d25b862a44e815ea2ebc308d46de30933e1f6c9a089457d
 SHA512:
-  metadata.gz: 94643682f6f44bbbaab85beb4efc63b0a2c49c383571fc904b078d1e46f5c3e6e1cc96278366089a1a9bc3c7d049da1b81800f299ac6dd4f8b21e93cc3d53026
-  data.tar.gz: 4cd4391e4747294e2d66ea6aa93e55c27f2102f13d0ebbdef4c6240ecd4e20d922ec2bd7b139ce32eb8a99ff8864bfdde89fd98350aeeb4a8de7fb482c6ee3ef
+  metadata.gz: 6da72901a00717a60459ab310893e79c25f53f6633ed9734e8836e8a0ebbc310fa449f4ba79b08d879780058c8c0362c737af9b73e488db5aeb38a1210c7efbc
+  data.tar.gz: 885217cfd29aed61cbfb98644f0b38f2838e063c2535dc59cdf074b2ea0c8dbb5142921cfb77ac1d490b8aaaf8284a2e8a7781f37c939b52d4c6242f60cfe97d

data/README.md

@@ -8,7 +8,7 @@ Ruby library to access the Authy API
     require 'authy'
 
     Authy.api_key = 'your-api-key'
-    Authy.api_uri = 'https://api.authy.com/'
+    Authy.api_uri = 'https://api.authy.com'
 ```
 
 Using Ruby on Rails? _Put this in **config/initializers** and create a new file called **authy.rb**._
@@ -83,6 +83,14 @@ the SMS pass force=true as an option
     response = Authy::API.request_sms(:id => user.authy_id, :force => true)
 ```
 
+If you wish to send SMS in a specific language, you can provide locale information in the params as shown below.
+
+```ruby
+    response = Authy::API.request_sms(:id => user.authy_id, :force => true, :locale => 'es')
+```
+
+If the locale that you provide is wrong or does not match, the SMS will be sent in english.
+
 ## 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.
@@ -104,6 +112,22 @@ This call will be ignored if the user is using the Authy Mobile App. If you ensu
     response = Authy::API.request_phone_call(:id => user.authy_id, :force => true)
 ```
 
+## Requesting QR code for authenticator apps like Google Authenticator
+
+`Authy::API.request_qr_code` takes authy_id that you want to deliver the qr code. This requires **Generic authenticator tokens** to be enabled in Authy console setting. Optinally, you can provide `qr_size` as a number to decide the output of qr image (For example: `qr_size: 400` will returns a 400x400 image) and `label` as a custom label to be shown by the authenticator app.  
+
+```ruby
+    response = Authy::API.request_qr_code(id: user.authy_id, qr_size: 500, label: "My Example App")
+    if response.ok?
+      # qr code was generated
+    else
+      response.errors
+    end
+
+    # You can access the iamge link with
+    link = response.qr_code
+```
+
 ## Deleting users
 
 `Authy::API.delete_user` takes the authy_id of the user that you want to remove from your app.
@@ -138,7 +162,7 @@ This call will be ignored if the user is using the Authy Mobile App. If you ensu
 
 ### Starting a phone verification
 
-`Authy::PhoneVerification.start` takes a country code, phone number and a method (sms or call) to deliver the code.
+`Authy::PhoneVerification.start` takes a country code, phone number and a method (sms or call) to deliver the code.  You can also provide a custom_code but this feature needs to be enabled by support@twilio.com
 
 ```ruby
 response = Authy::PhoneVerification.start(via: "sms", country_code: 1, phone_number: "111-111-1111")

data/examples/pv-check.rb

@@ -0,0 +1,9 @@
+require 'authy' # gem install authy
+
+Authy.api_url = "https://api.authy.com"
+Authy.api_key = "[YOUR_API_KEY]"
+
+response = Authy::PhoneVerification.check(verification_code: "1234", country_code: [YOUR_COUNTRY_CODE], phone_number: "[YOUR_PHONE_NUMBER]")
+if response.ok?
+  # verification was started
+end

data/examples/pv.rb

@@ -0,0 +1,12 @@
+require 'authy' # gem install authy
+
+Authy.api_url = "https://api.authy.com"
+Authy.api_key = "[YOUR_API_KEY]"
+
+# Custom Code example
+# response = Authy::PhoneVerification.start(via: "sms", country_code: 1, phone_number: "[YOUR_NUMBER]", custom_code: "1234")
+
+response = Authy::PhoneVerification.start(via: "sms", country_code: [YOUR_COUNTRY_CODE], phone_number: "[YOUR_PHONE_NUMBER]")
+if response.ok?
+  # verification was started
+end

data/lib/authy/api.rb

@@ -64,6 +64,25 @@ module Authy
       get_request("protected/json/sms/:user_id", params.merge({"user_id" => user_id}))
     end
 
+    # options:
+    # :id user id
+    # :qr_size qr size
+    # :qr_label context for qr code
+    def self.request_qr_code(params)
+      user_id = params.delete(:id) || params.delete('id')
+      qr_size = params.delete(:qr_size) || params.delete('qr_size') || 300
+      qr_label = params.delete(:qr_label) || params.delete('qr_label') || ""
+
+      return invalid_response('User id is invalid') unless is_digit?(user_id)
+      return invalid_response('Qr image size is invalid') unless is_digit?(qr_size)
+
+      response = post_request("protected/json/users/:user_id/secret" ,params.merge({
+        "user_id" => user_id,
+        "qr_size" => qr_size,
+        "label" => qr_label
+      }))
+    end
+
     # options:
     # :id user id
     # :force force phone_call

data/lib/authy/phone_verification.rb

@@ -4,6 +4,8 @@ module Authy
     #   :via (sms|call)
     #   :country_code Numeric calling country code of the country.
     #   :phone_number The persons phone number.
+    #   :custom_code Pass along any generated custom code.
+    #   :custom_message Custom Message.
     def self.start(params)
       params[:via] = "sms" unless %w(sms, call).include?(params[:via])
 

data/lib/authy/version.rb

@@ -1,3 +1,3 @@
 module Authy
-  VERSION = "2.7.2"
+  VERSION = "2.7.3"
 end

data/spec/authy/api_spec.rb

@@ -121,6 +121,37 @@ describe "Authy::API" do
     end
   end
 
+  describe "requesting qr code for other authenticator apps" do
+    before do
+      @user = Authy::API.register_user(email: generate_email, cellphone: generate_cellphone, country_code: 1)
+      expect(@user).to be_ok
+    end
+
+    it "should request qrcode" do
+      url = "#{Authy.api_uri}/protected/json/users/#{Authy::API.escape_for_url(@user.id)}/secret"
+      expect_any_instance_of(HTTPClient).to receive(:request).with(:post, url, body: "qr_size=300&label=example+app+name", header: {"X-Authy-API-Key" => Authy.api_key}) { double(ok?: true, body: "", status: 200) }
+      response = Authy::API.send("request_qr_code", id: @user.id, qr_size: 300, qr_label: "example app name")
+      expect(response).to be_ok
+    end
+
+
+    context "user id is not a number" do
+      it "should not be ok" do
+        response = Authy::API.send("request_qr_code", id: "tony")
+        expect(response.errors['message']).to eq "User id is invalid"
+        expect(response).to_not be_ok
+      end
+    end
+
+    context "qr size is not a number" do
+      it "should return the right error" do
+        response = Authy::API.send("request_qr_code", id: @user.id, qr_size: "notanumber")
+        expect(response.errors['message']).to eq "Qr image size is invalid"
+        expect(response).to_not be_ok
+      end
+    end
+  end
+
   ["sms", "phone_call"].each do |kind|
     title = kind.upcase
     describe "Requesting #{title}" do

data/spec/authy/phone_verification_spec.rb

@@ -53,6 +53,20 @@ describe "Authy::PhoneVerification" do
     end
   end
 
+  describe 'Check that a custom code request' do
+    it "should return an error if not enabled" do
+      pending("API is not returning expected response in this case. The test phone number is invalid")
+
+      response = Authy::PhoneVerification.start(
+        country_code: "1",
+        phone_number: "111-111-1111",
+        custom_code: "1234"
+      )
+      expect(response).not_to be_ok
+      expect(response.message).to eq("Phone verification couldn't be created: custom codes are not allowed.")
+    end
+  end
+
   describe "Check the verification code" do
     it "should return success true if code is correct" do
       pending("API is not returning expected response in this case. The test phone number is invalid.")
@@ -93,4 +107,5 @@ describe "Authy::PhoneVerification" do
       expect(response.message).to eq('Phone number is invalid')
     end
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authy
 version: !ruby/object:Gem::Version
-  version: 2.7.2
+  version: 2.7.3
 platform: ruby
 authors:
 - Authy Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2018-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -142,6 +142,8 @@ files:
 - authy.gemspec
 - bin/authy-api-console
 - examples/demo.rb
+- examples/pv-check.rb
+- examples/pv.rb
 - lib/authy.rb
 - lib/authy/api.rb
 - lib/authy/config.rb
@@ -181,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: authy
-rubygems_version: 2.5.2.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby library to access Authy services