telapi 1.0.0

data/spec/telapi/error_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Telapi::ApiError do
+  subject do
+    Telapi::ApiError.new(
+      'status' => 403,
+      'message' => 'Invalid credentials supplied',
+      'code' => 10004,
+      'more_info' => 'http://www.telapi.com/docs/api/rest/overview/errors/10004'
+    )
+  end
+
+  it "has a status" do
+    subject.status.should == 403
+  end
+
+  it "has a code" do
+    subject.code.should == 10004
+  end
+
+  it "has a help uri" do
+    subject.help_uri.should == 'http://www.telapi.com/docs/api/rest/overview/errors/10004'
+  end
+end
+
+describe Telapi::InvalidConfiguration do
+  subject { Telapi::InvalidConfiguration.new('attribute name') }
+
+  it "has a message containing the attribute" do
+    subject.message.should include('attribute name')
+  end
+end

data/spec/telapi/fraud_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Telapi::Fraud do
+  before do
+    stub_telapi_request
+    set_account_sid_and_auth_token
+  end
+
+  it { should be_kind_of(Telapi::Resource) }
+
+  describe ".list" do
+    before { stub_telapi_request('{ "frauds": [] }') }
+
+    it "calls api via http get and returns a ResourceCollection" do
+      api_should_use(:get)
+      klass.list.should be_a(Telapi::ResourceCollection)
+    end
+
+    context "when Fraud controls exist" do
+      before { stub_telapi_request('{ "frauds": [{ "key": "value" }] }') }
+
+      it "has a collection of Fraud objects" do
+        klass.list.first.should be_a(klass)
+      end
+    end
+  end
+
+  describe ".authorize" do
+    it "calls api via http post and returns a Fraud resource" do
+      api_should_use(:post)
+      klass.authorize('US').should be_a(klass)
+    end
+  end
+
+  describe ".extend_authorization" do
+    it "calls api via http post and returns a Fraud resource" do
+      api_should_use(:post)
+      klass.extend_authorization('US').should be_a(klass)
+    end
+  end
+
+  describe ".block" do
+    it "calls api via http post and returns a Fraud resource" do
+      api_should_use(:post)
+      klass.block('US').should be_a(klass)
+    end
+  end
+
+  describe ".whitelist" do
+    it "calls api via http post and returns a Fraud resource" do
+      api_should_use(:post)
+      klass.whitelist('US').should be_a(klass)
+    end
+  end
+end

data/spec/telapi/inbound_xml_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+# to avoid retesting the Nokogiri gem, our specs are minimal
+describe Telapi::InboundXml do
+  describe "#reponse" do
+    it "returns XML wrapped in a Response node" do
+
+      ix = klass.new do
+        Say('Hello.', :loop => 3, :voice => 'man')
+        Say('Hello, my name is Jane.', :voice => 'woman')
+        Say('Now I will not stop talking.', :loop => 0)
+      end
+
+      expected = <<-END.gsub(/^ {6}/, '')
+      <?xml version="1.0"?>
+      <Response>
+        <Say loop="3" voice="man">Hello.</Say>
+        <Say voice="woman">Hello, my name is Jane.</Say>
+        <Say loop="0">Now I will not stop talking.</Say>
+      </Response>
+      END
+
+      ix.response.should == expected
+    end
+
+    it "handles nested blocks correctly" do
+
+      ix = klass.new do
+        Gather(:action      => 'http://example.com/example-callback-url/say?example=simple.xml',
+               :method      => 'GET',
+               :numDigits   => '4',
+               :finishOnKey => '#') {
+          Say 'Please enter your 4 digit pin.'
+        }
+      end
+
+      expected = <<-END.gsub(/^ {6}/, '')
+      <?xml version="1.0"?>
+      <Response>
+        <Gather action="http://example.com/example-callback-url/say?example=simple.xml" method="GET" numDigits="4" finishOnKey="#">
+          <Say>Please enter your 4 digit pin.</Say>
+        </Gather>
+      </Response>
+      END
+
+      ix.response.should == expected
+    end
+  end
+end

data/spec/telapi/incoming_phone_number_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Telapi::IncomingPhoneNumber do
+  before do
+    stub_telapi_request
+    set_account_sid_and_auth_token
+  end
+
+  it { should be_kind_of(Telapi::Resource) }
+
+  describe ".list" do
+    before { stub_telapi_request('{ "incoming_phone_numbers": [] }') }
+
+    it "calls api via http get and returns a ResourceCollection" do
+      api_should_use(:get)
+      klass.list.should be_a(Telapi::ResourceCollection)
+    end
+
+    context "when Incoming Phone Numbers exist" do
+      before { stub_telapi_request('{ "incoming_phone_numbers": [{ "phone_number": "+14242495526" }] }') }
+
+      it "has a collection of Incoming Phone Number objects" do
+        klass.list.first.should be_a(klass)
+      end
+    end
+  end
+
+  describe ".get" do
+    it "calls api via http get and returns a IncomingPhoneNumber resource" do
+      api_should_use(:get)
+      klass.get('abc123').should be_a(klass)
+    end
+  end
+
+  describe ".create" do
+    it "calls api via http post and returns an IncomingPhoneNumber resource" do
+      api_should_use(:post)
+      klass.create('14155551234').should be_a(klass)
+    end
+  end
+
+  describe ".delete" do
+    it "calls api via http delete and returns an IncomingPhoneNumber resource" do
+      api_should_use(:delete)
+      klass.delete('123').should be_a(klass)
+    end
+  end
+
+  describe "#delete" do
+    it "proxies to IncomingPhoneNumber.speak_text" do
+      klass.should_receive(:delete)
+      klass.get('abc123').delete
+    end
+  end
+
+  describe ".update" do
+    it "calls api via http post and returns an IncomingPhoneNumber resource" do
+      api_should_use(:post)
+      klass.update('123', :FriendlyName => 'new name').should be_a(klass)
+    end
+  end
+
+  describe "#update" do
+    it "proxies to IncomingPhoneNumber.update" do
+      klass.should_receive(:update)
+      klass.get('abc123').update(:FriendlyName => 'new name')
+    end
+  end
+end

data/spec/telapi/message_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Telapi::Message do
+  before do
+    stub_telapi_request
+    set_account_sid_and_auth_token
+  end
+
+  it { should be_kind_of(Telapi::Resource) }
+
+  describe ".list" do
+    before { stub_telapi_request('{ "sms_messages": [] }') }
+
+    it "calls api via http get and returns a ResourceCollection" do
+      api_should_use(:get)
+      klass.list.should be_a(Telapi::ResourceCollection)
+    end
+
+    context "when SMS Messages exist" do
+      before { stub_telapi_request('{ "sms_messages": [{ "from": "+14245551234","to": "+17325551234"}] }') }
+
+      it "has a collection of Message objects" do
+        klass.list.first.should be_a(klass)
+      end
+    end
+  end
+
+  describe ".get" do
+    it "calls api via http get and returns a Message resource" do
+      api_should_use(:get)
+      klass.get('abc123').should be_a(klass)
+    end
+  end
+
+  describe ".create" do
+    it "calls api via http post and returns a Message resource" do
+      api_should_use(:post)
+      klass.create('(111) 111-1111', '(999) 999-9999', 'My SMS message').should be_a(klass)
+    end
+  end
+end

data/spec/telapi/network_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Telapi::Network do
+  before do
+    set_account_sid_and_auth_token
+    stub_telapi_request
+  end
+
+  describe ".get" do
+    it "gets an api response and converts to a hash" do
+      subject.get.should be_a(Hash)
+    end
+
+    context "when error is returned by the API" do
+      before { stub_telapi_request_with_error_response }
+
+      it "raises a ApiError" do
+        expect { subject.get }.to raise_error(Telapi::ApiError)
+      end
+    end
+  end
+
+  describe ".post" do
+    it "gets an api response and converts to a hash" do
+      subject.post(:param1 => 'value1').should be_a(Hash)
+    end
+
+    context "when error is returned by the API" do
+      before { stub_telapi_request_with_error_response }
+
+      it "raises a ApiError" do
+        expect { subject.post(:param1 => 'value1') }.to raise_error(Telapi::ApiError)
+      end
+    end
+  end
+
+  describe ".delete" do
+    it "gets an api response and converts to a hash" do
+      subject.delete.should be_a(Hash)
+    end
+
+    context "when error is returned by the API" do
+      before { stub_telapi_request_with_error_response }
+
+      it "raises a ApiError" do
+        expect { subject.delete }.to raise_error(Telapi::ApiError)
+      end
+    end
+  end
+
+  describe ".api_uri" do
+    it "generates a uri using an array of path components" do
+      path_components = ['SomeResource', '123']
+      subject.api_uri(path_components).should == 'https://api.telapi.com/2011-07-01/Accounts/a1b2c3/SomeResource/123.json'
+    end
+
+    context "when path components are not supplied" do
+      it "generates a uri consisting of the root resource (Account)" do
+        subject.api_uri.should == 'https://api.telapi.com/2011-07-01/Accounts/a1b2c3.json'
+      end
+    end
+  end
+
+  describe ".response_format" do
+    it "is json" do
+      subject.response_format.should == '.json'
+    end
+  end
+
+  describe ".default_options" do
+    it "raises an Invalid Configuration exception when not set properly" do
+      reset_config
+      expect { subject.default_options }.to raise_error(Telapi::InvalidConfiguration)
+    end
+
+    it "gets a hash of config options" do
+      subject.default_options.should be_a(Hash)
+    end
+  end
+end

data/spec/telapi/notification_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Telapi::Notification do
+  before do
+    stub_telapi_request
+    set_account_sid_and_auth_token
+  end
+
+  it { should be_kind_of(Telapi::Resource) }
+
+  describe ".list" do
+    before { stub_telapi_request('{ "notifications": [] }') }
+
+    it "calls api via http get and returns a ResourceCollection" do
+      api_should_use(:get)
+      klass.list.should be_a(Telapi::ResourceCollection)
+    end
+
+    context "when Notifications exist" do
+      before { stub_telapi_request('{ "notifications": [{ "message_text": "foo" }] }') }
+
+      it "has a collection of Notification objects" do
+        klass.list.first.should be_a(klass)
+      end
+    end
+  end
+
+  describe ".get" do
+    it "calls api via http get and returns a Notification resource" do
+      api_should_use(:get)
+      klass.get('abc123').should be_a(klass)
+    end
+  end
+end

data/spec/telapi/recording_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Telapi::Recording do
+  before do
+    stub_telapi_request
+    set_account_sid_and_auth_token
+  end
+
+  it { should be_kind_of(Telapi::Resource) }
+
+  describe ".list" do
+    before { stub_telapi_request('{ "recordings": [] }') }
+
+    it "calls api via http get and returns a ResourceCollection" do
+      api_should_use(:get)
+      klass.list.should be_a(Telapi::ResourceCollection)
+    end
+
+    context "when Recordings exist" do
+      before { stub_telapi_request('{ "recordings": [{ "duration": "6" }] }') }
+
+      it "has a collection of Recording objects" do
+        klass.list.first.should be_a(klass)
+      end
+    end
+  end
+
+  describe ".get" do
+    it "calls api via http get and returns a Recording resource" do
+      api_should_use(:get)
+      klass.get('abc123').should be_a(klass)
+    end
+  end
+
+  describe ".transcribe" do
+    it "calls api via http post and returns a Transcription resource" do
+      api_should_use(:post)
+      klass.transcribe('abc123').should be_a(Telapi::Transcription)
+    end
+  end
+
+  describe "#transcribe" do
+    it "proxies to Recording.transcribe" do
+      klass.should_receive(:transcribe)
+      klass.get('abc123').transcribe
+    end
+  end
+
+  describe ".transcriptions" do
+    before { stub_telapi_request('{ "transcriptions": [] }') }
+
+    it "calls api via http get and returns a ResourceCollection" do
+      api_should_use(:get)
+      klass.transcriptions('abc123').should be_a(Telapi::ResourceCollection)
+    end
+
+    context "when Transcriptions exist" do
+      before { stub_telapi_request('{ "transcriptions": [{ "transcription_text": "foo" }] }') }
+
+      it "has a collection of Transcription objects" do
+        klass.transcriptions('abc123').first.should be_a(Telapi::Transcription)
+      end
+    end
+  end
+
+  describe "#transcriptions" do
+    it "proxies to Recording.transcriptions" do
+      klass.should_receive(:transcriptions)
+      klass.get('abc123').transcriptions
+    end
+  end
+end

data/spec/telapi/resource_collection_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Telapi::ResourceCollection do
+  context "when initialized with at least one nested item" do
+    subject do
+      klass.new({
+        'page' => 0,
+        'num_pages' => 0,
+        'page_size' => 5,
+        'total' => 1,
+        'start' => 0,
+        'end' => 0,
+        'items' => [{ 'food' => 'burger', 'drink' => 'beer' }]
+        }, 'items', Telapi::Resource)
+    end
+
+    context "setting collection-specific metrics" do
+      its(:page) { should == 0 }
+      its(:num_pages) { should == 0 }
+      its(:page_size) { should == 5 }
+      its(:total) { should == 1 }
+      its(:start) { should == 0 }
+      its(:end) { should == 0 }
+    end
+
+    it "has an item count greater than 0" do
+      subject.items.length.should be > 0
+    end
+
+    it "is not empty" do
+      subject.should_not be_empty
+    end
+
+    it "can return the last item" do
+      subject.last.should be_a(Telapi::Resource)
+    end
+
+    it "can return an item using its index" do
+      subject[0].should be_a(Telapi::Resource)
+    end
+  end
+
+  context "when initialized without any nested items" do
+    subject do
+      klass.new({ 'meal' => 'dinner', 'items' => [] }, 'items', Telapi::Resource)
+    end
+
+    it "has 0 items" do
+      subject.items.length.should == 0
+    end
+
+    it "is empty" do
+      subject.should be_empty
+    end
+
+    it "returns nil when getting the last item" do
+      subject.last.should be_nil
+    end
+
+    it "returns nil when getting a specific index" do
+      subject[0].should be_nil
+    end
+  end
+end