voipfone_client 0.0.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec00aae0364688ff1e2c3a8c5965b9d78b952571
-  data.tar.gz: 61bffd3ac3eb9f92b083256f2d7a8cf505ff6a1c
+  metadata.gz: 301fd49404a1148d61c266b3277a9c2095f68c00
+  data.tar.gz: 406cbcf01334c54881834c36caa499c5bab12a93
 SHA512:
-  metadata.gz: c86c3a9856a801fe831df734b897fbdb7939a2240aeb2d1862b0cb03875254d2b21d3aff4a51740f380b9dc60d8fcb950ebae17232f324deb0232464a22392cd
-  data.tar.gz: e5d538c38fcdd211f40edce34ea412fea850b7f829565247c525702d8f504113053de7e1954a0340ce1cf4e5cf986c088020053ec37662bcf24ac559eb7e281a
+  metadata.gz: f5f3cc00772a9f448bdc10cfbb09ef32bd2b81b2a024fd68c309e01f14a273642275015b7fbf8e8cd3932751da8fa2e7173159bb406d514353f8374f11b02ea3
+  data.tar.gz: 19aaea9bc58b10fca0f7a6349dcf08bc29150f8865e1fbab3fd0e023091246f4999f8e3f72e0db4ddda31a0c965da8e2a5374fab9ca9cb1843c101a37c157764

data/lib/voipfone_client.rb

@@ -1,12 +1,7 @@
 require 'json'
 require 'mechanize'
-require 'voipfone_client/errors'
-require 'voipfone_client/client'
-require 'voipfone_client/account_balance'
-require 'voipfone_client/account_details'
-require 'voipfone_client/diverts'
-require 'voipfone_client/voicemail'
-require 'voipfone_client/sms'
+require 'require_all'
+require_all 'lib/voipfone_client'
 
 module VoipfoneClient
   BASE_URL = "https://www.voipfone.co.uk"

data/lib/voipfone_client/client.rb

@@ -19,7 +19,6 @@ module VoipfoneClient
 			end
 		end
 
-		private
 		# Responses from the private Voipfone API are always in the form ["message", {content}]
 		# We will strip the message (hopefully "OK"), raise if not OK, and return the content.
 		# @param request [JSON] The raw request response from the Voipfone API

data/lib/voipfone_client/divert_list_item.rb

@@ -0,0 +1,48 @@
+module VoipfoneClient
+  class DivertListItem < Client
+    attr_accessor :name, :number
+
+    # Constructor for `DivertListItem` which accepts the name and number of the phone number to add to the diverts list.
+    # @param name [String] the name of the phone to be diverted to
+    # @param number [String] the number of the phone to be diverted to.
+    def initialize(name: nil, number: nil)
+      @name = name
+      @number = number
+      super()
+    end
+
+    # Add a new number to the list of numbers which can be diverted to. Requires a name
+    # and a phone number, which will have spaces stripped from it. May be in international
+    # format.
+    # @return [Boolean] true on success or a failure message (in which case a `VoipfoneAPIError` will be raised)
+    def save
+      if @name.nil? || @number.nil?
+        raise ArgumentError, "You need to include a name and number to add to the diverts list"
+      end
+      @number = @number.gsub(" ","")
+      parameters = {
+        "div-list-name" => @name,
+        "div-list-num" => number
+      }
+      request = @browser.post("#{VoipfoneClient::API_POST_URL}?setDivertsList", parameters)
+      response = parse_response(request)
+      if response == [@name, @number]
+        return true
+      else
+        raise VoipfoneAPIError, "Although Voipfone returned an OK, the data they stored didn't match what you asked for: #{response}"
+      end
+    end
+
+    class << self
+      # Get a list of phones which can be diverted to. Returns a nested array of name and phone number.
+      # @return [Array] of names and phone numbers 
+      def all
+        d = self.new
+        request = d.browser.get("#{VoipfoneClient::API_GET_URL}?divertsCommon")
+        d.parse_response(request)["divertsCommon"].collect do |i|
+          DivertListItem.new(name: i.first, number: i.last)
+        end
+      end
+    end
+  end
+end

data/lib/voipfone_client/global_divert.rb

@@ -0,0 +1,101 @@
+module VoipfoneClient
+  # Set up a global (whole-account) divert on your account.
+  # You need to specify the type of divert and the number to which the divert will go to.
+  # There are 4 supported situations which can be
+  # diverted for, namely:
+  #  - all calls (i.e. no calls will reach the pbx / phones - immediate divert)
+  #  - when there is a failure in the phone system
+  #  - when the phone(s) are busy
+  #  - when there's no answer
+  class GlobalDivert < Client
+    attr_accessor :type, :number
+
+    # Constructor for `GlobalDivert` which allows you to pass in a `DivertListItem` to be used as the receiving number.
+    # @param divert_list_item [DivertListItem] a `DivertListItem` object which will be used to fill the `GlobalDivert` number.
+    # You still need to specify the divert type.
+    def initialize(divert_list_item = nil)
+      if divert_list_item.is_a?(DivertListItem)
+        @number = divert_list_item.number
+      end
+      super()
+    end
+
+    # A hash of voipfone divert names vs our divert names. Note that when we query
+    # voipfone the returned value of the divert type is UPPERCASE.
+    VOIPFONE_DIVERT_NAMES = {
+      "all" => "all",
+      "chanunavail" => "fail",
+      "busy" => "busy",
+      "noanswer" => "no_answer"
+    }
+
+    #Save the divert on your account
+    # @return [Boolean] true on success, or a failure message (in which case a `VoipfoneAPIError` will be raised)
+    def save
+      if @type.nil? || @number.nil?
+        raise ArgumentError, "You need to set a divert type and divert number before you can save the divert."
+      end
+      set_diverts(@type => @number)
+    end
+
+    #Clear all diverts
+    # @return [Boolean] true on success, or a failure message (in which case a `VoipfoneAPIError` will be raised)
+    def clear!
+      set_diverts()
+    end
+    class << self
+      # Get current diverts
+      # @return [Array] A nested set of arrays with divert information for each type of divert currently set
+      def all
+        g = self.new
+        request = g.browser.get("#{VoipfoneClient::API_GET_URL}?divertsMain")
+        g.parse_response(request)["divertsMain"].collect do |d|
+          divert = GlobalDivert.new
+          divert.number = d[1]
+          divert.type = VOIPFONE_DIVERT_NAMES[d[2].downcase].to_sym
+          divert
+        end
+      end
+    end
+
+    private
+    # Divert calls for different circumstances. There are 4 supported situations which can be
+    # diverted for, namely:
+    #  - all calls (i.e. no calls will reach the pbx / phones - immediate divert)
+    #  - when there is a failure in the phone system
+    #  - when the phone(s) are busy
+    #  - when there's no answer
+    # If no values are passed, all diverts are cleared.
+    # @param all [String] The number to which all calls will be diverted.
+    # @param fail [String] The number to which calls will be diverted in the event of a failure
+    # @param busy [String] The number to which calls will be diverted if the phones are busy
+    # @param no_answer [String] The number to which calls will be diverted if there's no answer
+    # @return [Boolean] true on success, or a failure message (in which case a `VoipfoneAPIError` will be raised)
+    def set_diverts(all: nil, fail: nil, busy: nil, no_answer: nil)
+      all ||= ""
+      fail ||= ""
+      busy ||= ""
+      no_answer ||= ""
+      parameters = {
+        "all" => all.gsub(" ",""),
+        "chanunavail" => fail.gsub(" ",""),
+        "busy" => busy.gsub(" ",""),
+        "noanswer" => no_answer.gsub(" ","")
+      }
+      request = @browser.post("#{VoipfoneClient::API_POST_URL}?divertsMain", parameters)
+      response = parse_response(request)
+      if response == "ok"
+        return true
+      else
+        raise VoipfoneAPIError, response.first
+      end
+    end
+  end
+end
+
+
+
+
+    
+
+

data/lib/voipfone_client/phone_numbers.rb

@@ -0,0 +1,10 @@
+module VoipfoneClient
+	class Client
+    # Return the phone numbers for this account, as strings
+    # @return [Array] Phone numbers as strings.
+		def phone_numbers
+      request = @browser.get("#{VoipfoneClient::API_GET_URL}?nums")
+      parse_response(request)["nums"].collect {|n| n.first}
+		end
+	end
+end

data/lib/voipfone_client/registered_mobile.rb

@@ -0,0 +1,18 @@
+module VoipfoneClient
+	class RegisteredMobile < Client
+    attr_accessor :number, :name
+
+    class << self
+      def all
+        r = RegisteredMobile.new
+        request = r.browser.get("#{VoipfoneClient::API_GET_URL}?registeredMobile")
+        r.parse_response(request)["registeredMobile"].collect do |m|
+          mobile = RegisteredMobile.new
+          mobile.number = m[0]
+          mobile.name = m[1]
+          mobile
+        end
+      end
+    end
+	end
+end

data/lib/voipfone_client/sms.rb

@@ -1,25 +1,37 @@
-class VoipfoneClient::Client
-  # Send an sms from your account.
-  # @param to [String] the phone number to send the SMS to, as a string. Spaces will be stripped; + symbol allowed.
-  # @param from [String] the phone number to send the SMS from, as a string. Spaces will be stripped; + symbol allowed.
-  # @param message [String] the message to send. The first 160 characters only will be sent.
-  def send_sms(to:to, from:from, message:message)
-    if to.nil? || from.nil? || message.nil?
-      raise ArgumentError, "You need to include 'to' and 'from' numbers and a message to send an SMS"
+module VoipfoneClient
+  class SMS < Client
+    attr_accessor :from, :to, :message
+
+    # Constructor to create an SMS - optionally pass in to, from and message
+    # @param to [String] the phone number to send the SMS to, as a string. Spaces will be stripped; + symbol allowed.
+    # @param from [String] the phone number to send the SMS from, as a string. Spaces will be stripped; + symbol allowed.
+    # @param message [String] the message to send. The first 160 characters only will be sent.
+    def initialize(to: nil, from: nil, message: nil)
+      @to = to
+      @from = from
+      @message = message
+      super()
     end
-    to = to.gsub(" ","")
-    from = from.gsub(" ","")
-    parameters = {
-      "sms-send-to" => to,
-      "sms-send-from" => from,
-      "sms-message" => message
-    }
-    request = @browser.post("#{VoipfoneClient::API_POST_URL}?smsSend", parameters)
-    response = parse_response(request)
-    if response == "ok"
-      return true
-    else
-      raise VoipfoneAPIError, response
+
+    # Send an sms from your account.
+    def send
+      if @to.nil? || @from.nil? || @message.nil?
+        raise ArgumentError, "You need to include 'to' and 'from' numbers and a message to send an SMS"
+      end
+      to = @to.gsub(" ","")
+      from = @from.gsub(" ","")
+      parameters = {
+        "sms-send-to" => to,
+        "sms-send-from" => from,
+        "sms-message" => @message[0..159]
+      }
+      request = @browser.post("#{VoipfoneClient::API_POST_URL}?smsSend", parameters)
+      response = parse_response(request)
+      if response == "ok"
+        return true
+      else
+        raise VoipfoneAPIError, response
+      end
     end
   end
 end

data/lib/voipfone_client/version.rb

@@ -1,3 +1,3 @@
 module VoipfoneClient
-  VERSION = "0.0.5"
+  VERSION = "0.2.0"
 end

data/voipfone_client.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard", "~> 0.8"
 
   spec.add_dependency "mechanize", "~> 2.7"
+  spec.add_dependency "require_all", "~> 1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voipfone_client
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Error Creative Studio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-27 00:00:00.000000000 Z
+date: 2014-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: Voipfone are a brilliant SIP provider with loads of features, but no
   API. This Gem hooks into the API which their web interfaces uses.
 email:
@@ -85,8 +99,11 @@ files:
 - lib/voipfone_client/account_balance.rb
 - lib/voipfone_client/account_details.rb
 - lib/voipfone_client/client.rb
-- lib/voipfone_client/diverts.rb
+- lib/voipfone_client/divert_list_item.rb
 - lib/voipfone_client/errors.rb
+- lib/voipfone_client/global_divert.rb
+- lib/voipfone_client/phone_numbers.rb
+- lib/voipfone_client/registered_mobile.rb
 - lib/voipfone_client/sms.rb
 - lib/voipfone_client/version.rb
 - lib/voipfone_client/voicemail.rb

data/lib/voipfone_client/diverts.rb

@@ -1,79 +0,0 @@
-class VoipfoneClient::Client
-  # Get a list of phones which can be diverted to. Returns a nested array of name and phone number.
-  # @return [Array] of names and phone numbers 
-  def diverts_list
-    request = @browser.get("#{VoipfoneClient::API_GET_URL}?divertsCommon")
-    parse_response(request)["divertsCommon"]
-  end
-
-  # Add a new number to the list of numbers which can be diverted to. Requires a name
-  # and a phone number, which will have spaces stripped from it. May be in international
-  # format.
-  # @param name [String] The name which appears in dropdowns in the web interface
-  # @param number [String] The number which will be called. Spaces will be stripped. + symbol accepted
-  # @return [Boolean] true on success or a failure message (in which case a `VoipfoneAPIError` will be raised)
-  def add_to_diverts_list(name: nil, number: nil)
-    if name.nil? || number.nil?
-      raise ArgumentError, "You need to include a name and number to add to the diverts list"
-    end
-    number = number.gsub(" ","")
-    parameters = {
-      "div-list-name" => name,
-      "div-list-num" => number
-    }
-    request = @browser.post("#{VoipfoneClient::API_POST_URL}?setDivertsList", parameters)
-    response = parse_response(request)
-    if response == [name, number]
-      return true
-    else
-      raise VoipfoneAPIError, "Although Voipfone returned an OK, the data they stored didn't match what you asked for: #{response}"
-    end
-  end
-
-
-  # Divert calls for different circumstances. There are 4 supported situations which can be
-  # diverted for, namely:
-  #  - all calls (i.e. no calls will reach the pbx / phones - immediate divert)
-  #  - when there is a failure in the phone system
-  #  - when the phone(s) are busy
-  #  - when there's no answer
-  # If no values are passed, all diverts are cleared.
-  # @param all [String] The number to which all calls will be diverted.
-  # @param fail [String] The number to which calls will be diverted in the event of a failure
-  # @param busy [String] The number to which calls will be diverted if the phones are busy
-  # @param no_answer [String] The number to which calls will be diverted if there's no answer
-  # @return [Boolean] true on success, or a failure message (in which case a `VoipfoneAPIError` will be raised)
-  def set_diverts(all: nil, fail: nil, busy: nil, no_answer: nil)
-    all ||= ""
-    fail ||= ""
-    busy ||= ""
-    no_answer ||= ""
-    parameters = {
-      "all" => all.gsub(" ",""),
-      "chanunavail" => fail.gsub(" ",""),
-      "busy" => busy.gsub(" ",""),
-      "noanswer" => no_answer.gsub(" ","")
-    }
-    request = @browser.post("#{VoipfoneClient::API_POST_URL}?divertsMain", parameters)
-    response = parse_response(request)
-    if response == "ok"
-      return true
-    else
-      raise VoipfoneAPIError, response.first
-    end
-  end
-
-  # Diverts all calls to the number passed into this method
-  # @param number [String] The number to be diverted to.
-  # @return [Boolean] true on success, or an error message (in which case a `VoipfoneAPIError` will be raised)
-  def divert_all_calls(number: nil)
-    set_diverts(all: number)
-  end
-
-  # Get current diverts
-  # @return [Array] A nested set of arrays with divert information for each type of divert currently set
-  def get_diverts
-    request = @browser.get("#{VoipfoneClient::API_GET_URL}?divertsMain")
-    parse_response(request)["divertsMain"]
-  end
-end