kazoo-rb 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+kazoo.yml
+examples/private_conf

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'nestful', :git => 'git://github.com/zlu/nestful.git'

data/Gemfile.lock

@@ -0,0 +1,46 @@
+GIT
+  remote: git://github.com/zlu/nestful.git
+  revision: c6e3d981545d5054778e40d7b573a521ba1a600a
+  specs:
+    nestful (0.0.8)
+      activesupport (>= 3.0.0.beta)
+
+PATH
+  remote: .
+  specs:
+    kazoo-rb (0.0.1)
+      nestful
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8.rc2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.2.8)
+    crack (0.1.8)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    webmock (1.8.8)
+      addressable (~> 2.2.8)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  kazoo-rb!
+  nestful!
+  rake
+  rspec
+  webmock

data/LICENSE.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2012 Zhao Lu
+http://zlu.me
+
+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,11 @@
+[![Build Status](https://secure.travis-ci.org/zlu/kazoo-rb.png)](http://travis-ci.org/zlu/kazoo-rb)
+
+Kazoo-rb
+====
+
+Ruby library for [Kazoo](http://www.2600hz.com/platform.html)
+
+First, copy lib/kazoo.yml.sample to lib/kazoo.yml and fill in your Kazoo credentials
+
+## Conference
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rspec/core/rake_task'
+
+task :default => :spec
+RSpec::Core::RakeTask.new do |spec|
+  spec.rspec_opts = '--color'
+end

data/examples/conference.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+require 'kazoo'
+
+def init_config
+  YAML.load(File.open(File.join(File.expand_path("../../lib", __FILE__), 'kazoo.yml')))
+end
+
+phone_number = []
+ARGV.each do |number|
+  phone_number << number
+end
+
+auth = Kazoo::Auth.new(init_config)
+conf = Kazoo::Conference.new(auth)
+conf.create_callflow(phone_number)
+conf.create_room('test conf room', ['1234'])
+

data/kazoo.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "kazoo/version"
+
+Gem::Specification.new do |s|
+  s.name        = "kazoo-rb"
+  s.version     = Kazoo::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Zhao Lu"]
+  s.email       = %q{zlu@me.com}
+  s.date        = %q{2012-07-30}
+  s.homepage    = "https://github.com/zlu/kazoo-rb"
+  s.summary     = %q{Ruby wrapper for Kazoo}
+  s.description = %q{Ruby wrapper for Kazoo, a powerful telephony platform}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.rdoc_options = %w{--charset=UTF-8}
+  s.extra_rdoc_files = %w{README.md}
+
+  s.add_dependency("nestful")
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("webmock")
+end

data/lib/kazoo.rb

@@ -0,0 +1,11 @@
+require 'json'
+require 'nestful'
+
+$:.unshift(File.dirname(__FILE__))
+require 'kazoo/auth'
+require 'kazoo/conference'
+require 'kazoo/connection_error'
+
+module Kazoo
+  extend self
+end

data/lib/kazoo.yml.sample

@@ -0,0 +1,5 @@
+api_key: 'your_kazoo_developer_api_key'
+account_id: 'your_account_id'
+host: 'api.2600hz.com'
+port: '8000'
+version: 'v1'

data/lib/kazoo/auth.rb

@@ -0,0 +1,26 @@
+module Kazoo
+  class Auth
+    attr_reader :api_key, :host, :port, :version, :token, :account_id
+
+    def initialize(kazoo_config)
+      @api_key = kazoo_config['api_key']
+      @host = kazoo_config['host']
+      @port = kazoo_config['port']
+      @version = kazoo_config['version']
+      @account_id = kazoo_config['account_id']
+      get_token
+    end
+
+    def get_token
+      unless token
+        base_uri = 'http://' + host + ":" + port + '/' + version + '/'
+        auth_url = base_uri + 'api_auth'
+        payload = {'data' => {'api_key' => api_key}}
+        response = Nestful.json_put(auth_url, {:params => payload})
+        @token = response['auth_token']
+      end
+
+      @token
+    end
+  end
+end

data/lib/kazoo/conference.rb

@@ -0,0 +1,22 @@
+module Kazoo
+  class Conference
+    attr_reader :auth
+
+    def initialize(auth)
+      instance_variable_set :@auth, auth
+      @base_uri = 'http://' + @auth.host + ":" + @auth.port + '/' + @auth.version + '/' + 'accounts/' + @auth.account_id
+    end
+
+    def create_callflow(phone_numbers)
+      callflow_url = @base_uri  + '/callflows?auth_token=' + @auth.token
+      payload = {'data' => {'numbers' => phone_numbers, 'flow' => {'module' => "conference", 'data' => {}, 'children' => {}}}}
+      Nestful.json_put(callflow_url, {:params => payload})
+    end
+
+    def create_room(name, conference_numbers)
+      room_url = @base_uri + '/conferences?auth_token=' + @auth.token
+      payload = {'data' => {'name' => name, 'conference_numbers' => conference_numbers}}
+      Nestful.json_put(room_url, {:params => payload})
+    end
+  end
+end

data/lib/kazoo/connection_error.rb

@@ -0,0 +1,19 @@
+module Nestful
+  class ConnectionError
+    attr_reader :response
+
+    def initialize(response, message = nil)
+      @body = response.body if response.respond_to?(:body)
+      @response = response
+      @message  = message
+    end
+
+    def to_s
+      message = "Failed."
+      message << "  Response code = #{response.code}." if response.respond_to?(:code)
+      message << "  Response message = #{response.message}." if response.respond_to?(:message)
+      message << "  Response data = #{JSON.parse(@body)['data']}"
+      message
+    end
+  end
+end

data/lib/kazoo/version.rb

@@ -0,0 +1,3 @@
+module Kazoo
+  VERSION = '0.0.1'
+end

data/spec/kazoo/auth_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Kazoo::Auth do
+  before do
+    @auth_token = "eca9233822a03ef9da0adf207db64d48"
+    stub_request(:put, "http://api.2600hz.com:8000/v1/api_auth").
+        with(:headers => {'Accept' => '*/*', 'User-Agent' => 'Ruby', 'Content-Type' => 'application/json'},
+             :body => {:data => {:api_key => /.*/}}).
+        to_return(:body => {"auth_token" => @auth_token,
+                            "status" => "success",
+                            "data" => {"account_id" => "my_test_account_id"}}.to_json)
+    @auth = Kazoo::Auth.new(kazoo_config)
+  end
+
+  describe '#initialize' do
+    specify { @auth.api_key.length.should eq 64 }
+    specify { @auth.host.should eq 'api.2600hz.com' }
+    specify { @auth.port.should eq '8000' }
+    specify { @auth.version.should eq 'v1' }
+    specify { @auth.account_id.length.should eq 32 }
+    specify { @auth.token.length.should eq 32 }
+  end
+
+  describe '#get_token' do
+    context 'where there is not an existing auth token' do
+      specify { @auth.get_token.should eq @auth_token }
+      specify { @auth.get_token.length.should eq 32 }
+    end
+
+    context 'when there is an auth token' do
+      it 'should not make request if auth_token exists' do
+        auth = Kazoo::Auth.new(kazoo_config)
+        auth.should_receive(:token).and_return("a valid auth token")
+        Nestful.should_not_receive(:put)
+        auth.get_token
+      end
+    end
+  end
+end

data/spec/kazoo/conference_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Kazoo::Conference do
+  before do
+    Kazoo::Auth.any_instance.should_receive(:token).any_number_of_times.and_return('valid-token')
+    @auth = Kazoo::Auth.new(kazoo_config)
+    @phone_numbers = ['+14151112222']
+    @name = 'my super duper conference'
+    @conference_numbers = ['1234']
+  end
+
+  subject { Kazoo::Conference.new(@auth) }
+  specify { subject.auth.should eq @auth }
+
+  describe '#create_callflow' do
+    it 'should return an error if phone numbers are not array' do
+      pending
+    end
+
+    it 'should create a new call flow' do
+      expected_response = {"auth_token" => @auth.token,
+                           "status" => "success",
+                           "data" => {"numbers" => @phone_numbers,
+                                      "flow" => {"module" => "conference",
+                                                 "data" => {},
+                                                 "children" => {}},
+                                      "id" => "ae16f443d8ce3a5b70716d0dbd4d0fc2"},
+                           "revision" => "1-eda087bf61f19b37dab1cc14404c7034"}
+
+      stub_request(:put, "http://api.2600hz.com:8000/v1/accounts/#{@auth.account_id}/callflows").
+          with(:headers => {'Accept' => '*/*', 'User-Agent' => 'Ruby', 'Content-Type' => 'application/json'},
+               :body => {:data => {:numbers => @phone_numbers, :flow => {:module => "conference", :data => {}, :children => {}}}, :auth_token => @auth.token}).
+          to_return(:body => expected_response.to_json)
+
+      subject.create_callflow(@phone_numbers).should eq expected_response
+    end
+
+    context 'and fails' do
+      it 'should raise error' do
+        pending 'need to think about how to test error cases'
+        response = mock('response')
+        response.body = {:data => 'some error'}.to_json
+        stub_request(:put, "http://api.2600hz.com:8000/v1/accounts/#{@auth.account_id}/callflows").
+            with(:headers => {'Accept' => '*/*', 'User-Agent' => 'Ruby', 'Content-Type' => 'application/json'},
+                 :body => {:data => {:numbers => @phone_numbers, :flow => {:module => "conference", :data => {}, :children => {}}}, :auth_token => @auth.token}).
+            to_raise(Nestful::ConnectionError.new(response))
+
+        lambda {
+          subject.create_callflow(@phone_numbers)
+        }.should raise_error
+      end
+    end
+  end
+
+  describe '#create_room' do
+    context 'and succeeds' do
+      it 'should create a new conference room' do
+        expected_response =
+            {"auth_token" => "555555c8d6f213098729999999999999",
+             "status" => "success",
+             "data" => {"name" => @name,
+                        "conference_numbers" => @conference_numbers,
+                        "member" => {"pins" => [], "numbers" => [], "play_name" => false, "join_muted" => true, "join_deaf" => false},
+                        "moderator" => {"pins" => [], "numbers" => [], "play_name" => false, "join_muted" => true, "join_deaf" => false},
+                        "require_moderator" => false,
+                        "wait_for_moderator" => true,
+                        "max_members" => 15,
+                        "id" => "5eb2aac8d6f21309872920aedccbf885"},
+             "revision" => "1-d832f5497369796e1e0f0482584678ee"}
+
+        stub_request(:put, "http://api.2600hz.com:8000/v1/accounts/#{@auth.account_id}/conferences").
+            with(:headers => {'Accept' => '*/*', 'User-Agent' => 'Ruby', 'Content-Type' => 'application/json'},
+                 :body => {:data => {:name => @name, :conference_numbers => @conference_numbers}, :auth_token => @auth.token}).
+            to_return(:body => expected_response.to_json)
+
+        subject.create_room(@name, @conference_numbers).should eq expected_response
+      end
+    end
+
+    context 'and fails' do
+      it 'should return with error for conference numbers not in array' do
+        pending
+      end
+    end
+  end
+end

data/spec/kazoo_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Kazoo do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+require 'webmock/rspec'
+require 'kazoo'
+
+RSpec.configure do |config|
+  config.include RSpec::Matchers
+end
+
+def kazoo_config
+  {   'api_key' => 'your_kazoo_developer_api_key' + '*' * 36,
+      'account_id' => 'your_account_id' + '*' * 17,
+      'host' => 'api.2600hz.com',
+      'port' => '8000',
+      'version' => 'v1',
+  }
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: kazoo-rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Zhao Lu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nestful
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for Kazoo, a powerful telephony platform
+email: zlu@me.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/conference.rb
+- kazoo.gemspec
+- lib/kazoo.rb
+- lib/kazoo.yml.sample
+- lib/kazoo/auth.rb
+- lib/kazoo/conference.rb
+- lib/kazoo/connection_error.rb
+- lib/kazoo/version.rb
+- spec/kazoo/auth_spec.rb
+- spec/kazoo/conference_spec.rb
+- spec/kazoo_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/zlu/kazoo-rb
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for Kazoo
+test_files: []