ruby-vonage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aaa1ad6c60f26ce3ac9414dbac7626c8da2eb5e5
+  data.tar.gz: c7d5bb95ea24dbcc46edbb9984dda11228abccda
+SHA512:
+  metadata.gz: e756db126a7a71a6750783b1482f0cc2cf1ddb28422d4baee0db95828ee54fb77fd984d9369a6ee2269e51b9383eca83ca3936b65bf63fc3d1fef11905cd4c32
+  data.tar.gz: 8e1f07c53e1815c7d2f7440914b5d1592ba4a809a7ad29050bbb1fc70cee7370e10cef37aff9bdd7d7098c01f7b47f83dd63dd933d4d224d24cda1d4a0fc813c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alex Watt
+
+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,51 @@
+# ruby-vonage
+
+This is a Ruby client for the Vonage Business API, version 1.5.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-vonage'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-vonage
+
+## Usage
+
+```ruby
+client = Vonage::Client("myusername", "mypassword")
+
+# Manual authentication is optional.
+# (Client automatically authenticates before other API calls.)
+client.authenticate
+```
+
+### Click to Call
+
+```ruby
+client.click_to_call("1234567890")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alexcwatt/ruby-vonage.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruby-vonage"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ruby-vonage.rb

@@ -0,0 +1,9 @@
+require 'httparty'
+
+require 'vonage/http'
+require 'vonage/error'
+require 'vonage/authentication'
+
+require 'vonage/rest'
+
+require 'vonage/client'

data/lib/vonage/authentication.rb

@@ -0,0 +1,21 @@
+module Vonage
+  module Authentication
+
+    def authenticate
+      params = {login: @login, password: @password}
+      get_response = get "/appserver/rest/user/null", params
+
+      @cookies = parse_cookies(get_response)
+    end
+    
+    def authenticated?
+      !@cookies.empty?
+    end
+    
+    def reauthenticate
+      @cookies = CookieHash.new
+      authenticate
+    end
+    
+  end
+end

data/lib/vonage/client.rb

@@ -0,0 +1,23 @@
+require "vonage/version"
+
+module Vonage
+
+  class Client
+    include HTTParty
+    base_uri 'https://my.vonagebusiness.com'
+
+    include Authentication
+    include Http
+
+    include Rest
+
+    attr_accessor :login, :password, :cookies
+
+    def initialize login, password
+      @login = login
+      @password = password
+
+      @cookies = CookieHash.new
+    end
+  end
+end

data/lib/vonage/error.rb

@@ -0,0 +1,25 @@
+module Vonage
+  class Error < StandardError; end
+  
+  class AuthenticationError < Error; end
+  class NetError < Error; end
+  class InvalidPhoneNumber < Error; end
+
+  class ResponseError < Error
+    def initialize(res)
+      @res = res
+    end
+
+    def to_s
+      @res.to_s
+    end
+
+    def code
+      @res.code.to_i
+    end
+
+    def inspect
+      @res.inspect.to_s
+    end
+  end
+end

data/lib/vonage/http.rb

@@ -0,0 +1,46 @@
+module Vonage
+  module Http
+    
+    def get action, params = {}, num_retries = 0
+      options = {query: params, headers: {'Cookie': @cookies.to_cookie_string}}
+      check_response self.class.get(action, options)
+
+    rescue Vonage::AuthenticationError => e
+      handle_expired_cookies :get, action, params, num_retries, e
+    
+    rescue SocketError, Interrupt, EOFError, SystemCallError, Timeout::Error => e
+      raise Vonage::NetError.new(e)
+    end
+    
+    def parse_cookies resp
+      cookie_hash = HTTParty::CookieHash.new
+      resp.get_fields('Set-Cookie').each { |c| cookie_hash.add_cookies(c) }
+      cookie_hash
+    end
+
+    protected
+    
+    def handle_expired_cookies method, action, params, num_retries, e
+      raise e unless num_retries == 0
+      
+      reauthenticate
+      
+      send(method, object, path, params, 1)
+    end
+    
+    def check_response http_response
+      case http_response.code
+      when 400
+        throw Vonage::InvalidPhoneNumber
+      when 403
+        throw Vonage::AuthenticationError if http_response.include?("USER NOT LOGGED IN")
+        throw Vonage::Error
+      when (401..600)
+        throw Vonage::Error("Status Code: #{http_response.code}")
+      end
+      
+      http_response
+    end
+    
+  end
+end

data/lib/vonage/rest.rb

@@ -0,0 +1,10 @@
+module Vonage
+  module Rest
+
+    include Http
+
+    def click_to_call phone_number
+      get "/presence/rest/clicktocall/#{phone_number}"
+    end
+  end
+end

data/lib/vonage/version.rb

@@ -0,0 +1,3 @@
+module Vonage
+  VERSION = "0.1.0"
+end

data/ruby-vonage.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vonage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-vonage"
+  spec.version       = Vonage::VERSION
+  spec.author        = "Alex Watt"
+  spec.email         = "alexcwatt@gmail.com"
+
+  spec.summary       = "Use the Vonage Business API with Ruby"
+  spec.homepage      = "https://github.com/alexcwatt/ruby-vonage"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: ruby-vonage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Watt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email: alexcwatt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby-vonage.rb
+- lib/vonage/authentication.rb
+- lib/vonage/client.rb
+- lib/vonage/error.rb
+- lib/vonage/http.rb
+- lib/vonage/rest.rb
+- lib/vonage/version.rb
+- ruby-vonage.gemspec
+homepage: https://github.com/alexcwatt/ruby-vonage
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Use the Vonage Business API with Ruby
+test_files: []