voipfone_client 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a80fbbc197d700cc57e5b9e3cdd6a5aa7bc26e8b
+  data.tar.gz: 2a43848c3dd0a881e7594e77217eb93b851f4ec8
+SHA512:
+  metadata.gz: 9629390a383c7d49eebf55d33def7806240372dc1ef433666da3c7b4166d76a515ffd2098a9740615259496eafa22c4bfed5cd97d1d081aad755ae8bb76fa7da
+  data.tar.gz: d8c2770f668a0a09b710636d89bc69212d4e7e06b195e80f23581146e0ec3a20fc3b542174efe6e8c0c19639be87cee5c1c3db2c0ecd982e748e11b51e44055a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+voipfone_client

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p451

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in voipfone_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Error Creative Studio
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Voipfone Client
+
+A gem to programatically manipulate your [Voipfone](http://www.voipfone.co.uk) account using Ruby.
+
+Voipfone is a brilliant SIP VOIP provider with a very neat set of features, but unfortunately no API. So this gem hopefully fills that gap by using the same JSON API their web interface uses.
+
+## Installation
+
+This gem is in Rubygems, so you can add this line to your application's Gemfile:
+
+    gem 'voipfone_client'
+
+And then execute:
+
+    $ bundle
+
+Or you can manually install the gem using:
+
+	gem install voipfone_client
+
+##Configuration and Use
+
+Before you can instantiate a `VoipfoneClient::Client` object, you need to need to configure it:
+
+```ruby
+VoipfoneClient.configure do |config|
+	config.username = "your@email.address"
+	config.password = "yourpass"
+end
+```
+
+This approach gives us lots of options for adding more config options in the future.
+
+After that you can create a new object to call Voipfone:
+
+```ruby
+c = VoipfoneClient::Client.new
+c.account_balance #will return your balance as a float
+```
+
+## Contributing
+
+We'd love your input!
+
+1. Fork it ( http://github.com/errorstudio/voipfone_client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/voipfone_client.rb

@@ -0,0 +1,34 @@
+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'
+
+module VoipfoneClient
+  BASE_URL = "https://www.voipfone.co.uk"
+  API_GET_URL = "https://www.voipfone.co.uk/api/srv"
+  API_POST_URL = "https://www.voipfone.co.uk/api/upd"
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  # A module method which accepts a block, allowing us to configure the module.
+  # @param [Block] the configuration block, containing the configuration variables
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  # A configuration class which contains the attributes we want to set in the module method
+  class Configuration
+    attr_accessor :username, :password, :user_agent_string
+
+    def initialize
+
+    end
+  end
+end

data/lib/voipfone_client/account_balance.rb

@@ -0,0 +1,8 @@
+class VoipfoneClient::Client
+  # Return the balance of the account as a float.
+  # @return [Float] Account balance as a float. Should be rounded to 2dp before presentation.     
+  def account_balance
+    request = @browser.get("#{VoipfoneClient::API_GET_URL}?balance&builder")
+    parse_response(request)["balance"]
+  end
+end

data/lib/voipfone_client/account_details.rb

@@ -0,0 +1,8 @@
+class VoipfoneClient::Client
+	# Return the basic account details, as stored by Voipfone.
+  # @return [Hash] of account details
+	def account_details
+		request = @browser.get("#{VoipfoneClient::API_GET_URL}?account")
+		parse_response(request)
+	end
+end

data/lib/voipfone_client/client.rb

@@ -0,0 +1,35 @@
+module VoipfoneClient
+	class Client
+		attr_reader :browser
+		#  Intantiates a new Voipfone client, with username and password from the `VoipfoneClient::Configuration` class
+		# @return [VoipfoneClient::Client] the object created
+		def initialize()
+			if VoipfoneClient.configuration.username.nil? || VoipfoneClient.configuration.password.nil?
+				raise LoginCredentialsMissing, "You need to include a username and password to log in."
+			end
+			username = VoipfoneClient.configuration.username
+			password = VoipfoneClient.configuration.password
+			@browser = Mechanize.new
+			login_url = "#{VoipfoneClient::BASE_URL}/login.php?method=process"
+			@browser.post(login_url,{"hash" => "urlHash", "login" => username, "password" => password})
+			#We'll do a call to a cheap endpoint (the balance) and if it returns 'authfirst', there's a problem
+			#with the username / password. Oddly it still returns 200 OK.
+			if account_balance == "authfirst"
+				raise NotAuthenticatedError, "Username or Password weren't accepted. You'll need to instantiate a new VoipfoneClient::Client object."
+			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
+		# @return [Hash] the parsed JSON
+		def parse_response(request)
+			raw = JSON.parse(request.body)
+			unless raw.first == "ok" || raw.first == "OK"
+				raise VoipfoneAPIError, raw.first
+			end
+			raw.last
+		end
+	end
+end

data/lib/voipfone_client/diverts.rb

@@ -0,0 +1,78 @@
+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 - at least one option is required. 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
+  # @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

data/lib/voipfone_client/errors.rb

@@ -0,0 +1,3 @@
+class LoginCredentialsMissing < StandardError; end
+class NotAuthenticatedError < StandardError; end
+class VoipfoneAPIError < StandardError; end

data/lib/voipfone_client/version.rb

@@ -0,0 +1,3 @@
+module VoipfoneClient
+  VERSION = "0.0.4"
+end

data/lib/voipfone_client/voicemail.rb

@@ -0,0 +1,8 @@
+class VoipfoneClient::Client
+  #Return a list of voicemail entries, with details for each
+  #@return [Hash] of voicemail information. This includes a reference to a WAV file which isn't accessible (yet?)
+  def voicemail
+    request = @browser.get("#{VoipfoneClient::API_GET_URL}?vm_view")
+    parse_response(request)["vm_view"].first["voicemail"]
+  end
+end

data/voipfone_client.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'voipfone_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "voipfone_client"
+  spec.version       = VoipfoneClient::VERSION
+  spec.authors       = ["Error Creative Studio"]
+  spec.email         = ["hosting@errorstudio.co.uk"]
+  spec.summary       = %q{A client for voipfone.co.uk, a UK-based SIP provider}
+  spec.description   = %q{Voipfone are a brilliant SIP provider with loads of features, but no API. This Gem hooks into the API which their web interfaces uses.}
+  spec.homepage      = "https://github.com/errorstudio/voipfone_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.2"
+  spec.add_development_dependency "yard", "~> 0.8"
+
+  spec.add_dependency "mechanize", "~> 2.7"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: voipfone_client
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Error Creative Studio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+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:
+- hosting@errorstudio.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/voipfone_client.rb
+- 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/errors.rb
+- lib/voipfone_client/version.rb
+- lib/voipfone_client/voicemail.rb
+- voipfone_client.gemspec
+homepage: https://github.com/errorstudio/voipfone_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: A client for voipfone.co.uk, a UK-based SIP provider
+test_files: []
+has_rdoc: