Merge pull request #5 from messagebird/lookup

Adding the new Lookup API endpoints

Author: samwierema

examples/lookup.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib/')
+require 'messagebird'
+
+# ACCESS_KEY = 'YOUR KEY HERE'
+# PHONE_NUMBER = '+31612345678'
+
+unless defined?(ACCESS_KEY)
+  puts 'You need to set an ACCESS_KEY constant in this file'
+  exit 1
+end
+
+unless defined?(PHONE_NUMBER)
+  puts 'You need to set an PHONE_NUMBER constant in this file'
+end
+
+begin
+  # Create a MessageBird client with the specified ACCESS_KEY.
+  client = MessageBird::Client.new(ACCESS_KEY)
+
+  # Fetch the HLR object for the specified HLR_ID.
+  lookup = client.lookup(PHONE_NUMBER)
+
+  # Print the object information.
+  puts
+  puts "The following information was returned as an HLR object:"
+  puts
+  puts "  href            : #{lookup.href}"
+  puts "  countryCode     : #{lookup.countryCode}"
+  puts "  countryPrefix   : #{lookup.countryPrefix}"
+  puts "  phoneNumber     : #{lookup.phoneNumber}"
+  puts "  type            : #{lookup.type}"
+
+  puts "  formats         :"
+  puts "    e164          : #{lookup.formats.e164}"
+  puts "    international : #{lookup.formats.international}"
+  puts "    national      : #{lookup.formats.national}"
+  puts "    rfc3966       : #{lookup.formats.rfc3966}"
+
+  unless lookup.hlr.nil?
+    puts "  hlr             :"
+    puts "    id              : #{lookup.hlr.id}"
+    puts "    href            : #{lookup.hlr.href}"
+    puts "    msisdn          : #{lookup.hlr.msisdn}"
+    puts "    reference       : #{lookup.hlr.reference}"
+    puts "    status          : #{lookup.hlr.status}"
+    puts "    createdDatetime : #{lookup.hlr.createdDatetime}"
+    puts "    statusDatetime  : #{lookup.hlr.statusDatetime}"
+  end
+
+rescue MessageBird::ErrorException => ex
+  puts
+  puts 'An error occured while requesting the lookup:'
+  puts
+
+  ex.errors.each do |error|
+    puts "  code        : #{error.code}"
+    puts "  description : #{error.description}"
+    puts "  parameter   : #{error.parameter}"
+    puts
+  end
+end

examples/lookup_hlr.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib/')
+require 'messagebird'
+
+# ACCESS_KEY = 'YOUR KEY HERE'
+# PHONE_NUMBER = '+31612345678'
+
+unless defined?(ACCESS_KEY)
+  puts 'You need to set an ACCESS_KEY constant in this file'
+  exit 1
+end
+
+unless defined?(PHONE_NUMBER)
+  puts 'You need to set an PHONE_NUMBER constant in this file'
+  exit 1
+end
+
+begin
+  # Create a MessageBird client with the specified ACCESS_KEY.
+  client = MessageBird::Client.new(ACCESS_KEY)
+
+  # Do a new HLR lookup.
+  hlr = client.lookup_hlr(PHONE_NUMBER)
+
+  # Print the object information.
+  puts
+  puts "The following information was returned as an HLR object:"
+  puts
+  puts "  id              : #{hlr.id}"
+  puts "  href            : #{hlr.href}"
+  puts "  msisdn          : #{hlr.msisdn}"
+  puts "  reference       : #{hlr.reference}"
+  puts "  status          : #{hlr.status}"
+  puts "  createdDatetime : #{hlr.createdDatetime}"
+  puts "  statusDatetime  : #{hlr.statusDatetime}"
+  puts
+
+rescue MessageBird::ErrorException => ex
+  puts
+  puts 'An error occured while requesting an HLR object:'
+  puts
+
+  ex.errors.each do |error|
+    puts "  code        : #{error.code}"
+    puts "  description : #{error.description}"
+    puts "  parameter   : #{error.parameter}"
+    puts
+  end
+end

examples/lookup_hlr_create.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib/')
+require 'messagebird'
+
+# ACCESS_KEY = 'YOUR KEY HERE'
+# PHONE_NUMBER = '+31612345678'
+
+unless defined?(ACCESS_KEY)
+  puts 'You need to set an ACCESS_KEY constant in this file'
+  exit 1
+end
+
+unless defined?(PHONE_NUMBER)
+  puts 'You need to set an PHONE_NUMBER constant in this file'
+  exit 1
+end
+
+begin
+  # Create a MessageBird client with the specified ACCESS_KEY.
+  client = MessageBird::Client.new(ACCESS_KEY)
+
+  # Create a new HLR object.
+  hlr = client.lookup_hlr_create(PHONE_NUMBER, :reference => 'Reference')
+
+  # Print the object information.
+  puts
+  puts "The following information was returned as an HLR object:"
+  puts
+  puts "  id              : #{hlr.id}"
+  puts "  href            : #{hlr.href}"
+  puts "  msisdn          : #{hlr.msisdn}"
+  puts "  reference       : #{hlr.reference}"
+  puts "  status          : #{hlr.status}"
+  puts "  createdDatetime : #{hlr.createdDatetime}"
+  puts "  statusDatetime  : #{hlr.statusDatetime}"
+  puts
+
+rescue MessageBird::ErrorException => ex
+  puts
+  puts 'An error occured while requesting an HLR object:'
+  puts
+
+  ex.errors.each do |error|
+    puts "  code        : #{error.code}"
+    puts "  description : #{error.description}"
+    puts "  parameter   : #{error.parameter}"
+    puts
+  end
+end

lib/messagebird.rb

@@ -2,7 +2,7 @@
 $:.unshift(libdir) unless $:.include?(libdir)
 
 module MessageBird
-  CLIENT_VERSION = '1.2.2'
+  CLIENT_VERSION = '1.3.0'
   ENDPOINT       = 'https://rest.messagebird.com'
 end
 

lib/messagebird/client.rb

@@ -8,6 +8,7 @@
 require 'messagebird/otp'
 require 'messagebird/message'
 require 'messagebird/voicemessage'
+require 'messagebird/lookup'
 
 module MessageBird
   class ErrorException < StandardError
@@ -137,5 +138,18 @@ def voice_message_create(recipients, body, params={})
         'voicemessages',
         params.merge({ :recipients => recipients, :body => body.to_s })))
     end
+
+    def lookup(phoneNumber, params={})
+      Lookup.new(request(:get, "lookup/#{phoneNumber}", params))
+    end 
+
+    def lookup_hlr_create(phoneNumber, params={})
+      HLR.new(request(:post, "lookup/#{phoneNumber}/hlr", params))
+    end
+
+    def lookup_hlr(phoneNumber, params={})
+      HLR.new(request(:get, "lookup/#{phoneNumber}/hlr", params))
+    end
+
   end
 end

lib/messagebird/lookup.rb

@@ -0,0 +1,22 @@
+require 'time'
+
+require 'messagebird/base'
+
+module MessageBird
+  class Lookup < MessageBird::Base
+    attr_accessor :href, :countryCode, :countryPrefix, :phoneNumber, :type
+    attr_reader :formats, :hlr
+
+    def formats=(newFormats)
+      @formats = Formats.new(newFormats)
+    end
+
+    def hlr=(newHLR)
+      @hlr = HLR.new(newHLR)
+    end
+  end
+
+  class Formats < MessageBird::Base
+    attr_accessor :e164, :international, :national, :rfc3966
+  end
+end