messagebird-rest 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fef609127e904a092153ab2dc6e80cd6a775b7d0
-  data.tar.gz: c75c619d065f6e551e9d875098d089915da4bcd2
+  metadata.gz: 4726ce8ee0e2583a41d1f73a7e6866dda139fb14
+  data.tar.gz: 484cd5e20ed84a89ea58e969289e58daa2d02bdd
 SHA512:
-  metadata.gz: d5ed9a42b17dfbdfe55a6b8c2a88218b48001edb8764e748b42e5777406f5fe5d8ce9bd60ebf7801461f8211eecd46e481645c9c068ab59c1dd1ead037a5b07c
-  data.tar.gz: 8dcca59dca9154927d34ebb5dfcb4b1104427c8dc50fc9b1de7f969583a5a6d536ca3042bc41df4c7c22fd51216f0ab4fc26212b79c6196aa2e8c47344878035
+  metadata.gz: 79a490c8dd3d3af74ff5ab0bb45209982f35dae182fc6b83cb90177e5b75a60afd36c56bb4285f0affbc1fff15cc7eacf0542e88a1fe742fc88c5a39eee11985
+  data.tar.gz: 6869c83755659c52549eee08b411076a42ed4c469d7ba1b8016f1b3b1668e681db46d8439ac32c2fcb32054207db9a51cdbf76d57c76ddf3d352af121c6ef26b

data/README.md

@@ -4,7 +4,7 @@ This repository contains the open source Ruby client for MessageBird's REST API.
 
 Requirements
 ------------
-- [Sign up](https://www.messagebird.com/en/signup) for a free MessageBird account
+- [Sign up](https://dashboard.messagebird.com/app/en/sign-up) for a free MessageBird account
 - Create a new `access_key` in the developers sections
 - MessageBird's API client for Ruby requires Ruby >= 1.9
 
@@ -111,14 +111,14 @@ Similar to the **message_create** and **message** methods, the **hlr_create** me
 client.hlr('4933bed0453ba7455031712h16830892')
 ```
 
-##### OTP (One-Time Password)
-You can send and verify One-Time Passwords through the MessageBird API using the **otp_generate** and **otp_verify** methods.
+##### Verify (One-Time Password)
+You can send and verify One-Time Passwords through the MessageBird API using the **verify_create** and **verify_token** methods.
 
 ```ruby
-# otp_generate requires a recipient as a required parameter, and other optional paramaters
-client.otp_generate(31612345678, {:reference => "YourReference"})
+# verify_create requires a recipient as a required parameter, and other optional paramaters
+client.verify_create(31612345678, {:reference => "YourReference"})
 
-#<MessageBird::OTP:0x007fb3c18c8148
+#<MessageBird::Verify:0x007fb3c18c8148
  @id="080b7f804555213678f14f6o24607735",
  @recipient="31612345678",
  @reference="YourReference",
@@ -128,11 +128,11 @@ client.otp_generate(31612345678, {:reference => "YourReference"})
  @validUntilDatetime=2015-05-12 16:51:49 +0200>
 ```
 
-This sends a token to the recipient, which can be verified with the **otp_verify** method.
+This sends a token to the recipient, which can be verified with the **verify_token** method.
 
 ```ruby
-# otp_verify requires a recipient, a token as required parameters, and other optional paramaters
-client.otp_verify(31612345678, 123456, {:reference => "YourReference"})
+# verify_token requires the id of the verify request and a token as required parameters.
+client.verify_token('080b7f804555213678f14f6o24607735', 123456)
 ```
 
 ##### Voice Message

data/lib/messagebird.rb

@@ -2,7 +2,7 @@ libdir = File.dirname(__FILE__)
 $:.unshift(libdir) unless $:.include?(libdir)
 
 module MessageBird
-  CLIENT_VERSION = '1.3.2'
+  CLIENT_VERSION = '1.3.3'
   ENDPOINT       = 'https://rest.messagebird.com'
 end
 
@@ -10,6 +10,6 @@ require 'messagebird/balance'
 require 'messagebird/client'
 require 'messagebird/error'
 require 'messagebird/hlr'
-require 'messagebird/otp'
+require 'messagebird/verify'
 require 'messagebird/message'
 require 'messagebird/voicemessage'

data/lib/messagebird/client.rb

@@ -5,7 +5,7 @@ require 'uri'
 require 'messagebird/balance'
 require 'messagebird/error'
 require 'messagebird/hlr'
-require 'messagebird/otp'
+require 'messagebird/verify'
 require 'messagebird/message'
 require 'messagebird/voicemessage'
 require 'messagebird/lookup'
@@ -19,6 +19,8 @@ module MessageBird
     end
   end
 
+  class InvalidPhoneNumberException < TypeError; end
+
   class Client
     attr_reader :access_key
 
@@ -51,7 +53,7 @@ module MessageBird
       when 200, 201, 204, 401, 404, 405, 422
         json = JSON.parse(response.body)
       else
-        raise Net::HTTPServerError.new response.http_version, 'Unknown response from server', response
+        raise InvalidPhoneNumberException, 'Unknown response from server'
       end
 
       # If the request returned errors, create Error objects and raise.
@@ -81,27 +83,30 @@ module MessageBird
         :reference => reference))
     end
 
-    # Generate a new One-Time-Password message
-    def otp_generate(recipient, params={})
-        OTP.new(request(
-            :post,
-            'otp/generate',
-            params.merge({
-                :recipient => recipient
-            })
-        ))
+    # Retrieve the information of specific Verify.
+    def verify(id)
+      Verify.new(request(:get, "verify/#{id.to_s}"))
     end
 
-    # Verify the One-Time-Password
-    def otp_verify(recipient, token, params={})
-        # Set the path to include all the parameters
-        # Blame Sam Wierema for not adhering to REST principles...
-        path = 'otp/verify?' + URI.encode_www_form(params.merge({
-            :recipient => recipient,
-            :token => token
-        }))
+    # Generate a new One-Time-Password message.
+    def verify_create(recipient, params={})
+      Verify.new(request(
+          :post,
+          'verify',
+          params.merge({
+              :recipient => recipient
+          })
+      ))
+    end
 
-        OTP.new(request(:get, path))
+    # Verify the One-Time-Password.
+    def verify_token(id, token)
+      Verify.new(request(:get, "verify/#{id.to_s}?token=#{token}"))
+    end
+
+    # Delete a Verify
+    def verify_delete(id)
+      Verify.new(request(:delete, "verify/#{id.to_s}"))
     end
 
     # Retrieve the information of specific message.
@@ -141,7 +146,7 @@ module MessageBird
 
     def lookup(phoneNumber, params={})
       Lookup.new(request(:get, "lookup/#{phoneNumber}", params))
-    end 
+    end
 
     def lookup_hlr_create(phoneNumber, params={})
       HLR.new(request(:post, "lookup/#{phoneNumber}/hlr", params))

data/lib/messagebird/{otp.rb → verify.rb}

@@ -3,7 +3,7 @@ require 'time'
 require 'messagebird/base'
 
 module MessageBird
-  class OTP < MessageBird::Base
+  class Verify < MessageBird::Base
     attr_accessor :id, :recipient, :reference, :status, :href,
                   :createdDatetime, :validUntilDatetime
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: messagebird-rest
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Maurice Nonnekes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-24 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies: []
 description: A simple REST API for MessageBird in Ruby
 email: maurice@messagebird.com
@@ -16,6 +16,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- lib/messagebird.rb
 - lib/messagebird/balance.rb
 - lib/messagebird/base.rb
 - lib/messagebird/client.rb
@@ -23,12 +26,9 @@ files:
 - lib/messagebird/hlr.rb
 - lib/messagebird/lookup.rb
 - lib/messagebird/message.rb
-- lib/messagebird/otp.rb
 - lib/messagebird/recipient.rb
+- lib/messagebird/verify.rb
 - lib/messagebird/voicemessage.rb
-- lib/messagebird.rb
-- LICENSE
-- README.md
 homepage: https://github.com/messagebird/ruby-rest-api
 licenses:
 - BSD-2-Clause
@@ -39,17 +39,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: MessageBird's REST API