telapi 1.0.0 → 1.1.0

data/README.md

@@ -1,4 +1,4 @@
-# Telapi::Ruby
+# TelAPI Ruby Gem
 
 See www.telapi.com to signup for TelAPI.
 
@@ -153,6 +153,10 @@ Refer to the documentation for more examples.
       )
     end
 
+## Compatibility
+
+Currently targeted for Ruby 1.9.
+
 ## Contributing
 
 1. Fork it

data/lib/telapi.rb

@@ -18,6 +18,7 @@ require 'telapi/fraud'
 require 'telapi/incoming_phone_number'
 require 'telapi/message'
 require 'telapi/notification'
+require 'telapi/participant'
 require 'telapi/recording'
 require 'telapi/transcription'
 

data/lib/telapi/conference.rb

@@ -7,9 +7,10 @@ module Telapi
       # See http://www.telapi.com/docs/api/rest/conferences/list/
       #
       # Optional params is a hash containing:
-      # +MemberID+:: string
-      # +Muted+:: true or false
-      # +Deafed+:: true or false
+      # +FriendlyName+:: string
+      # +Status+:: init, in-progress, or completed
+      # +DateCreate+:: date in the following format: YYYY-MM-DD
+      # +DateUpdated+:: date in the following format: YYYY-MM-DD
       # +Page+:: integer greater than 0
       # +PageSize+:: integer greater than 0
       def list(optional_params = {})
@@ -21,185 +22,49 @@ module Telapi
       # See http://www.telapi.com/docs/api/rest/conferences/view/
       #
       # Required params:
-      # +conference_name+:: conference name
-      #
-      # Optional params is a hash containing:
-      # +MemberID+:: string
-      # +Muted+:: true or (false)
-      # +Deafed+:: true or (false)
-      def get(conference_name, optional_params = {})
-        response = Network.get(['Conferences', conference_name], optional_params)
+      # +conference_sid+:: conference identifier
+      def get(conference_sid)
+        response = Network.get(['Conferences', conference_sid])
         Conference.new(response)
       end
 
-      # Mute a member of a conference call, returning a Telapi::Conference object
-      # See http://www.telapi.com/docs/api/rest/conferences/mute/
-      #
-      # Required params:
-      # +conference_name+:: conference name
-      # +member_id+:: string
-      def mute_member(conference_name, member_id)
-        opts = { :MemberID => member_id }
-        response = Network.post(['Conferences', conference_name, 'Mute'], opts)
-        Conference.new(response)
-      end
-
-      # Unmute a member of a conference call, returning a Telapi::Conference object
-      # See http://www.telapi.com/docs/api/rest/conferences/unmute/
-      #
+      # Returns a resource collection containing Telapi::Participant objects
+      # See http://www.telapi.com/docs/api/rest/conferences/list-participants/
       # Required params:
-      # +conference_name+:: conference name
-      # +member_id+:: string
-      def unmute_member(conference_name, member_id)
-        opts = { :MemberID => member_id }
-        response = Network.post(['Conferences', conference_name, 'UnMute'], opts)
-        Conference.new(response)
-      end
-
-      # Deaf audio for a specific member of a conference call, returning a Telapi::Conference object
-      # See http://www.telapi.com/docs/api/rest/conferences/deaf/
-      #
-      # Required params:
-      # +conference_name+:: conference name
-      # +member_id+:: string
-      def deaf_member(conference_name, member_id)
-        opts = { :MemberID => member_id }
-        response = Network.post(['Conferences', conference_name, 'Deaf'], opts)
-        Conference.new(response)
-      end
-
-      # Restore audio for a specific member of a conference call, returning a Telapi::Conference object
-      # See http://www.telapi.com/docs/api/rest/conferences/undeaf/
+      # +conference_sid+:: conference identifier
       #
-      # Required params:
-      # +conference_name+:: conference name
-      # +member_id+:: string
-      def undeaf_member(conference_name, member_id)
-        opts = { :MemberID => member_id }
-        response = Network.post(['Conferences', conference_name, 'UnDeaf'], opts)
-        Conference.new(response)
-      end
-
-      # Hangup a specific member of a conference call, returning a Telapi::Conference object
-      # See http://www.telapi.com/docs/api/rest/conferences/hangup/
-      #
-      # Required params:
-      # +conference_name+:: conference name
-      # +member_id+:: string
-      def hangup_member(conference_name, member_id)
-        opts = { :MemberID => member_id }
-        response = Network.post(['Conferences', conference_name, 'Hangup'], opts)
-        Conference.new(response)
-      end
-
-      # Remove a specific member of a conference call, returning a Telapi::Conference object
-      # See http://www.telapi.com/docs/api/rest/conferences/kick/
-      #
-      # Required params:
-      # +conference_name+:: conference name
-      # +member_id+:: string
-      def kick_member(conference_name, member_id)
-        opts = { :MemberID => member_id }
-        response = Network.post(['Conferences', conference_name, 'Kick'], opts)
-        Conference.new(response)
-      end
-
-      # Send message that will be read in an audible voice to conference members, returning a Telapi::Conference object
-      # See http://www.telapi.com/docs/api/rest/conferences/speak-text/
-      #
-      # Required params:
-      # +conference_name+:: conference name
-      # +member_id+:: string
-      # +text+:: string
-      def speak_text(conference_name, member_id, text)
-        opts = { :MemberID => member_id, :Text => text }
-        response = Network.post(['Conferences', conference_name, 'Say'], opts)
-        Conference.new(response)
-      end
-
-      # Play pre-recorded sound from a file to conference members, returning a Telapi::Conference object
-      # See http://www.telapi.com/docs/api/rest/conferences/play-audio/
-      #
-      # Required params:
-      # +conference_name+:: conference name
-      # +member_id+:: string
-      # +sound_url+:: valid URL
-      def play_audio(conference_name, member_id, sound_url)
-        opts = { :MemberID => member_id, :Url => sound_url }
-        response = Network.post(['Conferences', conference_name, 'Play'], opts)
-        Conference.new(response)
-      end
-
-      # Record conference, returning a Telapi::Conference object
-      # See http://www.telapi.com/docs/api/rest/conferences/start-recording/
-      #
-      # Required params:
-      # +conference_name+:: conference name
-      def start_recording(conference_name)
-        response = Network.post(['Conferences', conference_name, 'RecordStart'])
-        Conference.new(response)
+      # Optional params:
+      # +Muted+:: true or (false)
+      # +Deaf+:: true or (false)
+      # +Page+:: integer greater than 0
+      # +PageSize+:: integer greater than 0
+      def participants(conference_sid, optional_params = {})
+        response = Network.get(['Conferences', conference_sid, 'Participants'], optional_params)
+        ResourceCollection.new(response, 'participants', Participant)
       end
 
-      # End recording of conference, returning a Telapi::Conference object
-      # See http://www.telapi.com/docs/api/rest/conferences/stop-recording/
-      #
+      # Returns a Telapi::Participant object
+      # See http://www.telapi.com/docs/api/rest/conferences/view-participant/
       # Required params:
-      # +conference_name+:: conference name
-      def stop_recording(conference_name)
-        response = Network.post(['Conferences', conference_name, 'RecordStop'])
-        Conference.new(response)
+      # +conference_sid+:: conference identifier
+      # +call_sid+:: call identifier
+      def participant(conference_sid, call_sid)
+        response = Network.get(['Conferences', conference_sid, 'Participants', call_sid])
+        Participant.new(response)
       end
 
     end
 
-    # See ::mute_member
-    def mute_member(member_id)
-      self.class.mute_member(self.name, member_id)
-    end
-
-    # See ::unmute_member
-    def unmute_member(member_id)
-      self.class.unmute_member(self.name, member_id)
-    end
-
-    # See ::deaf_member
-    def deaf_member(member_id)
-      self.class.deaf_member(self.name, member_id)
-    end
-
-    # See ::undeaf_member
-    def undeaf_member(member_id)
-      self.class.undeaf_member(self.name, member_id)
-    end
-
-    # See ::hangup_member
-    def hangup_member(member_id)
-      self.class.hangup_member(self.name, member_id)
-    end
-
-    # See ::kick_member
-    def kick_member(member_id)
-      self.class.kick_member(self.name, member_id)
-    end
-
-    # See ::speak_text
-    def speak_text(member_id, text)
-      self.class.speak_text(self.name, member_id, text)
-    end
-
-    # See ::play_audio
-    def play_audio(member_id, sound_url)
-      self.class.play_audio(self.name, member_id, sound_url)
-    end
-
-    # See ::start_recording
-    def start_recording
-      self.class.start_recording(self.name)
+    # See ::participants
+    def participants(optional_params = {})
+      self.class.participants(self.sid, optional_params)
     end
 
-    # See ::stop_recording
-    def stop_recording
-      self.class.stop_recording(self.name)
+    # See ::participant
+    # Required params:
+    # +call_sid+:: call (participant) identifier
+    def participant(call_sid)
+      self.class.participant(self.sid, call_sid)
     end
 
   end

data/lib/telapi/participant.rb

@@ -0,0 +1,64 @@
+module Telapi
+  # A Participant is always generated via Conferences but
+  # this class also provides some convenience methods to access
+  # them directly, thereby reducing API calls.
+  class Participant < Resource
+    class << self
+      # Convenient alternative to Conference::participants
+      def list(conference_sid, optional_params = {})
+        Conference.participants(conference_sid, optional_params)
+      end
+
+      # Convenient alternative to Conference::participant
+      def get(conference_sid, call_sid)
+        Conference.participant(conference_sid, call_sid)
+      end
+    end
+
+    # Deaf a participant of a conference call, returning a Telapi::Participant object
+    # See http://www.telapi.com/docs/api/rest/conferences/deaf-or-mute/
+    def deaf
+      response = Network.post(['Conferences', self.conference_sid, 'Participant', self.call_sid], { :Deaf => true })
+      Participant.new(response)
+    end
+
+    # Undeaf a participant of a conference call, returning a Telapi::Participant object
+    # See http://www.telapi.com/docs/api/rest/conferences/deaf-or-mute/
+    def undeaf
+      response = Network.post(['Conferences', self.conference_sid, 'Participant', self.call_sid], { :Deaf => false })
+      Participant.new(response)
+    end
+
+    # Mute a participant of a conference call, returning a Telapi::Participant object
+    # See http://www.telapi.com/docs/api/rest/conferences/deaf-or-mute/
+    def mute
+      response = Network.post(['Conferences', self.conference_sid, 'Participant', self.call_sid], { :Muted => true })
+      Participant.new(response)
+    end
+
+    # Unmute a participant of a conference call, returning a Telapi::Participant object
+    # See http://www.telapi.com/docs/api/rest/conferences/deaf-or-mute/
+    def unmute
+      response = Network.post(['Conferences', self.conference_sid, 'Participant', self.call_sid], { :Muted => false })
+      Participant.new(response)
+    end
+
+    # Hangup a participant of a conference call, returning a Telapi::Participant object
+    # See http://www.telapi.com/docs/api/rest/conferences/hangup-participant/
+    def hangup
+      response = Network.delete(['Conferences', self.conference_sid, 'Participant', self.call_sid])
+      Participant.new(response)
+    end
+
+    # Play pre-recorded sound from a file to conference members, returning a Telapi::Participant object
+    # See http://www.telapi.com/docs/api/rest/conferences/play-audio/
+    #
+    # Required params:
+    # +sound_url+:: URL containing an audio file
+    def play_audio(sound_url = 'http://www.telapi.com/audio.mp3')
+      response = Network.post(['Conferences', self.conference_sid, 'Participant', self.call_sid], { :AudioUrl => sound_url })
+      Participant.new(response)
+    end
+
+  end
+end

data/lib/telapi/version.rb

@@ -1,3 +1,3 @@
 module Telapi
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/telapi/conference_spec.rb

@@ -17,7 +17,7 @@ describe Telapi::Conference do
     end
 
     context "when conferences exist" do
-      before { stub_telapi_request('{ "conferences": [{ "name": "TelAPIChat" }] }') }
+      before { stub_telapi_request('{ "conferences": [{ "friendly_name": "testing" }] }') }
 
       it "has a collection of Conference objects" do
         klass.list.first.should be_a(klass)
@@ -32,143 +32,41 @@ describe Telapi::Conference do
     end
   end
 
-  describe ".mute_member" do
-    it "calls api via http post and returns a Conference resource" do
-      api_should_use(:post)
-      klass.mute_member('abc123', '123').should be_a(klass)
-    end
-  end
-
-  describe "#mute_member" do
-    it "proxies to Conference.mute_member" do
-      klass.should_receive(:mute_member)
-      klass.get('abc123').mute_member('123')
-    end
-  end
-
-  describe ".unmute_member" do
-    it "calls api via http post and returns a Conference resource" do
-      api_should_use(:post)
-      klass.unmute_member('abc123', '123').should be_a(klass)
-    end
-  end
-
-  describe "#unmute_member" do
-    it "proxies to Conference.unmute_member" do
-      klass.should_receive(:unmute_member)
-      klass.get('abc123').unmute_member('123')
-    end
-  end
-
-  describe ".deaf_member" do
-    it "calls api via http post and returns a Conference resource" do
-      api_should_use(:post)
-      klass.deaf_member('abc123', '123').should be_a(klass)
-    end
-  end
-
-  describe "#deaf_member" do
-    it "proxies to Conference.deaf_member" do
-      klass.should_receive(:deaf_member)
-      klass.get('abc123').deaf_member('123')
-    end
-  end
-
-  describe ".undeaf_member" do
-    it "calls api via http post and returns a Conference resource" do
-      api_should_use(:post)
-      klass.undeaf_member('abc123', '123').should be_a(klass)
-    end
-  end
-
-  describe "#undeaf_member" do
-    it "proxies to Conference.undeaf_member" do
-      klass.should_receive(:undeaf_member)
-      klass.get('abc123').undeaf_member('123')
-    end
-  end
-
-  describe ".hangup_member" do
-    it "calls api via http post and returns a Conference resource" do
-      api_should_use(:post)
-      klass.hangup_member('abc123', '123').should be_a(klass)
-    end
-  end
-
-  describe "#hangup_member" do
-    it "proxies to Conference.hangup_member" do
-      klass.should_receive(:hangup_member)
-      klass.get('abc123').hangup_member('123')
-    end
-  end
-
-  describe ".kick_member" do
-    it "calls api via http post and returns a Conference resource" do
-      api_should_use(:post)
-      klass.kick_member('abc123', '123').should be_a(klass)
-    end
-  end
-
-  describe "#kick_member" do
-    it "proxies to Conference.kick_member" do
-      klass.should_receive(:kick_member)
-      klass.get('abc123').kick_member('123')
-    end
-  end
-
-  describe ".speak_text" do
-    it "calls api via http post and returns a Conference resource" do
-      api_should_use(:post)
-      klass.speak_text('abc123', '123', 'hi').should be_a(klass)
-    end
-  end
-
-  describe "#speak_text" do
-    it "proxies to Conference.speak_text" do
-      klass.should_receive(:speak_text)
-      klass.get('abc123').speak_text('123', 'hi')
-    end
-  end
+  describe ".participants" do
+    before { stub_telapi_request('{ "participants": [] }') }
 
-  describe ".play_audio" do
-    it "calls api via http post and returns a Conference resource" do
-      api_should_use(:post)
-      klass.play_audio('abc123', '123', 'http://url').should be_a(klass)
+    it "calls api via http get and returns a ResourceCollection" do
+      api_should_use(:get)
+      klass.participants('abc123').should be_a(Telapi::ResourceCollection)
     end
-  end
 
-  describe "#play_audio" do
-    it "proxies to Conference.play_audio" do
-      klass.should_receive(:play_audio)
-      klass.get('abc123').play_audio('123', 'http://url')
-    end
-  end
+    context "when Participants exist" do
+      before { stub_telapi_request('{ "participants": [{ "duration": "6" }] }') }
 
-  describe ".start_recording" do
-    it "calls api via http post and returns a Conference resource" do
-      api_should_use(:post)
-      klass.start_recording('abc123').should be_a(klass)
+      it "has a collection of Participant objects" do
+        klass.participants('abc123').first.should be_a(Telapi::Participant)
+      end
     end
   end
 
-  describe "#start_recording" do
-    it "proxies to Conference.start_recording" do
-      klass.should_receive(:start_recording)
-      klass.get('abc123').start_recording
+  describe "#participants" do
+    it "proxies to Conference.participants" do
+      klass.should_receive(:participants)
+      klass.get('abc123').participants
     end
   end
 
-  describe ".stop_recording" do
-    it "calls api via http post and returns a Conference resource" do
-      api_should_use(:post)
-      klass.stop_recording('abc123').should be_a(klass)
+  describe ".participant" do
+    it "calls api via http get and returns a Participant" do
+      api_should_use(:get)
+      klass.participant('abc123', '123').should be_a(Telapi::Participant)
     end
   end
 
-  describe "#stop_recording" do
-    it "proxies to Conference.stop_recording" do
-      klass.should_receive(:stop_recording)
-      klass.get('abc123').stop_recording
+  describe "#participant" do
+    it "proxies to Conference.participant" do
+      klass.should_receive(:participant)
+      klass.get('abc123').participant('123')
     end
   end
 end

data/spec/telapi/participant_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Telapi::Participant do
+  before do
+    stub_telapi_request
+    set_account_sid_and_auth_token
+  end
+
+  it { should be_kind_of(Telapi::Participant) }
+
+  describe ".list" do
+    it "proxies to Conference.participants" do
+      Telapi::Conference.should_receive(:participants).with('abc123', {})
+      klass.list('abc123')
+    end
+  end
+
+  describe ".get" do
+    it "proxies to Conference.participant" do
+      Telapi::Conference.should_receive(:participant).with('abc123', '123')
+      klass.get('abc123', '123')
+    end
+  end
+
+  let(:participant) { klass.get('abc123', '123') }
+
+  describe "#deaf" do
+    it "calls api via http post and returns a Participant resource" do
+      api_should_use(:post)
+      participant.deaf.should be_a(klass)
+    end
+  end
+
+  describe "#undeaf" do
+    it "calls api via http post and returns a Participant resource" do
+      api_should_use(:post)
+      participant.undeaf.should be_a(klass)
+    end
+  end
+
+  describe "#mute" do
+    it "calls api via http post and returns a Participant resource" do
+      api_should_use(:post)
+      participant.mute.should be_a(klass)
+    end
+  end
+
+  describe "#unmute" do
+    it "calls api via http post and returns a Participant resource" do
+      api_should_use(:post)
+      participant.unmute.should be_a(klass)
+    end
+  end
+
+  describe "#hangup" do
+    it "calls api via http delete and returns a Participant resource" do
+      api_should_use(:delete)
+      participant.hangup.should be_a(klass)
+    end
+  end
+
+  describe "#play_audio" do
+    it "calls api via http post and returns a Participant resource" do
+      api_should_use(:post)
+      participant.play_audio('http://url').should be_a(klass)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: telapi
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-11 00:00:00.000000000 Z
+date: 2012-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -152,6 +152,7 @@ files:
 - lib/telapi/message.rb
 - lib/telapi/network.rb
 - lib/telapi/notification.rb
+- lib/telapi/participant.rb
 - lib/telapi/recording.rb
 - lib/telapi/resource.rb
 - lib/telapi/resource_collection.rb
@@ -174,6 +175,7 @@ files:
 - spec/telapi/message_spec.rb
 - spec/telapi/network_spec.rb
 - spec/telapi/notification_spec.rb
+- spec/telapi/participant_spec.rb
 - spec/telapi/recording_spec.rb
 - spec/telapi/resource_collection_spec.rb
 - spec/telapi/resource_spec.rb
@@ -221,6 +223,7 @@ test_files:
 - spec/telapi/message_spec.rb
 - spec/telapi/network_spec.rb
 - spec/telapi/notification_spec.rb
+- spec/telapi/participant_spec.rb
 - spec/telapi/recording_spec.rb
 - spec/telapi/resource_collection_spec.rb
 - spec/telapi/resource_spec.rb