messagebird-rest 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65e692932b82b38e07641c5787691f0dddc4330e
-  data.tar.gz: ae82199dc7751a50e772ba289fcdc712721fec88
+  metadata.gz: 3b53bdc58624f5473f812a02642ac6b74bb83dd4
+  data.tar.gz: be218bdcb5e9cdbe47fb58021cbfc0f7805ad0bf
 SHA512:
-  metadata.gz: 0ff89ec13b1720dfef137c1e26fca6d105bd6e2538c2e0cbf647b2924791aa81716f62a377100cebc0f4385cfaf953ef224044a853eef0aaa6059ca0d72d145d
-  data.tar.gz: 62078521b02b35ffd7a30dfd5c1f4226cc20b920d2cd006b118b1f8188ed868b756ba6ed2c78e0e084a28eb748316bffb80d7f49f26f6e98fe0ae9ba16c0d5d7
+  metadata.gz: 9889deb627a5ae4a4bca6d7d5d46b7b345c51f8a8e90a26432d219b36b4e885e957305fd68e1590e4d242fa8cd66e7ab5a4fb5a35aa43031d64365c25eb72280
+  data.tar.gz: 9b3e70e9894d055929b76762c556257af34cb98f48371663dd6f32255e9e280de37cd72cd7cefe698e3b6e8611baddb8440ecb39581de52e9ad373c9872f2b25

data/README.md

@@ -32,7 +32,7 @@ require 'messagebird'
 client = MessageBird::Client.new(YOUR_ACCESS_KEY)
 ```
 
-That's easy enough. Now we can query the server for information. 
+That's easy enough. Now we can query the server for information.
 
 ##### Balance
 Lets start with out with an overview of our balance.
@@ -111,6 +111,30 @@ 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.
+
+```ruby
+# otp_generate requires a recipient as a required parameter, and other optional paramaters
+client.otp_generate(31612345678, {:reference => "YourReference"})
+
+#<MessageBird::OTP:0x007fb3c18c8148
+ @id="080b7f804555213678f14f6o24607735",
+ @recipient="31612345678",
+ @reference="YourReference",
+ @status="sent",
+ @href={"message"=>"https://rest.messagebird.com/messages/67d42f004555213679416f0b13254392"},
+ @createdDatetime=2015-05-12 16:51:19 +0200,
+ @validUntilDatetime=2015-05-12 16:51:49 +0200>
+```
+
+This sends a token to the recipient, which can be verified with the **otp_verify** method.
+
+```ruby
+# otp_verify requires a recipient, a token as required parameters, and other optional paramaters
+client.otp_verify(31612345678, 123456, {:reference => "YourReference"})
+```
+
 ##### Voice Message
 MessageBird also offers the ability to send out a text message as a voice message, or text-to-speech. For that purpose we have created the **voice_message_create** method, which takes one or more required *recipients* and a *body* text for parameters.
 

data/lib/messagebird/client.rb

@@ -5,6 +5,7 @@ require 'uri'
 require 'messagebird/balance'
 require 'messagebird/error'
 require 'messagebird/hlr'
+require 'messagebird/otp'
 require 'messagebird/message'
 require 'messagebird/voicemessage'
 
@@ -20,8 +21,8 @@ module MessageBird
   class Client
     attr_reader :access_key
 
-    def initialize(access_key)
-      @access_key = access_key
+    def initialize(access_key = nil)
+      @access_key = access_key || ENV['MESSAGEBIRD_ACCESS_KEY']
     end
 
     def request(method, path, params={})
@@ -79,6 +80,29 @@ 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
+            })
+        ))
+    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
+        }))
+
+        OTP.new(request(:get, path))
+    end
+
     # Retrieve the information of specific message.
     def message(id)
       Message.new(request(:get, "messages/#{id.to_s}"))

data/lib/messagebird/otp.rb

@@ -0,0 +1,18 @@
+require 'time'
+
+require 'messagebird/base'
+
+module MessageBird
+  class OTP < MessageBird::Base
+    attr_accessor :id, :recipient, :reference, :status, :href,
+                  :createdDatetime, :validUntilDatetime
+
+    def createdDatetime=(value)
+      @createdDatetime = value_to_time(value)
+    end
+
+    def validUntilDatetime=(value)
+      @validUntilDatetime = value_to_time(value)
+    end
+  end
+end

data/lib/messagebird.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: messagebird-rest
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Maurice Nonnekes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-10 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies: []
 description: A simple REST API for MessageBird in Ruby
 email: maurice@messagebird.com
@@ -16,17 +16,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
-- README.md
-- lib/messagebird.rb
 - lib/messagebird/balance.rb
 - lib/messagebird/base.rb
 - lib/messagebird/client.rb
 - lib/messagebird/error.rb
 - lib/messagebird/hlr.rb
 - lib/messagebird/message.rb
+- lib/messagebird/otp.rb
 - lib/messagebird/recipient.rb
 - lib/messagebird/voicemessage.rb
+- lib/messagebird.rb
+- LICENSE
+- README.md
 homepage: https://github.com/messagebird/ruby-rest-api
 licenses:
 - BSD-2-Clause
@@ -37,17 +38,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.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: MessageBird's REST API